clearml-docs/docs/webapp/webapp_model_table.md

71 lines
4.1 KiB
Markdown
Raw Normal View History

2021-05-13 23:48:51 +00:00
---
title: The Models Table
---
2021-05-23 20:17:12 +00:00
The models table is a [customizable](#customizing-the-models-table) list of models associated with the experiments in a project. From the models table,
2021-05-13 23:48:51 +00:00
view model details, and modify, publish, archive, tag, and move models to other projects.
![image](../img/webapp_models_01.png)
## Models table columns
2021-05-23 20:17:12 +00:00
The models table contains the following columns:
2021-05-13 23:48:51 +00:00
| Column | Description | Type |
|---|---|---|
| **FRAMEWORK** | The model framework. The list includes all frameworks, including custom frameworks. | Default |
| **NAME** | Model name. | Default |
| **TAGS** | User-defined labels added to models for grouping and organization. | Default |
| **STATUS** | The status of the model, which can be *Draft* (editable) or *Published* (read-only). | Default |
| **PROJECT** | The project with which the model is associated.| Default |
| **USER** | The user who ran the experiment that created the model, or the user who imported the model.| Default |
| **TASK** | The experiment (Task) name that created the model. | Default |
| **CREATED** | Elapsed time since the model creation. Hover over the elapsed time to view the date and time.| Default |
| **DESCRIPTION** | The model description. | Default (hidden) |
## Customizing the models table
2021-05-23 20:17:12 +00:00
The models table is customizable. Changes are persistent (cached in the browser) and represented in the URL, so customized settings
2021-05-13 23:48:51 +00:00
can be saved in a browser bookmark and shared with other **ClearML** users to collaborate.
Customize any combination of the following:
* Dynamic column ordering - Drag a column title to a different position.
2021-05-23 20:17:12 +00:00
* Show / hide columns - Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" />
**>** select or clear the checkboxes of columns to show or hide.
2021-05-13 23:48:51 +00:00
* Filter columns - Type of experiment, experiment status (state), user
* Sort columns - Metrics and hyperparameters, type of experiment, experiment name, start and last update elapsed time, and last iteration.
* Column autofit - In the column heading, double click a resizer (column separator).
## ClearML Actions from the models table
2021-05-23 20:17:12 +00:00
The following table describes the **ClearML** features that can be used from the models table, including the states that
2021-05-13 23:48:51 +00:00
allow each feature. Model states are *Draft* (editable) and *Published* (read-only).
| ClearML Action | Description | States Valid for the Action |
|---|---|--|
| View details | Model details include general information, the model configuration, and label enumeration. Click a model and the info panel slides open. | Any state |
| Publish | Publish a model to prevent changes to it. *Published* models are read-only. If a model is Published, its experiment also becomes Published (read-only). | *Draft* |
| Archive | To more easily work with active models, move a model to the archive. See [Archiving](webapp_archiving). | Any state |
| Tags | Tag models with color-coded labels to assist in organizing work. See [tagging models](#tagging-models). | Any state |
| Download | Download a model. The file format depends upon the framework. | *Published* |
| Move to project | To organize work and improve collaboration, move a model to another project. | Any state |
## Tagging models
2021-05-23 20:17:12 +00:00
Tags are user-defined, color-coded labels that can be added to models (and experiments), allowing to easily identify and
group of experiments. A tag can show any text, for any purpose. For example, add tags for the type of remote machine
2021-05-13 23:48:51 +00:00
experiments execute on, label versions of experiments, or apply team names to organize experimentation.
* To Add tags and to 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" />
2021-05-13 23:48:51 +00:00
(menu)
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**.