Shortcuts

mmengine.fileio.copytree_from_local

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

Recursively copy an entire directory tree rooted at src to a 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 local directory to be copied.

  • dst (str or Path) – Copy directory to dst.

  • backend_args (dict, optional) – Arguments to instantiate the corresponding backend. Defaults to None.

Returns:

The destination directory.

Return type:

str

Examples

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