From ee9aebd1d739b06bc528a9bb2a275fcc4b1049ae Mon Sep 17 00:00:00 2001 From: revital Date: Wed, 29 May 2024 09:30:57 +0300 Subject: [PATCH] Add get_mutable_local_copy note --- clearml/datasets/dataset.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/clearml/datasets/dataset.py b/clearml/datasets/dataset.py index ef6759dd..22208d45 100644 --- a/clearml/datasets/dataset.py +++ b/clearml/datasets/dataset.py @@ -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.