mirror of
https://github.com/clearml/clearml
synced 2025-02-07 13:23:40 +00:00
Add get_mutable_local_copy note (#1276)
* Add get_mutable_local_copy note
This commit is contained in:
parent
7fcd315c4e
commit
c106155935
@ -962,8 +962,10 @@ class Dataset(object):
|
|||||||
):
|
):
|
||||||
# type: (Union[Path, _Path, str], bool, Optional[int], Optional[int], bool, Optional[int]) -> Optional[str]
|
# type: (Union[Path, _Path, str], bool, Optional[int], Optional[int], bool, Optional[int]) -> Optional[str]
|
||||||
"""
|
"""
|
||||||
return a base folder with a writable (mutable) local copy of the entire dataset
|
Return a base folder with a writable (mutable) local copy of the entire dataset.
|
||||||
download and copy / soft-link, files from all the parent dataset versions
|
Download and copy / soft-link, files from all the parent dataset versions. Note that the method initially
|
||||||
|
downloads the local copy into a cache directory before moving it to the `target_folder`. Make sure the default
|
||||||
|
cache directory has sufficient disk space.
|
||||||
|
|
||||||
:param target_folder: Target folder for the writable copy
|
:param target_folder: Target folder for the writable copy
|
||||||
:param overwrite: If True, recursively delete the target folder before creating a copy.
|
:param overwrite: If True, recursively delete the target folder before creating a copy.
|
||||||
|
Loading…
Reference in New Issue
Block a user