ray.tune.ProgressReporter.setup#

ProgressReporter.setup(start_time: float | None = None, total_samples: int | None = None, metric: str | None = None, mode: str | None = None, **kwargs)[source]#

Setup progress reporter for a new Ray Tune run.

This function is used to initialize parameters that are set on runtime. It will be called before any of the other methods.

Defaults to no-op.

Parameters:

  • start_time – Timestamp when the Ray Tune run is started.

  • total_samples – Number of samples the Ray Tune run will run.

  • metric – Metric to optimize.

  • mode – Must be one of [min, max]. Determines whether objective is minimizing or maximizing the metric attribute.

  • **kwargs – Keyword arguments for forward-compatibility.