Skip to content

Commit

Permalink
[tune] Fix TrialTerminationReporter in docs (#29254)
Browse files Browse the repository at this point in the history
Co-authored-by: Antoni Baum <[email protected]>
  • Loading branch information
linusbiostat and Yard1 authored Oct 14, 2022
1 parent d0faec1 commit f86b141
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/source/tune/api_docs/reporters.rst
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

0 comments on commit f86b141

Please sign in to comment.