ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation (#193)

Browse Source
This commit is contained in:
pollfly
2022-03-06 13:00:46 +02:00
committed by GitHub
parent 6633ed6ce6
commit 1871e3da9a
32 changed files with 171 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/webapp/webapp_exp_comparing.md
View File

@@ -191,7 +191,7 @@ Compare debug samples at any iteration to verify that an experiment is running a
first. Use the viewer / player to inspect images, audio, video samples and do any of the following:
* Move to the same sample in a different iteration (move the iteration slider).
* Show the next or previous iteration's sample.
* Download the file <img src="/docs/latest/icons/ico-download-json.svg" alt="Download" className="icon size-md space-sm" />.
* Download the file <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />.
* Zoom.
* View the sample's iteration number, width, height, and coordinates.
@@ -220,7 +220,7 @@ first. Use the viewer / player to inspect images, audio, video samples and do an
1. Do any of the following:
* Move to the same sample in another iteration - Move the slider, or click **<** (previous) or **>** (next).
* Download the file - Click <img src="/docs/latest/icons/ico-download-json.svg" alt="Download" className="icon size-md space-sm" />.
* Download the file - Click <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />.
* Zoom
* For images, locate a position on the sample - Hover over the sample and the X, Y coordinates appear in the legend below the sample.

28
docs/webapp/webapp_exp_table.md
View File

@@ -38,11 +38,18 @@ The experiments table default and customizable columns are described in the foll
## Customizing the Experiments Table
The experiments table can be customized by:
* Showing / hiding default columns
* Adding metrics and hyperparameters
* Sorting
* Filtering
Customize the table using any of the following:
* Dynamic column order - Drag a column title to a different position.
* Resize columns - Drag the column separator to change the width of that column. Double click the column separator for
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.
* Add custom columns - Click **+ METRICS** or **+ HYPER PARAMETERS** to add metric / hyperparameter columns to the
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.
Use experiments table customization for various use cases, including:
@@ -114,16 +121,6 @@ in the top right corner of the table.
### Using Other Customization Features
**To use other customization features:**
* 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.
* Sort columns - According to metrics and hyperparameters, type of experiment, experiment name, start and last update elapsed time, and last iteration.
* Dynamic column ordering - Drag a column title to a different position.
* Column resizing - In the column heading, drag to a new size.
* Column autofit - In the column heading, double click a column separator.
## Experiment Actions
The following table describes the actions that can be done from the experiments table, including the [states](../fundamentals/task.md#task-states)
@@ -136,6 +133,7 @@ that allow each operation.
| View a worker | If an experiment is *Running*, view resource utilization, worker details, and queues to which a worker is listening. | *Running* | None |
| 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 |
| Restore |Action available in the archive. Restore a Dataview to the active Dataviews table.| Any State | None |
| 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* |

3
docs/webapp/webapp_exp_track_visual.md
View File

@@ -445,7 +445,8 @@ These controls allow you to better analyze the results. Hover over a plot, and t
| <img src="/docs/latest/icons/ico-compare-data.svg" alt="Compare data icon" className="icon size-sm space-sm" /> | Compare data on hover. Click <img src="/docs/latest/icons/ico-compare-data.svg" alt="Compare data icon" className="icon size-sm space-sm" /> and then hover over the plot. |
| <img src="/docs/latest/icons/ico-logarithmic-view.svg" alt="Logarithmic view icon" className="icon size-sm space-sm" /> | Switch to logarithmic view. |
| <img src="/docs/latest/icons/ico-ico-graph-legend.svg" alt="Graph legend icon" className="icon size-sm space-sm" /> | Hide / show the legend. |
| <img src="/docs/latest/icons/ico-download-json.svg" alt="Download JSON icon" className="icon size-sm space-sm" /> | To get metric data for further analysis, download plot data to JSON file. |
| <img src="/docs/latest/icons/ico-download-json-plot.svg" alt="Download JSON icon" className="icon size-sm space-sm" /> | Download plot data as a JSON file. |
| <img src="/docs/latest/icons/ico-download-csv.svg" alt="Download CSV icon" className="icon size-sm space-sm" /> | Download plot data as a CSV file. |
| <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" /> | Expand plot to entire window. When used with scalar graphs, full screen mode displays plots with all data points, as opposed to an averaged plot |
| <img src="/docs/latest/icons/ico-reset.svg" alt="Refresh" className="icon size-sm space-sm" /> | Refresh scalar graphs in full screen mode to update it |

25
docs/webapp/webapp_model_modifying.md
View File

@@ -1,25 +0,0 @@
---
title: Modifying Models
---
In the models table, modify models that have a status of *Draft* (status *Published* is read-only). Modify the model
configuration and label enumeration.
## Model Configuration
**To edit the model configuration:**
* In the **MODELS** tab, click a model **>** **NETWORK** **>** Hover over **MODEL CONFIGURATION** **>** **CLEAR**
(to delete the design) or **EDIT** **>** If editing, an editor textbox appears **>** edit **>** **OK**.
![image](../img/webapp_models_05a.png)
### Label Enumeration
For each class, label enumeration contains the class name (key) and value.
**To add, change, or delete label enumeration classes:**
* In the **MODELS** tab, click a model **>** **LABELS** **>** Hover over **LABELS** **>** **EDIT** **>** **+**, edit a
key or value, or <img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-sm space-sm" /> (delete) **>** **SAVE**.
![image](../img/webapp_models_04a.png)

42
docs/webapp/webapp_model_table.md
View File

@@ -13,31 +13,36 @@ 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) |
| **FRAMEWORK** | The model framework. The list includes all frameworks, including custom frameworks. | String |
| **NAME** | Model name. | String |
| **TAGS** | User-defined labels added to models for grouping and organization. | Tag |
| **STATUS** | The status of the model, which can be *Draft* (editable) or *Published* (read-only). | String |
| **PROJECT** | The project with which the model is associated.| String |
| **USER** | The user who ran the experiment that created the model, or the user who imported the model.| String |
| **TASK** | The experiment (Task) name that created the model. | String |
| **UPDATED** | Elapsed time since the model was updated. Hover over the elapsed time to view the date and time.| Date-time |
| **DESCRIPTION** | The model description (not shown by default). | String |
| *Metadata*| User defined metadata key column. Available options depend upon the models in the table. | String |
## 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.
can be saved in a browser bookmark and shared with other ClearML users to collaborate.
Customize any combination of the following:
Customize the table using any of the following:
* Dynamic column ordering - Drag a column title to a different position.
* 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.
* 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).
* Dynamic column order - Drag a column title to a different position.
* Resize columns - Drag the column separator to change the width of that column. Double click the column separator for
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.
* Add custom columns - Click **+ ADD CUSTOM METADATA COLUMN** to add metadata columns to the main column list. Added
columns are by default displayed in the table. You can remove the metadata columns from the main column list or the
column addition window.
* Filter columns - By ML framework, tags, user
* Sort columns - By metadata, ML framework, description, and last update elapsed time.
:::note
The following models-table customizations are saved on a **per project** basis:
@@ -61,6 +66,7 @@ allow each feature. Model states are *Draft* (editable) and *Published* (read-on
| 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.md). | Any state |
| Restore | Action available in the archive. Restore a Dataview to the active Dataviews table. | 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 |

