Update docs (#254)
@ -38,7 +38,10 @@ Customize the table using any of the following:
|
|||||||
|
|
||||||
* Dynamic column order - Drag a column title to a different position.
|
* Dynamic column order - Drag a column title to a different position.
|
||||||
* Resize columns - Drag the column separator to change the width of that column. Double click the column separator for automatic fit.
|
* Resize columns - Drag the column separator to change the width of that column. Double click the column separator for automatic fit.
|
||||||
* Filter by user and / or status
|
* Filter by user and / or status - When a filter is applied to a column, its filter icon will appear with a highlighted
|
||||||
|
dot on its top right (<img src="/docs/latest/icons/ico-filter-on.svg" alt="Filter on" className="icon size-md" /> ). To
|
||||||
|
clear all active filters, click <img src="/docs/latest/icons/ico-filter-reset.svg" alt="Clear filters" className="icon size-md" />
|
||||||
|
in the top right corner of the table.
|
||||||
* Sort columns - By experiment name and / or elapsed time since creation.
|
* Sort columns - By experiment name and / or elapsed time since creation.
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
Before Width: | Height: | Size: 113 KiB After Width: | Height: | Size: 121 KiB |
Before Width: | Height: | Size: 122 KiB After Width: | Height: | Size: 112 KiB |
Before Width: | Height: | Size: 194 KiB After Width: | Height: | Size: 183 KiB |
Before Width: | Height: | Size: 152 KiB After Width: | Height: | Size: 116 KiB |
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 244 KiB After Width: | Height: | Size: 237 KiB |
Before Width: | Height: | Size: 264 KiB After Width: | Height: | Size: 249 KiB |
Before Width: | Height: | Size: 345 KiB After Width: | Height: | Size: 321 KiB |
@ -38,5 +38,7 @@ of a pipeline card to open its context menu and access pipeline actions.
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
* Rename - Change the pipeline’s name
|
* **Rename** - Change the pipeline’s name
|
||||||
* Add Tag - Add label to the pipeline to help easily classify groups of pipelines.
|
* **Add Tag** - Add label to the pipeline to help easily classify groups of pipelines.
|
||||||
|
* **Delete** - Delete the pipeline: delete all its runs and any models/artifacts produced (a list of remaining artifacts
|
||||||
|
is returned). To delete a pipeline, all its runs must first be [archived](../webapp_archiving.md).
|
@ -5,9 +5,10 @@ It is always useful to investigate what causes an experiment to succeed.
|
|||||||
The **ClearML Web UI** provides a deep experiment comparison, allowing to locate, visualize, and analyze differences including:
|
The **ClearML Web UI** provides a deep experiment comparison, allowing to locate, visualize, and analyze differences including:
|
||||||
|
|
||||||
* [Details](#details)
|
* [Details](#details)
|
||||||
- [Artifacts](#artifacts) - Input model, output model, and model design.
|
- Artifacts - Input model, output model, and model design.
|
||||||
- [Execution](#execution-details) - Installed packages and source code.
|
- Execution - Installed packages and source code.
|
||||||
- [Configuration](#configuration) - Configuration objects used by the experiment.
|
- Configuration - Configuration objects used by the experiment.
|
||||||
|
- Info - General experiment details.
|
||||||
* [Hyperparameters](#hyperparameters)
|
* [Hyperparameters](#hyperparameters)
|
||||||
- [Values (table) view](#values-mode) - Key/value of all the arguments used by the experiments.
|
- [Values (table) view](#values-mode) - Key/value of all the arguments used by the experiments.
|
||||||
- [Parallel coordinates view](#parallel-coordinates-mode) - Impact of each argument on a selected metric
|
- [Parallel coordinates view](#parallel-coordinates-mode) - Impact of each argument on a selected metric
|
||||||
@ -36,30 +37,18 @@ The ClearML experiment comparison provides [comparison features](#comparison-fea
|
|||||||
## Details
|
## Details
|
||||||
|
|
||||||
The **DETAILS** tab includes deep comparisons of the following:
|
The **DETAILS** tab includes deep comparisons of the following:
|
||||||
|
* Artifacts - Input/output models and their configuration, and other artifacts, if any.
|
||||||
|
* Execution Details - Source code, uncommitted changes, and installed python packages. See details [here](webapp_exp_track_visual.md#execution).
|
||||||
|
* Configuration - Configuration objects used by the experiment, sorted by sections. See details [here](webapp_exp_track_visual.md#configuration).
|
||||||
|
* Info - General experiment details. This includes information describing the stored experiment. See details [here](webapp_exp_track_visual.md#general-information).
|
||||||
|
|
||||||
### Artifacts
|
**To Locate the Source Differences:**
|
||||||
|
|
||||||
* Input model and model configuration.
|
Click the **DETAILS** tab **>** Expand highlighted sections, or, in the header, click <img src="/docs/latest/icons/ico-previous-diff.svg" alt="Up arrow" className="icon size-md" />
|
||||||
* Output model and model configuration.
|
|
||||||
* Other artifacts, if any.
|
|
||||||
|
|
||||||
### Execution Details
|
|
||||||
* The Source code - repository, branch, commit ID, script file name, and working directory.
|
|
||||||
* Uncommitted changes, sorted by file name.
|
|
||||||
* Installed Python packages and versions, sorted by package name.
|
|
||||||
|
|
||||||
### Configuration
|
|
||||||
* Configuration objects used by the experiment (see [configuration objects](../fundamentals/hyperparameters.md#connecting-objects)),
|
|
||||||
sorted by sections.
|
|
||||||
|
|
||||||
|
|
||||||
### To Locate the Source Differences:
|
|
||||||
|
|
||||||
* Click the **DETAILS** tab **>** Expand highlighted sections, or, in the header, click <img src="/docs/latest/icons/ico-previous-diff.svg" alt="Up arrow" className="icon size-md" />
|
|
||||||
(Previous diff) or <img src="/docs/latest/icons/ico-next-diff.svg" alt="Down arrow" className="icon size-md space-sm" /> (Next diff).
|
(Previous diff) or <img src="/docs/latest/icons/ico-next-diff.svg" alt="Down arrow" className="icon size-md space-sm" /> (Next diff).
|
||||||
|
|
||||||
For example, in the image below, expanding **ARTIFACTS** **>** **Output Model** **>** **Model** shows that the model ID
|
For example, in the image below, expanding **ARTIFACTS** **>** **Output Model** **>** **Model** shows that the model names
|
||||||
and name are different.
|
are different.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
@ -335,6 +335,7 @@ These controls allow you to better analyze the results. Hover over a plot, and t
|
|||||||
| <img src="/docs/latest/icons/ico-compare-data.svg" alt="Compare data icon" className="icon size-sm space-sm" /> | Compare data on hover. Click <img src="/docs/latest/icons/ico-compare-data.svg" alt="Compare data icon" className="icon size-sm space-sm" /> and then hover over the plot. |
|
| <img src="/docs/latest/icons/ico-compare-data.svg" alt="Compare data icon" className="icon size-sm space-sm" /> | Compare data on hover. Click <img src="/docs/latest/icons/ico-compare-data.svg" alt="Compare data icon" className="icon size-sm space-sm" /> and then hover over the plot. |
|
||||||
| <img src="/docs/latest/icons/ico-logarithmic-view.svg" alt="Logarithmic view icon" className="icon size-sm space-sm" /> | Switch to logarithmic view. |
|
| <img src="/docs/latest/icons/ico-logarithmic-view.svg" alt="Logarithmic view icon" className="icon size-sm space-sm" /> | Switch to logarithmic view. |
|
||||||
| <img src="/docs/latest/icons/ico-ico-graph-legend.svg" alt="Graph legend icon" className="icon size-sm space-sm" /> | Hide / show the legend. |
|
| <img src="/docs/latest/icons/ico-ico-graph-legend.svg" alt="Graph legend icon" className="icon size-sm space-sm" /> | Hide / show the legend. |
|
||||||
|
| <img src="/docs/latest/icons/ico-reset_1.svg" alt="Plot layout setting" className="icon size-sm space-sm" />| Switch between original and auto-fitted plot dimensions. The original layout is the plot's user-defined dimensions. |
|
||||||
| <img src="/docs/latest/icons/ico-download-json-plot.svg" alt="Download JSON icon" className="icon size-sm space-sm" /> | Download plot data as a JSON file. |
|
| <img src="/docs/latest/icons/ico-download-json-plot.svg" alt="Download JSON icon" className="icon size-sm space-sm" /> | Download plot data as a JSON file. |
|
||||||
| <img src="/docs/latest/icons/ico-download-csv.svg" alt="Download CSV icon" className="icon size-sm space-sm" /> | Download plot data as a CSV file. |
|
| <img src="/docs/latest/icons/ico-download-csv.svg" alt="Download CSV icon" className="icon size-sm space-sm" /> | Download plot data as a CSV file. |
|
||||||
| <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" /> | Expand plot to entire window. When used with scalar graphs, full screen mode displays plots with all data points, as opposed to an averaged plot |
|
| <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" /> | Expand plot to entire window. When used with scalar graphs, full screen mode displays plots with all data points, as opposed to an averaged plot |
|
||||||
|
@ -87,6 +87,16 @@ information).
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
You can edit the labels of credentials in your own workspace, or credentials that you created in other workspaces.
|
||||||
|
|
||||||
|
**To edit the credentials label:** hover over the desired credentials, and click <img src="/docs/latest/icons/ico-edit.svg" alt="Edit Pencil" className="icon size-md" />
|
||||||
|
|
||||||
|
You can revoke any credentials in your own workspace, or credentials that you created in other workspaces. Once revoked,
|
||||||
|
these credentials cannot be recovered.
|
||||||
|
|
||||||
|
**To revoke ClearML credentials:** hover over the desired credentials, and click <img src="/docs/latest/icons/ico-trash.svg" alt="Trash can" className="icon size-md" />
|
||||||
|
|
||||||
|
|
||||||
### Changing Your Workspace Name
|
### Changing Your Workspace Name
|
||||||
To change the name of your own workspace, click **Edit workspace name** <img src="/docs/latest/icons/ico-edit.svg" alt="Edit Pencil" className="icon size-md" />
|
To change the name of your own workspace, click **Edit workspace name** <img src="/docs/latest/icons/ico-edit.svg" alt="Edit Pencil" className="icon size-md" />
|
||||||
(under App credentials) **>** modify the name **>** click <img src="/docs/latest/icons/ico-save.svg" alt="Check Mark" className="icon size-md" />.
|
(under App credentials) **>** modify the name **>** click <img src="/docs/latest/icons/ico-save.svg" alt="Check Mark" className="icon size-md" />.
|
||||||
|
@ -54,6 +54,7 @@ By default, the graphs display the overall information of all queues.
|
|||||||
|
|
||||||
The queue table shows the following queue information:
|
The queue table shows the following queue information:
|
||||||
* Queue - Queue name
|
* Queue - Queue name
|
||||||
|
* Workers - Number of workers servicing the queue
|
||||||
* Next Experiment - The next experiment available in this queue
|
* Next Experiment - The next experiment available in this queue
|
||||||
* Last Updated - The last time queue contents were modified
|
* Last Updated - The last time queue contents were modified
|
||||||
* In Queue - Number of experiments currently enqueued in the queue
|
* In Queue - Number of experiments currently enqueued in the queue
|
||||||
|