mirror of
https://github.com/clearml/clearml-docs
synced 2025-02-24 21:14:37 +00:00
206 lines
12 KiB
Markdown
206 lines
12 KiB
Markdown
---
|
|
title: Comparing Tasks
|
|
---
|
|
|
|
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
|
|
objects, and other details.
|
|
* Hyperparameters
|
|
* [Values](#side-by-side-textual-comparison) - Compare parameters and their values
|
|
* [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
|
|
* Scalars - Compare task metrics:
|
|
* [Values](#tabular-scalar-comparison) - Compare minimal, maximal or last reported values in a concise comparison
|
|
table
|
|
* [Graphs](#plot-comparison) - Overlay compared tasks in a single graph per metric
|
|
* [Plots](#plot-comparison) - Compare task plots
|
|
* [Debug samples](#side-by-side-debug-sample-comparison) - Compare debug samples by iteration
|
|
|
|
With these comparisons, you can investigate the impact of different setups on your task results, and gain insight
|
|
for crafting future tasks.
|
|
|
|
## Selecting Tasks to Compare
|
|
|
|
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**.
|
|
|
|
The comparison page opens in the **DETAILS** tab with the tasks [compared side by side](#side-by-side-textual-comparison).
|
|
|
|
### Modifying Task Selection
|
|
|
|
Click the `TASKS` button to view your currently compared tasks. Click `X` on a listed task to remove
|
|
it from the comparison.
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
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).
|
|
1. Click **APPLY**.
|
|
|
|
## 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.).
|
|
|
|
## 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
|
|
tasks update. The Enterprise Plan and Hosted Service support embedding resources in external tools (e.g. Notion).
|
|
|
|
## 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
|
|
* [Scatter plot](#scatter-plot)
|
|
* [Overlaid plot comparison](#plot-comparison)
|
|
* Side-by-side [debug sample](#side-by-side-debug-sample-comparison) and [plot](#plot-comparison) comparison
|
|
|
|
### Side-by-side Textual Comparison
|
|
|
|
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),
|
|
models, artifacts, configuration objects, and additional general information. **Hyperparameters** (Values view) displays the
|
|
tasks' hyperparameter and their values.
|
|
|
|
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
|
|
one of the following ways:
|
|
* 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
|
|
|
|
The differences between the tasks are highlighted. Easily locate
|
|
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.
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
### 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
|
|
|
|
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" />.
|
|
|
|
Switch on the **Show row extremes** toggle to highlight each variant's maximum and minimum values.
|
|
|
|
|
|
|
|
|
|
### Parallel Coordinates Mode
|
|
|
|
The **Hyperparameters** tab's **Parallel Coordinates** comparison shows tasks' hyperparameter impact on specified
|
|
metrics:
|
|
1. Under **Performance Metrics**, select metrics to compare for
|
|
1. Select the values to use for each metric in the plot (can select multiple):
|
|
* LAST - The final value, or the most recent value, for currently running tasks
|
|
* MIN - Minimal value
|
|
* MAX - Maximal value
|
|
1. In **Parameters**, select the hyperparameters to compare.
|
|
|
|
|
|
For example, plot the metric/variant `accuracy`/`total` against the hyperparameters
|
|
`base_lr`, `dropout`, and `number_of_epochs`.
|
|
|
|
|
|
|
|
|
|
To focus on a specific task, hover over its name in the graph legend.
|
|
|
|
To hide a task, click its name in the graph legend (click again to bring back).
|
|
|
|
### Scatter Plot
|
|
The **Hyperparameters** tab's **Scatter Plot** comparison shows tasks' correlation between a selected
|
|
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:
|
|
* **LAST** - The final value, or the most recent value, for currently running tasks
|
|
* **MIN** - Minimal value
|
|
* **MAX** - Maximal value
|
|
1. Under X-axis select the hyperparameter.
|
|
|
|
Hovering over each datapoint in the resulting plot will show the task name and the metric and parameter value for that
|
|
point. You can add additional metrics and hyperparameters values to the datapoint tooltip through **ADDITIONAL DATA POINT INFORMATION**.
|
|
|
|
|
|
|
|
|
|
### Plot Comparison
|
|
The **Scalars** (Graph view) and **Plots** tabs compare tasks' plots.
|
|
|
|
The **Scalars** tab displays scalar values as time series line charts. The **Plots** tab compares the last reported
|
|
iteration sample of each metric/variant combination per compared task.
|
|
|
|
Line, scatter, box, and bar graphs are compared by overlaying each metric/variant from all compared tasks' into a single
|
|
comparative plot.
|
|
|
|
For overlaid plots, use **Group by** to select how to group plots:
|
|
* **Metric** - All variants for a metric appear on the same plot.
|
|
|
|
|
|
|
|
|
|
* **Metric+Variant** (default) - Every variant appears on its own plot.
|
|
|
|
|
|
|
|
|
|
Other plot types that are not overlaid are displayed separately for each task:
|
|
|
|
|
|
|
|
|
|
All single value scalars are plotted into a single clustered bar chart under the "Summary" title, where each cluster
|
|
represents a reported metric, and each bar in the cluster represents a task.
|
|
|
|
|
|
|
|
|
|
Hover over plots to access plot controls (see [Scalar Plot Tools](webapp_exp_track_visual.md#scalar-plot-tools)).
|
|
|
|
### Side-by-side Debug Sample Comparison
|
|
Compare debug samples at different iterations to examine how your tasks perform throughout their execution.
|
|
|
|
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).
|
|
|
|
Click <img src="/docs/latest/icons/ico-disconnect.svg" alt="Sync selection" className="icon size-md space-sm" /> in order
|
|
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
|
|
comparison.
|
|
|
|
|
|
|
|
|
|
Open a debug sample (image, audio, or video) in the viewer or player, by clicking the thumbnail.
|
|
|
|
|
|
|
|
|
|
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.
|