clearml-docs/docs/webapp/webapp_exp_track_visual.md

410 lines
21 KiB
Markdown
Raw Normal View History

2021-05-13 23:48:51 +00:00
---
title: Tracking Experiments and Visualizing Results
---
2022-03-13 13:07:06 +00:00
While an experiment is running, and any time after it finishes, track it and visualize the results in the ClearML Web UI,
2021-05-23 20:17:12 +00:00
including:
2021-05-13 23:48:51 +00:00
2022-05-18 08:49:31 +00:00
* [Execution details](#execution) - Code, the base Docker image used for [ClearML Agent](../clearml_agent.md), output destination for artifacts, and the logging level.
2021-05-13 23:48:51 +00:00
* [Configuration](#configuration) - Hyperparameters, user properties, and configuration objects.
* [Artifacts](#artifacts) - Input model, output model, model snapshot locations, other artifacts.
* [General information](#general-information) - Information about the experiment, for example: the experiment start, create, and last update times and dates, user creating the experiment, and its description.
* [Console](#console) - stdout, stderr, output to the console from libraries, and ClearML explicit reporting.
2021-05-13 23:48:51 +00:00
* [Scalars](#scalars) - Metric plots.
* [Plots](#plots) - Other plots and data, for example: Matplotlib, Plotly, and ClearML explicit reporting.
2021-05-13 23:48:51 +00:00
* [Debug samples](#debug-samples) - Images, audio, video, and HTML.
2021-09-09 10:17:46 +00:00
## Viewing Modes
2021-05-13 23:48:51 +00:00
The ClearML Web UI provides two viewing modes for experiment details:
2021-05-13 23:48:51 +00:00
* The info panel
2021-05-23 20:17:12 +00:00
* Full screen details mode.
Both modes contain all experiment details. When either view is open, switch to the other mode by clicking <img src="/docs/latest/icons/ico-info-min.svg" alt="Table/Full screen view" className="icon size-md space-sm" />
2021-05-23 20:17:12 +00:00
(**View in experiments table / full screen**), or clicking <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (**menu**) > **View in experiments
2021-05-13 23:48:51 +00:00
table / full screen**.
2021-09-09 10:17:46 +00:00
### Info Panel
2021-05-13 23:48:51 +00:00
2021-12-28 10:52:15 +00:00
The info panel keeps the experiment table in view so that [experiment actions](webapp_exp_table.md#experiment-actions)
2021-05-23 20:17:12 +00:00
can be performed from the table (as well as the menu in the info panel).
2021-05-13 23:48:51 +00:00
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
![Info panel](../img/webapp_tracking_40.png)
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
</div>
</details>
2021-09-09 10:17:46 +00:00
### Full Screen Details View
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
The full screen details view allows for easier viewing and working with experiment tracking and results. The experiments
2021-05-13 23:48:51 +00:00
table is not visible when the full screen details view is open. Perform experiment actions from the menu.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
![Full screen view](../img/webapp_tracking_33.png)
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
</div>
</details>
2022-03-13 13:07:06 +00:00
## Execution
An experiment's **EXECUTION** tab of lists the following:
2021-05-23 20:17:12 +00:00
* Source code
* Uncommitted changes
2021-05-13 23:48:51 +00:00
* Installed Python packages
2022-03-13 13:07:06 +00:00
* Container details
* Output details
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
In full-screen mode, the source code and output details are grouped in the **DETAILS** section.
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
### Source Code
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
The Source Code section of an experiment's **EXECUTION** tab includes:
2021-05-13 23:48:51 +00:00
* The experiment's repository
* Commit ID
* Script path
2021-05-23 20:17:12 +00:00
* Working directory
2022-03-13 13:07:06 +00:00
![Source code section](../img/webapp_exp_source_code.png)
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
### Uncommitted Changes
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
ClearML displays the git diff of the experiment in the Uncommitted Changes section.
2021-05-23 20:17:12 +00:00
2022-03-13 13:07:06 +00:00
![Uncommitted changes section](../img/webapp_exp_uncommitted_changes.png)
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
### Installed Packages
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
The Installed Packages section lists the experiment's installed Python packages and their versions.
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
![Installed packages section](../img/webapp_exp_installed_packages.png)
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
### Container
The Container section list the following information:
* Image - a pre-configured Docker that ClearML Agent will use to remotely execute this experiment (see [Building Docker containers](../clearml_agent.md#exporting-a-task-into-a-standalone-docker-container))
* Arguments - add Docker arguments
* Setup shell script - a bash script to be executed inside the Docker before setting up the experiment's environment
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
![Container section](../img/webapp_exp_container.png)
2021-05-23 20:17:12 +00:00
2022-03-13 13:07:06 +00:00
### Output
The Output details include:
* The output destination used for storing model checkpoints (snapshots) and artifacts (see also, [default_output_uri](../configs/clearml_conf.md#config_default_output_uri)
in the configuration file, and `output_uri` in [`Task.init`](../references/sdk/task.md#taskinit) parameters).
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
* The logging level for the experiment, which uses the standard Python [logging levels](https://docs.python.org/3/howto/logging.html#logging-levels).
2021-05-23 20:17:12 +00:00
2022-03-13 13:07:06 +00:00
![Execution details section](../img/webapp_exp_output.png)
2021-05-13 23:48:51 +00:00
## Configuration
All parameters and configuration objects appear in the **CONFIGURATION** tab.
### Hyperparameters
2021-05-23 20:17:12 +00:00
:::important
2022-03-13 13:07:06 +00:00
In older versions of ClearML Server, the **CONFIGURATION** tab was named **HYPER PARAMETERS**, and it contained all parameters. The renamed tab contains a **HYPER PARAMETER** section, and subsections for hyperparameter groups.
2021-05-13 23:48:51 +00:00
:::
Hyperparameters are grouped by their type and appear in **CONFIGURATION** **>** **HYPER PARAMETERS**.
2021-09-09 10:17:46 +00:00
#### Command Line Arguments
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
The **Args** parameter group shows automatically logged `argparse` arguments, and all older experiments parameters, except
TensorFlow Definitions. Hover over a parameter, and the type, description, and default value appear, if they were provided.
2021-05-13 23:48:51 +00:00
![Command line arguments configuration group](../img/webapp_tracking_22.png)
2021-05-23 20:17:12 +00:00
2021-09-09 10:17:46 +00:00
#### Environment Variables
2021-05-13 23:48:51 +00:00
2022-01-19 12:26:14 +00:00
If the `CLEARML_LOG_ENVIRONMENT` variable was set, the **Environment** group will show environment variables (see [this FAQ](../faq.md#track-env-vars)).
2021-05-13 23:48:51 +00:00
![Environment variables configuration group](../img/webapp_tracking_23.png)
2021-05-23 20:17:12 +00:00
2021-09-09 10:17:46 +00:00
#### Custom Parameter Groups
2021-05-13 23:48:51 +00:00
Custom parameter groups show parameter dictionaries if the parameters were connected to the Task, using the `Task.connect` method,
2021-05-13 23:48:51 +00:00
with a `name` argument provided.
![Custom parameters group](../img/webapp_tracking_25.png)
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
#### TensorFlow Definitions
The **TF_DEFINE** parameter group shows automatic TensorFlow logging.
2021-05-13 23:48:51 +00:00
![TF_DEFINE parameter group](../img/webapp_tracking_26.png)
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
Once an experiment is run and stored in **ClearML Server**, any of these hyperparameters can be [modified](webapp_exp_tuning.md#modifying-experiments).
2021-09-09 10:17:46 +00:00
### User Properties
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
User properties allow to store any descriptive information in a key-value pair format. They are editable in any experiment,
2021-05-13 23:48:51 +00:00
except experiments whose status is *Published* (read-only).
![User properties section](../img/webapp_tracking_21.png)
2021-05-23 20:17:12 +00:00
2021-09-09 10:17:46 +00:00
### Configuration Objects
2021-05-13 23:48:51 +00:00
ClearML tracks experiment (Task) model configuration objects, which appear in **Configuration Objects** **>** **General**.
2021-05-23 20:17:12 +00:00
These objects include those that are automatically tracked, and those connected to a Task in code (see [Task.connect_configuration](../references/sdk/task.md#connect_configuration)).
2021-05-13 23:48:51 +00:00
![Configuration objects](../img/webapp_tracking_24.png)
2021-05-23 20:17:12 +00:00
2022-03-13 13:07:06 +00:00
ClearML supports providing a name for a Task model configuration object (see the `name`
parameter in [`Task.connect_configuration`](../references/sdk/task.md#connect_configuration)).
2021-05-13 23:48:51 +00:00
![Custom configuration objects](../img/webapp_tracking_28.png)
2021-05-23 20:17:12 +00:00
2022-03-13 13:07:06 +00:00
:::important
In older versions of **ClearML Server**, the Task model configuration appeared in the **ARTIFACTS** tab, **MODEL CONFIGURATION** section. Task model configurations now appear in the **Configuration Objects** section, in the **CONFIGURATION** tab.
:::
2021-05-13 23:48:51 +00:00
## Artifacts
Artifacts tracked in an experiment appear in the **ARTIFACTS** tab, and include models and other artifacts.
Artifacts location is stored in the `FILE PATH` field.
The UI provides locally stored artifacts with a 'copy to clipboard' action (<img src="/docs/latest/icons/ico-clipboard.svg" alt="Clipboard" className="icon size-sm space-sm" />)
to facilitate local storage access (since web applications are prohibited from accessing the local disk for security reasons).
The UI provides Network hosted (e.g. https://, s3:// etc. URIs) artifacts with a download action (<img src="/docs/latest/icons/ico-download-json.svg" alt="Download" className="icon size-sm space-sm" />)
to retrieve these files.
2021-05-13 23:48:51 +00:00
### Models
2021-05-23 20:17:12 +00:00
The input and output models appear in the **ARTIFACTS** tab. Models are associated with the experiment, but to see further model details,
2021-05-13 23:48:51 +00:00
including design, label enumeration, and general information, go to the **MODELS** tab, by clicking the model name, which is a hyperlink to those details.
**To retrieve a model:**
1. In the **ARTIFACTS** tab **>** **MODELS** **>** **Input Model** or **Output Model**, click the model name hyperlink.
1. In the model details **>** **GENERAL** tab **>** **MODEL URL**, either:
2021-05-23 20:17:12 +00:00
* Download the model<img src="/docs/latest/icons/ico-download.svg" className="icon size-md space-sm" />, if it is stored in remote storage.
* Copy its location to the clipboard <img src="/docs/latest/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md space-sm" />,
2021-05-13 23:48:51 +00:00
if it is in a local file.
![Models in Artifacts tab](../img/webapp_exp_artifacts_01.png)
2021-05-23 20:17:12 +00:00
2021-09-09 10:17:46 +00:00
### Other Artifacts
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
Other artifacts, which are uploaded but not dynamically tracked after the upload, appear in the **OTHER** section.
They include the file path, file size, and hash.
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
**To retrieve Other artifacts:**
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
In the **ARTIFACTS** tab **>** **OTHER** **>** Select an artifact **>** Either:
* Download the artifact <img src="/docs/latest/icons/ico-download.svg" className="icon size-md space-sm" />, if it is stored in remote storage.
* Copy its location to the clipboard <img src="/docs/latest/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md space-sm" />,
2021-05-13 23:48:51 +00:00
if it is in a local file.
![Other artifacts section](../img/webapp_tracking_30.png)
2021-05-23 20:17:12 +00:00
2021-09-09 10:17:46 +00:00
## General Information
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
General experiment details appear in the **INFO** tab. This includes information describing the stored experiment:
2021-05-13 23:48:51 +00:00
* The parent experiment
* Project name
* Creation, start, and last update dates and times
* User who created the experiment
* Experiment state (status)
* Whether the experiment is archived
2021-07-14 07:41:12 +00:00
* Runtime properties - Information about the machine running the experiment, including:
* Operating system
* CUDA driver version
* Number of CPU cores
* Number of GPUs
* CPU / GPU type
* Memory size
* Host name
* Processor
* Python version
2022-05-11 07:44:39 +00:00
* Experiment Progress
2021-07-14 07:41:12 +00:00
![Info tab](../img/webapp_tracking_31.png)
2021-05-23 20:17:12 +00:00
2021-09-09 10:17:46 +00:00
## Experiment Results
2021-05-13 23:48:51 +00:00
2021-05-18 22:31:01 +00:00
### Console
2021-05-13 23:48:51 +00:00
2021-11-21 07:42:29 +00:00
The complete experiment log containing everything printed to stdout and stderr appears in the **CONSOLE** tab. The full log
2021-05-13 23:48:51 +00:00
is downloadable. To view the end of the log, click **Jump to end**.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
![Console tab](../img/webapp_tracking_32.png)
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
</div>
2021-05-23 20:17:12 +00:00
</details>
2021-05-13 23:48:51 +00:00
### Scalars
All scalars that ClearML automatically logs, as well as those explicitly reported in code, appear in **RESULTS** **>**
**SCALARS**. Scalar values are presented as time series line chart. To see the series for a metric in high resolution,
view it in full screen mode by hovering over the graph and clicking <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" />.
:::info Full Screen Refresh
Scalar graphs in full screen mode do not auto-refresh. Click <img src="/docs/latest/icons/ico-reset.svg" alt="Refresh" className="icon size-sm space-sm" />
to update the graph.
:::
2021-05-13 23:48:51 +00:00
2021-09-09 10:17:46 +00:00
#### Scalar Plot Tools
2021-05-13 23:48:51 +00:00
Use the scalar tools to improve analysis of scalar metrics. In the info panel, click <img src="/docs/latest/icons/ico-settings.svg" alt="Settings gear" className="icon size-md space-sm" /> to use the tools. In the full screen details view, the tools
2021-05-13 23:48:51 +00:00
are on the left side of the window. The tools include:
2021-11-21 07:42:29 +00:00
* **Group by** - Select one of the following:
* **Metric** - All variants for a metric on the same plot
2021-05-23 20:17:12 +00:00
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
2021-05-23 20:17:12 +00:00
![Plots grouped by metric](../img/webapp_tracking_33.png)
2021-05-13 23:48:51 +00:00
</div>
</details>
<br/>
* **None** - Group by metric and variant (individual metric-variant plots).
2021-05-23 20:17:12 +00:00
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
2021-05-13 23:48:51 +00:00
![Plots groups my metric and variant](../img/webapp_tracking_34.png)
2021-05-23 20:17:12 +00:00
</div>
</details>
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
* Show / hide plots - Click **HIDE ALL**, and then click <img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />
2021-05-13 23:48:51 +00:00
on those you want to see.
2021-05-23 20:17:12 +00:00
* **Horizontal axis** modes (scalars, only) - Select one of the following:
2021-05-13 23:48:51 +00:00
* **ITERATIONS**
2021-11-21 07:42:29 +00:00
* **RELATIVE** - Time since experiment began
* **WALL** - Local clock time
2021-05-23 20:17:12 +00:00
* Curve smoothing (scalars, only) - In **Smoothing** **>** Move the slider or type a smoothing factor between **0** and **0.999**.
2021-05-13 23:48:51 +00:00
See additional [plot controls](#plot-controls) below.
2021-05-13 23:48:51 +00:00
### Plots
Non-time-series plots appear in **RESULTS** **>** **PLOTS**. These include data reported by libraries, visualization
tools, and ClearML explicit reporting. These may include 2D and 3D plots, tables (Pandas and CSV files), and Plotly plots.
2021-05-13 23:48:51 +00:00
Individual plots can be shown / hidden or filtered by title.
![Plots tab](../img/webapp_tracking_35.png)
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
2021-09-09 10:17:46 +00:00
#### Plot Controls
2021-05-13 23:48:51 +00:00
The table below lists the plot controls which may be available for any plot (in the **SCALARS** and **PLOTS** tabs).
These controls allow you to better analyze the results. Hover over a plot, and the controls appear.
2021-05-13 23:48:51 +00:00
|Icon|Description|
|---|---|
2021-09-26 09:42:31 +00:00
| <img src="/docs/latest/icons/ico-download-pic.svg" alt="Download PNG icon" className="icon size-sm space-sm" /> | Download plots as PNG files. |
| <img src="/docs/latest/icons/ico-pan.svg" alt="Pan icon" className="icon size-sm space-sm" /> | Pan around plot. Click <img src="/docs/latest/icons/ico-pan.svg" alt="Pan icon" className="icon size-sm space-sm" />, click the plot, and then drag. |
| <img src="/docs/latest/icons/ico-dotted-box.svg" alt="Dotted box icon" className="icon size-sm space-sm" /> | To examine an area, draw a dotted box around it. Click <img src="/docs/latest/icons/ico-dotted-box.svg" alt="Dotted box icon" className="icon size-sm space-sm" /> and then drag. |
| <img src="/docs/latest/icons/ico-dotted-lasso.svg" alt="Dotted lasso icon" className="icon size-sm space-sm" /> | To examine an area, draw a dotted lasso around it. Click <img src="/docs/latest/icons/ico-dotted-lasso.svg" alt="Dotted lasso icon" className="icon size-sm space-sm" /> and then drag. |
| <img src="/docs/latest/icons/ico-zoom.svg" alt="Zoom icon" className="icon size-sm space-sm" /> | Zoom into a section of a plot. Zoom in - Click <img src="/docs/latest/icons/ico-zoom.svg" alt="Zoom icon" className="icon size-sm space-sm" /> and drag over a section of the plot. Reset to original scale - Click <img src="/docs/latest/icons/ico-reset-autoscale.svg" alt="Reset autoscale icon" className="icon size-sm space-sm" /> . |
| <img src="/docs/latest/icons/ico-zoom-in-square.svg" alt="Zoom-in icon" className="icon size-sm space-sm" /> | Zoom in. |
| <img src="/docs/latest/icons/ico-zoom-out-square.svg" alt="Zoom-out icon" className="icon size-sm space-sm" /> | Zoom out. |
| <img src="/docs/latest/icons/ico-reset-autoscale.svg" alt="Reset autoscale icon" className="icon size-sm space-sm" /> | Reset to autoscale after zooming ( <img src="/docs/latest/icons/ico-zoom.svg" alt="Zoom icon" className="icon size-sm space-sm" />, <img src="/docs/latest/icons/ico-zoom-in-square.svg" alt="Zoom-in icon" className="icon size-sm space-sm" />, or <img src="/docs/latest/icons/ico-zoom-out-square.svg" alt="Zoom-out icon" className="icon size-sm space-sm" />). |
| <img src="/docs/latest/icons/ico-reset-axes.svg" alt="Reset axes icon" className="icon size-sm space-sm" /> | Reset axes after a zoom. |
| <img src="/docs/latest/icons/ico-spike-lines.svg" alt="Spike lines icon" className="icon size-sm space-sm" /> | Show / hide spike lines. |
| <img src="/docs/latest/icons/ico-show-closest.svg" alt="Show closest icon" className="icon size-sm space-sm" /> | Show the closest data point on hover, including horizontal and vertical axes values. Click <img src="/docs/latest/icons/ico-show-closest.svg" alt="Show closest icon" className="icon size-sm space-sm" /> and then hover over a series on 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-ico-graph-legend.svg" alt="Graph legend icon" className="icon size-sm space-sm" /> | Hide / show the legend. |
2022-05-18 07:24:00 +00:00
| <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. |
2022-03-06 11:00:46 +00:00
| <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-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-reset.svg" alt="Refresh" className="icon size-sm space-sm" /> | Refresh scalar graphs in full screen mode to update it |
2021-09-09 10:17:46 +00:00
#### 3D Plot Controls
|Icon|Description|
|---|---|
| <img src="/docs/latest/icons/ico-orbital-rotation.svg" alt="Orbital rotation mode icon" className="icon size-sm space-sm" />| Switch to orbital rotation mode - rotate the plot around its middle point. |
| <img src="/docs/latest/icons/ico-turntable-rotation.svg" alt="Turntable rotation mode icon" className="icon size-sm space-sm" />| Switch to turntable rotation mode - rotate the plot around its middle point while constraining one axis |
| <img src="/docs/latest/icons/ico-reset-axes.svg" alt="reset axes icon" className="icon size-sm space-sm" />| Reset axes to default position. |
2021-05-13 23:48:51 +00:00
2021-09-09 10:17:46 +00:00
### Debug Samples
2021-05-13 23:48:51 +00:00
2022-03-13 13:07:06 +00:00
View debug samples by metric at any iteration. The most recent iteration appears first.
![Debug Samples tab](../img/webapp_tracking_43.png)
Use the viewer / player to inspect images, audio, video samples and do any of the following:
2021-05-13 23:48:51 +00:00
* Move to the same sample in a different iteration (move the iteration slider).
* Show the next or previous iteration's sample.
* Download the file <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />.
2021-05-13 23:48:51 +00:00
* Zoom.
* View the sample's iteration number, width, height, and coordinates.
![Debug Samples image viewer](../img/webapp_tracking_44.png)
2021-05-23 20:17:12 +00:00
2021-05-13 23:48:51 +00:00
**To view debug samples:**
1. Click the **DEBUG SAMPLES** tab. The most recent iteration appears at the top.
1. Locate debug samples by doing the following:
* Filter by metric. In the **Metric** list, choose a metric.
* Show other 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" /> (New images),
or <img src="/docs/latest/icons/ico-circle-newest.svg" alt="Skip to newest arrow" className="icon size-md space-sm" /> (Newest images).
2021-05-13 23:48:51 +00:00
**To view a debug sample in the viewer / player:**
1. Click the debug sample click the thumbnail.
1. Do any of the following:
* Move to the same sample in another iteration - Move the slider, or click **<** (previous) or **>** (next).
* Download the file - Click <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />.
2021-05-13 23:48:51 +00:00
* Zoom
2021-05-23 20:17:12 +00:00
* For images, locate a position on the sample - Hover over the sample and the X, Y coordinates appear in the legend below the sample.
2021-05-13 23:48:51 +00:00
2021-09-09 10:17:46 +00:00
## Tagging Experiments
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
Tags are user-defined, color-coded labels that can be added to experiments (and models), allowing to easily identify and
group experiments. Tags can show any text. For example, add tags for the type of remote machine experiments were executed
2021-05-13 23:48:51 +00:00
on, label versions of experiments, or apply team names to organize experimentation.
* To add tags and change tag colors:
2021-05-23 20:17:12 +00:00
1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (menu)
2021-05-13 23:48:51 +00:00
1. Do one of the following:
* Add a new tag - Type the new tag name **>** **(Create New)**.
* Add an existing tag - Click a tag.
2021-05-23 20:17:12 +00:00
* Change a tag's colors - Click **Tag Colors** **>** Click the tag icon **>** **Background** or **Foreground** **>** Pick a color **>** **OK** **>** **CLOSE**.
2021-05-13 23:48:51 +00:00
* To remove a tag - Hover over the tag **>** **X**.
2021-09-09 10:17:46 +00:00
## Locating the Experiment (Task) ID
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
* In the info panel, in the top area, to the right of the Task name, click **ID**. The Task ID appears.