diff --git a/docs/hyperdatasets/webapp/webapp_dataviews.md b/docs/hyperdatasets/webapp/webapp_dataviews.md index 8eb41a29..1f35bdae 100644 --- a/docs/hyperdatasets/webapp/webapp_dataviews.md +++ b/docs/hyperdatasets/webapp/webapp_dataviews.md @@ -38,7 +38,10 @@ Customize the table using any of the following: * 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. -* 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 (Filter on ). To + clear all active filters, click Clear filters + in the top right corner of the table. * Sort columns - By experiment name and / or elapsed time since creation. :::note diff --git a/docs/img/4100.png b/docs/img/4100.png index 31f8048d..1289631a 100644 Binary files a/docs/img/4100.png and b/docs/img/4100.png differ diff --git a/docs/img/hyperdatasets/webapp_dataviews_table.png b/docs/img/hyperdatasets/webapp_dataviews_table.png index 1ffd3ae8..5ebf7d5e 100644 Binary files a/docs/img/hyperdatasets/webapp_dataviews_table.png and b/docs/img/hyperdatasets/webapp_dataviews_table.png differ diff --git a/docs/img/webapp_compare_05.png b/docs/img/webapp_compare_05.png index 66cad797..150c8c33 100644 Binary files a/docs/img/webapp_compare_05.png and b/docs/img/webapp_compare_05.png differ diff --git a/docs/img/webapp_compare_10.png b/docs/img/webapp_compare_10.png index 83cdf143..06f670f3 100644 Binary files a/docs/img/webapp_compare_10.png and b/docs/img/webapp_compare_10.png differ diff --git a/docs/img/webapp_pipeline_context_menu.png b/docs/img/webapp_pipeline_context_menu.png index be82fbcc..2a63a798 100644 Binary files a/docs/img/webapp_pipeline_context_menu.png and b/docs/img/webapp_pipeline_context_menu.png differ diff --git a/docs/img/webapp_tracking_33.png b/docs/img/webapp_tracking_33.png index a72cfae2..0fa9b467 100644 Binary files a/docs/img/webapp_tracking_33.png and b/docs/img/webapp_tracking_33.png differ diff --git a/docs/img/webapp_tracking_34.png b/docs/img/webapp_tracking_34.png index 493452ed..9c612761 100644 Binary files a/docs/img/webapp_tracking_34.png and b/docs/img/webapp_tracking_34.png differ diff --git a/docs/img/webapp_tracking_40.png b/docs/img/webapp_tracking_40.png index 1119440e..66d46953 100644 Binary files a/docs/img/webapp_tracking_40.png and b/docs/img/webapp_tracking_40.png differ diff --git a/docs/webapp/pipelines/webapp_pipeline_page.md b/docs/webapp/pipelines/webapp_pipeline_page.md index efeae70c..42cc9fe9 100644 --- a/docs/webapp/pipelines/webapp_pipeline_page.md +++ b/docs/webapp/pipelines/webapp_pipeline_page.md @@ -38,5 +38,7 @@ of a pipeline card to open its context menu and access pipeline actions. -* Rename - Change the pipeline’s name -* Add Tag - Add label to the pipeline to help easily classify groups of pipelines. +* **Rename** - Change the pipeline’s name +* **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). \ No newline at end of file diff --git a/docs/webapp/webapp_exp_comparing.md b/docs/webapp/webapp_exp_comparing.md index d0b8f984..af3328d5 100644 --- a/docs/webapp/webapp_exp_comparing.md +++ b/docs/webapp/webapp_exp_comparing.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: * [Details](#details) - - [Artifacts](#artifacts) - Input model, output model, and model design. - - [Execution](#execution-details) - Installed packages and source code. - - [Configuration](#configuration) - Configuration objects used by the experiment. + - Artifacts - Input model, output model, and model design. + - Execution - Installed packages and source code. + - Configuration - Configuration objects used by the experiment. + - Info - General experiment details. * [Hyperparameters](#hyperparameters) - [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 @@ -36,30 +37,18 @@ The ClearML experiment comparison provides [comparison features](#comparison-fea ## Details 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. - * Output model and model configuration. - * Other artifacts, if any. +Click the **DETAILS** tab **>** Expand highlighted sections, or, in the header, click Up arrow +(Previous diff) or Down arrow (Next diff). -### 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 Up arrow - (Previous diff) or Down arrow (Next diff). - -For example, in the image below, expanding **ARTIFACTS** **>** **Output Model** **>** **Model** shows that the model ID -and name are different. +For example, in the image below, expanding **ARTIFACTS** **>** **Output Model** **>** **Model** shows that the model names +are different. ![image](../img/webapp_compare_05.png) diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index fa5026fe..36421bec 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -335,6 +335,7 @@ These controls allow you to better analyze the results. Hover over a plot, and t | Compare data icon | Compare data on hover. Click Compare data icon and then hover over the plot. | | Logarithmic view icon | Switch to logarithmic view. | | Graph legend icon | Hide / show the legend. | +| Plot layout setting| Switch between original and auto-fitted plot dimensions. The original layout is the plot's user-defined dimensions. | | Download JSON icon | Download plot data as a JSON file. | | Download CSV icon | Download plot data as a CSV file. | | Maximize plot icon | 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 | diff --git a/docs/webapp/webapp_profile.md b/docs/webapp/webapp_profile.md index 29879545..be4bb7fc 100644 --- a/docs/webapp/webapp_profile.md +++ b/docs/webapp/webapp_profile.md @@ -87,6 +87,16 @@ information). ![ClearML credentials](../img/settings_configuration_creation.png) +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 Edit Pencil + +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 Trash can + + ### Changing Your Workspace Name To change the name of your own workspace, click **Edit workspace name** Edit Pencil (under App credentials) **>** modify the name **>** click Check Mark. diff --git a/docs/webapp/webapp_workers_queues.md b/docs/webapp/webapp_workers_queues.md index f415f0cc..6511273d 100644 --- a/docs/webapp/webapp_workers_queues.md +++ b/docs/webapp/webapp_workers_queues.md @@ -52,8 +52,9 @@ Use the **QUEUES** tab to manage queues and monitor their statistics. The page s wait time and the number of queued experiments, and a queue details table. Hover over any plot point to view its data. 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 +* Workers - Number of workers servicing the queue * Next Experiment - The next experiment available in this queue * Last Updated - The last time queue contents were modified * In Queue - Number of experiments currently enqueued in the queue