clearml-docs/docs/webapp/webapp_exp_table.md

200 lines
14 KiB
Markdown
Raw Normal View History

2021-05-13 23:48:51 +00:00
---
title: The Experiments Table
---
2021-05-23 20:17:12 +00:00
The experiments table is a [customizable](#customizing-the-experiments-table) list of experiments associated with a project. From the experiments
table, view experiment details, and work with experiments (reset, clone, enqueue, create [tracking leaderboards](../guides/ui/building_leader_board.md)
to monitor experimentation, and more). The experiments table's auto-refresh allows users to continually monitor experiment progress.
2021-05-13 23:48:51 +00:00
2022-04-07 08:49:11 +00:00
View the experiments table in table view <img src="/docs/latest/icons/ico-table-view.svg" alt="Table view" className="icon size-md space-sm" />
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your experiments according
to columns of interest. Use the details view to access a selected experiments details, while keeping the experiment list
2022-12-26 09:08:10 +00:00
in view. Details view can also be accessed by double-clicking a specific experiment in the table view to open its details view.
2021-05-13 23:48:51 +00:00
:::info
2021-05-23 20:17:12 +00:00
To assist in focusing on active experimentation, experiments and models can be archived, so they will not appear
2022-01-19 12:26:14 +00:00
in the active experiments and models tables. See [Archiving](webapp_archiving.md).
2021-05-13 23:48:51 +00:00
:::
2022-03-13 13:07:06 +00:00
![Experiment table](../img/webapp_experiment_table.png)
2021-05-13 23:48:51 +00:00
## Experiments Table Columns
2021-05-13 23:48:51 +00:00
The experiments table default and customizable columns are described in the following table.
| Column | Description | Type |
|---|---|---|
2022-03-13 13:07:06 +00:00
| **TYPE** | Type of experiment. ClearML supports multiple [task types](../fundamentals/task.md#task-types) for experimentation, and a variety of workflows and use cases. | Default |
2021-05-13 23:48:51 +00:00
| **NAME** | Experiment name. | Default |
2022-01-20 12:12:28 +00:00
| **TAGS** | Descriptive, user-defined, color-coded tags assigned to experiments. Use tags to classify experiments, and filter the list. See [tagging experiments](webapp_exp_track_visual.md#tagging-experiments). | Default |
2022-05-18 08:49:31 +00:00
| **STATUS** | Experiment state (status). See a list of the [task states and state transitions](../fundamentals/task.md#task-states). If you programmatically set task progress values, you will also see a progress indicator for Running, Failed, and Aborted tasks. See [here](../clearml_sdk/task_sdk.md#tracking-task-progress). | Default |
2021-05-13 23:48:51 +00:00
| **PROJECT** | Name of experiment's project. | Default |
| **USER** | User who created or cloned the experiment. | Default (hidden) |
| **STARTED** | Elapsed time since the experiment started. To view the date and time of start, hover over the elapsed time. | Default |
2021-05-23 20:17:12 +00:00
| **UPDATED** | Elapsed time since the last update to the experiment. To view the date and time of update, hover over the elapsed time. | Default |
| **ITERATION** | Last or most recent iteration of the experiment. | Default |
2021-05-13 23:48:51 +00:00
| **DESCRIPTION** | A description of the experiment. For cloned experiments, the description indicates it was auto generated with a timestamp. | Default (hidden) |
| **RUN TIME** | The current / total running time of the experiment. | Default (hidden) |
| **_Metrics_** | Add metrics column (last, minimum, and / or maximum values). The metrics depend upon the experiments in the table. See [adding metrics](#to-add-metrics). | Customizable |
| **_Hyperparameters_** | Add hyperparameters. The hyperparameters depend upon the experiments in the table. See [adding hyperparameters](#to-add-hyperparameters). | Customizable |
## Customizing the Experiments Table
2021-05-13 23:48:51 +00:00
2022-03-06 11:00:46 +00:00
Customize the table using any of the following:
* Dynamic column order - Drag a column title to a different position.
2022-12-26 09:08:10 +00:00
* Resize columns - Drag the column separator to change the width of that column. Double-click the column separator for
2022-03-06 11:00:46 +00:00
automatic fit.
* Changing table columns
* Show / hide columns - Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" />
**>** mark or clear the checkboxes of columns to show or hide.
2023-01-12 10:49:55 +00:00
* Add custom columns - Click **+ METRICS** or **+ HYPERPARAMETERS** to add metric / hyperparameter columns to the
2022-03-06 11:00:46 +00:00
main column list. Added columns are by default displayed in the table. You can remove the custom columns from the
main column list or the column addition windows.
* [Filter columns](#filtering-columns)
* Sort columns - According to metrics and hyperparameters, type of experiment, experiment name, start and last update elapsed time, and last iteration.
2021-05-13 23:48:51 +00:00
Use experiments table customization for various use cases, including:
2021-05-23 20:17:12 +00:00
* Creating a [leaderboard](#creating-an-experiment-leaderboard) that will update in real time with experiment
2021-05-13 23:48:51 +00:00
performance, which can be shared and stored.
2021-05-23 20:17:12 +00:00
* Sorting models by metrics - Models are associated with the experiments that created them. For each metric, use the last
2021-05-13 23:48:51 +00:00
value, the minimal value, and / or the maximal value.
* Tracking hyperparameters - Track hyperparameters by adding them as columns, and applying filters and sorting.
2021-05-23 20:17:12 +00:00
Changes are persistent (cached in the browser), and represented in the URL so customized settings can be saved in a browser
2022-03-13 13:07:06 +00:00
bookmark and shared with other ClearML users to collaborate.
2021-05-13 23:48:51 +00:00
2021-07-14 07:37:55 +00:00
:::note
2022-12-26 09:08:10 +00:00
The following experiments-table customizations are saved on a **per-project** basis:
2021-07-14 07:37:55 +00:00
* Columns order
* Column width
* Active sort order
* Active filters
* Custom columns
2021-12-21 11:42:44 +00:00
If a project has subprojects, the experiments can be viewed by their subproject groupings or together with
2021-07-14 07:37:55 +00:00
all the experiments in the project. The customizations of these two views are saved separately.
:::
2021-05-13 23:48:51 +00:00
### Adding Metrics and / or Hyperparameters
2021-05-13 23:48:51 +00:00
2021-07-14 07:37:55 +00:00
![Experiment table customization gif](../img/gif/webapp_exp_table_cust.gif)
2021-05-23 20:17:12 +00:00
Add metrics and / or hyperparameters columns to the experiments table. The metrics and hyperparameters depend upon the
2021-05-13 23:48:51 +00:00
experiments in the table.
#### To Add Metrics:
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
* Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> **>** **+ METRICS** **>** Expand a metric **>** Select the **LAST** (value),
2021-05-13 23:48:51 +00:00
**MIN** (minimal value), and / or **MAX** (maximal value) checkboxes.
#### To Add Hyperparameters:
2021-05-13 23:48:51 +00:00
2023-01-12 10:49:55 +00:00
* Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> **>** **+ HYPERPARAMETERS** **>** Expand a section **>** Select the
2021-05-13 23:48:51 +00:00
hyperparameter checkboxes.
:::note Float Values Display
By default, the experiments table displays rounded up float values. Hover over a float to view its precise value in the
2022-01-12 08:28:29 +00:00
tooltip that appears. To view all precise values in a column, hover over a float and click <img src="/docs/latest/icons/ico-line-expand.svg" alt="Expand" className="icon size-md" />.
:::
2021-05-13 23:48:51 +00:00
### Filtering Columns
2021-07-15 06:56:34 +00:00
![Filtering table gif](../img/gif/filter_screenshots.gif)
Filters can be applied by clicking <img src="/docs/latest/icons/ico-filter-off.svg" alt="Filter" className="icon size-md" />
on a column, and the relevant filter appears.
There are a few types of filters:
* Value set - Choose which values to include from a list of all values in the column
* Numerical ranges - Insert minimum and / or maximum value
* Date ranges - Insert starting and / or ending date and time
* Tags - Choose which tags to filter by from a list of all tags used in the column.
* Filter by multiple tag values using the **ANY** or **ALL** options, which correspond to the logical "AND" and "OR" respectively. These
options appear on the top of the tag list.
* Filter by the absence of a tag (logical "NOT") by clicking its checkbox twice. An `X` will appear in the tag's checkbox.
2021-07-15 06:56:34 +00:00
2021-07-15 10:28:42 +00:00
Once 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" /> ).
2021-07-15 06:56:34 +00:00
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.
2021-07-15 06:56:34 +00:00
## Experiment Actions
2021-05-13 23:48:51 +00:00
The following table describes the actions that can be done from the experiments table, including the [states](../fundamentals/task.md#task-states)
that allow each operation.
2021-05-13 23:48:51 +00:00
2022-04-07 08:49:11 +00:00
Access these actions with the context menu in any of the following ways:
2023-01-25 11:25:29 +00:00
* In the experiments table, right-click an experiment or hover over an experiment and click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" />
2022-04-07 08:49:11 +00:00
* In an experiment info panel, click the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bar menu" className="icon size-md space-sm" />
| Action | Description | States Valid for the Action | State Transition |
2021-05-13 23:48:51 +00:00
|---|---|---|---|
2022-12-27 14:01:47 +00:00
| Details | Open the experiment's [info panel](webapp_exp_track_visual.md#info-panel) (keeps the experiments list in view). Can also be accessed by double-clicking an experiment in the experiments table. | Any state | None |
2022-04-07 08:49:11 +00:00
| View Full Screen | View experiment details in [full screen](webapp_exp_track_visual.md#full-screen-details-view). | Any state | None |
| Manage Queue | If an experiment is *Pending* in a queue, view the utilization of that queue, manage that queue (remove experiments and change the order of experiments), and view information about the worker(s) listening to the queue. See the [Workers and Queues](webapp_workers_queues.md) page. | *Enqueued* | None |
| View Worker | If an experiment is *Running*, view resource utilization, worker details, and queues to which a worker is listening. | *Running* | None |
2022-01-19 12:26:14 +00:00
| Share | For **ClearML Hosted Service** users only, [share](webapp_exp_sharing.md) an experiment and its model with a **ClearML Hosted Service** user in another workspace. | Any state | None |
| Archive | To more easily work with active experiments, move an experiment to the archive. See [Archiving](webapp_archiving.md). | Any state | None |
2022-03-21 14:00:29 +00:00
| Restore |Action available in the archive. Restore an experiment to the active experiments table.| Any State | None |
2021-05-13 23:48:51 +00:00
| Enqueue | Add an experiment to a queue for a worker or workers (listening to the queue) to execute. | *Draft* | *Pending* |
| Dequeue | Remove an experiment from a queue. | *Pending* | *Draft* |
| Reset | Delete the log and output from a previous run of an experiment (for example, before rerunning it). | *Completed*, *Aborted*, or *Failed* | *Draft* |
| Abort | Manually terminate a *Running* experiment. | *Running* | *Aborted* |
| Abort All Children | Manually terminate all *Running* experiments which have this task as a parent | *Running* or *Aborted* | None for parent experiment, *Aborted* for child experiments |
2021-05-13 23:48:51 +00:00
| Publish | Publish an experiment to prevent changes to its tracking data, inputs, and outputs. Published experiments and their models are read-only. *Published* experiments cannot be enqueued, but they can be cloned, and their clones can be edited, tuned, and enqueued. | *Completed*, *Aborted*, or *Failed*. | *Published* |
2022-04-07 08:49:11 +00:00
| Add Tag | Tag experiments with color-coded labels to assist you in organizing your work. See [tagging experiments](webapp_exp_track_visual.md#tagging-experiments). | Any state | None |
2021-05-13 23:48:51 +00:00
| Clone | Make an exact, editable copy of an experiment (for example, to reproduce an experiment, but keep the original). | *Draft* | Newly Cloned Experiment is *Draft* |
2022-04-07 08:49:11 +00:00
| Move to Project | Move an experiment to another project. | Any state | None |
2022-01-19 12:26:14 +00:00
| Custom action | The ClearML Enterprise Server provides a mechanism to define your own custom actions, which will appear in the context menu. See [Custom UI Context Menu Actions](../deploying_clearml/clearml_server_config.md#custom-ui-context-menu-actions). | Any State | None |
2021-05-13 23:48:51 +00:00
Most of the actions mentioned in the chart above can be performed on multiple experiments at once.
[Select multiple experiments](#selecting-multiple-experiments), then use either the context menu, or the bar that appears at the bottom of the page, to perform
operations on the selected experiments. Actions can be performed only on the experiments that match the action criteria
(for example, only *Running* experiments can be aborted). The context menu shows the number
of experiments that can be affected by each action. The same information can be found in the bottom menu, in a tooltip that
appears when hovering over an action icon.
2022-03-13 13:07:06 +00:00
![Experiment table batch operations](../img/webapp_experiment_table_context_menu.png)
## Selecting Multiple Experiments
Select multiple experiments by clicking the checkbox on the left of each relevant experiment. Clear any existing selection
by clicking the checkbox in the top left corner of the table.
Click the checkbox in the top left corner of the table to select all items currently visible.
An extended bulk selection tool is available through the down arrow next to the checkbox in the top left corner, enabling
selecting items beyond the items currently on-screen:
* **All** - Select all experiments in the project
2022-01-18 11:23:47 +00:00
* **None** - Clear selection
* **Filtered** - Select **all experiments in the project** that match the current active filters in the project
2021-05-13 23:48:51 +00:00
## Creating an Experiment Leaderboard
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
Filter & sort the experiments of any project to create a leaderboard that can be shared and stored. This leaderboard
updates in real time with experiment performance and outputs.
2021-05-13 23:48:51 +00:00
2022-04-07 08:49:11 +00:00
Modify the experiments table in the following ways to create a customized leaderboard:
2021-05-13 23:48:51 +00:00
* Add experiment configuration ([hyperparameters](#to-add-hyperparameters))
* Edit and add experiments [properties](webapp_exp_track_visual.md#user-properties)
2021-05-23 20:17:12 +00:00
* Add reported [metrics](#to-add-metrics), any time series reported metric can be selected, then select the last reported
2021-05-13 23:48:51 +00:00
value, or the minimum / maximum reported value.
* Filter based on user (dropdown and select) or [experiment types](../fundamentals/task.md#task-types)
2021-07-15 06:56:34 +00:00
* Add specific [tags](webapp_exp_track_visual.md#tagging-experiments) and filter based on them.
2021-05-13 23:48:51 +00:00
2021-05-23 20:17:12 +00:00
Now the table can be sorted based on any of the columns (probably one of the performance metrics). Select to filter experiments
2021-05-13 23:48:51 +00:00
based on their name by using the search bar.
2021-05-23 20:17:12 +00:00
The final dashboard can be shared by copying the URL from the address bar, this address will replicate the exact same dashboard on any browser.
2021-05-13 23:48:51 +00:00
The dashboard can also be bookmarked for later use.
2021-07-14 07:37:55 +00:00
![Experiment table sharing](../img/webapp_exp_table_sharing.png)