Update docs (#330)

This commit is contained in:
pollfly 2022-09-15 16:10:11 +03:00 committed by GitHub
parent c8f96230bf
commit 5a65a2654b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
43 changed files with 182 additions and 104 deletions

View File

@ -14,6 +14,8 @@ pip install clearml
```
## Connect ClearML SDK to the Server
### Local Python
1. Execute the following command to run the ClearML setup wizard:
```bash
@ -35,7 +37,10 @@ pip install clearml
```
1. Get ClearML credentials. Open the ClearML Web UI in a browser. On the [**SETTINGS > WORKSPACE**](https://app.clear.ml/settings/workspace-configuration)
page, click **Create new credentials** **>** **Copy to clipboard**.
page, click **Create new credentials**.
The **LOCAL PYTHON** tab shows the data required by the setup wizard (a copy to clipboard action is available on
hover)
1. At the command prompt `Paste copied configuration here:`, copy and paste the ClearML credentials.
The setup wizard confirms the credentials.
@ -74,7 +79,17 @@ pip install clearml
CLEARML setup completed successfully.
```
Now you can integrate ClearML into your code!
Now you can integrate ClearML into your code! Continue [here](#auto-log-experiment).
### Jupyter Notebook
To use ClearML with Jupyter Notebook, you need to configure ClearML Server access credentials for your notebook.
1. Get ClearML credentials. Open the ClearML Web UI in a browser. On the [**SETTINGS > WORKSPACE**](https://app.clear.ml/settings/workspace-configuration)
page, click **Create new credentials**. The **JUPYTER NOTEBOOK** tab shows the commands required to configure your
notebook (a copy to clipboard action is available on hover)
1. Add these commands to your notebook
Now you can use ClearML in your notebook!
## Auto-log Experiment
@ -99,7 +114,6 @@ Then initialize the Task object in your `main()` function, or the beginning of t
task = Task.init(project_name='great project', task_name='best experiment')
```
Task name is not unique, it's possible to have multiple experiments with the same name.
If the project does not already exist, a new one will be created automatically.
The console should return the following output:

View File

@ -81,8 +81,8 @@ The panel below describes the details contained within a `frame`:
* `confidence` (*float*) - Confidence level of the ROI label (between 0 and 1.0).
* `labels` (*[string]*)
* For [FrameGroup objects](#frame-objects) (Regions of Interest), these are the labels applied to the ROI.
* For [FrameGroup labels](#frame-labels), this is the label applied to the entire frame.
* For [FrameGroup objects](annotations.md#frame-objects) (Regions of Interest), these are the labels applied to the ROI.
* For [FrameGroup labels](annotations.md#frame-labels), this is the label applied to the entire frame.
* `mask` (*dict*) - RGB value of the mask applied to the ROI, if a mask is used (for example, for semantic segmentation).
The ID points to the source of the mask.

View File

@ -106,7 +106,7 @@ with that label.
* In the **Version Browser**, choose a label on the label list.
For example:
* Before filtering, the **Version Browser** in the image below contains seven frames.
* The **version browser** in the image below contains 101 frames.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
@ -120,7 +120,7 @@ For example:
</details>
<br/>
* A simple label filter for `person` shows three frames with each containing at least one ROI labeled `person`.
* A simple label filter for `teddy bear` shows three frames with each containing at least one ROI labeled `teddy bear`.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
@ -160,7 +160,7 @@ where each frame filter can be a combination of ROI, frame, and source rules.
#### ROI Rules
* Create one ROI rule for <code>person</code> shows the same three frames as the simple frame filter (above).
* Create one ROI rule for the `teddy bear` label, which shows the same three frames as the simple frame filter (above).
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
@ -171,7 +171,8 @@ where each frame filter can be a combination of ROI, frame, and source rules.
</details>
<br/>
* In the ROI rule, add a second label. Add `partially_occluded`. Only frames containing at least one ROI labeled as both <code>person</code> and <code>partially_occluded</code> match the filter.
* In the ROI rule, add a second label. Add `partially_occluded`. Only frames containing at least one ROI labeled as both
`teddy bear` and `partially_occluded` match the filter.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content">
@ -199,7 +200,7 @@ where each frame filter can be a combination of ROI, frame, and source rules.
Filter by metadata using Lucene queries.
* Add a frame rule to filter by the metadata key <code>dangerous</code> for the value of <code>no</code>.
* Add a frame rule to filter by the metadata key `dangerous` for the value of `yes`.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
@ -228,7 +229,7 @@ Filter by metadata using Lucene queries.
Filter by sources using Lucene queries.
* Add a source rule to filter for sources URIs with a wildcards.
* Add a source rule to filter for sources URIs with wildcards.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary>
@ -240,8 +241,7 @@ Filter by sources using Lucene queries.
</details>
<br/>
Use Lucene queries in ROI label filters and frame rules.
Lucene queries can also be used in ROI label filters and frame rules.
## Masks
@ -273,13 +273,13 @@ The panel presents labels only from masks that are currently displayed.
1. Click **OK**
## Annotations
### Frame Objects (Regions of Interest)
### Adding Frame Objects (Regions of Interest)
You can add annotations by drawing new bounding areas, and copying existing annotations in the same or other frames.
**To draw a bounding area for a new annotation:**
#### Creating New Frame Objects
1. Optionally, select a default label in the Default ROI Label(s) list. New annotations are automatically assigned this label.
To draw a bounding area for a new annotation:
1. Click one of the following modes and create a bounding area in the frame:
@ -297,72 +297,55 @@ You can add annotations by drawing new bounding areas, and copying existing anno
A new annotation is created.
1. In the newly created annotation, select or type a label.
1. Optionally, add metadata. This is metadata for the annotation, not the entire frame.
1. Optionally, lock the annotation.
1. If you move to another frame, the frame editor automatically saves changes. Otherwise, if you exit the frame editor,
you are prompted to save.
1. In the newly created annotation, select or type-in a label(s). Click the circle in the label name to select a
different label color.
**To copy an annotation:**
You can use the **Default ROI Label(s)** list to automatically set labels to all new annotations.
1. Click the annotation or bounded area in the image or video clip.
1. In the annotation, click <img src="/docs/latest/icons/ico-copy-to-clipboard.svg" alt="Copy annotation icon" className="icon size-md space-sm" />
(copy annotation)
1. Optionally, navigate to a different frame.
1. Click **PASTE**. The new annotation appears in the same location as the one you copied.
1. Optionally, to paste the same annotation, click **PASTE** again in the desired frame.
#### Copying Frame Objects
You can copy existing annotations, and paste them to any frame of your choice:
1. Click the annotation or bounded area in the frame.
1. Click <img src="/docs/latest/icons/ico-copy-to-clipboard.svg" alt="Copy annotation" className="icon size-md space-sm" />
(copy annotation).
1. Navigate to the frame of your choice (you can remain in the same frame).
1. Click **PASTE**. The new annotation appears in the same location as the one you copied. You can paste the annotation
multiple times.
Copy all annotations in a frame by clicking the **COPY ALL** button.
**To copy all annotations:**
### Annotation Actions
1. Click **COPY ALL**.
1. Optionally, navigate to a different frame.
1. Click **PASTE**.
The following table describes the actions that can be performed on existing annotations. The frame editor automatically
saves changes when you move to another frame using the frame navigation controls
(<img src="/docs/latest/icons/ico-arrow-right.svg" alt="Next frame icon" className="icon size-md space-sm" />, <img src="/docs/latest/icons/ico-skip-next.svg" alt="Jump to next unfiltered annotation" className="icon size-md space-sm" />, <img src="/docs/latest/icons/ico-skip-forward.svg" alt="Jump forwards icon" className="icon size-md space-sm" />, <img src="/docs/latest/icons/ico-arrow-left.svg" alt="Previous frame icon" className="icon size-md space-sm" />, <img src="/docs/latest/icons/ico-skip-previous.svg" alt="Jump to previous unfiltered annotation" className="icon size-md space-sm" />, <img src="/docs/latest/icons/ico-skip-backward.svg" alt="Jump backwards icon" className="icon size-md space-sm" />,
or the arrow keys on the keyboard). Closing the frame editor will prompt you to save any changes.
| Icon (when applicable) | Action | Description |
|---|---|---|
|| Move annotation | Click on a bounded area and drag it. |
|| Resize annotation| Select an annotation, then click on a bounded areas vertex and drag it. |
|<img src="/docs/latest/icons/ico-metadata.svg" alt="edit metadata" className="icon size-md space-sm" />|Edit metadata|Hover over an annotation in the list and click the icon to open the edit window. Input the metadata dictionary in JSON format. This metadata is specific to the selected annotation, not the entire frame.|
|<img src="/docs/latest/icons/ico-lock-open.svg" alt="Lock annotation" className="icon size-md space-sm" />|Lock / Unlock annotation |Click the button on a specific annotation to make it uneditable. You can also click the button on top of the annotations list to lock all annotations in the frame.|
|<img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-sm space-sm" />|Delete annotation|Click the annotation or bounded area in the frame and then click the button to delete the annotation.|
|<img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />|Show/hide all annotations |Click the button to view the frame without annotations. When annotations are hidden, they cant be modified. |
||Delete label |In the relevant annotation, click **x** on the label you want to remove.|
### Frame Labels
You can add labels which describe the whole frame, with no specific coordinates.
**To add frame labels:**
1. Expand the **FRAME LABELS** area.
1. Click **+ Add new**.
1. Enter a label.
1. Optionally, click <img src="/docs/latest/icons/ico-edit.svg" alt="Edit pencil" className="icon size-md space-sm" />.
### Annotation Management
**To move annotations:**
* Move a bounded area by clicking on it and dragging.
**To resize annotations:**
* Resize a bounded area by clicking on a vertex and dragging.
**To modify annotation metadata:**
* In the label, click edit and then in the popup modify the metadata dictionary (in JSON format).
**To modify annotation colors:**
* Modify the color of an area by clicking the circle in the label name and select a new color.
**To lock annotations:**
* All annotations - Above the annotations, click the lock / unlock.
* A specific annotation - In an annotation, click the lock / unlock.
**To delete annotations:**
1. Click the annotation or bounded area in the image or video clip.
1. Press the **DELETE** key, or in the annotation, click **X**.
**To add, change, or delete labels to annotations labels:**
* Add - Click in the annotation and choose a label from the label list, or type a new label.
* Change - In the annotation label textbox, choose a label from the list or type a new label.
* Delete - In the annotation, in the label area, click the label's **X**.
1. Expand the **FRAME LABELS** area (below **OBJECTS**)
1. Click **+ Add new**
1. Enter a label(s)
## Frame Metadata
**To edit frame metadata:**
1. Expand the **FRAME METADATA** area
1. Click edit <img src="/docs/latest/icons/ico-metadata.svg" alt="edit metadata" className="icon size-md space-sm" />
which will open an editing window
1. Modify the metadata dictionary in JSON format
* Expand the **FRAME METADATA** area, click edit, and then in the popup modify the metadata dictionary (in JSON format).

View File

@ -6,7 +6,15 @@ Use the Dataset versioning WebApp (UI) features for viewing, creating, modifying
deleting [Dataset versions](../dataset.md#dataset-versioning).
## Dataset Version History
The WebApp (UI) will present your dataset version structure in one of two ways, depending on the structure implemented.
The WebApp (UI) presents your dataset version structure in [simple view](#simple-view) or [advanced view](#advanced-view),
depending on the structure implemented.
Use the search bar to find specific versions. You can query by version name or version description. The search returns
all versions that match the query.
In advanced view, parent versions that do not match the query where a child version does appear in a muted color.
![Dataset version search](../../img/hyperdatasets/hyperdataset_search_2.png)
## Simple View
While your dataset maintains a simple (linear) [version structure](../dataset.md#dataset-version-structure), the WebApp
@ -123,7 +131,22 @@ Label usage stats for this dataset version.
## Version Frame Browser
The **Version Frame Browser** displays a preview of the contents of the selected dataset version.
The dataset version can be filtered by multiple criteria. The resulting frames can be exported as a JSON file.
View the version's frames as thumbnails or in a table. Use the view toggle to switch between thumbnail
view <img src="/docs/latest/icons/ico-grid-view.svg" alt="thumbnail view" className="icon size-md space-sm" /> and
table view <img src="/docs/latest/icons/ico-table-view.svg" alt="table view" className="icon size-md space-sm" /> .
Use the thumbnail view for a visual preview of the version's frames:
![Frame browser thumbnails](../../img/hyperdatasets/frame_browser_thumbnails.png)
Use the table view to list the versions frames in a customizable table. Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" />
for column customization options.
![Frame browser list](../../img/hyperdatasets/frame_browser_list.png)
The dataset version can be filtered by multiple criteria. The resulting frames can be exported as a JSON file.
To view further details about a specific frame, click on its preview, which will open the [Frame Viewer](webapp_datasets_frames.md#frame-viewer).
@ -137,12 +160,12 @@ with that label.
<summary className="cml-expansion-panel-summary">Simple filter example</summary>
<div className="cml-expansion-panel-content">
* Before filtering, the **Version Browser** in the image below contains seven frames.
* The **version browser** in the image below contains 101 frames.
![Unfiltered version browser](../../img/hyperdatasets/frame_filtering_01.png)
* A simple label filter for `person` shows three frames, each containing at least one ROI labeled `person`.
* A simple label filter for `teddy bear` shows three frames, each containing at least one ROI labeled `teddy bear`.
![Filtered version browser](../../img/hyperdatasets/frame_filtering_02.png)
@ -173,12 +196,12 @@ where each frame filter can be a combination of ROI, frame, and source rules.
<summary className="cml-expansion-panel-summary">ROI Rules</summary>
<div className="cml-expansion-panel-content">
* Create one ROI rule for `person` shows the same three frames as the simple frame filter (above).
* Create one ROI rule for the `teddy bear` label, which shows the same three frames as the simple frame filter (above).
![Adding an ROI rule](../../img/hyperdatasets/frame_filtering_03.png)
* In the ROI rule, add a second label. Add `partially_occluded`. Only frames containing at least one ROI labeled as both
`person` and `partially_occluded` match the filter.
`teddy bear` and `partially_occluded` match the filter.
![Add label to ROI rule](../../img/hyperdatasets/frame_filtering_04.png)
@ -196,9 +219,9 @@ where each frame filter can be a combination of ROI, frame, and source rules.
Filter by metadata using Lucene queries.
* Add a frame rule to filter by the metadata key `dangerous` for the value of `no`.
* Add a frame rule to filter by the metadata key `dangerous` for the value of `yes`.
![Filter by metadata ](../../img/hyperdatasets/frame_filtering_08.png)
![Filter by metadata](../../img/hyperdatasets/frame_filtering_08.png)
* Open a frame in the frame viewer to see its metadata.
@ -214,7 +237,7 @@ Filter by metadata using Lucene queries.
Filter by sources using Lucene queries.
* Add a source rule to filter for sources URIs with a wildcards.
* Add a source rule to filter for sources URIs with wildcards.
![Filter by source](../../img/hyperdatasets/frame_filtering_10.png)
@ -225,12 +248,14 @@ Lucene queries can also be used in ROI label filters and frame rules.
### Exporting Frames
To export (download) filtered datasets as a JSON file, click **EXPORT FRAMES**.
To export (download) the filtered frames as a JSON file, click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" /> > **EXPORT FRAMES**.
### Frame Browser Configuration
Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> to open the
Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" /> to open the
frame browser configuration settings.
![Frame browser config menu](../../img/hyperdatasets/frame_browser_menu.png)
#### Grouping Previews
FrameGroups or SingleFrames can share the same `context_id` (URL). For example, users can set the same `context_id`
to multiple FrameGroups that represent frames in a single video.

View File

@ -12,6 +12,7 @@ View the Dataviews table in table view <img src="/docs/latest/icons/ico-table-vi
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your Dataviews according to
columns of interest. Use the details view to access a selected Dataviews details, while keeping the Dataview list in view.
Details view can also be accessed by double clicking a specific Dataview in the table view to open its details view.
![Dataviews table](../../img/hyperdatasets/webapp_dataviews_table.png)
@ -66,7 +67,7 @@ Access these actions with the context menu in any of the following ways:
| ClearML Action | Description |
|---|---|
| Details | Dataview details, including input datasets, label mapping, augmentation operations, and iteration control. |
| Details | View Dataview details, including input datasets, label mapping, augmentation operations, and iteration control. Can also be accessed by double clicking a Dataview in the Dataviews table. |
| 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. |

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 548 KiB

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 265 KiB

After

Width:  |  Height:  |  Size: 164 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 277 KiB

After

Width:  |  Height:  |  Size: 174 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 216 KiB

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 686 KiB

After

Width:  |  Height:  |  Size: 1.6 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 341 KiB

After

Width:  |  Height:  |  Size: 266 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 675 KiB

After

Width:  |  Height:  |  Size: 1.0 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 183 KiB

After

Width:  |  Height:  |  Size: 578 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 MiB

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 MiB

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 162 KiB

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 135 KiB

After

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -18,9 +18,11 @@ queue (until reaching the defined maximum number of instances). You can add an i
each instance is spun up.
## Autoscaler Instance Configuration
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **AWS Credentials** - Credentials with which the autoscaler can access your AWS account. See [Generating AWS IAM Credentials](#generating-aws-iam-credentials)
* Use IAM role - Select if you are running your autoscalers on your own EC2 instances which are attached to an [IAM
role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html). In such a case, no AWS IAM credentials are required.
role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html). In such a case, no AWS IAM credentials are required
* AWS Region - [AWS Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.Regions)
where the EC2 instances will be spun up
* AWS Access Key ID and AWS Secret Access Key - The credentials with which the autoscaler will access your AWS
@ -53,17 +55,19 @@ each instance is spun up.
for full list of types
* Instance Key Pair (Optional) - AWS key pair that is provided to the spun EC2 instances for connecting to them via
SSH. Provide the Key Pair's name, as was created in AWS. See [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html)
for more details.
for more details
* Security Group ID (Optional) - Comma separated list of AWS VPC Security Group IDs to attach to the launched
instance. Read more [here](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html)
* \+ Add Item - Define another resource type
* **IAM Instance Profile** (Optional) - Set an IAM instance profile for all instances spun by the Autoscaler
* Arn - Amazon Resource Name specifying the instance profile
* Name - Name identifying the instance profile
* **Autoscaler Instance Name** (Optional) - Name for the Autoscaler instance. This will appear in the instance list.
* **Autoscaler Instance Name** (Optional) - Name for the Autoscaler instance. This will appear in the instance list
* **Init script** (Optional) - A bash script to execute after launching the EC2 instance
* **Additional ClearML Configuration** (Optional) - A ClearML configuration file to use by the ClearML Agent when
executing your experiments
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration
![Autoscaler wizard](../../img/app_aws_autoscaler_wizard.png)

View File

@ -19,11 +19,13 @@ in a queue (until reaching the defined maximum number of instances). You can add
when each VM instance is spun up.
## Autoscaler Instance Configuration
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **GCP Configuration**
* GCP Project ID - Project used for spinning up VM instances
* GCP Zone - The GCP zone where the VM instances will be spun up. See [Regions and zones](https://cloud.google.com/compute/docs/regions-zones)
* GCP Credentials - Project credentials, see [here](https://cloud.google.com/docs/authentication/production) for
more details.
more details
* **Git Configuration** - Git credentials with which the ClearML Agents running on your VM instances will access your
repositories to retrieve the code for their jobs
* Git User
@ -31,23 +33,25 @@ when each VM instance is spun up.
* **Base Docker Image** (Optional) - Default Docker image in which the ClearML Agent will run. Provide a Docker stored in a
Docker artifactory so VM instances can automatically fetch it
* **Compute Resources**
* Resource Name - Assign a name to the resource type. This name will appear in the Autoscaler dashboard.
* Resource Name - Assign a name to the resource type. This name will appear in the Autoscaler dashboard
* GCP Machine Type - See list of [machine types](https://cloud.google.com/compute/docs/machine-types)
* Run in CPU mode - Select to have the autoscaler utilize only CPU VM instances
* GPU Type - See list of [supported GPUs by instance](https://cloud.google.com/compute/docs/gpus)
* Use Preemptible Instance - Choose whether VM instances of this type will be [preemptible](https://cloud.google.com/compute/docs/instances/preemptible).
* Use Preemptible Instance - Choose whether VM instances of this type will be [preemptible](https://cloud.google.com/compute/docs/instances/preemptible)
* Max Number of Instances - Maximum number of concurrent running VM instances of this type allowed
* Monitored Queue - Queue associated with this VM instance type. The tasks enqueued to this queue will be executed on VM instances of this type
* Machine Image (Optional) - The GCP machine image to launch
* Disc Size (in GB) (Optional)
* \+ Add Item - Define another resource type
* **Autoscaler Instance Name** (Optional) - Name for the Autoscaler instance. This will appear in the instance list.
* **Autoscaler Instance Name** (Optional) - Name for the Autoscaler instance. This will appear in the instance list
* **Max Idle Time** (Optional) - Maximum time in minutes that a VM instance can be idle before the autoscaler spins it down
* **Workers Prefix** (Optional) - A Prefix added to workers names, associating them with this autoscaler
* **Polling Interval** (Optional) - Time period in minutes at which the designated queue is polled for new tasks
* **Init Script** (Optional) - A bash script to execute after launching the VM instance
* **Additional ClearML Configuration** (Optional) - A ClearML configuration file to use by the ClearML Agent when executing your experiments
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration.
![GCP autoscaler wizard](../../img/apps_gcp_autoscaler_wizard.png)
:::note Enterprise Feature

View File

@ -19,8 +19,10 @@ Control the optimization process with the advanced configuration options, which
limits.
## HPO Instance Configuration
* **Import Configuration** - Import an app instance configuration file. This will fill the configuration wizard with the
values from the file, which can be modified before launching the app instance
* **Initial Task to Optimize** - ID of an existing ClearML task to optimize. This task will be cloned, and each clone will
sample a different set of hyperparameters values.
sample a different set of hyperparameters values
* **Optimization Configuration**
* Optimization Method - The optimization strategy to employ (e.g. random, grid, hyperband)
* Optimization Objective Metrics Title - Title of metric to optimize
@ -38,15 +40,15 @@ limits.
* Discrete Parameters - A set of values to sample
* Values - Comma separated list of values to sample
* Name - The original tasks configuration parameter name (including section name e.g. `Args/lr`)
* **Optimization Job Title** (Optional) - Name for the HPO instance. This will appear in the instance list.
* **Optimization Job Title** (Optional) - Name for the HPO instance. This will appear in the instance list
* **Optimization Experiments Destination Project** (Optional) - The project where optimization tasks will be saved.
Leave empty to use the same project as the Initial task.
* **Maximum Concurrent Tasks** - The maximum number of simultaneously running optimization experiments
* **Advanced Configuration** (Optional)
* Limit Total HPO Experiments - Maximum total number of optimization experiments
* Number of Top Experiments to Save - Number of best performing experiments to save (the rest are archived).
* Number of Top Experiments to Save - Number of best performing experiments to save (the rest are archived)
* Limit Single Experiment Running Time (Minutes) - Time limit per optimization experiment. Experiments will be
stopped after the specified time elapsed.
stopped after the specified time elapsed
* Minimal Number of Iterations Per Single Experiment - Some search methods, such as Optuna, prune underperforming
experiments. This is the minimum number of iterations per experiment before it can be stopped. Iterations are
based on the experiments' own reporting (for example, if experiments report every epoch, then iterations=epochs)
@ -54,7 +56,9 @@ limits.
stopped. Iterations are based on the experiments' own reporting (for example, if experiments report every epoch,
then iterations=epochs)
* Limit Total Optimization Instance Time (Minutes) - Time limit for the whole optimization process (in minutes)
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration.
![HPO app wizard](../../img/apps_hpo_wizard.png)
## Dashboard

View File

@ -34,6 +34,16 @@ Each applications page is split into two sections:
1. Fill in the configuration details
1. **Launch**
:::tip Configuration shortcuts
You can also launch an app instance with the configuration of a previously launched instance:
* Cloning a previously launched app instance will open the launch wizard with the original instance's configuration
prefilled.
* Importing an app configuration file. You can export an existing app instance's configuration as a JSON file when
viewing its configuration.
The prefilled configuration wizard can be edited before launching the new app instance.
:::
## App Instance Actions
Access app instance actions, by right clicking an instance, or through the menu button <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" /> (available on hover).
@ -41,6 +51,22 @@ Access app instance actions, by right clicking an instance, or through the menu
* **Rename** - Rename the instance
* **Configuration** - View an instances configuration
* **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create
a new instance with the same configuration
* **Stop** - Shutdown the instance
* **Clone** - Launch a new instance with same configuration prefilled
* **Delete** - Delete the instance
## Instance List Actions
Access the instance list actions by clicking the action menu ( <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" /> )
on the instance list header:
![Instance list actions](../../img/apps_instance_list_actions.png)
* **Import Configuration** - Import an app instance's configuration file. This opens the app configuration wizard
prefilled according to the imported file. You can modify the configuration before launching the instance.
* **Clear Completed** - Delete all app instances that have completed their execution. This action only
deletes instances in the current instance list view (i.e. My instances / All).

View File

@ -40,7 +40,9 @@ On the right side of the dataset version panel, view the **VERSION INFO** which
* Number of files modified
* Number of files removed
* Change in size
* Version description - to modify, hover over description and click <img src="/docs/latest/icons/ico-edit.svg" alt="Edit pencil" className="icon size-md space-sm" /> ,
which opens the edit window
<div class="max-w-50">
![Version info](../../img/webapp_dataset_version_info.png)

View File

@ -10,6 +10,7 @@ View the runs table in table view <img src="/docs/latest/icons/ico-table-view.sv
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your runs according to
columns of interest. Use the details view to access a selected runs details, while keeping the pipeline runs list in view.
Details view can also be accessed by double clicking a specific pipeline run in the table view to open its details view.
![Pipeline runs table](../../img/webapp_pipeline_runs_table.png)
@ -99,7 +100,7 @@ Access these actions with the context menu in any of the following ways:
| Action | Description | States Valid for the Action | State Transition |
|---|---|---|---|
| Details | View pipeline details. | Any state | None |
| Details | View pipeline details. Can also be accessed by double clicking a run in the pipeline runs table. | Any state | None |
| Run | Create a new pipeline run. Configure and enqueue it for execution. See [Create Run](#create-run). | Any State | *Pending* |
| Abort | Manually stop / cancel a run. | *Running* / *Pending* | *Aborted* |
| Continue | Rerun with the same parameters. | *Aborted* | *Pending* |

View File

@ -192,6 +192,9 @@ first. Use the viewer / player to inspect images, audio, video samples and do an
* Filter by metric. In the **Metric** list, choose a metric.
* Show other iterations. Click <img src="/docs/latest/icons/ico-circle-older.svg" alt="Left arrow" className="icon size-md space-sm" /> (Older images),
<img src="/docs/latest/icons/ico-circle-newer.svg" alt="Right arrow" className="icon size-md space-sm" /> (New images), or <img src="/docs/latest/icons/ico-circle-newest.svg" alt="right arrow, newest image" className="icon size-md space-sm" /> (Newest images).
* Click <img src="/docs/latest/icons/ico-disconnect.svg" alt="Sync selection" className="icon size-md space-sm" /> in
order to synchronize iteration and metric selection across experiments. For example, if you select a metric for
one experiments debug samples, the same metric will be automatically selected for the rest of the experiments in the comparison.
![image](../img/webapp_compare_30.png)

View File

@ -10,7 +10,7 @@ View the experiments table in table view <img src="/docs/latest/icons/ico-table-
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your experiments according
to columns of interest. Use the details view to access a selected experiments details, while keeping the experiment list
in view.
in view. Details view can also be accessed by double clicking a specific experiment in the table view to open its details view.
:::info
To assist in focusing on active experimentation, experiments and models can be archived, so they will not appear
@ -137,7 +137,7 @@ Access these actions with the context menu in any of the following ways:
| Action | Description | States Valid for the Action | State Transition |
|---|---|---|---|
| Details | Open the experiment's [info panel](webapp_exp_track_visual.md#info-panel) (keeps the experiments list in view). | Any state | None |
| Details | Open the experiment's [info panel](webapp_exp_track_visual.md#info-panel) (keeps the experiments list in view). Can also be accessed by double clicking an experiment in the experiments table. | Any state | None |
| View Full Screen | View experiment details in [full screen](webapp_exp_track_visual.md#full-screen-details-view). | Any state | None |
| Manage Queue | If an experiment is *Pending* in a queue, view the utilization of that queue, manage that queue (remove experiments and change the order of experiments), and view information about the worker(s) listening to the queue. See the [Workers and Queues](webapp_workers_queues.md) page. | *Enqueued* | None |
| View Worker | If an experiment is *Running*, view resource utilization, worker details, and queues to which a worker is listening. | *Running* | None |

View File

@ -9,7 +9,7 @@ View the models table in table view <img src="/docs/latest/icons/ico-table-view.
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your models according to
columns of interest. Use the details view to access a selected models details, while keeping the model list in view.
Details view can also be accessed by double clicking a specific model in the table view to open its details view.
![Models table](../img/webapp_models_01.png)
@ -73,7 +73,7 @@ Access these actions with the context menu in any of the following ways:
| ClearML Action | Description | States Valid for the Action |
|---|---|--|
| Details | Model details include general information, the model configuration, and label enumeration. | Any state |
| Details | View model details, which include general information, the model configuration, and label enumeration. Can also be accessed by double clicking a model in the models table | 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 model to the active model table. | Any state |

View File

@ -2,7 +2,7 @@
title: Model Details
---
In the models table, click on a model to view and / or modify the following:
In the models table, double click on a model to view and / or modify the following:
* General model information
* Model configuration
* Model label enumeration

View File

@ -70,7 +70,7 @@ to switch to.
### ClearML Credentials
Generate ClearML credentials, made up of an access and secret key pair, and insert them into your [configuration file](../configs/clearml_conf.md)
to grant the ClearML SDK and the ClearML Agent API access to the server.
or Jupyter Notebook to grant the ClearML SDK and the ClearML Agent API access to the server.
You can create credentials for any workspace that you are a member of.

View File

@ -0,0 +1,4 @@
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
<path style="fill:none" d="M0 0h24v24H0z"/>
<path d="M7.08 6.11a5 5 0 1 1 7.7 5.04.5.5 0 0 1-.78-.42v-1.3a.486.486 0 0 1 .15-.34 3 3 0 0 0-3.1-4.93 2.93 2.93 0 0 0-1.9 1.9 3 3 0 0 0 .7 3.03.509.509 0 0 1 .15.35v1.3a.5.5 0 0 1-.77.43 4.99 4.99 0 0 1-2.15-5.04zm7.7 6.74a.5.5 0 0 0-.78.42v1.3a.529.529 0 0 0 .15.35 2.989 2.989 0 0 1 .7 3.03 2.909 2.909 0 0 1-1.9 1.9 3 3 0 0 1-3.1-4.93.486.486 0 0 0 .15-.34v-1.31a.5.5 0 0 0-.77-.43 5 5 0 1 0 5.55 0z" transform="rotate(-90 12.002 11.999)" style="fill:#8492c2"/>
</svg>

After

Width:  |  Height:  |  Size: 610 B

View File

@ -0,0 +1,4 @@
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20">
<path d="M20 20H0V0h20z" style="fill:none"/>
<path d="M-697.167-195.666a1.667 1.667 0 0 1-1.667-1.667v-2.5a1.667 1.667 0 0 1 1.667-1.667H-693a1.667 1.667 0 0 1 1.667 1.667v2.5a1.667 1.667 0 0 1-1.667 1.667zm-9.167 0a1.667 1.667 0 0 1-1.666-1.668v-2.5a1.667 1.667 0 0 1 1.667-1.667h4.166a1.667 1.667 0 0 1 1.667 1.667v2.5a1.667 1.667 0 0 1-1.667 1.667zm9.167-7.5a1.667 1.667 0 0 1-1.667-1.667v-2.5a1.667 1.667 0 0 1 1.667-1.667H-693a1.667 1.667 0 0 1 1.667 1.667v2.5a1.667 1.667 0 0 1-1.667 1.667zm-9.167 0a1.667 1.667 0 0 1-1.666-1.668v-2.5a1.667 1.667 0 0 1 1.667-1.666h4.166a1.667 1.667 0 0 1 1.667 1.667v2.5a1.667 1.667 0 0 1-1.667 1.667z" transform="translate(709.667 212.333)" style="fill:#707ba3"/>
</svg>

After

Width:  |  Height:  |  Size: 804 B

View File

@ -0,0 +1,3 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M18,10H8V8.2c0-2.1,1.5-4,3.6-4.2c2.1-0.2,3.9,1.2,4.3,3.2C16,7.7,16.4,8,16.9,8l0,0c0.6,0,1.1-0.6,1-1.2c-0.6-3-3.5-5.1-6.7-4.7C8.2,2.4,6,5.2,6,8.2V10c-1.1,0-2,0.9-2,2v8c0,1.1,0.9,2,2,2h12c1.1,0,2-0.9,2-2v-8C20,10.9,19.1,10,18,10z M13,16h-2v-3h2V16z" fill="#8F9DC9" />
</svg>

After

Width:  |  Height:  |  Size: 343 B