progress
================================

.. py:module:: evalml.automl.progress

.. autoapi-nested-parse::

   Progress abstraction holding stopping criteria and progress information.



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

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

.. autoapisummary::

   evalml.automl.progress.Progress





Contents
~~~~~~~~~~~~~~~~~~~
.. py:class:: Progress(max_time=None, max_batches=None, max_iterations=None, patience=None, tolerance=None, automl_algorithm=None, objective=None, verbose=False)

   Progress object holding stopping criteria and progress information.

   :param max_time: Maximum time to search for pipelines.
   :type max_time: int
   :param max_iterations: Maximum number of iterations to search.
   :type max_iterations: int
   :param max_batches: The maximum number of batches of pipelines to search. Parameters max_time, and
                       max_iterations have precedence over stopping the search.
   :type max_batches: int
   :param patience: Number of iterations without improvement to stop search early.
   :type patience: int
   :param tolerance: Minimum percentage difference to qualify as score improvement for early stopping.
   :type tolerance: float
   :param automl_algorithm: The automl algorithm to use. Used to calculate iterations if max_batches is selected as stopping criteria.
   :type automl_algorithm: str
   :param objective: The objective used in search.
   :type objective: str, ObjectiveBase
   :param verbose: Whether or not to log out stopping information.
   :type verbose: boolean




   **Methods**

   .. autoapisummary::
      :nosignatures:

      evalml.automl.progress.Progress.elapsed
      evalml.automl.progress.Progress.return_progress
      evalml.automl.progress.Progress.should_continue
      evalml.automl.progress.Progress.start_timing

   .. py:method:: elapsed(self)

      Return time elapsed using the start time and current time.


   .. py:method:: return_progress(self)

      Return information about current and end state of each stopping criteria in order of priority.

      :returns: list of dictionaries containing information of each stopping criteria.
      :rtype: List[Dict[str, unit]]


   .. py:method:: should_continue(self, results, interrupted=False, mid_batch=False)

      Given AutoML Results, return whether or not the search should continue.

      :param results: AutoMLSearch results.
      :type results: dict
      :param interrupted: whether AutoMLSearch was given an keyboard interrupt. Defaults to False.
      :type interrupted: bool
      :param mid_batch: whether this method was called while in the middle of a batch or not. Defaults to False.
      :type mid_batch: bool

      :returns: True if search should continue, False otherwise.
      :rtype: bool


   .. py:method:: start_timing(self)

      Sets start time to current time.