to_directory

Checkpoint.to_directory(path: str | PathLike | None = None) → str

Write checkpoint data to a local directory.

If multiple processes on the same node call this method simultaneously, only a single process will perform the download, while the others wait for the download to finish. Once the download finishes, all processes receive the same local directory to read from.

Parameters:

path (str | PathLike | None) – Target directory to download data to. If not specified, this method will use a temporary directory.

Returns:

Directory containing checkpoint data.

Return type:

str