From 81b0a2322aae84311c094aaffd6ad9d3491f9bab Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Wed, 10 Nov 2021 14:52:06 +0200 Subject: [PATCH] Add ClearML Data admonitions (#115) * Add admonition to differentiate between hyperdatasets and ClearML Data * fix link * edit hyperdataset admonition --- docs/clearml_data/best_practices.md | 5 +++++ docs/clearml_data/clearml_data.md | 5 +++++ docs/clearml_data/clearml_data_cli.md | 5 +++++ docs/clearml_data/clearml_data_sdk.md | 4 ++++ docs/clearml_data/data_management_examples/workflows.md | 5 +++++ 5 files changed, 24 insertions(+) diff --git a/docs/clearml_data/best_practices.md b/docs/clearml_data/best_practices.md index 3d2e59b3..289c0045 100644 --- a/docs/clearml_data/best_practices.md +++ b/docs/clearml_data/best_practices.md @@ -2,6 +2,11 @@ title: Best Practices --- +:::important +This page covers `clearml-data`, ClearML's file-based data management solution. +See [Hyper-Datasets](../hyperdatasets/overview.md) for ClearML's advanced queryable dataset management solution. +::: + The following are some recommendations for using ClearML Data. ## Versioning Datasets diff --git a/docs/clearml_data/clearml_data.md b/docs/clearml_data/clearml_data.md index 53665100..700d7094 100644 --- a/docs/clearml_data/clearml_data.md +++ b/docs/clearml_data/clearml_data.md @@ -2,6 +2,11 @@ title: Introduction --- +:::important +This page covers `clearml-data`, ClearML's file-based data management solution. +See [Hyper-Datasets](../hyperdatasets/overview.md) for ClearML's advanced queryable dataset management solution. +::: + In Machine Learning, you are very likely dealing with a gargantuan amount of data that you need to put in a dataset, which you then need to be able to share, reproduce, and track. diff --git a/docs/clearml_data/clearml_data_cli.md b/docs/clearml_data/clearml_data_cli.md index e262e0c6..db86db5d 100644 --- a/docs/clearml_data/clearml_data_cli.md +++ b/docs/clearml_data/clearml_data_cli.md @@ -2,6 +2,11 @@ title: CLI --- +:::important +This page covers `clearml-data`, ClearML's file-based data management solution. +See [Hyper-Datasets](../hyperdatasets/overview.md) for ClearML's advanced queryable dataset management solution. +::: + The `clearml-data` utility is a CLI tool for controlling and managing your data with ClearML. The following page provides a reference to `clearml-data`'s CLI commands. diff --git a/docs/clearml_data/clearml_data_sdk.md b/docs/clearml_data/clearml_data_sdk.md index 32613c2d..aabb11b0 100644 --- a/docs/clearml_data/clearml_data_sdk.md +++ b/docs/clearml_data/clearml_data_sdk.md @@ -2,6 +2,10 @@ title: SDK --- +:::important +This page covers `clearml-data`, ClearML's file-based data management solution. +See [Hyper-Datasets](../hyperdatasets/overview.md) for ClearML's advanced queryable dataset management solution. +::: Datasets can be created, modified, and managed with ClearML Data's python interface. The following page provides an overview for using the most basic methods of the `Dataset` class. See the [Dataset reference page](../references/sdk/dataset.md) diff --git a/docs/clearml_data/data_management_examples/workflows.md b/docs/clearml_data/data_management_examples/workflows.md index a0f3fa3f..5aebd778 100644 --- a/docs/clearml_data/data_management_examples/workflows.md +++ b/docs/clearml_data/data_management_examples/workflows.md @@ -2,6 +2,11 @@ title: Workflows --- +:::important +This page covers `clearml-data`, ClearML's file-based data management solution. +See [Hyper-Datasets](../../hyperdatasets/overview.md) for ClearML's advanced queryable dataset management solution. +::: + Take a look at the ClearML Data examples which demonstrate common workflows using the `clearml-data` CLI and the `Dataset` class: * [Dataset Management with CLI](data_man_simple.md) - Tutorial for creating, modifying, and consuming dataset with CLI.