ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-16 03:19:59 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fix icons

Browse Source
This commit is contained in:
allegroai 2021-05-23 23:17:12 +03:00
parent ab83c33b25
commit 83c20f3d54
11 changed files with 406 additions and 406 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
docs/clearml_data.md
View File

@ -80,10 +80,10 @@ Creates a new dataset. <br/>
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|name |Dataset's name| <img src="/icons/ico-optional-no.svg" className="icon size-md center-md" /> | |name |Dataset's name| <img src="/docs/latest/icons/ico-optional-no.svg" className="icon size-md center-md" /> |
|project|Dataset's project| <img src="/icons/ico-optional-no.svg" className="icon size-md center-md" /> | |project|Dataset's project| <img src="/docs/latest/icons/ico-optional-no.svg" className="icon size-md center-md" /> |
|parents|IDs of the dataset's parents. The dataset inherits all of its parents' content. Multiple parents can be entered, but they are merged in the order they were entered| <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |parents|IDs of the dataset's parents. The dataset inherits all of its parents' content. Multiple parents can be entered, but they are merged in the order they were entered| <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|tags |Dataset user tags. The dataset can be labeled, which can be useful for organizing datasets| <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |tags |Dataset user tags. The dataset can be labeled, which can be useful for organizing datasets| <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
:::important :::important
clearml-data works in a stateful mode so once a new dataset is created, the following commands clearml-data works in a stateful mode so once a new dataset is created, the following commands
@ -102,11 +102,11 @@ It's possible to add individual files or complete folders.<br/>
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|id | Dataset's ID. Default: previously created / accessed dataset| <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |id | Dataset's ID. Default: previously created / accessed dataset| <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|files|Files / folders to add. Wildcard selection is supported, for example: `~/data/*.jpg ~/data/json` | <img src="/icons/ico-optional-no.svg" className="icon size-md center-md" /> | |files|Files / folders to add. Wildcard selection is supported, for example: `~/data/*.jpg ~/data/json` | <img src="/docs/latest/icons/ico-optional-no.svg" className="icon size-md center-md" /> |
|dataset-folder | Dataset base folder to add the files to in the dataset. Default: dataset root| <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |dataset-folder | Dataset base folder to add the files to in the dataset. Default: dataset root| <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|non-recursive | Disable recursive scan of files | <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |non-recursive | Disable recursive scan of files | <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|verbose | Verbose reporting | <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |verbose | Verbose reporting | <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -119,10 +119,10 @@ clearml-data remove --id <dataset_id_to_remove_from> --files <filenames/folders_
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|id | Dataset's ID. Default: previously created / accessed dataset| <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |id | Dataset's ID. Default: previously created / accessed dataset| <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|files | Files / folders to remove (wildcard selection is supported, for example: `~/data/*.jpg ~/data/json`). Notice: file path is the path within the dataset, not the local path.| <img src="/icons/ico-optional-no.svg" className="icon size-md center-md" /> | |files | Files / folders to remove (wildcard selection is supported, for example: `~/data/*.jpg ~/data/json`). Notice: file path is the path within the dataset, not the local path.| <img src="/docs/latest/icons/ico-optional-no.svg" className="icon size-md center-md" /> |
|non-recursive | Disable recursive scan of files | <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |non-recursive | Disable recursive scan of files | <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|verbose | Verbose reporting | <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |verbose | Verbose reporting | <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -138,10 +138,10 @@ Once a dataset is finalized, it can no longer be modified.
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|id| Dataset's ID. Default: previously created / accessed dataset| <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |id| Dataset's ID. Default: previously created / accessed dataset| <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|storage| Remote storage to use for the dataset files. Default: files_server | <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |storage| Remote storage to use for the dataset files. Default: files_server | <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|disable-upload | Disable automatic upload when closing the dataset | <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |disable-upload | Disable automatic upload when closing the dataset | <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|verbose | Verbose reporting | <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |verbose | Verbose reporting | <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -157,9 +157,9 @@ medium by entering an upload destination, such as `s3://bucket`, `gs://`, `azure
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|id| Dataset's ID. Default: previously created / accessed dataset| <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |id| Dataset's ID. Default: previously created / accessed dataset| <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|storage| Remote storage to use for the dataset files. Default: files_server | <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |storage| Remote storage to use for the dataset files. Default: files_server | <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|verbose | Verbose reporting | <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |verbose | Verbose reporting | <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -180,15 +180,15 @@ This command also uploads the data and finalizes the dataset automatically.
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|id| Dataset's ID. Default: previously created / accessed dataset| <img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" /> | |id| Dataset's ID. Default: previously created / accessed dataset| <img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" /> |
|folder|Local folder to sync. Wildcard selection is supported, for example: `~/data/*.jpg ~/data/json`|<img src="/icons/ico-optional-no.svg" className="icon size-md center-md" />| |folder|Local folder to sync. Wildcard selection is supported, for example: `~/data/*.jpg ~/data/json`|<img src="/docs/latest/icons/ico-optional-no.svg" className="icon size-md center-md" />|
|storage|Remote storage to use for the dataset files. Default: files_server |<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |storage|Remote storage to use for the dataset files. Default: files_server |<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|parents|IDs of the dataset's parents (i.e. merge all parents). All modifications made to the folder since the parents were synced will be reflected in the dataset|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |parents|IDs of the dataset's parents (i.e. merge all parents). All modifications made to the folder since the parents were synced will be reflected in the dataset|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|project|If creating a new dataset, specify the dataset's project name|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |project|If creating a new dataset, specify the dataset's project name|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|name|If creating a new dataset, specify the dataset's name|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |name|If creating a new dataset, specify the dataset's name|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|tags|Dataset user tags|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |tags|Dataset user tags|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|skip-close|Do not auto close dataset after syncing folders|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |skip-close|Do not auto close dataset after syncing folders|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|verbose | Verbose reporting |<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |verbose | Verbose reporting |<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -201,11 +201,11 @@ clearml-data list [--id <dataset_id>]
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|id|Dataset ID whose contents will be shown (alternatively, use project / name combination). Default: previously accessed dataset|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |id|Dataset ID whose contents will be shown (alternatively, use project / name combination). Default: previously accessed dataset|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|project|Specify dataset project name (if used instead of ID, dataset name is also required)|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |project|Specify dataset project name (if used instead of ID, dataset name is also required)|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|name|Specify dataset name (if used instead of ID, dataset project is also required)|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |name|Specify dataset name (if used instead of ID, dataset project is also required)|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|filter|Filter files based on folder / wildcard. Multiple filters are supported. Example: `folder/date_*.json folder/sub-folder`|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |filter|Filter files based on folder / wildcard. Multiple filters are supported. Example: `folder/date_*.json folder/sub-folder`|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|modified|Only list file changes (add / remove / modify) introduced in this version|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |modified|Only list file changes (add / remove / modify) introduced in this version|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -221,8 +221,8 @@ This does not work on datasets with children.
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|id|ID of dataset to be deleted. Default: previously created / accessed dataset that hasn't been finalized yet|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |id|ID of dataset to be deleted. Default: previously created / accessed dataset that hasn't been finalized yet|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|force|Force dataset deletion even if other dataset versions depend on it|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />|| |force|Force dataset deletion even if other dataset versions depend on it|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />||
<br/> <br/>
@ -238,10 +238,10 @@ Datasets can be searched by project, name, ID, and tags.
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|ids|A list of dataset IDs|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |ids|A list of dataset IDs|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|project|The project name of the datasets|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |project|The project name of the datasets|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|name|A dataset name or a partial name to filter datasets by|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |name|A dataset name or a partial name to filter datasets by|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|tags|A list of dataset user tags|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |tags|A list of dataset user tags|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -259,8 +259,8 @@ Returns a path to dataset in cache, and downloads it if it is not already in cac
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|use_soft_links|If True, use soft links. Default: False on Windows, True on Posix systems|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |use_soft_links|If True, use soft links. Default: False on Windows, True on Posix systems|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|raise_on_error|If True, raise exception if dataset merging failed on any file|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |raise_on_error|If True, raise exception if dataset merging failed on any file|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -273,9 +273,9 @@ its contents with the dataset contents.
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|target_folder|Local target folder for the writable copy of the dataset|<img src="/icons/ico-optional-no.svg" className="icon size-md center-md" />| |target_folder|Local target folder for the writable copy of the dataset|<img src="/docs/latest/icons/ico-optional-no.svg" className="icon size-md center-md" />|
|overwrite|If True, recursively delete the contents of the target folder before creating a copy of the dataset. If False (default) and target folder contains files, raise exception or return None|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |overwrite|If True, recursively delete the contents of the target folder before creating a copy of the dataset. If False (default) and target folder contains files, raise exception or return None|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|raise_on_error|If True, raise exception if dataset merging failed on any file|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |raise_on_error|If True, raise exception if dataset merging failed on any file|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -291,10 +291,10 @@ in the previous parent dataset.
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|dataset_name|Name of the new dataset|<img src="/icons/ico-optional-no.svg" className="icon size-md center-md" />| |dataset_name|Name of the new dataset|<img src="/docs/latest/icons/ico-optional-no.svg" className="icon size-md center-md" />|
|dataset_project|The project containing the dataset. If not specified, infer project name from parent datasets. If there is no parent dataset, then this value is required|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |dataset_project|The project containing the dataset. If not specified, infer project name from parent datasets. If there is no parent dataset, then this value is required|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|parent_datasets|Expand a parent dataset by adding / removing files|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |parent_datasets|Expand a parent dataset by adding / removing files|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|use_current_task|If True, the dataset is created on the current Task. Default: False|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |use_current_task|If True, the dataset is created on the current Task. Default: False|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -306,12 +306,12 @@ Add files or folder into the current dataset.
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|path|Add a folder / file to the dataset|<img src="/icons/ico-optional-no.svg" className="icon size-md center-md" />| |path|Add a folder / file to the dataset|<img src="/docs/latest/icons/ico-optional-no.svg" className="icon size-md center-md" />|
|wildcard|Add only a specific set of files based on wildcard matching. Wildcard matching can be a single string or a list of wildcards, for example: `~/data/*.jpg`, `~/data/json`|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |wildcard|Add only a specific set of files based on wildcard matching. Wildcard matching can be a single string or a list of wildcards, for example: `~/data/*.jpg`, `~/data/json`|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|local_base_folder|Files will be located based on their relative path from local_base_folder|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |local_base_folder|Files will be located based on their relative path from local_base_folder|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|dataset_path|Where in the dataset the folder / files should be located|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |dataset_path|Where in the dataset the folder / files should be located|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|recursive|If True, match all wildcard files recursively|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |recursive|If True, match all wildcard files recursively|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|verbose| If True, print to console files added / modified|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |verbose| If True, print to console files added / modified|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -322,10 +322,10 @@ Start file uploading, the function returns when all files are uploaded.
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|show_progress|If True, show upload progress bar|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |show_progress|If True, show upload progress bar|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|verbose|If True, print verbose progress report|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |verbose|If True, print verbose progress report|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|output_url|Target storage for the compressed dataset (default: file server). Examples: `s3://bucket/data`, `gs://bucket/data` , `azure://bucket/data`, `/mnt/share/data` |<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |output_url|Target storage for the compressed dataset (default: file server). Examples: `s3://bucket/data`, `gs://bucket/data` , `azure://bucket/data`, `/mnt/share/data` |<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|compression|Compression algorithm for the Zipped dataset file (default: ZIP_DEFLATED)|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |compression|Compression algorithm for the Zipped dataset file (default: ZIP_DEFLATED)|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
<br/> <br/>
@ -337,6 +337,6 @@ Before closing a dataset, its files must first be uploaded.
|Name|Description|Optional| |Name|Description|Optional|
|---|---|---| |---|---|---|
|verbose|If True, print verbose progress report|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |verbose|If True, print verbose progress report|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|
|raise_on_error|If True, raise exception if dataset finalizing failed|<img src="/icons/ico-optional-yes.svg" className="icon size-md center-md" />| |raise_on_error|If True, raise exception if dataset finalizing failed|<img src="/docs/latest/icons/ico-optional-yes.svg" className="icon size-md center-md" />|

4
docs/webapp/webapp_archiving.md
View File

@ -17,7 +17,7 @@ When archiving an experiment:
* Archive an experiment or model from either the: * Archive an experiment or model from either the:
* Experiments or models table - Right click the experiment or model **>** **Archive**. * Experiments or models table - Right click the experiment or model **>** **Archive**.
* Info panel or full screen details view - Click <img src="/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (menu) **>** **Archive**. * Info panel or full screen details view - Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (menu) **>** **Archive**.
* Archive multiple experiments or models from the: * Archive multiple experiments or models from the:
@ -34,7 +34,7 @@ When archiving an experiment:
* Restore an experiment or model from either the: * Restore an experiment or model from either the:
* Experiments or models table - Right click the experiment or model **>** **Restore**. * Experiments or models table - Right click the experiment or model **>** **Restore**.
* Info panel or full screen details view - Click <img src="/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> * Info panel or full screen details view - Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" />
(menu) **>** **Restore from archive**. (menu) **>** **Restore from archive**.
* Restore multiple experiments or models from the: * Restore multiple experiments or models from the:

26
docs/webapp/webapp_exp_comparing.md
View File

@ -57,8 +57,8 @@ sorted by sections.
### To locate the source differences: ### To locate the source differences:
* Click the **DETAILS** tab **>** Expand highlighted sections, or, in the header, click <img src="/icons/ico-previous-diff.svg" alt="Previous diff" className="icon size-md" /> * Click the **DETAILS** tab **>** Expand highlighted sections, or, in the header, click <img src="/docs/latest/icons/ico-previous-diff.svg" alt="Previous diff" className="icon size-md" />
(Previous diff) or <img src="/icons/ico-next-diff.svg" alt="next difference" className="icon size-md space-sm" /> (Next diff). (Previous diff) or <img src="/docs/latest/icons/ico-next-diff.svg" alt="next difference" className="icon size-md space-sm" /> (Next diff).
For example, in the image below, expanding **ARTIFACTS** **>** **Output Model** **>** **Model** shows that the model ID For example, in the image below, expanding **ARTIFACTS** **>** **Output Model** **>** **Model** shows that the model ID
and name are different. and name are different.
@ -81,8 +81,8 @@ The Values mode is a side-by-side comparison that shows hyperparameter value dif
1. In the dropdown menu (on the upper left, next to **+ Add Experiments**), choose **Values**. 1. In the dropdown menu (on the upper left, next to **+ Add Experiments**), choose **Values**.
1. To show only differences, move the **Hide Identical Fields** slider to on. 1. To show only differences, move the **Hide Identical Fields** slider to on.
1. Locate differences by either: 1. Locate differences by either:
* Clicking <img src="/icons/ico-previous-diff.svg" className="icon size-md space-sm" /> (Previous diff) or * Clicking <img src="/docs/latest/icons/ico-previous-diff.svg" className="icon size-md space-sm" /> (Previous diff) or
<img src="/icons/ico-next-diff.svg" className="icon size-md space-sm" /> (Next diff). <img src="/docs/latest/icons/ico-next-diff.svg" className="icon size-md space-sm" /> (Next diff).
* Scrolling to see highlighted hyperparameters. * Scrolling to see highlighted hyperparameters.
For example, expanding **General** shows that the `batch_size` and `epochs` differ between the experiments. For example, expanding **General** shows that the `batch_size` and `epochs` differ between the experiments.
@ -153,7 +153,7 @@ Compare scalar series in plots and analyze differences using **ClearML Web UI**
* Wall (clock time). * Wall (clock time).
* Smooth a curve - move the **Smoothing** slider or type in a smoothing number from **0** to **0.999**. * Smooth a curve - move the **Smoothing** slider or type in a smoothing number from **0** to **0.999**.
* Use plot controls, which appear when you hover over the top of a plot. * Use plot controls, which appear when you hover over the top of a plot.
* Hide / show scalar plots - Click **Hide all** and <img src="/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />. * Hide / show scalar plots - Click **Hide all** and <img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />.
* Filter scalars by full or partial scalar name. * Filter scalars by full or partial scalar name.
This image shows scalars grouped by metric. This image shows scalars grouped by metric.
@ -176,7 +176,7 @@ in the **PLOTS** tab.
1. Click the **PLOTS** tab. 1. Click the **PLOTS** tab.
1. To improve your comparison, use either of the following: 1. To improve your comparison, use either of the following:
* To locate scalars, click **HIDE ALL**, and then <img src="/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" /> * To locate scalars, click **HIDE ALL**, and then <img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />
(show) to choose which scalars to see. Scalars can also be filtered by full or partial scalar name, using the search bar. (show) to choose which scalars to see. Scalars can also be filtered by full or partial scalar name, using the search bar.
* Use any of the plot controls that appear when hovering over the top of a plot, including: * Use any of the plot controls that appear when hovering over the top of a plot, including:
* Downloading the image * Downloading the image
@ -212,8 +212,8 @@ first. Use the viewer / player to inspect images, audio, video samples and do an
![image](../img/webapp_compare_31.png) ![image](../img/webapp_compare_31.png)
1. To move to the same sample in another iteration, click <img src="/icons/ico-previous.svg" className="icon size-md space-sm" /> 1. To move to the same sample in another iteration, click <img src="/docs/latest/icons/ico-previous.svg" className="icon size-md space-sm" />
(previous), <img src="/icons/ico-next.svg" className="icon size-md space-sm" /> (next), or move the slider. (previous), <img src="/docs/latest/icons/ico-next.svg" className="icon size-md space-sm" /> (next), or move the slider.
**To view a debug sample in the viewer / player:** **To view a debug sample in the viewer / player:**
@ -245,7 +245,7 @@ To assist in experiment analysis, the comparison page supports:
Add an experiment to the comparison - Click **Add Experiment** and start typing an experiment name. An experiment search Add an experiment to the comparison - Click **Add Experiment** and start typing an experiment name. An experiment search
and select dialog appears showing matching experiments to choose from. To add an experiment, click **+**. To Remove and select dialog appears showing matching experiments to choose from. To add an experiment, click **+**. To Remove
an experiment, click <img src="/icons/ico-trash.svg" alt="Trash" className="icon size-md" />. an experiment, click <img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-md" />.
![image](../img/webapp_compare_0194.png) ![image](../img/webapp_compare_0194.png)
@ -253,8 +253,8 @@ an experiment, click <img src="/icons/ico-trash.svg" alt="Trash" className="icon
### Finding the next or previous difference ### Finding the next or previous difference
* Find the previous difference <img src="/icons/ico-previous-diff.svg" className="icon size-md space-sm" />, or * Find the previous difference <img src="/docs/latest/icons/ico-previous-diff.svg" className="icon size-md space-sm" />, or
the next difference <img src="/icons/ico-next-diff.svg" className="icon size-md space-sm" />. the next difference <img src="/docs/latest/icons/ico-next-diff.svg" className="icon size-md space-sm" />.
@ -273,7 +273,7 @@ Search all text in the comparison.
### Choosing a different base experiment ### Choosing a different base experiment
Show differences in other experiments in reference to a new base experiment. To set a new base experiment, do one of the following: Show differences in other experiments in reference to a new base experiment. To set a new base experiment, do one of the following:
* Click on <img src="/icons/ico-switch-base.svg" className="icon size-md space-sm" /> on the top right of the experiment that will be the new base. * Click on <img src="/docs/latest/icons/ico-switch-base.svg" className="icon size-md space-sm" /> on the top right of the experiment that will be the new base.
* Click on <img src="/docs/img/svg/pan.svg" className="icon size-md space-sm" /> the new base experiment and drag it all the way to the left * Click on <img src="/docs/img/svg/pan.svg" className="icon size-md space-sm" /> the new base experiment and drag it all the way to the left
![image](../img/webapp_compare_22.png) ![image](../img/webapp_compare_22.png)
@ -288,7 +288,7 @@ To reorder the experiments being compared, press <img src="/docs/img/svg/pan.svg
![image](../img/webapp_compare_21.png) ![image](../img/webapp_compare_21.png)
### Removing an experiment from the comparison ### Removing an experiment from the comparison
Remove an experiment from the comparison, by pressing <img src="/icons/ico-remove-compare.svg" className="icon size-md space-sm" /> Remove an experiment from the comparison, by pressing <img src="/docs/latest/icons/ico-remove-compare.svg" className="icon size-md space-sm" />
on the top right of the experiment that needs to be removed. on the top right of the experiment that needs to be removed.
![image](../img/webapp_compare_23.png) ![image](../img/webapp_compare_23.png)

6
docs/webapp/webapp_exp_table.md
View File

@ -64,19 +64,19 @@ experiments in the table.
#### To add metrics: #### To add metrics:
* Click <img src="/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> **>** **+ METRICS** **>** Expand a metric **>** Select the **LAST** (value), * Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> **>** **+ METRICS** **>** Expand a metric **>** Select the **LAST** (value),
**MIN** (minimal value), and / or **MAX** (maximal value) checkboxes. **MIN** (minimal value), and / or **MAX** (maximal value) checkboxes.
#### To add hyperparameters: #### To add hyperparameters:
* Click <img src="/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> **>** **+ HYPER PARAMETERS** **>** Expand a section **>** Select the * Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> **>** **+ HYPER PARAMETERS** **>** Expand a section **>** Select the
hyperparameter checkboxes. hyperparameter checkboxes.
### Using other customization features ### Using other customization features
**To use other customization features:** **To use other customization features:**
* Show / hide columns - Click <img src="/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> **>** select or clear the checkboxes of columns to show or hide. * 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 - According to type of experiment, experiment status (state), or user * Filter columns - According to type of experiment, experiment status (state), or user
* Sort columns - According to metrics and hyperparameters, type of experiment, experiment name, start and last update elapsed time, and last iteration. * 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. * Dynamic column ordering - Drag a column title to a different position.

24
docs/webapp/webapp_exp_track_visual.md
View File

@ -22,8 +22,8 @@ The **ClearML Web UI** provides two viewing modes for experiment details:
* Full screen details mode. * Full screen details mode.
Both modes contain all experiment details. When either view is open, switch to the other mode by clicking <img src="/icons/ico-info-min.svg" className="icon size-md space-sm" /> Both modes contain all experiment details. When either view is open, switch to the other mode by clicking <img src="/docs/latest/icons/ico-info-min.svg" className="icon size-md space-sm" />
(**View in experiments table / full screen**), or clicking <img src="/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (**menu**) > **View in experiments (**View in experiments table / full screen**), or clicking <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (**menu**) > **View in experiments
table / full screen**. table / full screen**.
@ -250,8 +250,8 @@ including design, label enumeration, and general information, go to the **MODELS
1. In the **ARTIFACTS** tab **>** **MODELS** **>** **Input Model** or **Output Model**, click the model name hyperlink. 1. In the **ARTIFACTS** tab **>** **MODELS** **>** **Input Model** or **Output Model**, click the model name hyperlink.
1. In the model details **>** **GENERAL** tab **>** **MODEL URL**, either: 1. In the model details **>** **GENERAL** tab **>** **MODEL URL**, either:
* Download the model<img src="/icons/ico-download.svg" className="icon size-md space-sm" />, if it is stored in remote storage. * Download the model<img src="/docs/latest/icons/ico-download.svg" className="icon size-md space-sm" />, if it is stored in remote storage.
* Copy its location to the clipboard <img src="/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md space-sm" />, * Copy its location to the clipboard <img src="/docs/latest/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md space-sm" />,
if it is in a local file. if it is in a local file.
@ -271,8 +271,8 @@ including design, label enumeration, and general information, go to the **MODELS
1. In the **ARTIFACTS** tab **>** **DATA AUDIT** or **OTHER** **>** Select an artifact **>** Either: 1. In the **ARTIFACTS** tab **>** **DATA AUDIT** or **OTHER** **>** Select an artifact **>** Either:
* Download the artifact <img src="/icons/ico-download.svg" className="icon size-md space-sm" />, if it is stored in remote storage. * Download the artifact <img src="/docs/latest/icons/ico-download.svg" className="icon size-md space-sm" />, if it is stored in remote storage.
* Copy its location to the clipboard <img src="/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md space-sm" />, * Copy its location to the clipboard <img src="/docs/latest/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md space-sm" />,
if it is in a local file. if it is in a local file.
#### Data audit #### Data audit
@ -354,7 +354,7 @@ All scalars that **ClearML** automatically logs, as well as those explicitly rep
#### Scalar plot tools #### Scalar plot tools
Use the scalar tools to improve analysis of scalar metrics. In the info panel, click <img src="/icons/ico-settings.svg" className="icon size-md space-sm" /> to use the tools. In the full screen details view, the tools Use the scalar tools to improve analysis of scalar metrics. In the info panel, click <img src="/docs/latest/icons/ico-settings.svg" className="icon size-md space-sm" /> to use the tools. In the full screen details view, the tools
are on the left side of the window. The tools include: are on the left side of the window. The tools include:
* **Group by** - select one of the following: * **Group by** - select one of the following:
* **Metric** - all variants for a metric on the same plot * **Metric** - all variants for a metric on the same plot
@ -379,7 +379,7 @@ are on the left side of the window. The tools include:
</div> </div>
</details> </details>
* Show / hide plots - Click **HIDE ALL**, and then click <img src="/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" /> * Show / hide plots - Click **HIDE ALL**, and then click <img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />
on those you want to see. on those you want to see.
* **Horizontal axis** modes (scalars, only) - Select one of the following: * **Horizontal axis** modes (scalars, only) - Select one of the following:
* **ITERATIONS** * **ITERATIONS**
@ -439,7 +439,7 @@ View debug samples by metric at any iteration. The most recent iteration appears
* Move to the same sample in a different iteration (move the iteration slider). * Move to the same sample in a different iteration (move the iteration slider).
* Show the next or previous iteration's sample. * Show the next or previous iteration's sample.
* Download the file <img src="/icons/ico-download.svg" className="icon size-md space-sm" />. * Download the file <img src="/docs/latest/icons/ico-download.svg" className="icon size-md space-sm" />.
* Zoom. * Zoom.
* View the sample's iteration number, width, height, and coordinates. * View the sample's iteration number, width, height, and coordinates.
@ -471,7 +471,7 @@ View debug samples by metric at any iteration. The most recent iteration appears
1. Locate debug samples by doing the following: 1. Locate debug samples by doing the following:
* Filter by metric. In the **Metric** list, choose a metric. * Filter by metric. In the **Metric** list, choose a metric.
* Show other iterations. Click <img src="/icons/ico-circle-older.svg" className="icon size-md space-sm" /> (Older images), <img src="/icons/ico-circle-newer.svg" className="icon size-md space-sm" /> (New images), or <img src="/icons/ico-circle-newest.svg" className="icon size-md space-sm" /> (Newest images). * Show other iterations. Click <img src="/docs/latest/icons/ico-circle-older.svg" className="icon size-md space-sm" /> (Older images), <img src="/docs/latest/icons/ico-circle-newer.svg" className="icon size-md space-sm" /> (New images), or <img src="/docs/latest/icons/ico-circle-newest.svg" className="icon size-md space-sm" /> (Newest images).
**To view a debug sample in the viewer / player:** **To view a debug sample in the viewer / player:**
@ -480,7 +480,7 @@ View debug samples by metric at any iteration. The most recent iteration appears
1. Do any of the following: 1. Do any of the following:
* Move to the same sample in another iteration - Move the slider, or click **<** (previous) or **>** (next). * Move to the same sample in another iteration - Move the slider, or click **<** (previous) or **>** (next).
* Download the file - Click <img src="/icons/ico-download.svg" className="icon size-md space-sm" />. * Download the file - Click <img src="/docs/latest/icons/ico-download.svg" className="icon size-md space-sm" />.
* Zoom * 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. * For images, locate a position on the sample - Hover over the sample and the X, Y coordinates appear in the legend below the sample.
@ -494,7 +494,7 @@ group experiments. Tags can show any text. For example, add tags for the type of
on, label versions of experiments, or apply team names to organize experimentation. on, label versions of experiments, or apply team names to organize experimentation.
* To add tags and change tag colors: * To add tags and change tag colors:
1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or <img src="/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (menu) 1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> (menu)
1. Do one of the following: 1. Do one of the following:
* Add a new tag - Type the new tag name **>** **(Create New)**. * Add a new tag - Type the new tag name **>** **(Create New)**.
* Add an existing tag - Click a tag. * Add an existing tag - Click a tag.

6
docs/webapp/webapp_exp_tuning.md
View File

@ -181,7 +181,7 @@ model in the **MODELS** tab.
**To select a different model:** **To select a different model:**
1. In **ARTIFACTS** **>** **Input Model** **>** Hover and click **EDIT**. 1. In **ARTIFACTS** **>** **Input Model** **>** Hover and click **EDIT**.
1. If a model is associated with the experiment, click <img src="/icons/ico-edit.svg" alt="Edit Pencil" className="icon size-md" />. 1. If a model is associated with the experiment, click <img src="/docs/latest/icons/ico-edit.svg" alt="Edit Pencil" className="icon size-md" />.
1. In the **SELECT MODEL** dialog, select a model from the current project or any other project. 1. In the **SELECT MODEL** dialog, select a model from the current project or any other project.
**To edit a model's configuration or label enumeration:** **To edit a model's configuration or label enumeration:**
@ -193,11 +193,11 @@ model in the **MODELS** tab.
remove the configuration remove the configuration
Users can also search for the configuration (hover over the configuration textbox, the search box appears) and copy the Users can also search for the configuration (hover over the configuration textbox, the search box appears) and copy the
configuration to the clipboard (hover and click <img src="/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md" />). configuration to the clipboard (hover and click <img src="/docs/latest/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md" />).
* Label enumeration - In the **LABELS** tab **>** Hover and click **EDIT** **>** Add, change, or delete label * Label enumeration - In the **LABELS** tab **>** Hover and click **EDIT** **>** Add, change, or delete label
enumeration key-value pairs. enumeration key-value pairs.
**To remove a model from an experiment:** **To remove a model from an experiment:**
* Hover and click **EDIT** **>** Click <img src="/icons/ico-trash.svg" alt="Trash" className="icon size-md" /> * Hover and click **EDIT** **>** Click <img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-md" />

2
docs/webapp/webapp_model_modifying.md
View File

@ -20,6 +20,6 @@ For each class, label enumeration contains the class name (key) and value.
**To add, change, or delete label enumeration classes:** **To add, change, or delete label enumeration classes:**
* In the **MODELS** tab, click a model **>** **LABELS** **>** Hover over **LABELS** **>** **EDIT** **>** **+**, edit a * In the **MODELS** tab, click a model **>** **LABELS** **>** Hover over **LABELS** **>** **EDIT** **>** **+**, edit a
key or value, or <img src="/icons/ico-trash.svg" alt="trash" className="icon size-sm space-sm" /> (delete) **>** **SAVE**. 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) ![image](../img/webapp_models_04a.png)

4
docs/webapp/webapp_model_table.md
View File

@ -33,7 +33,7 @@ can be saved in a browser bookmark and shared with other **ClearML** users to co
Customize any combination of the following: Customize any combination of the following:
* Dynamic column ordering - Drag a column title to a different position. * Dynamic column ordering - Drag a column title to a different position.
* Show / hide columns - Click <img src="/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> * 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. **>** select or clear the checkboxes of columns to show or hide.
* Filter columns - Type of experiment, experiment status (state), user * 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. * Sort columns - Metrics and hyperparameters, type of experiment, experiment name, start and last update elapsed time, and last iteration.
@ -60,7 +60,7 @@ group of experiments. A tag can show any text, for any purpose. For example, add
experiments execute on, label versions of experiments, or apply team names to organize experimentation. experiments execute on, label versions of experiments, or apply team names to organize experimentation.
* To Add tags and to change tag colors: * To Add tags and to change tag colors:
1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or <img src="/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" /> 1. Click the experiment **>** Hover over the tag area **>** **+ADD TAG** or <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-sm space-sm" />
(menu) (menu)
1. Do one of the following: 1. Do one of the following:
* Add a new tag - Type the new tag name **>** **(Create New)**. * Add a new tag - Type the new tag name **>** **(Create New)**.

4
docs/webapp/webapp_overview.md
View File

@ -34,9 +34,9 @@ The **ClearML Web UI** is composed of the following pages:
In addition, from the **ClearML Web UI**, use these buttons to access the **ClearML** community: In addition, from the **ClearML Web UI**, use these buttons to access the **ClearML** community:
* The **ClearML** <img src="/icons/ico-slack-c.svg" alt="Slack Channel" className="icon size-md" /> Slack channel. Ask questions about **ClearML**. * The **ClearML** <img src="/docs/latest/icons/ico-slack-c.svg" alt="Slack Channel" className="icon size-md" /> Slack channel. Ask questions about **ClearML**.
* The **ClearML** <img src='/icons/ico-youtube.svg' alt='YouTube' className='icon size-md' /> YouTube Channel. View our tutorials, presentations, and discussions. * The **ClearML** <img src='/icons/ico-youtube.svg' alt='YouTube' className='icon size-md' /> YouTube Channel. View our tutorials, presentations, and discussions.
* The **ClearML** <img src="/icons/ico-github.svg" alt="GitHub" className="icon size-md" /> GitHub repository. * The **ClearML** <img src="/docs/latest/icons/ico-github.svg" alt="GitHub" className="icon size-md" /> GitHub repository.

6
docs/webapp/webapp_profile.md
View File

@ -46,7 +46,7 @@ switch to it.
**To create ClearML credentials:** **To create ClearML credentials:**
1. Click the Profile button <img src="/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" /> 1. Click the Profile button <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" />
(upper right corner). (upper right corner).
1. In **WORKSPACES**, use the current workspace or select another (self-hosted **ClearML Server** users have one workspace). 1. In **WORKSPACES**, use the current workspace or select another (self-hosted **ClearML Server** users have one workspace).
@ -63,7 +63,7 @@ Switching workspaces does not apply to users of a self-hosted **ClearML Server**
**Switch workspaces in one of the following ways:** **Switch workspaces in one of the following ways:**
* Profile button - Click <img src="/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" /> (upper right corner on any page) **>** * Profile button - Click <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" /> (upper right corner on any page) **>**
Click the workspace to switch to. Click the workspace to switch to.
* Profile page - In the **WORKSPACES** section, click **SWITCH TO WORKSPACE** **>** Click the workspace to switch to. * Profile page - In the **WORKSPACES** section, click **SWITCH TO WORKSPACE** **>** Click the workspace to switch to.
@ -81,7 +81,7 @@ section shows the current members of the team, and whether the team has reached
1. Create an invitation hyperlink with one of these options: 1. Create an invitation hyperlink with one of these options:
* Profile button - Click <img src="/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" /> * Profile button - Click <img src="/docs/latest/icons/ico-me.svg" alt="Profile button" className="icon size-lg space-sm" />
**>** **Invite a User** **>** Copy the invitation hyperlink. **>** **Invite a User** **>** Copy the invitation hyperlink.
* Profile page - In **WORKSPACES** **>** **Members** **>** Click **INVITE USER** **>** Copy the invitation hyperlink. * Profile page - In **WORKSPACES** **>** **Members** **>** Click **INVITE USER** **>** Copy the invitation hyperlink.

6
docs/webapp/webapp_workers_queues.md
View File

@ -73,8 +73,8 @@ In the **Queues** tab, do any of the following:
* Rename a queue - Click **RENAME** > Type a queue name **>** **RENAME**, or click **DELETE**. * Rename a queue - Click **RENAME** > Type a queue name **>** **RENAME**, or click **DELETE**.
* Delete a queue - Click **Delete**. * Delete a queue - Click **Delete**.
* Do any of the following by right clicking an experiment in a queue's **EXPERIMENTS** tab (lower right): * 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="/icons/ico-dots-v-menu.svg" alt="Menu button" className="icon size-md space-sm" /> * 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**. (menu) and then select **Move to top** or **Move to bottom**.
* Move to a new queue - Click <img src="/icons/ico-dots-v-menu.svg" alt="Menu button" className="icon size-md space-sm" /> (menu) **>** **Move to queue...** **>** Select a queue **>** **ENQUEUE**. * 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="/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**.