Add context menu and batch operation info (#16)

This commit is contained in:
pollfly 2021-07-15 16:51:15 +03:00 committed by GitHub
parent c0b01c760b
commit c82efea77f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 53 additions and 7 deletions

View File

@ -43,6 +43,29 @@ all the Dataviews in the project. The customizations of these two views are save
:::
## Dataview actions
The following table describes the actions that can be performed from the Dataviews table.
| ClearML Action | Description |
|---|---|--|
| View details | Dataview details, including input datasets, label mapping, augmentation operations, and iteration control. Click a Dataview and the info panel slides open. |
| Archive | To more easily work with active Dataviews, move a Dataview to the archive. See [Archiving Dataviews](#archiving-dataviews). |
| Clone | Make an exact copy of a Dataview. |
| Move to project | To organize work and improve collaboration, move a Dataview to another project. |
These actions can be accessed with the context menu (when right-clicking a Dataview or clicking the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
in a Dataview's info panel).
Some of the actions mentioned in the chart above can be performed on multiple Dataviews at once.
Select multiple Dataviews, then use either the context menu, or the bar that appears at the bottom of the page, to perform
operations on the selected Dataviews. The context menu shows the number of Dataviews 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.
![Dataviews table batch operations](../../img/webapp_dataview_table_batch_operations.png)
## Viewing, adding, and editing Dataviews
**To view, add, or edit a Dataview:**

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 188 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 201 KiB

View File

@ -116,12 +116,12 @@ Once a filter is applied to a column, its filter icon will appear with a highlig
* Column resizing - In the column heading, drag to a new size.
* Column autofit - In the column heading, double click a column separator.
## ClearML actions from the experiments table
## Experiment actions
The following table describes the **ClearML** features that can be used from the experiments table, including the [states](../fundamentals/task.md#task-states-and-state-transitions)
that allow each feature.
The following table describes the actions that can be done from the experiments table, including the [states](../fundamentals/task.md#task-states-and-state-transitions)
that allow each operation.
| ClearML Action | Description | States Valid for the Action | State Transition |
| Action | Description | States Valid for the Action | State Transition |
|---|---|---|---|
| View details | View experiment details in the experiments table, the [info panel](webapp_exp_track_visual#info-panel) (keep the experiments table in view), or the [full screen details view](webapp_exp_track_visual#full-screen-details-view). | Any state | None |
| Manage a 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) page. | *Enqueued* | None |
@ -137,6 +137,19 @@ that allow each feature.
| 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* |
| Move | Move an experiment to another project. | Any state | None |
These actions can be accessed with the context menu (when right-clicking an experiment or clicking the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
in an experiment's info panel).
Most of the actions mentioned in the chart above can be performed on multiple experiments at once.
Select 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.
![Experiment table batch operations](../img/webapp_exp_table_batch_operations.png)
## Creating an experiment leaderboard

View File

@ -51,10 +51,10 @@ If a project has sub-projects, the models can be viewed by their sub-project gro
all the models in the project. The customizations of these two views are saved separately.
:::
## ClearML Actions from the models table
## Model actions
The following table describes the **ClearML** features that can be used from the models table, including the states that
allow each feature. Model states are *Draft* (editable) and *Published* (read-only).
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 |
|---|---|--|
@ -65,6 +65,16 @@ allow each feature. Model states are *Draft* (editable) and *Published* (read-on
| 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 |
These actions can be accessed with the context menu (when right-clicking a model or clicking the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
in a model's info panel).
Some of the 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](../img/webapp_models_table_batch_operations.png)
## Tagging models
Tags are user-defined, color-coded labels that can be added to models (and experiments), allowing to easily identify and