diff --git a/docs/clearml_data/best_practices.md b/docs/clearml_data/best_practices.md index ff7af939..a4861d08 100644 --- a/docs/clearml_data/best_practices.md +++ b/docs/clearml_data/best_practices.md @@ -9,6 +9,8 @@ See [Hyper-Datasets](../hyperdatasets/overview.md) for ClearML's advanced querya The following are some recommendations for using ClearML Data. +![Dataset UI gif](../img/dataset.gif) + ## Versioning Datasets Use ClearML Data to version your datasets. Once a dataset is finalized, it can no longer be modified. This makes clear diff --git a/docs/clearml_data/clearml_data.md b/docs/clearml_data/clearml_data.md index 8609fbee..837c43c3 100644 --- a/docs/clearml_data/clearml_data.md +++ b/docs/clearml_data/clearml_data.md @@ -14,6 +14,8 @@ ClearML Data Management solves two important challenges: - Accessibility - Making data easily accessible from every machine, - Versioning - Linking data and experiments for better **traceability**. +![Dataset lineage](../img/webapp_dataset_lineage.png) + **We believe Data is not code**. It should not be stored in a git tree, because progress on datasets is not always linear. Moreover, it can be difficult and inefficient to find on a git tree the commit associated with a certain version of a dataset. diff --git a/docs/clearml_data/data_management_examples/data_man_cifar_classification.md b/docs/clearml_data/data_management_examples/data_man_cifar_classification.md index 77fda20f..9ee4e2cf 100644 --- a/docs/clearml_data/data_management_examples/data_man_cifar_classification.md +++ b/docs/clearml_data/data_management_examples/data_man_cifar_classification.md @@ -65,10 +65,10 @@ clearml-data close This command sets the dataset task's status to *completed*, so it will no longer be modifiable. This ensures future reproducibility. -The information about the dataset, including a list of files and their sizes, can be viewed -in the WebApp, in the dataset task's **ARTIFACTS** tab. +Information about the dataset can be viewed in the WebApp, in the dataset's [details panel](../../webapp/datasets/webapp_dataset_viewing.md#version-details-panel). +In the panel's **CONTENT** tab, you can see a table summarizing version contents, including file names, file sizes, and hashes. -![image](../../img/examples_data_management_cifar_dataset.png) +![Dataset content tab](../../img/examples_data_management_cifar_dataset.png) ## Using the Dataset diff --git a/docs/clearml_data/data_management_examples/data_man_python.md b/docs/clearml_data/data_management_examples/data_man_python.md index dc01ace7..1e3236f3 100644 --- a/docs/clearml_data/data_management_examples/data_man_python.md +++ b/docs/clearml_data/data_management_examples/data_man_python.md @@ -72,10 +72,10 @@ dataset.finalize() After a dataset has been closed, it can no longer be modified. This ensures future reproducibility. -The information about the dataset, including a list of files and their sizes, can be viewed -in the WebApp, in the dataset task's **ARTIFACTS** tab. +Information about the dataset can be viewed in the WebApp, in the dataset's [details panel](../../webapp/datasets/webapp_dataset_viewing.md#version-details-panel). +In the panel's **CONTENT** tab, you can see a table summarizing version contents, including file names, file sizes, and hashes. -![image](../../img/examples_data_management_cifar_dataset.png) +![Dataset content tab](../../img/examples_data_management_cifar_dataset.png) ## Data Ingestion diff --git a/docs/guides/datasets/data_man_cifar_classification.md b/docs/guides/datasets/data_man_cifar_classification.md index 41e844ee..1e0dea2c 100644 --- a/docs/guides/datasets/data_man_cifar_classification.md +++ b/docs/guides/datasets/data_man_cifar_classification.md @@ -65,10 +65,10 @@ clearml-data close This command sets the dataset task's status to *completed*, so it will no longer be modifiable. This ensures future reproducibility. -The information about the dataset, including a list of files and their sizes, can be viewed -in the WebApp, in the dataset task's **ARTIFACTS** tab. +Information about the dataset can be viewed in the WebApp, in the dataset's [details panel](../../webapp/datasets/webapp_dataset_viewing.md#version-details-panel). +In the panel's **CONTENT** tab, you can see a table summarizing version contents, including file names, file sizes, and hashes. -![image](../../img/examples_data_management_cifar_dataset.png) +![Dataset content tab](../../img/examples_data_management_cifar_dataset.png) ## Using the Dataset diff --git a/docs/guides/datasets/data_man_python.md b/docs/guides/datasets/data_man_python.md index 418e543b..f5c697fc 100644 --- a/docs/guides/datasets/data_man_python.md +++ b/docs/guides/datasets/data_man_python.md @@ -72,10 +72,10 @@ dataset.finalize() After a dataset has been closed, it can no longer be modified. This ensures future reproducibility. -The information about the dataset, including a list of files and their sizes, can be viewed -in the WebApp, in the dataset task's **ARTIFACTS** tab. +Information about the dataset can be viewed in the WebApp, in the dataset's [details panel](../../webapp/datasets/webapp_dataset_viewing.md#version-details-panel). +In the panel's **CONTENT** tab, you can see a table summarizing version contents, including file names, file sizes, and hashes. -![image](../../img/examples_data_management_cifar_dataset.png) +![Dataset content tab](../../img/examples_data_management_cifar_dataset.png) ## Data Ingestion diff --git a/docs/img/dataset.gif b/docs/img/dataset.gif new file mode 100644 index 00000000..023e96cc Binary files /dev/null and b/docs/img/dataset.gif differ diff --git a/docs/img/examples_data_management_cifar_dataset.png b/docs/img/examples_data_management_cifar_dataset.png index fde1d2f2..16057a9d 100644 Binary files a/docs/img/examples_data_management_cifar_dataset.png and b/docs/img/examples_data_management_cifar_dataset.png differ