diff --git a/docs/hyperdatasets/dataviews.md b/docs/hyperdatasets/dataviews.md index 2d2d7599..ec1db875 100644 --- a/docs/hyperdatasets/dataviews.md +++ b/docs/hyperdatasets/dataviews.md @@ -18,6 +18,12 @@ Dataviews are lazy and optimize processing. When an experiment script runs in a are initialized. If the experiment is cloned or extended, and that newly cloned or extended experiment is tuned and run, only changed pointers are initialized. The pointers that did not change are reused. +## Dataview State +Dataviews can be in either *Draft* or *Published* state. + +A *Draft* Dataview is editable. A *Published* Dataview is read-only, which ensures reproducible experiments and +preserves the Dataview's settings. + ## Filtering A Dataview filters experiment input data, using one or more frame filters. A frame filter defines the criteria for the diff --git a/docs/hyperdatasets/webapp/webapp_datasets_versioning.md b/docs/hyperdatasets/webapp/webapp_datasets_versioning.md index 5dccfaa0..58dd876d 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets_versioning.md +++ b/docs/hyperdatasets/webapp/webapp_datasets_versioning.md @@ -244,10 +244,10 @@ Use the **Grouping** menu to select one of the following options: #### Preview Source When using multi-source FrameGroups, users can choose which of the FrameGroups’ sources will be displayed as the preview. -Use the **PREVIEW SOURCE** menu to select from the list of sources. +Select a source from the **PREVIEW SOURCE** menu. Choose the `Default preview source` option to present the first available source. -:::note -If a FrameGroup doesn't have the selected preview source, the next available source will be used for the preview. +:::note Unavailable Source +If a FrameGroup doesn't have the selected preview source, the preview displays the "Source not available" message. ::: diff --git a/docs/hyperdatasets/webapp/webapp_dataviews.md b/docs/hyperdatasets/webapp/webapp_dataviews.md index 4878b17c..0c307d03 100644 --- a/docs/hyperdatasets/webapp/webapp_dataviews.md +++ b/docs/hyperdatasets/webapp/webapp_dataviews.md @@ -6,16 +6,17 @@ title: The Dataviews Table as well as the **DATAVIEWS** tab in the **All Projects** page. The **Dataviews table** is a [customizable](#customizing-the-dataviews-table) list of Dataviews associated with a project. -Use it to [view, create, and edit Dataviews](#viewing-adding-and-editing-dataviews) in the info panel. Dataview tables +Use it to view, create, and edit Dataviews in the info panel. Dataview tables can be filtered by name or name fragments and / or ID, by using the search bar. -![Dataviews table](../../img/hyperdatasets/dataviews_table_01.png) +![Dataviews table](../../img/hyperdatasets/webapp_dataviews_table.png) The Dataviews table columns in their default order are below. Dynamically order the columns by dragging a column heading to a new position. * **DATAVIEW** - Dataview name. -* **USER** - User creating the Dataview. +* **USER** - User who created the Dataview. +* **Status** - The status of the Dataview, which can be *Draft* (editable) or *Published* (read-only). * **CREATED** - Elapsed time since the Dataview was created. * **DESCRIPTION** @@ -24,12 +25,12 @@ to a new position. The Dataviews table can be customized. Changes are persistent (cached in the browser), and represented in the URL. Save customized settings in a browser bookmark, and share the URL with teammates. -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. -* Filter by user +* 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. +* Filter by user and / or status * Sort columns - By experiment name and / or elapsed time since creation. -* Column autofit - In the column heading, double click a resizer (column separator). :::note The following Dataviews-table customizations are saved on a **per project** basis: @@ -48,11 +49,13 @@ all the Dataviews in the project. The customizations of these two views are save 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. | +| 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. | +| 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).| These actions can be accessed with the context menu (when right-clicking a Dataview or clicking the menu button Menu @@ -64,68 +67,11 @@ Select multiple Dataviews, then use either the context menu, or the bar that app 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) +![Dataviews table batch operations](../../img/hyperdatasets/webapp_dataviews_context_menu.png) +## Creating a Dataview -## Viewing, Adding, and Editing Dataviews - -**To view, add, or edit a Dataview:** - -1. Do one of the following: - - * Create a new Dataview - Click **+ NEW DATAVIEW**. - * View or edit a Dataview - In the Dataview table, click the Dataview. - -1. To edit sections of the Dataview, follow the steps on the "Modifying Dataviews" page for the following: - - 1. [Selecting Dataset versions](webapp_exp_modifying.md#selecting-dataset-versions) - 1. [Filtering frames](webapp_exp_modifying.md#filtering-frames) - 1. [Mapping labels (label translation)](webapp_exp_modifying.md#mapping-labels-label-translation) (if appropriate for - the data and experiment) - 1. [Label enumeration](webapp_exp_modifying.md#label-enumeration) - 1. [Data augmentation](webapp_exp_modifying.md#data-augmentation) (if appropriate for the data - and experiment) - 1. [Iteration controls](webapp_exp_modifying.md#iteration-controls) - -## Cloning Dataviews - -Create an exact editable copy of a Dataview. For example, when tuning an experiment, clone a Dataview to apply the same -frame filters to different Dataset versions. - -**To clone a Dataview:** - -1. Do one of the following: - - * In the Dataview table, right click a Dataview and then click **Clone**. - * If the info panel is opened, click Menu - (menu) and then click **Clone**. - -1. Select a project or accept the current project, enter a name, and optionally enter a description - -1. Click **CLONE**. - -## Archiving Dataviews - -Archive Dataviews to more easily manage current work. Archived Dataviews do not appear on the active Dataviews table. -They only appear in the archive. After archiving, the Dataview can be restored from the archive later. - -**To archive a Dataview:** - -* In the Dataview table: - * Archive one Dataview - Right click the Dataview **>** **Archive**. - * Archive multiple Dataviews - Select the Dataview checkboxes **>** In the footer menu that appears at the bottom of - the page, click **ARCHIVE**. -* In the Dataview info panel - Click Menu - (menu) **>** **ARCHIVE**. - -**To restore a Dataview:** - -1. Go to the Dataview table of the archived Dataview or of the **All Projects** page -1. Click **OPEN ARCHIVE** -1. Do any of the following: - * In the Dataview table: - * Restore one Dataview - Right click the Dataview **>** **Restore**. - * Restore multiple Dataviews - Select the Dataview checkboxes **>** **Restore**. - * In the info panel, restore one Dataview - Click Menu - (menu) **>** **Restore**. +Create a new Dataview by clicking the **+ NEW DATAVIEW** button at the top right of the table, which open a +**NEW DATAVIEW** window. +![New Dataview window](../../img/webapp_dataview_new.png) \ No newline at end of file diff --git a/docs/hyperdatasets/webapp/webapp_exp_track_visual.md b/docs/hyperdatasets/webapp/webapp_exp_track_visual.md index 2593290a..0e1d480e 100644 --- a/docs/hyperdatasets/webapp/webapp_exp_track_visual.md +++ b/docs/hyperdatasets/webapp/webapp_exp_track_visual.md @@ -1,5 +1,5 @@ --- -title: Viewing Experiments +title: Experiment Dataviews --- While an experiment is running, and any time after it finishes, results are tracked and can be visualized in the ClearML @@ -11,7 +11,7 @@ experiment, which can be viewed and [modified](webapp_exp_modifying.md) in the W ## Viewing an Experiment's Dataviews In an experiment's page, go to the **DATAVIEWS** tab to view all the experiment's Dataview details, including: -* Input data [selection](#dataset-versions) and [filtering](#filtering) +* Input data [selection](#input) and [filtering](#filtering) * ROI [mapping](#mapping) (label translation) * [Label enumeration](#label-enumeration) * On-the-fly [data augmentation](#augmentation) diff --git a/docs/img/hyperdatasets/webapp_dataviews_context_menu.png b/docs/img/hyperdatasets/webapp_dataviews_context_menu.png new file mode 100644 index 00000000..69e7198a Binary files /dev/null and b/docs/img/hyperdatasets/webapp_dataviews_context_menu.png differ diff --git a/docs/img/hyperdatasets/webapp_dataviews_table.png b/docs/img/hyperdatasets/webapp_dataviews_table.png new file mode 100644 index 00000000..1a8a6f0a Binary files /dev/null and b/docs/img/hyperdatasets/webapp_dataviews_table.png differ diff --git a/docs/img/settings_configuration_creation.png b/docs/img/settings_configuration_creation.png index 443d0e5b..a32c8dbd 100644 Binary files a/docs/img/settings_configuration_creation.png and b/docs/img/settings_configuration_creation.png differ diff --git a/docs/img/settings_workspace_configuration.png b/docs/img/settings_workspace_configuration.png index fd89b919..d2518611 100644 Binary files a/docs/img/settings_workspace_configuration.png and b/docs/img/settings_workspace_configuration.png differ diff --git a/docs/img/webapp_dataview_new.png b/docs/img/webapp_dataview_new.png new file mode 100644 index 00000000..9b86e1cb Binary files /dev/null and b/docs/img/webapp_dataview_new.png differ diff --git a/docs/img/webapp_model_config_actions.png b/docs/img/webapp_model_config_actions.png new file mode 100644 index 00000000..1ea67f11 Binary files /dev/null and b/docs/img/webapp_model_config_actions.png differ diff --git a/docs/img/webapp_model_general.png b/docs/img/webapp_model_general.png new file mode 100644 index 00000000..9bc96c4e Binary files /dev/null and b/docs/img/webapp_model_general.png differ diff --git a/docs/img/webapp_model_labels.png b/docs/img/webapp_model_labels.png new file mode 100644 index 00000000..44ff9932 Binary files /dev/null and b/docs/img/webapp_model_labels.png differ diff --git a/docs/img/webapp_model_labels_edit.png b/docs/img/webapp_model_labels_edit.png new file mode 100644 index 00000000..c76f8147 Binary files /dev/null and b/docs/img/webapp_model_labels_edit.png differ diff --git a/docs/img/webapp_model_metadata.png b/docs/img/webapp_model_metadata.png new file mode 100644 index 00000000..bdb74d33 Binary files /dev/null and b/docs/img/webapp_model_metadata.png differ diff --git a/docs/img/webapp_model_metadata_edit.png b/docs/img/webapp_model_metadata_edit.png new file mode 100644 index 00000000..5bbde21a Binary files /dev/null and b/docs/img/webapp_model_metadata_edit.png differ diff --git a/docs/img/webapp_model_network.png b/docs/img/webapp_model_network.png new file mode 100644 index 00000000..298099f3 Binary files /dev/null and b/docs/img/webapp_model_network.png differ diff --git a/docs/img/webapp_models_02.png b/docs/img/webapp_models_02.png deleted file mode 100644 index 302446bd..00000000 Binary files a/docs/img/webapp_models_02.png and /dev/null differ diff --git a/docs/img/webapp_models_04.png b/docs/img/webapp_models_04.png deleted file mode 100644 index 203bf752..00000000 Binary files a/docs/img/webapp_models_04.png and /dev/null differ diff --git a/docs/img/webapp_models_05.png b/docs/img/webapp_models_05.png deleted file mode 100644 index c807ffa1..00000000 Binary files a/docs/img/webapp_models_05.png and /dev/null differ diff --git a/docs/img/webapp_workers_queues_context.png b/docs/img/webapp_workers_queues_context.png new file mode 100644 index 00000000..4d5b1773 Binary files /dev/null and b/docs/img/webapp_workers_queues_context.png differ diff --git a/docs/img/workers_queues_experiment_actions.png b/docs/img/workers_queues_experiment_actions.png new file mode 100644 index 00000000..de1db069 Binary files /dev/null and b/docs/img/workers_queues_experiment_actions.png differ diff --git a/docs/webapp/webapp_exp_comparing.md b/docs/webapp/webapp_exp_comparing.md index 46d9ccaa..c036b297 100644 --- a/docs/webapp/webapp_exp_comparing.md +++ b/docs/webapp/webapp_exp_comparing.md @@ -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 Download. +* Download the file Download. * 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 Download. + * Download the file - Click Download. * 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. diff --git a/docs/webapp/webapp_exp_table.md b/docs/webapp/webapp_exp_table.md index 7e74c49a..3eb35f6c 100644 --- a/docs/webapp/webapp_exp_table.md +++ b/docs/webapp/webapp_exp_table.md @@ -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 Setting Gear + **>** 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 Setting Gear **>** 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* | diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index 40a3dd7b..f614bacf 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -445,7 +445,8 @@ These controls allow you to better analyze the results. Hover over a plot, and t | Compare data icon | Compare data on hover. Click Compare data icon and then hover over the plot. | | Logarithmic view icon | Switch to logarithmic view. | | Graph legend icon | Hide / show the legend. | -| Download JSON icon | To get metric data for further analysis, download plot data to JSON file. | +| Download JSON icon | Download plot data as a JSON file. | +| Download CSV icon | Download plot data as a CSV file. | | Maximize plot icon | 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 | | Refresh | Refresh scalar graphs in full screen mode to update it | diff --git a/docs/webapp/webapp_model_modifying.md b/docs/webapp/webapp_model_modifying.md deleted file mode 100644 index f8be3286..00000000 --- a/docs/webapp/webapp_model_modifying.md +++ /dev/null @@ -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 Trash (delete) **>** **SAVE**. - -![image](../img/webapp_models_04a.png) diff --git a/docs/webapp/webapp_model_table.md b/docs/webapp/webapp_model_table.md index 1e40f2ef..18e9e53b 100644 --- a/docs/webapp/webapp_model_table.md +++ b/docs/webapp/webapp_model_table.md @@ -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 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). +* 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 Setting Gear + **>** 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 | diff --git a/docs/webapp/webapp_model_viewing.md b/docs/webapp/webapp_model_viewing.md index ef1bc5a3..d3cec0d4 100644 --- a/docs/webapp/webapp_model_viewing.md +++ b/docs/webapp/webapp_model_viewing.md @@ -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) + +* Magnifying glass Search +* Copy Copy configuration +* TrashCLEAR (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) \ No newline at end of file +![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) \ No newline at end of file diff --git a/docs/webapp/webapp_profile.md b/docs/webapp/webapp_profile.md index e541b350..29879545 100644 --- a/docs/webapp/webapp_profile.md +++ b/docs/webapp/webapp_profile.md @@ -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**. diff --git a/docs/webapp/webapp_workers_queues.md b/docs/webapp/webapp_workers_queues.md index 50f60eb3..b9b28582 100644 --- a/docs/webapp/webapp_workers_queues.md +++ b/docs/webapp/webapp_workers_queues.md @@ -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 Menu button - (menu) and then select **Move to top** or **Move to bottom**. - * Move to a new queue - Click Menu button (menu) **>** **Move to queue...** **>** Select a queue **>** **ENQUEUE**. - * Remove an experiment - Click Menu button (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 Menu button + 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 diff --git a/sidebars.js b/sidebars.js index 3d218907..b43f46ab 100644 --- a/sidebars.js +++ b/sidebars.js @@ -32,7 +32,7 @@ module.exports = { 'webapp/webapp_exp_comparing', 'webapp/webapp_exp_sharing'] }, { - 'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing', 'webapp/webapp_model_modifying'] + 'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing'] }, 'webapp/webapp_archiving' ] @@ -158,19 +158,20 @@ module.exports = { 'hyperdatasets/dataviews', 'hyperdatasets/task', {'WebApp': [ - {'Dataviews': [ - 'hyperdatasets/webapp/webapp_dataviews', - 'hyperdatasets/webapp/webapp_exp_modifying', - 'hyperdatasets/webapp/webapp_exp_track_visual', - 'hyperdatasets/webapp/webapp_exp_comparing', - ]}, - {'Datasets': [ - 'hyperdatasets/webapp/webapp_datasets', - 'hyperdatasets/webapp/webapp_datasets_versioning', - 'hyperdatasets/webapp/webapp_datasets_frames' - ]}, - 'hyperdatasets/webapp/webapp_annotator' - ]} + {'Projects': [ + 'hyperdatasets/webapp/webapp_dataviews', 'hyperdatasets/webapp/webapp_exp_track_visual', + 'hyperdatasets/webapp/webapp_exp_modifying', 'hyperdatasets/webapp/webapp_exp_comparing', + ] + }, + {'Datasets': [ + 'hyperdatasets/webapp/webapp_datasets', + 'hyperdatasets/webapp/webapp_datasets_versioning', + 'hyperdatasets/webapp/webapp_datasets_frames' + ] + }, + 'hyperdatasets/webapp/webapp_annotator' + ] + } ], sdkHyperDataset: [ {'HyperDataset': ['references/hyperdataset/hyperdataset', 'references/hyperdataset/hyperdatasetversion']}, diff --git a/static/icons/ico-download-csv.svg b/static/icons/ico-download-csv.svg new file mode 100644 index 00000000..ec46a750 --- /dev/null +++ b/static/icons/ico-download-csv.svg @@ -0,0 +1,3 @@ + + + diff --git a/static/icons/ico-download-json-plot.svg b/static/icons/ico-download-json-plot.svg new file mode 100644 index 00000000..99bc328f --- /dev/null +++ b/static/icons/ico-download-json-plot.svg @@ -0,0 +1,3 @@ + + +