ray.train.Result#

class ray.train.Result(metrics: Dict[str, Any] | None, checkpoint: ray.train._checkpoint.Checkpoint | None, error: ray.train.v2.api.exceptions.TrainingFailedError | None, path: str, metrics_dataframe: Optional[ForwardRef('pd.DataFrame')] = None, best_checkpoints: List[Tuple[ray.train._checkpoint.Checkpoint, Dict[str, Any]]] | None = None, _storage_filesystem: pyarrow.fs.FileSystem | None = None)#

Bases: Result

property config: Dict[str, Any] | None#

Warning

DEPRECATED: This API is deprecated and may be removed in future Ray releases.

classmethod from_path(path: str | PathLike, storage_filesystem: pyarrow.fs.FileSystem | None = None) → Result[source]#

Restore a training result from a previously saved training run path.

Parameters:

  • path – Path to the run output directory

  • storage_filesystem – Optional filesystem to use for accessing the path

Returns:

Result object with restored checkpoints and metrics

get_best_checkpoint(metric: str, mode: str) → Checkpoint | None[source]#

PublicAPI (alpha): This API is in alpha and may change before becoming stable.