clearml-docs/docs/webapp/webapp_model_table.md
pollfly eb91aaa361
Update docs (#153)
* add info for clear filter, float behavior, and tag exclusion

* add data examples to guides

* fix typo

* fix filtering wording, and float admonition title

* add abort all children action

* dataset metadata initial

* fix expand icon

* initial new exp comparison window

* initial scalar full screen

* fix typo

* edit dataset version metada

* edit exp comparison and add missing alts to icons

* add info about dataset-level datasets

* add info about full screen mode

* HOCON >>> JSON

* HOCON >>> JSON

* dataset card edits

* edit fullscreen scalar mode

* edit fullscreen scalar plots

* edit pipeline example based on code fixes

* full screen scalar edit

* add context navigation

* Add experiment selection info

* experiment selection edit

* custom ui plugin

* datasets and versioning

* fix link
2022-01-10 11:45:29 +02:00

6.5 KiB

title
The Models Table

The models table is a customizable list of models associated with the experiments in a project. From the models table, view model details, and modify, publish, archive, tag, and move models to other projects.

Models table

Models Table Columns

The models table contains the following columns:

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
UPDATED Elapsed time since the model was updated. Hover over the elapsed time to view the date and time. Default
DESCRIPTION The model description. Default (hidden)

Customizing the Models Table

The models table is customizable. Changes are persistent (cached in the browser) and represented in the URL, so customized settings 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.
  • Show / hide columns - Click Setting Gear > select or clear the checkboxes of columns to show or hide.
  • 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).

:::note The following models-table customizations are saved on a per project basis:

  • Columns order
  • Column width
  • Active sort order
  • Active filters
  • Custom columns

If a project has subprojects, the models can be viewed by their subproject groupings or together with all the models in the project. The customizations of these two views are saved separately. :::

Model Actions

The following table describes the actions that can be done from the models table, including the states that 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. Any state
Tags Tag models with color-coded labels to assist in organizing work. See 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
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. Any state

These actions can be accessed with the context menu (when right-clicking a model or clicking the menu button Menu in a model's info panel).

Some actions mentioned in the chart above can be performed on multiple models at once. Select multiple models, then use either the context menu, or the bar that appears at the bottom of the page, to perform operations on the selected models. The context menu shows the number of models 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.

Models table batch operations

Tagging Models

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 experiments execute on, label versions of experiments, or apply team names to organize experimentation.

  • To Add tags and to change tag colors:
    1. Click the experiment > Hover over the tag area > +ADD TAG or Bars menu (menu)
    2. Do one of the following:
      • Add a new tag - Type the new tag name > (Create New).
      • Add an existing tag - Click a tag.
      • Change a tag's colors - Click Tag Colors > Click the tag icon > Background or Foreground > Pick a color > OK > CLOSE.
  • To remove a tag - Hover over the tag > X.

Filtering Columns

Filters can be applied by clicking Filter on a column, and the relevant filter appears.

There are a couple filter types:

  • Value set - Choose which values to include from a list of all values in the column
  • 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.

Once a filter is applied to a column, its filter icon will appear with a highlighted dot on its top right (Filter on ).

To clear all active filters, click Clear filters in the top right corner of the table.