mmengine.fileio.copytree_to_local — mmengine 0.10.7 documentation (original) (raw)

mmengine.fileio.copytree_to_local(src, dst, backend_args=None)[source]¶

Recursively copy an entire directory tree rooted at src to a local directory named dst and return the destination directory.

Note

If the backend is the instance of LocalBackend, it does the same thing with copytree().

Parameters:

• src (str or Path) – A directory to be copied.
• dst (str or Path) – Copy directory to local dst.
• backend_args (dict, optional) – Arguments to instantiate the corresponding backend. Defaults to None.

Returns:

The destination directory.

Return type:

str

Examples

src = 's3://openmmlab/mmengine/dir' dst = '/path/of/dir' copytree_to_local(src, dst) '/path/of/dir'