clearml-docs/docs/webapp/webapp_exp_comparing.md

206 lines
12 KiB
Markdown
Raw Normal View History

2021-05-13 23:48:51 +00:00
---
2025-02-06 15:31:11 +00:00
title: Comparing Tasks
2021-05-13 23:48:51 +00:00
---
2023-11-02 08:30:12 +00:00
2025-02-06 15:31:11 +00:00
The ClearML Web UI provides features for comparing tasks, allowing to locate, visualize, and analyze the
differences in task results and their causes. You can view the differences in:
* [Details](#side-by-side-textual-comparison) - Compare task source code, package versions, models, configuration
2023-11-02 08:30:12 +00:00
objects, and other details.
* Hyperparameters
* [Values](#side-by-side-textual-comparison) - Compare parameters and their values
2024-03-11 17:23:48 +00:00
* [Parallel coordinates](#parallel-coordinates-mode) - View the impact of hyperparameters on selected metrics
* [Scatter plot](#scatter-plot) - View the correlation between a selected hyperparameter and metric
2025-02-06 15:31:11 +00:00
* Scalars - Compare task metrics:
2023-11-02 08:30:12 +00:00
* [Values](#tabular-scalar-comparison) - Compare minimal, maximal or last reported values in a concise comparison
table
2025-02-06 15:31:11 +00:00
* [Graphs](#plot-comparison) - Overlay compared tasks in a single graph per metric
* [Plots](#plot-comparison) - Compare task plots
2023-11-02 08:30:12 +00:00
* [Debug samples](#side-by-side-debug-sample-comparison) - Compare debug samples by iteration
2025-02-06 15:31:11 +00:00
With these comparisons, you can investigate the impact of different setups on your task results, and gain insight
for crafting future tasks.
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
## Selecting Tasks to Compare
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
To select tasks to compare:
1. Go to a task table that includes the tasks to be compared.
1. Select the tasks to compare. Once multiple tasks are selected, the batch action bar appears.
1. In the batch action bar, click **COMPARE**.
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
The comparison page opens in the **DETAILS** tab with the tasks [compared side by side](#side-by-side-textual-comparison).
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
### Modifying Task Selection
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
Click the `TASKS` button to view your currently compared tasks. Click `X` on a listed task to remove
2023-11-02 08:30:12 +00:00
it from the comparison.
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
![Tasks list](../img/webapp_compare_exp_select_2.png#light-mode-only)
![Tasks list](../img/webapp_compare_exp_select_2_dark.png#dark-mode-only)
You can add/remove tasks to your comparison:
1. Click the `+` button in any of the comparison tabs. This opens up a window with a task table with the currently
compared tasks at the top.
![Adding tasks](../img/webapp_compare_exp_select_1.png#light-mode-only)
![Adding tasks](../img/webapp_compare_exp_select_1_dark.png#dark-mode-only)
1. Find the tasks to add by sorting and [filtering](webapp_exp_table.md#filtering-columns) the tasks with the
appropriate column header controls. Alternatively, use the search bar to find tasks by name.
1. Select tasks to include in the comparison (and/or clear the selection of any tasks you wish to remove).
2023-11-02 08:30:12 +00:00
1. Click **APPLY**.
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
## Sharing Comparison Page
To share a comparison page, copy the full URL from the address bar and send it to a teammate to collaborate. They will
get the exact same page (including selected tabs etc.).
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
## Embedding Comparison Visualization
To embed plots and debug samples from the comparison pages in your [Reports](webapp_reports.md), hover over the
resource and click <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Embed code" className="icon size-md space-sm" />,
which will copy to clipboard the embed code to put in your Reports. These visualizations are updated live as the
2025-02-06 15:31:11 +00:00
tasks update. The Enterprise Plan and Hosted Service support embedding resources in external tools (e.g. Notion).
2023-11-02 08:30:12 +00:00
## Comparison Modes
The comparison pages provide the following views:
* [Side-by-side textual comparison](#side-by-side-textual-comparison)
* [Tabular scalar comparison](#tabular-scalar-comparison)
* [Parallel coordinates](#parallel-coordinates-mode) for parameter impact on metric
2024-03-11 17:23:48 +00:00
* [Scatter plot](#scatter-plot)
2023-11-02 08:30:12 +00:00
* [Overlaid plot comparison](#plot-comparison)
* Side-by-side [debug sample](#side-by-side-debug-sample-comparison) and [plot](#plot-comparison) comparison
2025-02-06 15:31:11 +00:00
### Side-by-side Textual Comparison
2023-11-02 08:30:12 +00:00
2025-02-06 15:31:11 +00:00
In the **Details** and **Hyperparameters** (Values view) tabs, you can view differences in the tasks' parameters' nominal
values. The **Details** tab displays the tasks' execution details (source code, uncommitted changes, python packages),
2023-11-02 08:30:12 +00:00
models, artifacts, configuration objects, and additional general information. **Hyperparameters** (Values view) displays the
2025-02-06 15:31:11 +00:00
tasks' hyperparameter and their values.
2023-11-02 08:30:12 +00:00
2025-02-06 15:31:11 +00:00
The tasks are laid out in vertical cards, so each field is lined up side-by-side. The task on the
left is used as the base task, to which the other tasks are compared. You can set a new base task in
2023-11-02 08:30:12 +00:00
one of the following ways:
2025-02-09 17:36:21 +00:00
* Hover and click <img src="/docs/latest/icons/ico-arrow-from-right.svg" alt="Switch base task" className="icon size-md space-sm" /> on the task that will be the new base.
* Hover and click <img src="/docs/latest/icons/ico-drag.svg" alt="Pan" className="icon size-md space-sm" /> on the new base task and drag it all the way to the left
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
The differences between the tasks are highlighted. Easily locate
2023-11-02 08:30:12 +00:00
value differences by clicking 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)
in the tab header. Obscure identical fields by switching on the **Hide Identical Fields** toggle.
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
Use the search bar to find any field names or values. Lines that match the search query are highlighted, and you can
navigate between search results.
2021-05-13 23:48:51 +00:00
2025-02-05 15:53:30 +00:00
![Side-by-side textual comparison](../img/webapp_compare_05.png#light-mode-only)
![Side-by-side textual comparison](../img/webapp_compare_05_dark.png#dark-mode-only)
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
### Tabular Scalar Comparison
The **Scalars** tab **Values** view lays out the tasks' metric values in a table: a row per metric/variant and a
column for each task. Select from the dropdown menu which metric values to display:
* Last Values: The last reported values for each task
* Min Values: The minimal value reported throughout the task execution
* Max Values: The maximal value reported throughout the task execution
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
You can download the scalar comparison table as a CSV file by clicking <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />.
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
Switch on the **Show row extremes** toggle to highlight each variant's maximum and minimum values.
2021-05-13 23:48:51 +00:00
2025-02-05 15:53:30 +00:00
![side-by-side scalar comparison](../img/webapp_compare_exp_scalar_vals.png#light-mode-only)
![side-by-side scalar comparison](../img/webapp_compare_exp_scalar_vals_dark.png#dark-mode-only)
2021-05-13 23:48:51 +00:00
2021-09-09 10:17:46 +00:00
### Parallel Coordinates Mode
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
The **Hyperparameters** tab's **Parallel Coordinates** comparison shows tasks' hyperparameter impact on specified
2024-03-11 17:23:48 +00:00
metrics:
2024-03-12 09:25:00 +00:00
1. Under **Performance Metrics**, select metrics to compare for
2024-03-11 17:23:48 +00:00
1. Select the values to use for each metric in the plot (can select multiple):
2025-02-06 15:31:11 +00:00
* LAST - The final value, or the most recent value, for currently running tasks
2023-11-02 08:30:12 +00:00
* MIN - Minimal value
* MAX - Maximal value
1. In **Parameters**, select the hyperparameters to compare.
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
For example, plot the metric/variant `accuracy`/`total` against the hyperparameters
`base_lr`, `dropout`, and `number_of_epochs`.
2021-05-13 23:48:51 +00:00
2025-02-05 15:53:30 +00:00
![Parallel coordinates](../img/webapp_compare_11.png#light-mode-only)
![Parallel coordinates](../img/webapp_compare_11_dark.png#dark-mode-only)
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
To focus on a specific task, hover over its name in the graph legend.
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
To hide a task, click its name in the graph legend (click again to bring back).
2023-04-30 09:50:32 +00:00
2025-02-06 15:31:11 +00:00
### Scatter Plot
The **Hyperparameters** tab's **Scatter Plot** comparison shows tasks' correlation between a selected
2024-03-11 17:23:48 +00:00
hyperparameter and metric.
To show the value distribution:
* Select the **Plot Axes**:
1. Under Y-axis select the metric and the metric values to use in the plot:
2025-02-06 15:31:11 +00:00
* **LAST** - The final value, or the most recent value, for currently running tasks
2024-03-11 17:23:48 +00:00
* **MIN** - Minimal value
* **MAX** - Maximal value
1. Under X-axis select the hyperparameter.
2025-02-06 15:31:11 +00:00
Hovering over each datapoint in the resulting plot will show the task name and the metric and parameter value for that
2024-03-11 17:23:48 +00:00
point. You can add additional metrics and hyperparameters values to the datapoint tooltip through **ADDITIONAL DATA POINT INFORMATION**.
2025-02-05 15:53:30 +00:00
![Comparison scatter plot](../img/webapp_compare_scatter.png#light-mode-only)
![Comparison scatter plot](../img/webapp_compare_scatter_dark.png#dark-mode-only)
2024-03-11 17:23:48 +00:00
2023-11-02 08:30:12 +00:00
### Plot Comparison
2025-02-06 15:31:11 +00:00
The **Scalars** (Graph view) and **Plots** tabs compare tasks' plots.
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
The **Scalars** tab displays scalar values as time series line charts. The **Plots** tab compares the last reported
2025-02-06 15:31:11 +00:00
iteration sample of each metric/variant combination per compared task.
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
Line, scatter, box, and bar graphs are compared by overlaying each metric/variant from all compared tasks' into a single
2023-11-02 08:30:12 +00:00
comparative plot.
2021-05-13 23:48:51 +00:00
2024-11-04 10:53:38 +00:00
For overlaid plots, use **Group by** to select how to group plots:
2023-11-02 08:30:12 +00:00
* **Metric** - All variants for a metric appear on the same plot.
2024-11-04 10:53:38 +00:00
2025-02-05 15:53:30 +00:00
![Scalar plot grouped by metric](../img/webapp_compare_07.png#light-mode-only)
![Scalar plot grouped by metric](../img/webapp_compare_07_dark.png#dark-mode-only)
2024-11-04 10:53:38 +00:00
2023-11-02 08:30:12 +00:00
* **Metric+Variant** (default) - Every variant appears on its own plot.
2021-05-13 23:48:51 +00:00
2025-02-05 15:53:30 +00:00
![Scalar plot grouped by metric and variant](../img/webapp_compare_08.png#light-mode-only)
![Scalar plot grouped by metric and variant](../img/webapp_compare_08_dark.png#dark-mode-only)
2021-05-13 23:48:51 +00:00
2025-02-06 15:31:11 +00:00
Other plot types that are not overlaid are displayed separately for each task:
2021-05-13 23:48:51 +00:00
2025-02-05 15:53:30 +00:00
![non-merged comparison](../img/webapp_compare_exp_plots.png#light-mode-only)
![non-merged comparison](../img/webapp_compare_exp_plots_dark.png#dark-mode-only)
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
All single value scalars are plotted into a single clustered bar chart under the "Summary" title, where each cluster
2025-02-06 15:31:11 +00:00
represents a reported metric, and each bar in the cluster represents a task.
2021-05-13 23:48:51 +00:00
2025-02-05 15:53:30 +00:00
![Single scalar comparison](../img/webapp_compare_exp_single_scalars.png#light-mode-only)
![Single scalar comparison](../img/webapp_compare_exp_single_scalars_dark.png#dark-mode-only)
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
Hover over plots to access plot controls (see [Scalar Plot Tools](webapp_exp_track_visual.md#scalar-plot-tools)).
2021-05-23 20:17:12 +00:00
2023-11-02 08:30:12 +00:00
### Side-by-side Debug Sample Comparison
2025-02-06 15:31:11 +00:00
Compare debug samples at different iterations to examine how your tasks perform throughout their execution.
2021-05-23 20:17:12 +00:00
2023-11-02 08:30:12 +00:00
You can view debug samples by metric in the reported iterations. Filter the samples by metric
by selecting a metric from the dropdown menu above the samples. The most recent iteration appears first. To navigate
between iterations, click <img src="/docs/latest/icons/ico-circle-older.svg" alt="Left arrow" className="icon size-md space-sm" /> (older images),
<img src="/docs/latest/icons/ico-circle-newer.svg" alt="Right arrow" className="icon size-md space-sm" /> (newer images),
or <img src="/docs/latest/icons/ico-circle-newest.svg" alt="right arrow, newest image" className="icon size-md space-sm" /> (newest images).
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
Click <img src="/docs/latest/icons/ico-disconnect.svg" alt="Sync selection" className="icon size-md space-sm" /> in order
2025-02-06 15:31:11 +00:00
to synchronize iteration and metric selection across tasks. For example, if you select a metric for one
task's debug samples, the same metric will be automatically selected for the rest of the tasks in the
2023-11-02 08:30:12 +00:00
comparison.
2021-05-23 20:17:12 +00:00
2025-02-05 15:53:30 +00:00
![Debug sample comparison](../img/webapp_compare_30.png#light-mode-only)
![Debug sample comparison](../img/webapp_compare_30_dark.png#dark-mode-only)
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
Open a debug sample (image, audio, or video) in the viewer or player, by clicking the thumbnail.
2021-05-13 23:48:51 +00:00
2025-02-05 15:53:30 +00:00
![Debug Sample viewer](../img/webapp_tracking_44.png#light-mode-only)
![Debug Sample viewer](../img/webapp_tracking_44_dark.png#dark-mode-only)
2021-05-13 23:48:51 +00:00
2023-11-02 08:30:12 +00:00
To move to the same sample in another iteration, click <img src="/docs/latest/icons/ico-previous.svg" alt="Left arrow" className="icon size-md space-sm" />
(previous), <img src="/docs/latest/icons/ico-next.svg" alt="Right arrow" className="icon size-md space-sm" /> (next), or move the slider.