ray.tune.syncer.Syncer.sync_up#

abstract Syncer.sync_up(local_dir: str, remote_dir: str, exclude: Optional[List] = None) → bool[source]#

Synchronize local directory to remote directory.

This function can spawn an asynchronous process that can be awaited in wait().

Parameters

  • local_dir – Local directory to sync from.

  • remote_dir – Remote directory to sync up to. This is an URI (protocol://remote/path).

  • exclude – Pattern of files to exclude, e.g. ["*/checkpoint_*] to exclude trial checkpoints.

Returns

True if sync process has been spawned, False otherwise.