Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[tune] Fix TrialTerminationReporter in docs #29254

Merged
merged 3 commits into from
Oct 14, 2022
Merged

[tune] Fix TrialTerminationReporter in docs #29254

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c68c69e
Make TrialTerminationReporter working
linusbiostat Oct 12, 2022
147f5eb
Update reporters.rst
linusbiostat Oct 12, 2022
5f0b726
Nit
Yard1 Oct 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/source/tune/api_docs/reporters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Extending ``CLIReporter`` lets you control reporting frequency. For example:

.. code-block:: python

from ray.tune.experiment.trial import Trial

class ExperimentTerminationReporter(CLIReporter):
def should_report(self, trials, done=False):
"""Reports only on experiment termination."""
Expand All @@ -55,6 +57,7 @@ Extending ``CLIReporter`` lets you control reporting frequency. For example:

class TrialTerminationReporter(CLIReporter):
def __init__(self):
super(TrialTerminationReporter, self).__init__()
self.num_terminated = 0

def should_report(self, trials, done=False):
Expand Down