Update docs for ClearML server 1.6 (#280)
@@ -26,6 +26,9 @@ Dataset changes are stored using differentiable storage, meaning a version will
|
||||
Local copies of datasets are always cached, so the same data never needs to be downloaded twice.
|
||||
When a dataset is pulled it will automatically pull all parent datasets and merge them into one output folder for you to work with.
|
||||
|
||||
The [Dataset Versions](../webapp/pipelines/webapp_pipeline_viewing.md) page in the web UI displays dataset versions'
|
||||
lineage and content information. See [dataset UI](../webapp/datasets/webapp_dataset_page.md) for more details.
|
||||
|
||||
## Setup
|
||||
|
||||
`clearml-data` comes built-in with the `clearml` python package! Just check out the [Getting Started](../getting_started/ds/ds_first_steps.md)
|
||||
@@ -39,59 +42,15 @@ ClearML Data offers two interfaces:
|
||||
|
||||
For an overview of our recommendations for ClearML Data workflows and practices, see [Best Practices](best_practices.md).
|
||||
|
||||
## WebApp
|
||||
|
||||
ClearML's WebApp provides a visual interface to your datasets through dataset tasks. Dataset tasks are categorized
|
||||
as data-processing [task type](../fundamentals/task.md#task-types), and they are labeled with a `DATASET` system tag.
|
||||
|
||||
Full log (calls / CLI) of the dataset creation process can be found in a dataset's **EXECUTION** section.
|
||||
|
||||
Listing of the dataset differential snapshot, summary of files added / modified / removed and details of files in the
|
||||
differential snapshot (location / size / hash), is available in the **ARTIFACTS** section. Download the dataset
|
||||
by clicking <img src="/docs/latest/icons/ico-download-json.svg" alt="Download" className="icon size-sm space-sm" />,
|
||||
next to the **FILE PATH**.
|
||||
|
||||
The full dataset listing (all files included) is available in the **CONFIGURATION** section under **Dataset Content**.
|
||||
This allows you to quickly compare two dataset contents and visually see the difference.
|
||||
The dataset genealogy DAG and change-set summary table is visualized in **PLOTS**
|
||||
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<summary className="cml-expansion-panel-summary">Dataset Contents</summary>
|
||||
<div className="cml-expansion-panel-content">
|
||||
|
||||

|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
||||
<br/>
|
||||
|
||||
View a DAG of the dataset dependencies (all previous dataset versions and their parents) in the dataset's page **> ARTIFACTS > state**.
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<summary className="cml-expansion-panel-summary">Data Dependency DAG</summary>
|
||||
<div className="cml-expansion-panel-content">
|
||||
|
||||

|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
||||
|
||||
Once a dataset has been finalized, view its genealogy in the dataset's
|
||||
page **>** **PLOTS**
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<summary className="cml-expansion-panel-summary">Dataset Genealogy</summary>
|
||||
<div className="cml-expansion-panel-content">
|
||||
|
||||

|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
||||
|
||||
## Dataset Version States
|
||||
The following table displays the possible states for a dataset version.
|
||||
|
||||
|
||||
| State | Description |
|
||||
|---|---|
|
||||
|*Uploading*| Dataset creation is in progress |
|
||||
|*Failed*| Dataset creation was terminated with an error|
|
||||
|*Aborted*| Dataset creation was aborted by user before it was finalization |
|
||||
|*Final*| A dataset was created and finalized successfully |
|
||||
|*Published*| The dataset is read-only. Publish a dataset to prevent changes to it |
|
||||
|
||||
|
||||
@@ -7,6 +7,11 @@ 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.
|
||||
:::
|
||||
|
||||
:::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 following page provides a reference to `clearml-data`'s CLI commands.
|
||||
@@ -38,9 +43,9 @@ clearml-data create [-h] [--parents [PARENTS [PARENTS ...]]] [--project PROJECT]
|
||||
|
||||
|
||||
:::tip Dataset ID
|
||||
* To locate a dataset's ID, go to the dataset task's info panel in the [WebApp](../webapp/webapp_exp_track_visual.md). In the top of the panel,
|
||||
to the right of the dataset task name, click `ID` and the dataset ID appears.
|
||||
|
||||
* To locate a dataset's ID, go to 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
|
||||
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
|
||||
do not require the `--id` flag.
|
||||
:::
|
||||
|
||||
@@ -7,6 +7,11 @@ 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.
|
||||
:::
|
||||
|
||||
:::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
|
||||
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.
|
||||
@@ -43,8 +48,9 @@ dataset = Dataset.create(
|
||||
```
|
||||
|
||||
:::tip Locating Dataset ID
|
||||
To locate a dataset's ID, go to the dataset task's info panel in the [WebApp](../webapp/webapp_overview.md). In the top of the panel,
|
||||
to the right of the dataset task name, click `ID` and the dataset ID appears
|
||||
To locate a dataset's ID, go to 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
|
||||
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
|
||||
|
||||
@@ -36,7 +36,7 @@ A ClearML Agent can service multiple queues in either of the following modes:
|
||||
|
||||
## Agent and Queue Workflow
|
||||
|
||||

|
||||

|
||||
|
||||
The diagram above demonstrates a typical flow where an agent executes a task:
|
||||
|
||||
|
||||
@@ -29,8 +29,6 @@ They appear in **PLOTS**.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
## Debug Samples
|
||||
|
||||
The example calls Matplotlib methods to log debug sample images. They appear in **DEBUG SAMPLES**.
|
||||
|
||||
@@ -57,9 +57,12 @@ In the experiment code, a configuration dictionary is connected to the Task by c
|
||||
method.
|
||||
|
||||
```python
|
||||
task.connect_configuration({'test': 1337, 'nested': {'key': 'value', 'number': 1}})
|
||||
task.connect_configuration(
|
||||
name="MyConfig"
|
||||
configuration={'test': 1337, 'nested': {'key': 'value', 'number': 1}}
|
||||
)
|
||||
```
|
||||
|
||||
It appears in **CONFIGURATION** **>** **CONFIGURATION OBJECTS** **>** **General**.
|
||||
It appears in **CONFIGURATION** **>** **CONFIGURATION OBJECTS** **>** **MyConfig**.
|
||||
|
||||

|
||||
@@ -159,10 +159,6 @@ View the scalars, including training and validation metrics, in the experiment's
|
||||
|
||||

|
||||
|
||||
<br/>
|
||||
|
||||

|
||||
|
||||
### Model Snapshots
|
||||
|
||||
|
||||
|
||||
@@ -18,7 +18,10 @@ classification dataset using XGBoost
|
||||
The feature importance plot and tree plot appear in the project's page in the **ClearML web UI**, under
|
||||
**PLOTS**.
|
||||
|
||||

|
||||

|
||||
|
||||

|
||||
|
||||
|
||||
## Console
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 130 KiB |
|
Before Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 121 KiB After Width: | Height: | Size: 122 KiB |
|
Before Width: | Height: | Size: 190 KiB After Width: | Height: | Size: 151 KiB |
|
Before Width: | Height: | Size: 121 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 75 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 78 KiB |
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 30 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 78 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 95 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 35 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 74 KiB |
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 74 KiB |
|
Before Width: | Height: | Size: 124 KiB After Width: | Height: | Size: 99 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 48 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 85 KiB |
|
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 240 KiB |
|
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 119 KiB |
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 299 KiB |
|
Before Width: | Height: | Size: 289 KiB After Width: | Height: | Size: 386 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 76 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 86 KiB |
|
Before Width: | Height: | Size: 1.0 MiB After Width: | Height: | Size: 712 KiB |
|
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 63 KiB |
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 33 KiB |
|
Before Width: | Height: | Size: 264 KiB After Width: | Height: | Size: 248 KiB |
|
Before Width: | Height: | Size: 127 KiB After Width: | Height: | Size: 66 KiB |
|
Before Width: | Height: | Size: 183 KiB After Width: | Height: | Size: 96 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 66 KiB |
|
Before Width: | Height: | Size: 306 KiB After Width: | Height: | Size: 201 KiB |
|
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 101 KiB |
|
Before Width: | Height: | Size: 155 KiB After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 177 KiB After Width: | Height: | Size: 122 KiB |
|
Before Width: | Height: | Size: 151 KiB After Width: | Height: | Size: 86 KiB |
|
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 264 KiB |
|
Before Width: | Height: | Size: 103 KiB After Width: | Height: | Size: 78 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 109 KiB After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 126 KiB After Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 210 KiB After Width: | Height: | Size: 182 KiB |
|
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 149 KiB |
|
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 115 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 83 KiB |
|
Before Width: | Height: | Size: 70 KiB After Width: | Height: | Size: 264 KiB |
|
Before Width: | Height: | Size: 124 KiB After Width: | Height: | Size: 155 KiB |
|
Before Width: | Height: | Size: 458 KiB After Width: | Height: | Size: 571 KiB |
|
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 123 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 81 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 93 KiB |
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 83 KiB |
|
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 89 KiB |
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 159 KiB |
|
Before Width: | Height: | Size: 139 KiB After Width: | Height: | Size: 231 KiB |
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 96 KiB |
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 72 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 103 KiB |
|
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 99 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 245 KiB After Width: | Height: | Size: 308 KiB |
|
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 130 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 96 KiB |
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 105 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 56 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 171 KiB After Width: | Height: | Size: 194 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 41 KiB |
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 54 KiB |
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 105 KiB After Width: | Height: | Size: 124 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 187 KiB After Width: | Height: | Size: 210 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 77 KiB |