ray.train.trainer.BaseTrainer.can_restore

classmethod BaseTrainer.can_restore(path: str | PathLike, storage_filesystem: pyarrow.fs.FileSystem | None = None) → bool

Checks whether a given directory contains a restorable Train experiment.

Parameters:

path – The path to the experiment directory of the Train experiment. This can be either a local directory (e.g., ~/ray_results/exp_name) or a remote URI (e.g., s3://bucket/exp_name).

Returns:

Whether this path exists and contains the trainer state to resume from

Return type:

bool

Warning

DEPRECATED: This API is deprecated and may be removed in future Ray releases. The restore and can_restore APIs are deprecated and will be removed in a future release. See this issue for more context and migration options: ray-project/ray#49454. Disable these warnings by setting the environment variable: RAY_TRAIN_ENABLE_V2_MIGRATION_WARNINGS=0