61
docs/webapp/webapp_model_viewing.md
View File

@@ -1,27 +1,64 @@
---
title: Viewing Model Details
title: Model Details
---
In the models table, click on a model to view its general information, configuration, and label enumeration.
In the models table, click on a model to view and / or modify the following:
* General model information
* Model configuration
* Model label enumeration
* Model metadata
Models in *Draft* status are editable, so you can modify their configuration, label enumeration, and metadata.
*Published* models are read-only, so only their metadata can be modified.
## General Model Information
General information includes:
The **GENERAL** tab lists the model's General information including:
* Model URL
* Model checkpoints (snapshots)
* Framework
* Creating experiment (experiment that stored the model in the **ClearML Server**)
* ML Framework
* Creating experiment (ClearML experiment that generated the model)
* Description (click to edit)
If a model is a local file, it is downloadable. If a model is in another type of storage location, the URL can be copied to the clipboard.
If the model is stored in a network location, it can be downloaded by clicking the model URL. If the model was stored on
the local machine you can copy its URL to manually access it.
![Model general information](../img/webapp_model_general.png)
![image](../img/webapp_models_02.png)
## Model Configuration
![image](../img/webapp_models_05.png)
The **NETWORK** tab displays the model's configuration.
![Model network](../img/webapp_model_network.png)
Hover over the model configuration area to access the following actions:
![Model config actions](../img/webapp_model_config_actions.png)
* <img src="/docs/latest/icons/ico-search.svg" alt="Magnifying glass" className="icon size-sm space-sm" /> Search
* <img src="/docs/latest/icons/ico-copy-to-clipboard.svg" alt="Copy" className="icon size-sm space-sm" /> Copy configuration
* <img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-sm space-sm" />CLEAR (for Draft models) - Delete the configuration
* EDIT (for Draft models) - Modify / Add model configuration
## Label Enumeration
For each class, label enumeration contains the class name (key) and value.
The **Label Enumeration** tab displays for each class label (“Label”) its name and enumerated value (“ID”).
![image](../img/webapp_models_04.png)
![Model label enumeration](../img/webapp_model_labels.png)
To modify / add / delete class labels (for Draft models), hover over the label table, then click EDIT. This opens the
label editing window.
![Model label editing](../img/webapp_model_labels_edit.png)
## Metadata
The **METADATA** tab lists the model's metadata entries, which consist of a key, type, and value.
![Model metadata](../img/webapp_model_metadata.png)
To modify / add / delete model metadata items, hover over Metadata, then click EDIT. This opens the Metadata editing
window.
![Model metadata editing](../img/webapp_model_metadata_edit.png)

