ray.tune.ProgressReporter#

class ray.tune.ProgressReporter[source]#

Bases: object

Abstract class for experiment progress reporting.

should_report() is called to determine whether or not report() should be called. Tune will call these functions after trial state transitions, receiving training results, and so on.

PublicAPI: This API is stable across Ray releases.

Methods

__init__()

report(trials, done, *sys_info)

Reports progress across trials.

setup([start_time, total_samples, metric, mode])

Setup progress reporter for a new Ray Tune run.

should_report(trials[, done])

Returns whether or not progress should be reported.