binary_classification_pipeline_mixin
===============================================================

.. py:module:: evalml.pipelines.binary_classification_pipeline_mixin

.. autoapi-nested-parse::

   Binary classification pipeline mix-in class.



Module Contents
---------------

Classes Summary
~~~~~~~~~~~~~~~

.. autoapisummary::

   evalml.pipelines.binary_classification_pipeline_mixin.BinaryClassificationPipelineMixin





Contents
~~~~~~~~~~~~~~~~~~~
.. py:class:: BinaryClassificationPipelineMixin

   Binary classification pipeline mix-in class.




   **Methods**

   .. autoapisummary::
      :nosignatures:

      evalml.pipelines.binary_classification_pipeline_mixin.BinaryClassificationPipelineMixin.optimize_threshold
      evalml.pipelines.binary_classification_pipeline_mixin.BinaryClassificationPipelineMixin.threshold

   .. py:method:: optimize_threshold(self, X, y, y_pred_proba, objective)

      Optimize the pipeline threshold given the objective to use. Only used for binary problems with objectives whose thresholds can be tuned.

      :param X: Input features.
      :type X: pd.DataFrame
      :param y: Input target values.
      :type y: pd.Series
      :param y_pred_proba: The predicted probabilities of the target outputted by the pipeline.
      :type y_pred_proba: pd.Series
      :param objective: The objective to threshold with. Must have a tunable threshold.
      :type objective: ObjectiveBase

      :raises ValueError: If objective is not optimizable.


   .. py:method:: threshold(self)
      :property:

      Threshold used to make a prediction. Defaults to None.