ray.tune.report

ray.tune.report(metrics: Dict, *, checkpoint: Checkpoint | None = None) → None

Report metrics and optionally save and register a checkpoint to Ray Tune.

If a checkpoint is provided, it will be persisted to storage.

Note

Each invocation of this method will automatically increment the underlying training_iteration number. The physical meaning of this “iteration” is defined by user depending on how often they call report. It does not necessarily map to one epoch.

Parameters:

• metrics – The metrics you want to report.

• checkpoint – The optional checkpoint you want to report.