From c10615593591103e2ee1b7c092d89d65776cc6aa Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Mon, 3 Jun 2024 13:55:01 +0300 Subject: [PATCH] Add get_mutable_local_copy note (#1276) * 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 e0212485..b7b74864 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.