Add ClearML Data admonitions (#115)

* Add admonition to differentiate between hyperdatasets and ClearML Data

* fix link

* edit hyperdataset admonition
This commit is contained in:
pollfly 2021-11-10 14:52:06 +02:00 committed by GitHub
parent 90302c33ac
commit 81b0a2322a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 24 additions and 0 deletions

View File

@ -2,6 +2,11 @@
title: Best Practices 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. The following are some recommendations for using ClearML Data.
## Versioning Datasets ## Versioning Datasets

View File

@ -2,6 +2,11 @@
title: Introduction 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, 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. which you then need to be able to share, reproduce, and track.

View File

@ -2,6 +2,11 @@
title: CLI 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 `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. The following page provides a reference to `clearml-data`'s CLI commands.

View File

@ -2,6 +2,10 @@
title: SDK 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 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) for using the most basic methods of the `Dataset` class. See the [Dataset reference page](../references/sdk/dataset.md)

View File

@ -2,6 +2,11 @@
title: Workflows 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 Take a look at the ClearML Data examples which demonstrate common workflows using the `clearml-data` CLI and the
`Dataset` class: `Dataset` class:
* [Dataset Management with CLI](data_man_simple.md) - Tutorial for creating, modifying, and consuming dataset with CLI. * [Dataset Management with CLI](data_man_simple.md) - Tutorial for creating, modifying, and consuming dataset with CLI.