mirror of
https://github.com/vale981/ray
synced 2025-03-09 12:56:46 -04:00
5cc9355303
Continuing docs overhaul, tune now has: - [x] better landing page - [x] a getting started guide - [x] user guide was cut down, partially merged with FAQ, and partially integrated with tutorials - [x] the new user guide contains guides to tune features and practical integrations - [x] we rewrote some of the feature guides for clarity - [x] we got rid of sphinx-gallery for this sub-project (only data and core left), as it looks bad and is unnecessarily complicated anyway (plus, makes the build slower) - [x] sphinx-gallery examples are now moved to markdown notebook, as started in #22030. - [x] Examples are tested in the new framework, of course. There's still a lot one can do, but this is already getting too large. Will follow up with more fine-tuning next week. Co-authored-by: Antoni Baum <antoni.baum@protonmail.com> Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
46 lines
1.5 KiB
ReStructuredText
46 lines
1.5 KiB
ReStructuredText
.. _tune-stoppers:
|
|
|
|
Stopping mechanisms (tune.stopper)
|
|
==================================
|
|
|
|
In addition to Trial Schedulers like :ref:`ASHA <tune-scheduler-hyperband>`, where a number of
|
|
trials are stopped if they perform subpar, Ray Tune also supports custom stopping mechanisms to stop trials early. For instance, stopping mechanisms can specify to stop trials when they reached a plateau and the metric
|
|
doesn't change anymore.
|
|
|
|
Ray Tune comes with several stopping mechanisms out of the box. For custom stopping behavior, you can
|
|
inherit from the :class:`Stopper <ray.tune.Stopper>` class.
|
|
|
|
Other stopping behaviors are described :ref:`in the user guide <tune-stopping-ref>`.
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 1
|
|
|
|
|
|
.. _tune-stop-ref:
|
|
|
|
Stopper (tune.Stopper)
|
|
----------------------
|
|
|
|
.. autoclass:: ray.tune.Stopper
|
|
:members: __call__, stop_all
|
|
|
|
MaximumIterationStopper (tune.stopper.MaximumIterationStopper)
|
|
--------------------------------------------------------------
|
|
|
|
.. autoclass:: ray.tune.stopper.MaximumIterationStopper
|
|
|
|
ExperimentPlateauStopper (tune.stopper.ExperimentPlateauStopper)
|
|
----------------------------------------------------------------
|
|
|
|
.. autoclass:: ray.tune.stopper.ExperimentPlateauStopper
|
|
|
|
TrialPlateauStopper (tune.stopper.TrialPlateauStopper)
|
|
------------------------------------------------------
|
|
|
|
.. autoclass:: ray.tune.stopper.TrialPlateauStopper
|
|
|
|
TimeoutStopper (tune.stopper.TimeoutStopper)
|
|
--------------------------------------------
|
|
|
|
.. autoclass:: ray.tune.stopper.TimeoutStopper
|