mirror of
https://github.com/clearml/clearml-docs
synced 2025-04-02 12:21:08 +00:00
Update docs (#153)
* add info for clear filter, float behavior, and tag exclusion * add data examples to guides * fix typo * fix filtering wording, and float admonition title * add abort all children action * dataset metadata initial * fix expand icon * initial new exp comparison window * initial scalar full screen * fix typo * edit dataset version metada * edit exp comparison and add missing alts to icons * add info about dataset-level datasets * add info about full screen mode * HOCON >>> JSON * HOCON >>> JSON * dataset card edits * edit fullscreen scalar mode * edit fullscreen scalar plots * edit pipeline example based on code fixes * full screen scalar edit * add context navigation * Add experiment selection info * experiment selection edit * custom ui plugin * datasets and versioning * fix link
This commit is contained in:
pollfly
GitHub
parent
8339e4902f
commit
eb91aaa361
@ -8,11 +8,12 @@ This documentation page applies to deploying your own open source ClearML Server
|
||||
|
||||
This page describes the **ClearML Server** [deployment](#clearml-server-deployment-configuration) and [feature](#clearml-server-feature-configurations) configurations. Namely, it contains instructions on how to configure **ClearML Server** for:
|
||||
|
||||
* [Sub-domains and load balancers](#sub-domains-and-load-balancers) - An AWS load balancing example.
|
||||
* [Sub-domains and load balancers](#sub-domains-and-load-balancers) - An AWS load balancing example
|
||||
* [Opening Elasticsearch, MongoDB, and Redis for External Access](#opening-elasticsearch-mongodb-and-redis-for-external-access).
|
||||
* [Web login authentication](#web-login-authentication) - Create and manage users and passwords.
|
||||
* [Web login authentication](#web-login-authentication) - Create and manage users and passwords
|
||||
* [Using hashed passwords](#using-hashed-passwords) - Option to use hashed passwords instead of plain-text passwords
|
||||
* [Non-responsive Task watchdog](#non-responsive-task-watchdog) - For inactive experiments.
|
||||
* [Non-responsive Task watchdog](#non-responsive-task-watchdog) - For inactive experiments
|
||||
* [Custom UI context menu actions](#custom-ui-context-menu-actions)
|
||||
|
||||
For all configuration options, see the [ClearML Configuration Reference](../configs/clearml_conf.md) page.
|
||||
|
||||
@ -293,7 +294,7 @@ You can also use hashed passwords instead of plain-text passwords. To do that:
|
||||
}
|
||||
}
|
||||
|
||||
### Non-responsive Task watchdog
|
||||
### Non-responsive Task Watchdog
|
||||
|
||||
The non-responsive experiment watchdog monitors experiments that were not updated for a specified time interval, and then
|
||||
the watchdog marks them as `aborted`. The non-responsive experiment watchdog is always active.
|
||||
@ -323,4 +324,60 @@ Modify the following settings for the watchdog:
|
||||
}
|
||||
}
|
||||
|
||||
1. Restart **ClearML Server**.
|
||||
1. Restart **ClearML Server**.
|
||||
|
||||
### Custom UI Context Menu Actions
|
||||
|
||||
:::note Enterprise Feature
|
||||
This feature is only supported by the ClearML Enterprise Server
|
||||
:::
|
||||
|
||||
Create custom UI context menu actions to be performed on ClearML objects (projects, tasks, models, dataviews, or queues)
|
||||
by defining an HTTP request to issue when clicking on the action from an object’s context menu.
|
||||
|
||||
To create a custom action, add the action definitions to the ClearML Server `/opt/clearml/config/services.conf`
|
||||
file, using the following format:
|
||||
|
||||
```conf
|
||||
organization.ui_actions: {
|
||||
# key is the object type: project / task / model / dataview / queue
|
||||
project: [
|
||||
{
|
||||
# name of action which will appear in the context menu
|
||||
name: "Action Item Name"
|
||||
tooltip: "Custom action 1"
|
||||
# action specifies the HTTP request performed by the browser when clicking the action
|
||||
action {
|
||||
# request method, options are GET / POST / DELETE
|
||||
method: GET
|
||||
# request URL, may contain ${id} which will be replaced by the object's ID
|
||||
url: "http://example.com/${id}"
|
||||
# Request payload (any string)
|
||||
payload: "{'foo': 'bar'}"
|
||||
# Request headers, custom key/value header values
|
||||
headers {
|
||||
# example: specify to the request target that the payload is in JSON format
|
||||
"Content-Type": "application/json"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The action will appear in the context menu for the object type in which it was specified:
|
||||
* Task, model, dataview - Right-click an object in the [experiments](../webapp/webapp_exp_table.md), [models](../webapp/webapp_model_table.md),
|
||||
and [dataviews](../hyperdatasets/webapp/webapp_dataviews.md) tables respectively. Alternatively, click the object to
|
||||
open its info tab, then click the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" className="icon size-md space-sm" />
|
||||
to access the context menu.
|
||||
* Project - In the project page > click the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" className="icon size-md space-sm" />
|
||||
on a specific project card to access its context menu
|
||||
* Queue - In the [Workers and Queues](../webapp/webapp_workers_queues.md) page > **QUEUES** tab, right-click the queue
|
||||
to access its context menu
|
||||
|
||||
The custom action is always performed from a context-menu opened from a specific selected item.
|
||||
|
||||
When clicking the custom action, the UI sends the target endpoint (`url`) the appropriate request, injecting the template
|
||||
with the object's ID.
|
||||
|
||||
The UI will display a toast message conveying action success or failure.
|
||||
@ -9,25 +9,11 @@ and functionality for the following purposes:
|
||||
* Integrating the powerful features of [Dataviews](dataviews.md) with an experiment
|
||||
* [Annotating](webapp/webapp_datasets_frames.md#annotations) images and videos
|
||||
|
||||
Datasets consist of versions with SingleFrames and / or FrameGroups. Each Dataset can contain multiple versions, where
|
||||
each version can have multiple children that inherit their parent's SingleFrames and / or FrameGroups. This inheritance
|
||||
includes the frame metadata and data connecting the source data to the ClearML Enterprise platform, as well as the other
|
||||
metadata and data.
|
||||
Datasets consist of versions with SingleFrames and / or FrameGroups. Each Dataset can contain multiple versions, which
|
||||
can have multiple children that inherit their parent's contents.
|
||||
|
||||
These parent-child version relationships can be represented as version trees with a root-level parent. A Dataset
|
||||
can contain one or more trees.
|
||||
|
||||
Mask-labels can be defined globally, for a DatasetVersion, which will be applied to all masks in that version.
|
||||
|
||||
## Dataset Version State
|
||||
|
||||
Dataset versions can have either **Draft** or **Published** status.
|
||||
|
||||
A **Draft** version is editable, so frames can be added to and deleted and / or modified from the Dataset.
|
||||
|
||||
A **Published** version is read-only, which ensures reproducible experiments and preserves a version of a Dataset.
|
||||
Child versions can only be created from *Published* versions. To create a child of a *Draft* Dataset version,
|
||||
it must be published first.
|
||||
Mask-labels can be defined globally, for a DatasetVersion. When defined this way, they will be applied to all masks in
|
||||
that version.
|
||||
|
||||
## Example Datasets
|
||||
|
||||
@ -123,19 +109,31 @@ Dataset.delete(dataset_name='MyDataset', delete_all_versions=True, force=True)
|
||||
Dataset versioning refers to the group of ClearML Enterprise SDK and WebApp (UI) features for creating,
|
||||
modifying, and deleting Dataset versions.
|
||||
|
||||
ClearML Enterprise supports simple and sophisticated Dataset versioning, including **simple version structures** and
|
||||
**advanced version structures**.
|
||||
ClearML Enterprise supports simple and advanced Dataset versioning paradigms. A **simple version structure** consists of
|
||||
a single evolving version, with historic static snapshots. Continuously push your changes to your single dataset version,
|
||||
and take a snapshot to record the content of your dataset at a specific point in time.
|
||||
|
||||
In a **simple version structure**, a parent can have one and only one child, and the last child in the Dataset versions
|
||||
tree must be a *Draft*. This simple structure allows working with a single set of versions of a Dataset. Create children
|
||||
and publish versions to preserve data history. Each version whose status is *Published* in a simple version structure is
|
||||
referred to as a **snapshot**.
|
||||
You can, alternatively, employ any **advanced structure**, where each version evolves in parallel, and you control which
|
||||
versions are locked for further changes and which can be modified. See details [below](#dataset-version-structure).
|
||||
|
||||
In an **advanced version structure**, at least one parent has more than one child (this can include more than one parent
|
||||
version at the root level), or the last child in the Dataset versions tree is *Published*.
|
||||
## Dataset Version State
|
||||
|
||||
Dataset versions can have either *Draft* or *Published* state.
|
||||
|
||||
A *Draft* version is editable, so frames can be added to and deleted and / or modified.
|
||||
|
||||
A *Published* version is read-only, which ensures reproducible experiments and preserves the Dataset version contents.
|
||||
Child versions can only be created from *Published* versions, as they inherit their predecessor version contents.
|
||||
|
||||
## Dataset Version Structure
|
||||
To implement a simple version structure, where the dataset is ever evolving, with a linear set of historic snapshots,
|
||||
a parent version can have one and only one child, with the last child in the Dataset versions tree in *Draft* state.
|
||||
Different version structures, such as where at least one parent has more than one child, or the single last child in the
|
||||
Dataset versions tree is *Published* are considered advanced version structures.
|
||||
|
||||
For details about programmatically implementing simple and advanced version structures, see [Creating Snapshots](#creating-snapshots)
|
||||
and [Creating Child Versions](#creating-child-versions) respectively below.
|
||||
|
||||
Creating a version in a simple version structure may convert it to an advanced structure. This happens when creating
|
||||
a Dataset version that yields a parent with two children, or when publishing the last child version.
|
||||
|
||||
## DatasetVersion Usage
|
||||
|
||||
|
||||
@ -12,20 +12,42 @@ The Datasets page offers the following functionalities:
|
||||
|
||||
## Dataset Cards
|
||||
|
||||
Dataset cards show summary information about versions, frames, and labels in a Dataset, and the elapsed time since the Dataset was last update and the user doing the update. Dataset cards allow you to open a specific Dataset to perform Dataset versioning and frames management.
|
||||
Dataset cards show summary information about versions, frames, and labels in a Dataset, and the elapsed time since the Dataset was last update and the user doing the update.
|
||||
Dataset cards allow you to open a specific Dataset to perform Dataset versioning and frames management.
|
||||
|
||||
* Dataset name
|
||||
* Elapsed time since the last update. Hover over elapsed time and view date of last update.
|
||||
* User updating the Dataset
|
||||
* If the dataset contains dataset-level metadata, the card displays the <img src="/docs/latest/icons/ico-status-completed.svg" alt="Check mark" className="icon size-md space-sm" />
|
||||
`Metadata` indicator, which is also a shortcut to [edit the Dataset's metadata](#editing-dataset-level-metadata)
|
||||
* The number of versions in the Dataset
|
||||
* The total number of frames in all versions of the Dataset. If an asterisk (\*) appears next to **FRAMES**, then you can hover it and see the name of the version whose frames were last updated appears.
|
||||
* The percentage of frames annotated in all versions of the Dataset. If an asterisk (\*) appears next to **ANNOTATED**, then you can hover it and see the name of the version whose frames were last annotated appears.
|
||||
* If the Dataset version's status is *Published*, then the top labels in the Dataset, color coded (colors are editable) appear. If the Dataset version is Draft, then no labels appear.
|
||||
* If the Dataset version's status is *Published*, then the Dataset's top labels appear (colors are editable). If the
|
||||
Dataset version is *Draft*, then no labels appear.
|
||||
|
||||
:::note
|
||||
:::note Change Label Color
|
||||
To change the label color coding, hover over a label color, click thr hand pointer, and then select a new color.
|
||||
:::
|
||||
|
||||
### Renaming a Dataset
|
||||
1. Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-md space-sm" />
|
||||
1. Click **Rename** <img src="/docs/latest/icons/ico-edit.svg" alt="Edit pencil" className="icon size-md space-sm" />
|
||||
1. Edit the name
|
||||
1. Click <img src="/docs/latest/icons/ico-save.svg" alt="Check mark" className="icon size-md space-sm" />
|
||||
|
||||
### Editing Dataset-level Metadata
|
||||
To edit the dataset-level metadata
|
||||
1. Open the metadata edit window in one the following ways:
|
||||
* Click <img src="/docs/latest/icons/ico-status-completed.svg" alt="Check mark" className="icon size-md space-sm" />
|
||||
`Metadata`
|
||||
* Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bars menu" className="icon size-md space-sm" />, then click **Edit Metadata** <img src="/docs/latest/icons/ico-metadata.svg" alt="Edit metadata" className="icon size-md space-sm" />
|
||||
1. Edit the section contents (JSON format)
|
||||
1. Click **OK**
|
||||
|
||||
|
||||
|
||||
|
||||
## Creating New Datasets
|
||||
|
||||
Create a new Dataset which will contain one version named `Current`. The new version will not contain any frames.
|
||||
|
||||
@ -37,7 +37,8 @@ Use frame viewer controls to navigate between frames in a Hyper-Dataset Version,
|
||||
|<img src="/docs/latest/icons/ico-zoom-out.svg" alt="Zoom out icon" className="icon size-md space-sm" />|Zoom out| **-** or Ctrl + Mouse wheel |
|
||||
|Percentage textbox|Zoom percentage| <img src="/docs/latest/icons/ico-optional-no.svg" alt="Not applicable" className="icon size-md center-md" /> |
|
||||
|
||||
#### Additional keyboard shortcuts
|
||||
|
||||
#### Additional Keyboard Shortcuts
|
||||
|
||||
**General Controls**
|
||||
|
||||
@ -67,7 +68,7 @@ Use frame viewer controls to navigate between frames in a Hyper-Dataset Version,
|
||||
|
||||
**To view / edit a frame in the frame editor**
|
||||
|
||||
1. Locate your frame by applying a [simple frame filter](#simple-frame-filtering) or [advanced frame filter](#advanced-frame-filtering), and clicking <span class="tr_gui">LOAD MORE</span>, if required.
|
||||
1. Locate your frame by applying a [simple frame filter](#simple-frame-filtering) or [advanced frame filter](#advanced-frame-filtering), and clicking **LOAD MORE**, if required.
|
||||
1. Click the frame thumbnail. The frame editor appears.
|
||||
1. Do any of the following:
|
||||
* View frame details, including:
|
||||
@ -78,10 +79,10 @@ Use frame viewer controls to navigate between frames in a Hyper-Dataset Version,
|
||||
* Annotations
|
||||
* Frame objects - Labeled Regions of Interest, with confidence levels and custom metadata per frame object.
|
||||
* Frame labels - Labels applied to the entire frame, not a region in the frame.
|
||||
* Optionally, filter annotations by confidence level using the <span class="tr_gui">Minimum confidence</span> slider.
|
||||
* Optionally, filter annotations by confidence level using the **Minimum confidence** slider.
|
||||
* Add, change, and delete [annotations](#annotations) and [frame metadata](#frame-metadata).
|
||||
|
||||
:::important
|
||||
:::important Saving Frame Changes
|
||||
To save frames changes at any time, click **SAVE** (below the annotation list area).
|
||||
:::
|
||||
|
||||
@ -315,7 +316,7 @@ You can add annotations by drawing new bounding areas, and copying existing anno
|
||||
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" className="icon size-md space-sm" />.
|
||||
1. Optionally, click <img src="/docs/latest/icons/ico-edit.svg" alt="Edit pencil" className="icon size-md space-sm" />.
|
||||
|
||||
### Annotation Management
|
||||
|
||||
|
||||
@ -1,66 +1,57 @@
|
||||
---
|
||||
title: Dataset Versioning
|
||||
title: Dataset Versions
|
||||
---
|
||||
|
||||
Use the Dataset versioning WebApp (UI) features for viewing, creating, modifying, and
|
||||
deleting Dataset versions.
|
||||
deleting [Dataset versions](../dataset.md#dataset-versioning).
|
||||
|
||||
From the Datasets page, click on one of the Datasets in order to see and work with its versions.
|
||||
From the [Datasets page](webapp_datasets.md), click on one of the Datasets in order to see and work with its versions.
|
||||
|
||||
### Viewing Snapshots
|
||||
|
||||
View snapshots in the simple version structure using either:
|
||||
|
||||
* The simple view, a table of snapshots.
|
||||
## Dataset Version History
|
||||
The WebApp (UI) will present your dataset version structure in one of two ways, depending on the structure implemented.
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<summary className="cml-expansion-panel-summary">Simple view (snapshot table)</summary>
|
||||
<div className="cml-expansion-panel-content">
|
||||
## Simple View
|
||||
While your dataset maintains a simple (linear) [version structure](../dataset.md#dataset-version-structure), the WebApp
|
||||
(UI) will present the version history as a table of historic snapshots:
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</details>
|
||||
<br/>
|
||||
|
||||
* The advanced view, a tree of versions. The tree contains one version whose status is <i>Draft</i>, and snapshots appear in
|
||||
chronological order, with oldest at the top, and the most recent at the bottom.
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<summary className="cml-expansion-panel-summary">Advanced view (version tree)</summary>
|
||||
<div className="cml-expansion-panel-content">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
||||
### Creating Snapshots
|
||||
|
||||
To create a snapshot, you must be in the simple (version table) view.
|
||||
|
||||
**To create a snapshot, do the following:**
|
||||
|
||||
1. If you are in the advanced view, click **Switch to Simple View** (In certain situations, this may not be possible,
|
||||
see [Dataset Versioning](../dataset.md#dataset-versioning))
|
||||
1. If the **DATASET HISTORY** section is not opened, click it.
|
||||
1. If a snapshot is currently selected, click **RETURN TO CURRENT VERSION**.
|
||||
1. Click **+ CREATE SNAPSHOT**.
|
||||
1. Enter a version name, and optionally a description.
|
||||
1. Click **CREATE**.
|
||||
|
||||
|
||||
:::note
|
||||
The WebApp (UI) does not currently support the automatic naming of snapshots with timestamps appended. You must provide a snapshot name.
|
||||
:::note VERSION BROWSING
|
||||
Snapshots are always taken of the current version. If you are currently viewing a previous snapshot, click
|
||||
**RETURN TO CURRENT VERSION** to make snapshot creation available.
|
||||
:::
|
||||
|
||||
You can view your dataset’s explicit version structure and create a more complex structure by switching to the advanced
|
||||
view.
|
||||
|
||||
### Modifying Snapshot Name
|
||||
To modify a Dataset version name:
|
||||
1. Click the snapshot name on the top left of the dataset page
|
||||
1. Edit the name,
|
||||
1. Click <img src="/docs/latest/icons/ico-save.svg" alt="check" className="icon size-md space-sm" /> (check).
|
||||
|
||||
|
||||
## Advanced View
|
||||
|
||||
When employing a non-trivial [version structure](../dataset.md#dataset-version-structure) of your dataset, the WebApp
|
||||
(UI) presents the version history as a tree of versions.
|
||||
|
||||
|
||||
|
||||
### Creating Versions
|
||||
|
||||
To create a version, you must be in the advanced (version tree) view.
|
||||
|
||||
**To create a child version, do the following:**
|
||||
|
||||
1. If you are in the simple view, click **Switch to Advanced View**.
|
||||
1. Click the (parent) version from which to create a child (inherit all frames).
|
||||
1. Click **+ CREATE NEW VERSION**.
|
||||
1. Enter a version name, and optionally a description.
|
||||
@ -68,46 +59,195 @@ To create a version, you must be in the advanced (version tree) view.
|
||||
|
||||
### Publishing Versions
|
||||
|
||||
Publish (make read-only) any Dataset version whose status is *Draft*. If the Dataset is in the simple structure,
|
||||
and you publish the current version, then only the advanced view is available,
|
||||
and you cannot create snapshots.
|
||||
Publish (make read-only) any Dataset version whose status is *Draft*. If you publish a dataset's current version, the
|
||||
dataset's structure will no longer be considered a simple version structure.
|
||||
|
||||
**To publish a version, do the following:**
|
||||
|
||||
1. If you are in the simple view, click **Switch to Advanced View**.
|
||||
1. Click the version to publish.
|
||||
1. Click **PUBLISH**.
|
||||
1. Click **PUBLISH** again to confirm.
|
||||
|
||||
### Exporting Frames
|
||||
|
||||
Frame exports downloaded filtered frames as a JSON file.
|
||||
|
||||
**To export frames, do the following:**
|
||||
|
||||
* In the Thumbnails area, click **EXPORT FRAMES**. The frames JSON file downloads.
|
||||
|
||||
|
||||
### Modifying Version Names
|
||||
|
||||
**To modify a Dataset version name, do the following:**
|
||||
**To modify a Dataset version name:**
|
||||
1. Click the dataset version name on the top left of the dataset page
|
||||
1. Edit the name,
|
||||
1. Click <img src="/docs/latest/icons/ico-save.svg" alt="check" className="icon size-md space-sm" /> (check).
|
||||
|
||||
* At the top right of the Dataset page, hover over the Dataset version name, click <img src="/docs/latest/icons/ico-edit.svg" className="icon size-md space-sm" /> , edit the name, and then click <img src="/docs/latest/icons/ico-save.svg" className="icon size-md space-sm" /> (check).
|
||||
|
||||
### Modifying Version Descriptions
|
||||
|
||||
**To modify a version description, do the following:**
|
||||
|
||||
* Expand the **INFO** area, hover over the **Description**, click <img src="/docs/latest/icons/ico-edit.svg" alt="Edit pencil" className="icon size-md space-sm" />,
|
||||
edit the name, and then click <img src="/docs/latest/icons/ico-save.svg" alt="Check mark" className="icon size-md space-sm" /> (check).
|
||||
|
||||
### Deleting Versions
|
||||
|
||||
You can delete versions whose status is *Draft*.
|
||||
|
||||
**To delete the current version, do the following:**
|
||||
1. Click the version to delete.
|
||||
1. Click **DELETE**.
|
||||
1. Click **DELETE** again to confirm.
|
||||
|
||||
## Version Information
|
||||
Additional information about the selected dataset version is presented below the version selection panel in collapsible
|
||||
panels:
|
||||
|
||||
### Version Info Panel
|
||||
Provides general version information:
|
||||
* Version ID
|
||||
* Dataset ID
|
||||
* Dataset name
|
||||
* Status (*Draft* or *Published*)
|
||||
* Creating user
|
||||
* Version update time
|
||||
* Version description.
|
||||
|
||||
**To modify a version description, do the following:**
|
||||
|
||||
1. Expand the **INFO** area
|
||||
1. Hover over the **Description** element
|
||||
1. Click <img src="/docs/latest/icons/ico-edit.svg" alt="Edit pencil" className="icon size-md space-sm" />
|
||||
1. Edit the description
|
||||
1. Click <img src="/docs/latest/icons/ico-save.svg" alt="Check mark" className="icon size-md space-sm" /> (check)
|
||||
|
||||
### Version Metadata Panel
|
||||
Any version specific metadata, in JSON format.
|
||||
The content icon color signifies whether any metadata is currently accompanying the dataset version.
|
||||
|
||||
**To edit a version's metadata:**
|
||||
|
||||
1. Click <img src="/docs/latest/icons/ico-metadata.svg" alt="Edit metadata" className="icon size-md space-sm" /> on the
|
||||
**VERSION METADATA** panel to open the edit window
|
||||
1. Edit the section contents (JSON format)
|
||||
1. Click **OK**
|
||||
|
||||
### Version Label Statistics Panel
|
||||
Label usage stats for this dataset version.
|
||||
* Each label is listed along with the number of times it was used in the version
|
||||
* The pie chart visualizes these stats. Hover over a chart slice and its associated label and usage
|
||||
percentage will appear at the center of the chart.
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
To view further details about a specific frame, click on its preview, which will open the [Frame Viewer](webapp_datasets_frames.md#frame-viewer).
|
||||
|
||||
### Simple Frame Filtering
|
||||
Simple frame filtering applies one annotation object (ROI) label and returns frames containing at least one annotation
|
||||
with that label.
|
||||
|
||||
**To apply a simple frame filter,** select a label from the **LABEL FILTER** list.
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<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.
|
||||
|
||||
|
||||
|
||||
|
||||
* A simple label filter for `person` shows three frames, each containing at least one ROI labeled `person`.
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
||||
### Advanced Frame Filtering
|
||||
|
||||
Advanced frame filtering applies sophisticated filtering logic, which is composed of as many frame filters as needed,
|
||||
where each frame filter can be a combination of ROI, frame, and source rules.
|
||||
* ROI rules use include and exclude logic to match frames by ROI label; an ROI label can match frames containing at least
|
||||
one annotation object (ROI) with all labels in the rule.
|
||||
* Frame rules and source rules use Lucene queries with AND, OR, and NOT logic. Frame rules apply to frame metadata.
|
||||
* Source rules apply to frame source information.
|
||||
|
||||
**To apply advanced filters:**
|
||||
1. In the **Version Browser**, click **Switch to advanced filters**.
|
||||
1. In a **FRAME FILTER**, create one of the following rules:
|
||||
* ROI rule
|
||||
* Choose **Include** or **Exclude**, select ROI labels, and optionally set the confidence level range.
|
||||
* To switch from the ROI dropdown list to a Lucene query mode, click <img src="/docs/latest/icons/ico-edit.svg" alt="Setting Gear" className="icon size-md space-sm" />.
|
||||
* Frame rule - Enter a Lucene query using frame metadata fields in the format `meta.<key>:<value>`.
|
||||
* Source rule - Enter a Lucene query using frame metadata fields in the format `sources.<key>:<value>`.
|
||||
|
||||
#### Filtering Examples
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<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).
|
||||
|
||||
|
||||
|
||||
* 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.
|
||||
|
||||
|
||||
|
||||
* By opening a frame in the frame viewer, you can see an ROI labeled with both.
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</details>
|
||||
<br/>
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<summary className="cml-expansion-panel-summary">Frame Rules</summary>
|
||||
<div className="cml-expansion-panel-content">
|
||||
|
||||
Filter by metadata using Lucene queries.
|
||||
|
||||
* Add a frame rule to filter by the metadata key `dangerous` for the value of `no`.
|
||||
|
||||
|
||||
|
||||
* Open a frame in the frame viewer to see its metadata.
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</details>
|
||||
<br/>
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
<summary className="cml-expansion-panel-summary">Source Rules</summary>
|
||||
<div className="cml-expansion-panel-content">
|
||||
|
||||
Filter by sources using Lucene queries.
|
||||
|
||||
* Add a source rule to filter for sources URIs with a wildcards.
|
||||
|
||||
|
||||
|
||||
Lucene queries can also be used in ROI label filters and frame rules.
|
||||
|
||||
</div>
|
||||
</details>
|
||||
|
||||
### Exporting Frames
|
||||
|
||||
To export (download) filtered datasets as a JSON file, click **EXPORT FRAMES**.
|
||||
|
||||
### Frame Browser Configuration
|
||||
Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" /> to open the
|
||||
frame browser configuration settings.
|
||||
|
||||
#### 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.
|
||||
|
||||
Use the **Grouping** menu to select one of the following options:
|
||||
* Split Preview - Show separate previews for each individual FrameGroup, regardless of shared context.
|
||||
* Group by URL - Show a single preview for all FrameGroups with the same context
|
||||
|
||||
#### Preview Source
|
||||
When using multi-source FrameGroups, users can choose which of the FrameGroups’ sources will be displayed as the preview.
|
||||
|
||||
Use the **PREVIEW SOURCE** menu to select from the list of sources.
|
||||
Choose the `Default preview source` option to present the first available source.
|
||||
|
||||
:::note
|
||||
If a FrameGroup doesn't have the selected preview source, the next available source will be used for the preview.
|
||||
:::
|
||||
|
||||
* If you are in the simple view, click **Switch to Advanced View**.
|
||||
* Click the version to delete.
|
||||
* Click **DELETE**.
|
||||
* Click **DELETE** again to confirm.
|
||||
|
||||
@ -53,6 +53,7 @@ The following table describes the actions that can be performed from the Datavie
|
||||
| Archive | To more easily work with active Dataviews, move a Dataview to the archive. See [Archiving Dataviews](#archiving-dataviews). |
|
||||
| Clone | Make an exact copy of a Dataview. |
|
||||
| Move to project | To organize work and improve collaboration, move a Dataview to another project. |
|
||||
| Custom action | When available, provides a mechanism to define your own custom action which will appear in the context menu. See [Custom UI Context Menu Actions](../../deploying_clearml/clearml_server_config.md#custom-ui-context-menu-actions).|
|
||||
|
||||
These actions can be accessed with the context menu (when right-clicking a Dataview or clicking the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
|
||||
in a Dataview's info panel).
|
||||
|
||||
BIN
docs/img/webapp_compare_add.png
Normal file
BIN
docs/img/webapp_compare_add.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 282 KiB |
@ -34,7 +34,6 @@ The **ClearML** experiment comparison provides [comparison features](#comparison
|
||||
1. In the bottom bar, click **COMPARE**. The comparison page appears, showing a column for each experiment and differences with a highlighted background color. The experiment on the left is the base experiment. Other experiments compare to the base experiment.
|
||||
|
||||
|
||||
|
||||
## Details
|
||||
|
||||
The **DETAILS** tab includes deep comparisons of the following:
|
||||
@ -230,7 +229,7 @@ first. Use the viewer / player to inspect images, audio, video samples and do an
|
||||
|
||||
To assist in experiment analysis, the comparison page supports:
|
||||
|
||||
* [Adding experiments to the comparison](#adding-experiments-to-the-comparison) using a partial name search.
|
||||
* [Changing compared experiments selection](#changing-compared-experiments-selection)
|
||||
* [Finding the next or previous difference](#finding-the-next-or-previous-difference).
|
||||
* [Hiding identical fields](#hiding-identical-fields)
|
||||
* [Searching all text](#searching-all-text)
|
||||
@ -241,13 +240,16 @@ To assist in experiment analysis, the comparison page supports:
|
||||
|
||||
|
||||
|
||||
### Adding Experiments to the Comparison
|
||||
### Changing Compared Experiments Selection
|
||||
|
||||
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
|
||||
an experiment, click <img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-md" />.
|
||||
1. Click **+ Add Experiment** in the top left corner of any of the comparison pages. This will open up a window with an
|
||||
experiment table with the currently compared experiments at the top.
|
||||
1. Find the experiments to add by sorting and [filtering](webapp_exp_table.md#filtering-columns) the experiments with
|
||||
the appropriate column header controls. Alternatively, use the search bar to find experiments by name.
|
||||
1. Select experiments to include in the comparison (and / or clear the selection of any experiment you wish to remove).
|
||||
1. Click **APPLY**.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -273,7 +275,7 @@ Search all text in the comparison.
|
||||
### 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:
|
||||
* Click on <img src="/docs/latest/icons/ico-switch-base.svg" alt="Switch base" 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" alt="Switch base experiment" 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-pan.svg" alt="Pan" className="icon size-md space-sm" /> the new base experiment and drag it all the way to the left
|
||||
|
||||
|
||||
|
||||
@ -85,8 +85,13 @@ experiments in the table.
|
||||
|
||||
* 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.
|
||||
|
||||
:::note Float Values Display
|
||||
By default, the experiments table displays rounded up float values. Hover over a float to view its precise value in the
|
||||
tooltip that appears. To view all precise values in a column, hover over a float and click <img src="/docs/latest/icons/ico-line-exapnd.svg" alt="Expand" className="icon size-md" />.
|
||||
:::
|
||||
|
||||
### Filtering Experiments
|
||||
### Filtering Columns
|
||||
|
||||
|
||||
|
||||
@ -97,12 +102,15 @@ There are a few types of filters:
|
||||
* Value set - Choose which values to include from a list of all values in the column
|
||||
* Numerical ranges - Insert minimum and / or maximum value
|
||||
* Date ranges - Insert starting and / or ending date and time
|
||||
* Tags - Choose which tags to include from a list of all tags used in the column. Additionally, tags can be filtered using
|
||||
the **ANY** or **ALL** options, which correspond to the logical "AND" and "OR" respectively. These options appear
|
||||
on the top of the tag list.
|
||||
* Tags - Choose which tags to filter by from a list of all tags used in the column.
|
||||
* Filter by multiple tag values using the **ANY** or **ALL** options, which correspond to the logical "AND" and "OR" respectively. These
|
||||
options appear on the top of the tag list.
|
||||
* Filter by the absence of a tag (logical "NOT") by clicking its checkbox twice. An `X` will appear in the tag's checkbox.
|
||||
|
||||
Once a filter is applied to a column, its filter icon will appear with a highlighted dot on its top right (<img src="/docs/latest/icons/ico-filter-on.svg" alt="Filter on" className="icon size-md" /> ).
|
||||
|
||||
To clear all active filters, click <img src="/docs/latest/icons/ico-filter-reset.svg" alt="Clear filters" className="icon size-md" />
|
||||
in the top right corner of the table.
|
||||
|
||||
|
||||
|
||||
@ -118,7 +126,7 @@ Once a filter is applied to a column, its filter icon will appear with a highlig
|
||||
|
||||
## Experiment Actions
|
||||
|
||||
The following table describes the actions that can be done from the experiments table, including the [states](../fundamentals/task.md#task-states-and-state-transitions)
|
||||
The following table describes the actions that can be done from the experiments table, including the [states](../fundamentals/task.md#task-states)
|
||||
that allow each operation.
|
||||
|
||||
| Action | Description | States Valid for the Action | State Transition |
|
||||
@ -132,17 +140,19 @@ that allow each operation.
|
||||
| Dequeue | Remove an experiment from a queue. | *Pending* | *Draft* |
|
||||
| Reset | Delete the log and output from a previous run of an experiment (for example, before rerunning it). | *Completed*, *Aborted*, or *Failed* | *Draft* |
|
||||
| Abort | Manually terminate a *Running* experiment. | *Running* | *Aborted* |
|
||||
| Abort All Children | Manually terminate all *Running* experiments which have this task as a parent | *Running* or *Aborted* | None for parent experiment, *Aborted* for child experiments |
|
||||
| Publish | Publish an experiment to prevent changes to its tracking data, inputs, and outputs. Published experiments and their models are read-only. *Published* experiments cannot be enqueued, but they can be cloned, and their clones can be edited, tuned, and enqueued. | *Completed*, *Aborted*, or *Failed*. | *Published* |
|
||||
| Tags | Tag experiments with color-coded labels to assist you in organizing your work. See [tagging experiments](webapp_exp_track_visual#tagging-experiments). | Any state | None |
|
||||
| Clone | Make an exact, editable copy of an experiment (for example, to reproduce an experiment, but keep the original). | *Draft* | Newly Cloned Experiment is *Draft* |
|
||||
| Move | Move an experiment to another project. | Any state | None |
|
||||
| Custom action | The ClearML Enterprise Server provides a mechanism to define your own custom actions, which will appear in the context menu. See [Custom UI Context Menu Actions](../deploying_clearml/clearml_server_config#custom-ui-context-menu-actions). | Any State | None |
|
||||
|
||||
These actions can be accessed with the context menu (when right-clicking an experiment or clicking the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
|
||||
in an experiment's info panel).
|
||||
|
||||
|
||||
Most of the actions mentioned in the chart above can be performed on multiple experiments at once.
|
||||
Select multiple experiments, then use either the context menu, or the bar that appears at the bottom of the page, to perform
|
||||
[Select multiple experiments](#selecting-multiple-experiments), then use either the context menu, or the bar that appears at the bottom of the page, to perform
|
||||
operations on the selected experiments. Actions can be performed only on the experiments that match the action criteria
|
||||
(for example, only *Running* experiments can be aborted). The context menu shows the number
|
||||
of experiments that can be affected by each action. The same information can be found in the bottom menu, in a tooltip that
|
||||
@ -150,6 +160,18 @@ appears when hovering over an action icon.
|
||||
|
||||
|
||||
|
||||
## Selecting Multiple Experiments
|
||||
|
||||
Select multiple experiments by clicking the checkbox on the left of each relevant experiment. Clear any existing selection
|
||||
by clicking the checkbox in the top left corner of the table.
|
||||
|
||||
Click the checkbox in the top left corner of the table to select all items currently visible.
|
||||
|
||||
An extended bulk selection tool is available through the down arrow next to the checkbox in the top left corner, enabling
|
||||
selecting items beyond the items currently on-screen:
|
||||
* **All** - Select all experiments in the project
|
||||
* **None** - Clear Selection
|
||||
* **Filtered** - Select **all experiments in the project** that match the current active filters in the project
|
||||
|
||||
## Creating an Experiment Leaderboard
|
||||
|
||||
|
||||
@ -5,18 +5,18 @@ title: Tracking Experiments and Visualizing Results
|
||||
While an experiment is running, and any time after it finishes, track it and visualize the results in the **ClearML Web UI**,
|
||||
including:
|
||||
|
||||
* [Execution details](#execution-details) - Code, the base Docker image used for **[ClearML Agent](../clearml_agent.md)**, output destination for artifacts, and the logging level.
|
||||
* [Execution details](#execution-details) - Code, the base Docker image used for [ClearML Agent](../clearml_agent.md), output destination for artifacts, and the logging level.
|
||||
* [Configuration](#configuration) - Hyperparameters, user properties, and configuration objects.
|
||||
* [Artifacts](#artifacts) - Input model, output model, model snapshot locations, other artifacts.
|
||||
* [General information](#general-information) - Information about the experiment, for example: the experiment start, create, and last update times and dates, user creating the experiment, and its description.
|
||||
* [Console](#console) - stdout, stderr, output to the console from libraries, and **ClearML** explicit reporting.
|
||||
* [Console](#console) - stdout, stderr, output to the console from libraries, and ClearML explicit reporting.
|
||||
* [Scalars](#scalars) - Metric plots.
|
||||
* [Plots](#plots) - Other plots and data, for example: Matplotlib, Plotly, and **ClearML** explicit reporting.
|
||||
* [Plots](#plots) - Other plots and data, for example: Matplotlib, Plotly, and ClearML explicit reporting.
|
||||
* [Debug samples](#debug-samples) - Images, audio, video, and HTML.
|
||||
|
||||
## Viewing Modes
|
||||
|
||||
The **ClearML Web UI** provides two viewing modes for experiment details:
|
||||
The ClearML Web UI provides two viewing modes for experiment details:
|
||||
|
||||
* The info panel
|
||||
|
||||
@ -59,7 +59,7 @@ table is not visible when the full screen details view is open. Perform experime
|
||||
## Execution Details
|
||||
In the EXECUTION tab of an experiment's detail page, there are records of:
|
||||
* Source code
|
||||
* **ClearML Agent** configuration
|
||||
* ClearML Agent configuration
|
||||
* Output details
|
||||
* Uncommitted changes
|
||||
* Installed Python packages
|
||||
@ -73,8 +73,8 @@ The source code details of the EXECUTION tab of an experiment include:
|
||||
* Script path
|
||||
* Working directory
|
||||
|
||||
Additionally, there is information about the **ClearML Agent** configuration. The **ClearML Agent** base image is a pre-configured Docker
|
||||
that **ClearML Agent** will use to remotely execute this experiment (see [Building Docker containers](../clearml_agent.md#building-docker-containers)).
|
||||
Additionally, there is information about the ClearML Agent configuration. The ClearML Agent base image is a pre-configured
|
||||
Docker that ClearML Agent will use to remotely execute this experiment (see [Building Docker containers](../clearml_agent.md#exporting-a-task-into-a-standalone-docker-container)).
|
||||
|
||||
The output details include:
|
||||
* The output destination used for storing model checkpoints (snapshots) and artifacts (see also, [default_output_uri](../configs/clearml_conf#config_default_output_uri)
|
||||
@ -203,9 +203,9 @@ except experiments whose status is *Published* (read-only).
|
||||
|
||||
### Configuration Objects
|
||||
|
||||
**ClearML** tracks experiment (Task) model configuration objects, which appear in **Configuration Objects** **>** **General**.
|
||||
ClearML tracks experiment (Task) model configuration objects, which appear in **Configuration Objects** **>** **General**.
|
||||
These objects include those that are automatically tracked, and those connected to a Task in code (see [Task.connect_configuration](../references/sdk/task.md#connect_configuration)).
|
||||
**ClearML** supports providing a name for a Task model configuration object (see the [name](../references/sdk/task.md#connect_configuration)
|
||||
ClearML supports providing a name for a Task model configuration object (see the [name](../references/sdk/task.md#connect_configuration)
|
||||
parameter in `Task.connect_configuration`).
|
||||
|
||||
:::important
|
||||
@ -278,7 +278,7 @@ including design, label enumeration, and general information, go to the **MODELS
|
||||
|
||||
#### Data Audit
|
||||
|
||||
Artifacts which are uploaded and dynamically tracked by **ClearML** appear in the **DATA AUDIT** section. They include the file path, file size, hash, and metadata stored with the artifact.
|
||||
Artifacts which are uploaded and dynamically tracked by ClearML appear in the **DATA AUDIT** section. They include the file path, file size, hash, and metadata stored with the artifact.
|
||||
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
@ -362,11 +362,18 @@ is downloadable. To view the end of the log, click **Jump to end**.
|
||||
|
||||
### Scalars
|
||||
|
||||
All scalars that **ClearML** automatically logs, as well as those explicitly reported in code, appear in **RESULTS** **>** **SCALARS**.
|
||||
All scalars that ClearML automatically logs, as well as those explicitly reported in code, appear in **RESULTS** **>**
|
||||
**SCALARS**. Scalar values are presented as time series line chart. To see the series for a metric in high resolution,
|
||||
view it in full screen mode by hovering over the graph and clicking <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" />.
|
||||
|
||||
:::info Full Screen Refresh
|
||||
Scalar graphs in full screen mode do not auto-refresh. Click <img src="/docs/latest/icons/ico-reset.svg" alt="Refresh" className="icon size-sm space-sm" />
|
||||
to update the graph.
|
||||
:::
|
||||
|
||||
#### Scalar Plot 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
|
||||
Use the scalar tools to improve analysis of scalar metrics. In the info panel, click <img src="/docs/latest/icons/ico-settings.svg" alt="Settings gear" 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:
|
||||
* **Group by** - Select one of the following:
|
||||
* **Metric** - All variants for a metric on the same plot
|
||||
@ -404,7 +411,7 @@ See additional [plot controls](#plot-controls) below.
|
||||
|
||||
### Plots
|
||||
Non-time-series plots appear in **RESULTS** **>** **PLOTS**. These include data reported by libraries, visualization
|
||||
tools, and **ClearML** explicit reporting. These may include 2D and 3D plots, tables (Pandas and CSV files), and Plotly plots.
|
||||
tools, and ClearML explicit reporting. These may include 2D and 3D plots, tables (Pandas and CSV files), and Plotly plots.
|
||||
Individual plots can be shown / hidden or filtered by title.
|
||||
|
||||
<details className="cml-expansion-panel screenshot">
|
||||
@ -439,7 +446,8 @@ These controls allow you to better analyze the results. Hover over a plot, and t
|
||||
| <img src="/docs/latest/icons/ico-logarithmic-view.svg" alt="Logarithmic view icon" className="icon size-sm space-sm" /> | Switch to logarithmic view. |
|
||||
| <img src="/docs/latest/icons/ico-ico-graph-legend.svg" alt="Graph legend icon" className="icon size-sm space-sm" /> | Hide / show the legend. |
|
||||
| <img src="/docs/latest/icons/ico-download-json.svg" alt="Download JSON icon" className="icon size-sm space-sm" /> | To get metric data for further analysis, download plot data to JSON file. |
|
||||
| <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" /> | Expand plot to entire window. |
|
||||
| <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" /> | Expand plot to entire window. When used with scalar graphs, full screen mode displays plots with all data points, as opposed to an averaged plot |
|
||||
| <img src="/docs/latest/icons/ico-reset.svg" alt="Refresh" className="icon size-sm space-sm" /> | Refresh scalar graphs in full screen mode to update it |
|
||||
|
||||
#### 3D Plot Controls
|
||||
|Icon|Description|
|
||||
@ -455,7 +463,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).
|
||||
* Show the next or previous iteration's sample.
|
||||
* Download the file <img src="/docs/latest/icons/ico-download.svg" className="icon size-md space-sm" />.
|
||||
* Download the file <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />.
|
||||
* Zoom.
|
||||
* View the sample's iteration number, width, height, and coordinates.
|
||||
|
||||
@ -487,7 +495,9 @@ View debug samples by metric at any iteration. The most recent iteration appears
|
||||
1. Locate debug samples by doing the following:
|
||||
|
||||
* Filter by metric. In the **Metric** list, choose a metric.
|
||||
* 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).
|
||||
* 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="Skip to newest arrow" className="icon size-md space-sm" /> (Newest images).
|
||||
|
||||
**To view a debug sample in the viewer / player:**
|
||||
|
||||
@ -496,7 +506,7 @@ View debug samples by metric at any iteration. The most recent iteration appears
|
||||
1. Do any of the following:
|
||||
|
||||
* Move to the same sample in another iteration - Move the slider, or click **<** (previous) or **>** (next).
|
||||
* Download the file - Click <img src="/docs/latest/icons/ico-download.svg" className="icon size-md space-sm" />.
|
||||
* Download the file - Click <img src="/docs/latest/icons/ico-download.svg" alt="Download" className="icon size-md space-sm" />.
|
||||
* Zoom
|
||||
* For images, locate a position on the sample - Hover over the sample and the X, Y coordinates appear in the legend below the sample.
|
||||
|
||||
|
||||
@ -64,6 +64,7 @@ allow each feature. Model states are *Draft* (editable) and *Published* (read-on
|
||||
| Tags | Tag models with color-coded labels to assist in organizing work. See [tagging models](#tagging-models). | Any state |
|
||||
| Download | Download a model. The file format depends upon the framework. | *Published* |
|
||||
| Move to project | To organize work and improve collaboration, move a model to another project. | Any state |
|
||||
| Custom action | The ClearML Enterprise Server provides a mechanism to define your own custom actions, which will appear in the context menu. See [Custom UI Context Menu Actions](../deploying_clearml/clearml_server_config.md#custom-ui-context-menu-actions). | Any state |
|
||||
|
||||
These actions can be accessed with the context menu (when right-clicking a model or clicking the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
|
||||
in a model's info panel).
|
||||
@ -90,3 +91,21 @@ experiments execute on, label versions of experiments, or apply team names to or
|
||||
* Change a tag's colors - Click **Tag Colors** **>** Click the tag icon **>** **Background** or **Foreground**
|
||||
**>** Pick a color **>** **OK** **>** **CLOSE**.
|
||||
* To remove a tag - Hover over the tag **>** **X**.
|
||||
|
||||
## Filtering Columns
|
||||
|
||||
Filters can be applied by clicking <img src="/docs/latest/icons/ico-filter-off.svg" alt="Filter" className="icon size-md" />
|
||||
on a column, and the relevant filter appears.
|
||||
|
||||
There are a couple filter types:
|
||||
* Value set - Choose which values to include from a list of all values in the column
|
||||
* Tags - Choose which tags to filter by from a list of all tags used in the column.
|
||||
* Filter by multiple tag values using the **ANY** or **ALL** options, which correspond to the logical "AND" and "OR" respectively. These
|
||||
options appear on the top of the tag list.
|
||||
* Filter by the absence of a tag (logical "NOT") by clicking its checkbox twice. An `X` will appear in the tag's checkbox.
|
||||
|
||||
Once a filter is applied to a column, its filter icon will appear with a highlighted dot on its top right
|
||||
(<img src="/docs/latest/icons/ico-filter-on.svg" alt="Filter on" className="icon size-md" /> ).
|
||||
|
||||
To clear all active filters, click <img src="/docs/latest/icons/ico-filter-reset.svg" alt="Clear filters" className="icon size-md" />
|
||||
in the top right corner of the table.
|
||||
@ -69,10 +69,12 @@ Optimize worker use by monitoring worker utilization in the **Workers** tab.
|
||||
In the **Queues** tab, do any of the following:
|
||||
|
||||
* Create a queue - Click **+ NEW QUEUE** (top right) **>** Type a queue name **>** **CREATE**.
|
||||
* Do either of the following by clicking a queue in the queues list (lower right):
|
||||
* Rename a queue - Click **RENAME** > Type a queue name **>** **RENAME**, or click **DELETE**.
|
||||
* Do any of the following by right-clicking a queue in the queues list (lower right):
|
||||
* Delete a queue - Click **Delete**.
|
||||
* Do any of the following by right clicking an experiment in a queue's **EXPERIMENTS** tab (lower right):
|
||||
* Rename a queue - Click **RENAME** > Type a queue name **>** **RENAME**, or click **DELETE**.
|
||||
* Custom action - The ClearML Enterprise Server provides a mechanism to define your own custom actions, which will
|
||||
appear in the context menu. See [Custom UI Context Menu Actions](../deploying_clearml/clearml_server_config.md#custom-ui-context-menu-actions).
|
||||
* Do any of the following by right-clicking an experiment in a queue's **EXPERIMENTS** tab (lower right):
|
||||
* Reorder experiments in a queue - Drag an experiment to a new position in the queue, or click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Menu button" className="icon size-md space-sm" />
|
||||
(menu) and then select **Move to top** or **Move to bottom**.
|
||||
* Move to a new queue - Click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Menu button" className="icon size-md space-sm" /> (menu) **>** **Move to queue...** **>** Select a queue **>** **ENQUEUE**.
|
||||
|
||||
1
static/icons/ico-filter-reset.svg
Normal file
1
static/icons/ico-filter-reset.svg
Normal file
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M21.82843,19.82843a1.00007,1.00007,0,0,1-1.41422,0L19,18.41421l-1.41421,1.41422a1,1,0,0,1-1.41422-1.41422L17.58579,17l-1.41422-1.41421a1,1,0,0,1,1.41422-1.41422L19,15.58579l1.41421-1.41422a1,1,0,0,1,1.41422,1.41422L20.41421,17l1.41422,1.41421A1.00007,1.00007,0,0,1,21.82843,19.82843Z" fill="#ed8a83"/><path d="M19.80975,5.54242,14,12v7a.97112.97112,0,0,1-1.73755.6189L10,17V12L4.19025,5.54242C3.48883,4.518,4.54529,4,5.00543,4H18.99457C19.45471,4,20.51117,4.518,19.80975,5.54242Z" fill="#8f9dc9"/><path d="M24,24H0V0H24Z" fill="none"/></svg>
|
||||
|
After Width: | Height: | Size: 633 B |
1
static/icons/ico-metadata.svg
Normal file
1
static/icons/ico-metadata.svg
Normal file
@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M9.50037,13.50037l7.87194-8.379L19.87195,7.621,12,16l-2.347.52277a.66661.66661,0,0,1-.66656-.66657ZM21.80505,4.75476,20.24524,3.195a.66381.66381,0,0,0-.93988,0L18.07892,4.41479l2.49963,2.49964,1.2265-1.21985A.66374.66374,0,0,0,21.80505,4.75476ZM19,11.167V19a1.001,1.001,0,0,1-1,1H5a1.001,1.001,0,0,1-1-1V10A1.001,1.001,0,0,1,5,9h5.89685l2-2H5a3.00328,3.00328,0,0,0-3,3v9a3.00328,3.00328,0,0,0,3,3H18a3.00328,3.00328,0,0,0,3-3V10a2.96813,2.96813,0,0,0-.10089-.73212Z" fill="#8f9dc9"/><path d="M24,24H0V0H24Z" fill="none"/></svg>
|
||||
|
After Width: | Height: | Size: 619 B |
Loading…
Reference in New Issue
Block a user