ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-02-07 13:21:46 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Edit experiment and dataview comparison pages (#545)

Browse Source
This commit is contained in:
pollfly 2023-05-02 15:35:03 +03:00 committed by GitHub
parent 931791aae6
commit 30c36c6999
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/hyperdatasets/webapp/webapp_dataviews.md
View File

@ -71,14 +71,14 @@ Access these actions with the context menu in any of the following ways:
| Archive | To more easily work with active Dataviews, move a Dataview to the archive, removing it from the active Dataview table. |
| Restore | Action available in the archive. Restore a Dataview to the active Dataviews table. |
| Clone | Make an exact copy of a Dataview that is editable. |
| Move to Project | To organize work and improve collaboration, move a Dataview to another project. |
| Move to Project | Move a Dataview to another project. |
| Publish | Publish a Dataview to prevent changes to it. *Published* Dataviews are read-only.|
| Custom action | When available, provides a mechanism to define your own custom action which will appear in the context menu. See [Custom UI Context Menu Actions](../../deploying_clearml/clearml_server_config.md#custom-ui-context-menu-actions).|
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
Select multiple Dataviews, then use either the context menu, or the batch action 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.
The same information can be found in the batch action bar, in a tooltip that appears when hovering over an action icon.
![Dataviews table batch operations](../../img/hyperdatasets/webapp_dataviews_context_menu.png)

11
docs/webapp/webapp_exp_comparing.md
View File

@ -27,12 +27,13 @@ The ClearML experiment comparison provides [comparison features](#comparison-fea
## Selecting Experiments to Compare
**To select experiments to compare:**
1. Go to an experiments table, which includes the experiments to be compared.
1. Select the experiments to compare, select the checkboxes individually or select the top checkbox for all experiments. After selecting the second checkbox, a bottom bar appears.
1. In the bottom bar, click **COMPARE**. The comparison page appears, showing a column for each experiment and differences with a highlighted background color. The experiment on the left is the base experiment. Other experiments compare to the base experiment.
To select experiments to compare:
1. Go to an experiments table that includes the experiments to be compared.
1. Select the experiments to compare. Once multiple experiments are selected, the batch action bar appears.
1. In the batch action bar, click **COMPARE**.
The comparison page opens in the **DETAILS** tab, showing a column for each experiment. The experiment on the left is
used as the base experiment, to which the other experiments are compared.
## Details

10
docs/webapp/webapp_exp_table.md
View File

@ -131,9 +131,11 @@ in the top right corner of the table.
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.
Access these actions with the context menu in any of the following ways:
Access these actions in any of the following ways:
* 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" />
to open the context menu
* 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" />
* Through the batch action bar: available at screen bottom when multiple experiments are selected
| Action | Description | States Valid for the Action | State Transition |
|---|---|---|---|
@ -153,13 +155,15 @@ Access these actions with the context menu in any of the following ways:
| 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 |
| 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 to Project | Move an experiment to another project. | Any state | None |
| Compare | Compare selected experiments (see [Comparing Experiments](webapp_exp_comparing.md)) | Any state | None |
| 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 |
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
[Select multiple experiments](#selecting-multiple-experiments), then use either the context menu, or the batch action 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
of experiments that can be affected by each action. The same information can be found in the batch action bar, in a tooltip that
appears when hovering over an action icon.
![Experiment table batch operations](../img/webapp_experiment_table_context_menu.png)