ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix dataset SDK version dependency message

Browse Source
This commit is contained in:
alnoam 2022-06-30 20:48:42 +03:00
parent b2af25b52d
commit 10d9a17704
4 changed files with 10 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/clearml_data/clearml_data_cli.md
View File

@ -7,11 +7,6 @@ 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. See [Hyper-Datasets](../hyperdatasets/overview.md) for ClearML's advanced queryable dataset management solution.
::: :::
:::tip version compatibility
To use the WebApp's [Dataset pages](../webapp/datasets/webapp_dataset_page.md), you must use `clearml` and
`clearml-server` versions 1.6+.
:::
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.
@ -43,9 +38,8 @@ clearml-data create [-h] [--parents [PARENTS [PARENTS ...]]] [--project PROJECT]
:::tip Dataset ID :::tip Dataset ID
* To locate a dataset's ID, go to the dataset version’s info panel in the [Dataset UI](../webapp/datasets/webapp_dataset_viewing.md) * For datasets created with `clearml` v1.6 or newer on ClearML Server v1.6 or newer, find the ID in the dataset version’s info panel in the [Dataset UI](../webapp/datasets/webapp_dataset_viewing.md).
where the ID is listed. If using `clearml` or `clearml-server` versions older than 1.6, go to the [dataset task's info For datasets created with earlier versions of `clearml`, or if using an earlier version of ClearML Server, find the ID in the task header of the [dataset task's info panel](../webapp/webapp_exp_track_visual.md).
panel](../webapp/webapp_exp_track_visual.md), where the ID is displayed in the task header.
* clearml-data works in a stateful mode so once a new dataset is created, the following commands * clearml-data works in a stateful mode so once a new dataset is created, the following commands
do not require the `--id` flag. do not require the `--id` flag.
::: :::

10
docs/clearml_data/clearml_data_sdk.md
View File

@ -7,11 +7,6 @@ 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. See [Hyper-Datasets](../hyperdatasets/overview.md) for ClearML's advanced queryable dataset management solution.
::: :::
:::tip version compatibility
To use the WebApp's [Dataset pages](../webapp/datasets/webapp_dataset_page.md), you must use `clearml` and
`clearml-server` versions 1.6+.
:::
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)
for a complete list of available methods. for a complete list of available methods.
@ -48,9 +43,8 @@ dataset = Dataset.create(
``` ```
:::tip Locating Dataset ID :::tip Locating Dataset ID
To locate a dataset's ID, go to the dataset version’s info panel in the [Dataset UI](../webapp/datasets/webapp_dataset_viewing.md) For datasets created with `clearml` v1.6 or newer on ClearML Server v1.6 or newer, find the ID in the dataset version’s info panel in the [Dataset UI](../webapp/datasets/webapp_dataset_viewing.md).
where the ID is listed. If using `clearml` or `clearml-server` versions older than 1.6, go to the [dataset task's info For datasets created with earlier versions of `clearml`, or if using an earlier version of ClearML Server, find the ID in the task header of the [dataset task's info panel](../webapp/webapp_exp_track_visual.md).
panel](../webapp/webapp_exp_track_visual.md), where the ID is displayed in the task header.
::: :::
Use the `output_uri` parameter to specify a network storage target to upload the dataset files, and associated information Use the `output_uri` parameter to specify a network storage target to upload the dataset files, and associated information

5
docs/webapp/datasets/webapp_dataset_page.md
View File

@ -2,8 +2,9 @@
title: Datasets Page title: Datasets Page
--- ---
:::tip version compatibility :::tip SDK version compatibility
To use the WebApp's Dataset pages, you must use `clearml` and `clearml-server` versions 1.6+. The datasets page shows datasets created with `clearml` v1.6 or newer.
Datasets created with earlier versions of `clearml` are available in their original project.
::: :::
Use the **Datasets** Page to navigate between and manage datasets. The page shows summaries Use the **Datasets** Page to navigate between and manage datasets. The page shows summaries

5
docs/webapp/datasets/webapp_dataset_viewing.md
View File

@ -2,8 +2,9 @@
title: Dataset Details title: Dataset Details
--- ---
:::tip version compatibility :::tip SDK version compatibility
To use the WebApp's Dataset pages, you must use `clearml` and `clearml-server` versions 1.6+. The datasets page shows datasets created with `clearml` v1.6 or newer.
Datasets created with earlier versions of `clearml` are available in their original project.
::: :::
The dataset page lists the dataset's versions. For a selected version, the **Dataset Version Panel** shoes its lineage The dataset page lists the dataset's versions. For a selected version, the **Dataset Version Panel** shoes its lineage