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

Synchronize remote directory to local directory.

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

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

  • local_dir – Local directory to sync to.

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


True if sync process has been spawned, False otherwise.