ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-02-07 13:23:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add get_mutable_local_copy note (#1276)

Browse Source 
* Add get_mutable_local_copy note
This commit is contained in:
pollfly 2024-06-03 13:55:01 +03:00 committed by GitHub
parent 7fcd315c4e
commit c106155935
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
clearml/datasets/dataset.py
View File

@ -962,8 +962,10 @@ class Dataset(object):
):
# 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
download and copy / soft-link, files from all the parent dataset versions
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. 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 overwrite: If True, recursively delete the target folder before creating a copy.