14
docs/webapp/webapp_profile.md
View File

@@ -60,7 +60,7 @@ In the **Web App Cloud Access** section, enter the following credentials:
Multiple workspaces is only available on the ClearML Hosted Service
:::
ClearML Hosted Service users can be member of multiple workspaces, which are listed under **WORKSPACES**.
ClearML Hosted Service users can be members of multiple workspaces, which are listed under **WORKSPACE**.
To switch to another workspace, click on the **SWITCH TO WORKSPACE** button next to the name of the workspace you want
to switch to.
@@ -76,10 +76,14 @@ You can create credentials for any workspace that you are a member of.
**To create ClearML credentials:**
1. In **WORKSPACES**, expand the desired workspace's panel (self-deployed ClearML Server users have one workspace)
1. In **WORKSPACE**, expand the desired workspace's panel (self-deployed ClearML Server users have one workspace)
1. In **App Credentials**, click **+ Create new credentials**. A dialog pops up with the new credentials formatted as a
ready-to-copy configuration file section (including server configuration information)
1. In **App Credentials**, click **+ Create new credentials**
1. In the dialog that pops up, you can input a label for the new credentials
The dialog displays new credentials, formatted as a ready-to-copy configuration file section (including server configuration
information).
![ClearML credentials](../img/settings_configuration_creation.png)
@@ -110,7 +114,7 @@ in that workspace. You can rejoin the workspace only if you are re-invited.
**To leave a workspace:**
1. In **WORKSPACES**, expand the desired workspace's panel
1. In **WORKSPACE**, expand the desired workspace's panel
1. In **Members** **>** Click **LEAVE WORKSPACE**.

33
docs/webapp/webapp_workers_queues.md
View File

@@ -66,17 +66,26 @@ Optimize worker use by monitoring worker utilization in the **Workers** tab.
## Queue Management
In the **Queues** tab, do any of the following:
The **Queues** tab lets you manage your queues and their contents:
* Create a queue - Click **+ NEW QUEUE** (top right) **>** Type a queue name **>** **CREATE**.
* Do any of the following by right-clicking a queue in the queues list (lower right):
* Delete a queue - Click **Delete**.
* Rename a queue - Click **RENAME** > Type a queue name **>** **RENAME**, or click **DELETE**.
* Create a queue - Click **+ NEW QUEUE** (top right)
* Right-click on a queue in the queues list to modify the queue:
![Queue context menu](../img/webapp_workers_queues_context.png)
* Delete - Delete the queue. Any pending tasks will be dequeued.
* Rename - Change the queue’s name
* Clear - Remove all pending tasks from the queue
* 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).
* Do any of the following by right-clicking an experiment in a queue's **EXPERIMENTS** tab (lower right):
* Reorder experiments in a queue - Drag an experiment to a new position in the queue, or click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Menu button" className="icon size-md space-sm" />
(menu) and then select **Move to top** or **Move to bottom**.
* Move to a new queue - Click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Menu button" className="icon size-md space-sm" /> (menu) **>** **Move to queue...** **>** Select a queue **>** **ENQUEUE**.
* Remove an experiment - Click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Menu button" className="icon size-md space-sm" /> (menu) **>** **Move to queue...** **>** Select a queue **>** **ENQUEUE**.
appear in the context menu. See [Custom UI Context Menu Actions](../deploying_clearml/clearml_server_config.md#custom-ui-context-menu-actions)
* Click on a queue to select it and see its task and worker information. Click on a
task’s menu button <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Menu button" className="icon size-md space-sm" />
in the **EXPERIMENTS** tab to reorganize your queue.
![Queue experiment's menu](../img/workers_queues_experiment_actions.png)
* Move a task to the top or bottom of the queue
* Move the task to a different queue
* Dequeue the task
You can also reorder experiments in a queue by dragging an experiment to a new position in the queue