ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-05-19 11:41:56 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fix icon links

Browse Source
This commit is contained in:
allegroai 2021-06-21 14:57:22 +03:00
parent 81bcabcb10
commit bc66f854d4
5 changed files with 175 additions and 175 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/hyperdatasets/webapp/webapp_annotator.md
View File

@ -2,8 +2,8 @@
title: Annotation Tasks title: Annotation Tasks
--- ---
Use the Annotations page to access and manage annotation Tasks. Use the Annotations page to access and manage annotation Tasks.
Use annotation tasks to efficiently organize the annotation of frames in Dataset versions and manage the work of annotators Use annotation tasks to efficiently organize the annotation of frames in Dataset versions and manage the work of annotators
(see [Annotating Images and Videos](#annotating-images-and-video)). (see [Annotating Images and Videos](#annotating-images-and-video)).
## Managing Annotation Tasks ## Managing Annotation Tasks
@ -16,43 +16,43 @@ Use annotation tasks to efficiently organize the annotation of frames in Dataset
**To create an annotation task:** **To create an annotation task:**
1. On the Annotator page, click **+ ADD NEW ANNOTATION**. 1. On the Annotator page, click **+ ADD NEW ANNOTATION**.
1. Enter a name for your new annotation task. 1. Enter a name for your new annotation task.
1. Choose a Dataset version to annotate. If the selected Dataset version's status is *Published*, then creating this 1. Choose a Dataset version to annotate. If the selected Dataset version's status is *Published*, then creating this
annotation task also creates a child version of the selected version. The new child version's status is *Draft*, and annotation task also creates a child version of the selected version. The new child version's status is *Draft*, and
its name is the same as the annotation task. its name is the same as the annotation task.
1. Set the filters for the frames this annotation task presents to the annotator. 1. Set the filters for the frames this annotation task presents to the annotator.
* In the **SET FILTERS** list, choose either: * In the **SET FILTERS** list, choose either:
* **All Frames** - Include all frames in this task. * **All Frames** - Include all frames in this task.
* **Empty Frames** - Include only frames without any annotations in this task. * **Empty Frames** - Include only frames without any annotations in this task.
* **By Label** - Include only frames with specific labels, and optionally filter these frames by confidence level and * **By Label** - Include only frames with specific labels, and optionally filter these frames by confidence level and
the number of instances. You can also click <img src="/static/icons/ico-code.svg" className="icon size-md space-sm" /> and then add a Lucene query for this ROI label filter. the number of instances. You can also click <img src="/docs/latest/static/icons/ico-code.svg" className="icon size-md space-sm" /> and then add a Lucene query for this ROI label filter.
1. Choose the iteration parameters specifying how frames in this version are presented to the annotator. 1. Choose the iteration parameters specifying how frames in this version are presented to the annotator.
1. In **ITERATION**, in the **ORDER** list, choose either: 1. In **ITERATION**, in the **ORDER** list, choose either:
* **Sequential** - Frames are sorted by the frame top-level `context_id` (primary sort key) and `timestamp` (secondary sort key) metadata key values, and returned by the iterator in the sorted order. * **Sequential** - Frames are sorted by the frame top-level `context_id` (primary sort key) and `timestamp` (secondary sort key) metadata key values, and returned by the iterator in the sorted order.
* **Random** - Frames are randomly returned using the value of the `random_seed` argument. The random seed is maintained with the experiments. Therefore, the random order is reproducible if the experiment is rerun. * **Random** - Frames are randomly returned using the value of the `random_seed` argument. The random seed is maintained with the experiments. Therefore, the random order is reproducible if the experiment is rerun.
1. In **REPETITION**, choose either **Use Each Frame Once** or **Limit Frames**. If you select **Limit Frames**, then in **Use Max. Frames**, type the number of frames to annotate. 1. In **REPETITION**, choose either **Use Each Frame Once** or **Limit Frames**. If you select **Limit Frames**, then in **Use Max. Frames**, type the number of frames to annotate.
1. If iterating randomly, in **RANDOM SEED** type your seed or leave blank, and the ClearML Enterprise platform generates a seed for you. 1. If iterating randomly, in **RANDOM SEED** type your seed or leave blank, and the ClearML Enterprise platform generates a seed for you.
1. If annotating video, then in **CLIP LENGTH (FOR VIDEO)**, type of the number of sequential frames per iteration to annotate. 1. If annotating video, then in **CLIP LENGTH (FOR VIDEO)**, type of the number of sequential frames per iteration to annotate.
1. Click **Create**. 1. Click **Create**.
### Completing annotation tasks ### Completing annotation tasks
To mark an annotation task as **Completed**: To mark an annotation task as **Completed**:
* In the annotation task card, click <img src="/static/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu) **>** **Complete** **>** **CONFIRM**. * In the annotation task card, click <img src="/docs/latest/static/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu) **>** **Complete** **>** **CONFIRM**.
### Deleting annotation tasks ### Deleting annotation tasks
To delete an annotation task: To delete an annotation task:
* In the annotation task card, click <img src="/static/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu) **>** **Delete** **>** **CONFIRM**. * In the annotation task card, click <img src="/docs/latest/static/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu) **>** **Delete** **>** **CONFIRM**.
### Filtering annotation tasks ### Filtering annotation tasks
@ -63,18 +63,18 @@ There are two option for filtering annotation tasks:
### Sorting annotation tasks ### Sorting annotation tasks
Sort the annotation tasks by either using **RECENT** or **NAME** from the drop-down menu on the top left of the page. Sort the annotation tasks by either using **RECENT** or **NAME** from the drop-down menu on the top left of the page.
### Viewing annotation task information ### Viewing annotation task information
To View the Dataset version, filters, and iteration information: To View the Dataset version, filters, and iteration information:
* In the annotation task card, click <img src="/static/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu) **>** **Info** * In the annotation task card, click <img src="/docs/latest/static/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu) **>** **Info**
## Annotating Images and Video ## Annotating Images and Video
Annotate images and video by labeling regions of interest in Dataset version frames. The frames presented for annotation Annotate images and video by labeling regions of interest in Dataset version frames. The frames presented for annotation
depend upon the settings in the annotation task (see [Creating Annotation Tasks](#creating-annotation-tasks)). depend upon the settings in the annotation task (see [Creating Annotation Tasks](#creating-annotation-tasks)).
@ -82,7 +82,7 @@ depend upon the settings in the annotation task (see [Creating Annotation Tasks]
**To annotate frames:** **To annotate frames:**
1. On the Annotator page, click the annotation task card, or click <img src="/static/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu) 1. On the Annotator page, click the annotation task card, or click <img src="/docs/latest/static/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu)
and then click **Annotate**. and then click **Annotate**.
1. See instructions below about annotating frames. 1. See instructions below about annotating frames.
@ -91,20 +91,20 @@ depend upon the settings in the annotation task (see [Creating Annotation Tasks]
1. Select an annotation mode and add the bounded area to the frame image. 1. Select an annotation mode and add the bounded area to the frame image.
* Rectangle mode - Click <img src="/static/icons/ico-rectangle-icon-purple.svg" className="icon size-md space-sm" /> and then click the image, drag and release. * Rectangle mode - Click <img src="/docs/latest/static/icons/ico-rectangle-icon-purple.svg" className="icon size-md space-sm" /> and then click the image, drag and release.
* Polygon mode - Click <img src="/static/icons/ico-polygon-icon-purple.svg" className="icon size-md space-sm" /> and then click the image for the first vertex, * Polygon mode - Click <img src="/docs/latest/static/icons/ico-polygon-icon-purple.svg" className="icon size-md space-sm" /> and then click the image for the first vertex,
move to another vertex and click, continue until closing the last vertex. move to another vertex and click, continue until closing the last vertex.
* Key points mode - Click <img src="/static/icons/ico-keypoint-icon-purple.svg" className="icon size-md space-sm" /> and then click each key point. * Key points mode - Click <img src="/docs/latest/static/icons/ico-keypoint-icon-purple.svg" className="icon size-md space-sm" /> and then click each key point.
1. In the new label area, choose or enter a label. 1. In the new label area, choose or enter a label.
1. Optionally, add metadata. 1. Optionally, add metadata.
1. Optionally, lock the annotation. 1. Optionally, lock the annotation.
#### Add frame labels #### Add frame labels
1. In **FRAME LABEL**, click **+ Add new**. 1. In **FRAME LABEL**, click **+ Add new**.
1. In the new label area, choose or enter a label. 1. In the new label area, choose or enter a label.
1. Optionally, add metadata. 1. Optionally, add metadata.
1. Optionally, lock the annotation. 1. Optionally, lock the annotation.
#### Copy / paste an annotations #### Copy / paste an annotations

136
docs/hyperdatasets/webapp/webapp_datasets_frames.md
View File

@ -2,18 +2,18 @@
title: Working with Frames title: Working with Frames
--- ---
View and edit SingleFrames in the Dataset page. After selecting a Dataset version, the **Version Browser** shows a sample View and edit SingleFrames in the Dataset page. After selecting a Dataset version, the **Version Browser** shows a sample
of frames and enables viewing SingleFrames and FramesGroups, and edit SingleFrames, in the [frame viewer](#frame-viewer). of frames and enables viewing SingleFrames and FramesGroups, and edit SingleFrames, in the [frame viewer](#frame-viewer).
Before opening the frame viewer, you can filter the frames by applying [simple](#simple-frame-filtering) or [advanced](#advanced-frame-filtering) Before opening the frame viewer, you can filter the frames by applying [simple](#simple-frame-filtering) or [advanced](#advanced-frame-filtering)
filtering logic. filtering logic.
![image](../../img/hyperdatasets/frames_01.png) ![image](../../img/hyperdatasets/frames_01.png)
## Frame viewer ## Frame viewer
Frame viewer allows you to view and edit annotations which can be FrameGroup objects (Regions of Interest) and FrameGroup Frame viewer allows you to view and edit annotations which can be FrameGroup objects (Regions of Interest) and FrameGroup
labels applied to the entire frame not a region of the frame, the frame details (see [frames](../frames.md)), labels applied to the entire frame not a region of the frame, the frame details (see [frames](../frames.md)),
frame metadata, the raw data source URI, as well as providing navigation and viewing tools. frame metadata, the raw data source URI, as well as providing navigation and viewing tools.
![image](../../img/hyperdatasets/web-app/dataset_example_frame_editor.png) ![image](../../img/hyperdatasets/web-app/dataset_example_frame_editor.png)
@ -23,18 +23,18 @@ Use frame viewer controls to navigate between frames in a Dataset Version, and c
|Control Icon|Actions| |Control Icon|Actions|
|-----|------| |-----|------|
|<img src="/static/icons/ico-skip-backward.svg" className="icon size-md space-sm" />|Jump backwards (CTRL + Left). Jumps backwards by five frames.| |<img src="/docs/latest/static/icons/ico-skip-backward.svg" className="icon size-md space-sm" />|Jump backwards (CTRL + Left). Jumps backwards by five frames.|
|<img src="/static/icons/ico-skip-previous.svg" className="icon size-md space-sm" />|Go to the previous frame containing a non-filtered annotation. The filter is the minimum confidence level setting. If the confidence level filter is set to zero, any frame containing annotations matches the filter.| |<img src="/docs/latest/static/icons/ico-skip-previous.svg" className="icon size-md space-sm" />|Go to the previous frame containing a non-filtered annotation. The filter is the minimum confidence level setting. If the confidence level filter is set to zero, any frame containing annotations matches the filter.|
|<img src="/static/icons/ico-arrow-left.svg" className="icon size-md space-sm" />|Go to the previous frame (Left Arrow).| |<img src="/docs/latest/static/icons/ico-arrow-left.svg" className="icon size-md space-sm" />|Go to the previous frame (Left Arrow).|
|<img src="/static/icons/ico-arrow-right.svg" className="icon size-md space-sm" />|Go to the next frame (Right Arrow).| |<img src="/docs/latest/static/icons/ico-arrow-right.svg" className="icon size-md space-sm" />|Go to the next frame (Right Arrow).|
|<img src="/static/icons/ico-skip-next.svg" className="icon size-md space-sm" />|Go to the next frame containing a non-filtered annotation (same filter as <img src="/static/icons/ico-skip-previous.svg" className="icon size-md space-sm" />).| |<img src="/docs/latest/static/icons/ico-skip-next.svg" className="icon size-md space-sm" />|Go to the next frame containing a non-filtered annotation (same filter as <img src="/docs/latest/static/icons/ico-skip-previous.svg" className="icon size-md space-sm" />).|
|<img src="/static/icons/ico-skip-forward.svg" className="icon size-md space-sm" />|Jump forwards (CTRL + Right). Jumps 5 frames forwards.| |<img src="/docs/latest/static/icons/ico-skip-forward.svg" className="icon size-md space-sm" />|Jump forwards (CTRL + Right). Jumps 5 frames forwards.|
|<img src="/static/icons/ico-revert.svg" className="icon size-md space-sm" />|Reload the frame.| |<img src="/docs/latest/static/icons/ico-revert.svg" className="icon size-md space-sm" />|Reload the frame.|
|<img src="/static/icons/ico-undo.svg" className="icon size-md space-sm" />|Undo changes.| |<img src="/docs/latest/static/icons/ico-undo.svg" className="icon size-md space-sm" />|Undo changes.|
|<img src="/static/icons/ico-redo.svg" className="icon size-md space-sm" />|Redo changes.| |<img src="/docs/latest/static/icons/ico-redo.svg" className="icon size-md space-sm" />|Redo changes.|
|<img src="/static/icons/ico-reset_1.svg" className="icon size-md space-sm" />|Autofit| |<img src="/docs/latest/static/icons/ico-reset_1.svg" className="icon size-md space-sm" />|Autofit|
|<img src="/static/icons/ico-zoom-in.svg" className="icon size-md space-sm" />|Zoom in| |<img src="/docs/latest/static/icons/ico-zoom-in.svg" className="icon size-md space-sm" />|Zoom in|
|<img src="/static/icons/ico-zoom-out.svg" className="icon size-md space-sm" />|Zoom out| |<img src="/docs/latest/static/icons/ico-zoom-out.svg" className="icon size-md space-sm" />|Zoom out|
|Percentage textbox|Zoom percentage| |Percentage textbox|Zoom percentage|
### Viewing and editing frames ### Viewing and editing frames
@ -54,16 +54,16 @@ Use frame viewer controls to navigate between frames in a Dataset Version, and c
* Frame labels - Labels applied to the entire frame, not a region in the frame. * 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 <span class="tr_gui">Minimum confidence</span> slider.
* Add, change, and delete [annotations](#annotations) and [frame metadata](#frame-metadata). * Add, change, and delete [annotations](#annotations) and [frame metadata](#frame-metadata).
:::important :::important
To save frames changes at any time, click **SAVE** (below the annotation list area). To save frames changes at any time, click **SAVE** (below the annotation list area).
::: :::
### Viewing FrameGroups ### Viewing FrameGroups
Viewing and editing frames in a FrameGroup is similar to viewing and editing SingleFrames. Viewing and editing frames in a FrameGroup is similar to viewing and editing SingleFrames.
Click the FrameGroup in the Dataset. In the frame viewer, select SingleFrame to view / modify from Click the FrameGroup in the Dataset. In the frame viewer, select SingleFrame to view / modify from
a dropdown list in the **Current Source** section. a dropdown list in the **Current Source** section.
![image](../../img/hyperdatasets/framegroup_01.png) ![image](../../img/hyperdatasets/framegroup_01.png)
@ -71,27 +71,27 @@ a dropdown list in the **Current Source** section.
## Filtering frames ## Filtering frames
### Simple frame filtering ### Simple frame filtering
Simple frame filtering applies one annotation object (ROI) label and returns frames containing at least one annotation Simple frame filtering applies one annotation object (ROI) label and returns frames containing at least one annotation
with that label. with that label.
**To apply a simple frame filter:** **To apply a simple frame filter:**
* In the **Version Browser**, choose a label on the label list. * In the **Version Browser**, choose a label on the label list.
For example: For example:
* Before filtering, the **Version Browser** in the image below contains seven frames. * Before filtering, the **Version Browser** in the image below contains seven frames.
<details className="cml-expansion-panel screenshot"> <details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">View a screenshot</summary> <summary className="cml-expansion-panel-summary">View a screenshot</summary>
<div className="cml-expansion-panel-content"> <div className="cml-expansion-panel-content">
![image](../../img/hyperdatasets/frame_filtering_01.png) ![image](../../img/hyperdatasets/frame_filtering_01.png)
</div> </div>
</details> </details>
<br/> <br/>
* A simple label filter for `person` shows three frames with each containing at least one ROI labeled `person`. * A simple label filter for `person` shows three frames with each containing at least one ROI labeled `person`.
@ -106,9 +106,9 @@ For example:
### Advanced frame filtering ### Advanced frame filtering
Advanced frame filtering applies sophisticated filtering logic, which is composed of as many frame filters as needed, 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. 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 * 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. 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. * 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. * Source rules apply to frame source information.
@ -122,14 +122,14 @@ where each frame filter can be a combination of ROI, frame, and source rules.
* Choose **Include** or **Exclude**, select ROI labels, and optionally set the confidence level range. * 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="/static/icons/ico-edit.svg" className="icon size-md space-sm" />. * To switch from the ROI dropdown list to a Lucene query mode, click <img src="/docs/latest/static/icons/ico-edit.svg" className="icon size-md space-sm" />.
* Frame rule - Enter a Lucene query using frame metadata fields in the format `meta.<key>:<value>`. * 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>`. * Source rule - Enter a Lucene query using frame metadata fields in the format `sources.<key>:<value>`.
### Examples ### Examples
#### ROI rules #### ROI rules
@ -141,7 +141,7 @@ where each frame filter can be a combination of ROI, frame, and source rules.
![image](../../img/hyperdatasets/frame_filtering_03.png) ![image](../../img/hyperdatasets/frame_filtering_03.png)
</div> </div>
</details> </details>
<br/> <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 <code>person</code> and <code>partially_occluded</code> match the filter.
@ -152,7 +152,7 @@ where each frame filter can be a combination of ROI, frame, and source rules.
![image](../../img/hyperdatasets/frame_filtering_04.png) ![image](../../img/hyperdatasets/frame_filtering_04.png)
</div> </div>
</details> </details>
<br/> <br/>
By opening a frame in the frame viewer, you can see an ROI labeled with both. By opening a frame in the frame viewer, you can see an ROI labeled with both.
@ -164,7 +164,7 @@ where each frame filter can be a combination of ROI, frame, and source rules.
![image](../../img/hyperdatasets/frame_filtering_05.png) ![image](../../img/hyperdatasets/frame_filtering_05.png)
</div> </div>
</details> </details>
<br/> <br/>
@ -181,7 +181,7 @@ Filter by metadata using Lucene queries.
![image](../../img/hyperdatasets/frame_filtering_08.png) ![image](../../img/hyperdatasets/frame_filtering_08.png)
</div> </div>
</details> </details>
<br/> <br/>
By opening a frame in the frame viewer, you can see the metadata. By opening a frame in the frame viewer, you can see the metadata.
@ -193,13 +193,13 @@ Filter by metadata using Lucene queries.
![image](../../img/hyperdatasets/frame_filtering_09.png) ![image](../../img/hyperdatasets/frame_filtering_09.png)
</div> </div>
</details> </details>
<br/> <br/>
#### Source rules #### Source rules
Filter by sources 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 a wildcards.
@ -210,11 +210,11 @@ Filter by sources using Lucene queries.
![image](../../img/hyperdatasets/frame_filtering_10.png) ![image](../../img/hyperdatasets/frame_filtering_10.png)
</div> </div>
</details> </details>
<br/> <br/>
Use Lucene queries in ROI label filters and frame rules. Use Lucene queries in ROI label filters and frame rules.
## Annotations ## Annotations
### Frame objects (Regions of Interest) ### Frame objects (Regions of Interest)
@ -225,26 +225,26 @@ You can add annotations by drawing new bounding areas, and copying existing anno
1. Optionally, select a default label in the Default ROI Label(s) list. New annotations are automatically assigned this label. 1. Optionally, select a default label in the Default ROI Label(s) list. New annotations are automatically assigned this label.
1. Click one of the following modes and create a bounding area in the frame: 1. Click one of the following modes and create a bounding area in the frame:
* <img src="/static/icons/ico-rectangle-icon-purple.svg" className="icon size-md space-sm" /> - Rectangle mode: Drag a
rectangle onto the frame.
* <img src="/static/icons/ico-ellipse-icon-purple.svg" className="icon size-md space-sm" /> - Ellipse mode: Drag an ellipse
onto the frame.
* <img src="/static/icons/ico-polygon-icon-purple.svg" className="icon size-md space-sm" /> - Polygon mode: Click the polygon
vertices onto the frame.
* <img src="/static/icons/ico-keypoint-icon-purple.svg" className="icon size-md space-sm" /> - Key points mode: Click each
keypoint onto the frame. After the clicking the last keypoint, click the first again to close the bounding area.
A new annotation is created. * <img src="/docs/latest/static/icons/ico-rectangle-icon-purple.svg" className="icon size-md space-sm" /> - Rectangle mode: Drag a
rectangle onto the frame.
1. In the newly created annotation, select or type a label. * <img src="/docs/latest/static/icons/ico-ellipse-icon-purple.svg" className="icon size-md space-sm" /> - Ellipse mode: Drag an ellipse
1. Optionally, add metadata. This is metadata for the annotation, not the entire frame. onto the frame.
* <img src="/docs/latest/static/icons/ico-polygon-icon-purple.svg" className="icon size-md space-sm" /> - Polygon mode: Click the polygon
vertices onto the frame.
* <img src="/docs/latest/static/icons/ico-keypoint-icon-purple.svg" className="icon size-md space-sm" /> - Key points mode: Click each
keypoint onto the frame. After the clicking the last keypoint, click the first again to close the bounding area.
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. Optionally, lock the annotation.
1. If you move to another frame, the frame editor automatically saves changes. Otherwise, if you exit the frame editor, 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. you are prompted to save.
**To copy an annotation:** **To copy an annotation:**
@ -267,7 +267,7 @@ You can add annotations by drawing new bounding areas, and copying existing anno
1. Expand the **FRAME LABELS** area. 1. Expand the **FRAME LABELS** area.
1. Click **+ Add new**. 1. Click **+ Add new**.
1. Enter a label. 1. Enter a label.
1. Optionally, click <img src="/static/icons/ico-edit.svg" className="icon size-md space-sm" />. 1. Optionally, click <img src="/docs/latest/static/icons/ico-edit.svg" className="icon size-md space-sm" />.
### Annotation management ### Annotation management
@ -280,13 +280,13 @@ You can add annotations by drawing new bounding areas, and copying existing anno
* Resize a bounded area by clicking on a vertex and dragging. * Resize a bounded area by clicking on a vertex and dragging.
**To modify annotation metadata:** **To modify annotation metadata:**
* In the label, click edit and then in the popup modify the metadata dictionary (in JSON format). * In the label, click edit and then in the popup modify the metadata dictionary (in JSON format).
**To modify annotation colors:** **To modify annotation colors:**
* Modify the color of an area by clicking the circle in the label name and select a new color. * Modify the color of an area by clicking the circle in the label name and select a new color.
**To lock annotations:** **To lock annotations:**
* All annotations - Above the annotations, click the lock / unlock. * All annotations - Above the annotations, click the lock / unlock.
@ -305,6 +305,6 @@ You can add annotations by drawing new bounding areas, and copying existing anno
## Frame metadata ## Frame metadata
**To edit frame metadata:** **To edit frame metadata:**
* Expand the **FRAME METADATA** area, click edit, and then in the popup 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).

34
docs/hyperdatasets/webapp/webapp_datasets_versioning.md
View File

@ -2,15 +2,15 @@
title: Dataset Versioning title: Dataset Versioning
--- ---
Use the Dataset versioning WebApp (UI) features for viewing, creating, modifying, and Use the Dataset versioning WebApp (UI) features for viewing, creating, modifying, and
deleting Dataset versions. deleting Dataset versions.
From the Datasets page, click on one of the Datasets in order to see and work with its versions. From the Datasets page, click on one of the Datasets in order to see and work with its versions.
### Viewing snapshots ### Viewing snapshots
View snapshots in the simple version structure using either: View snapshots in the simple version structure using either:
* The simple view, a table of snapshots. * The simple view, a table of snapshots.
<details className="cml-expansion-panel screenshot"> <details className="cml-expansion-panel screenshot">
@ -25,24 +25,24 @@ View snapshots in the simple version structure using either:
* The advanced view, a tree of versions. The tree contains one version whose status is <i>Draft</i>, and snapshots appear in * 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. chronological order, with oldest at the top, and the most recent at the bottom.
<details className="cml-expansion-panel screenshot"> <details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">Advanced view (version tree)</summary> <summary className="cml-expansion-panel-summary">Advanced view (version tree)</summary>
<div className="cml-expansion-panel-content"> <div className="cml-expansion-panel-content">
![image](../../img/hyperdatasets/web-app/dataset_simple_adv_02.png) ![image](../../img/hyperdatasets/web-app/dataset_simple_adv_02.png)
</div> </div>
</details> </details>
### Creating snapshots ### Creating snapshots
To create a snapshot, you must be in the simple (version table) view. To create a snapshot, you must be in the simple (version table) view.
**To create a snapshot, do the following:** **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, 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)) see [Dataset Versioning](../dataset.md#dataset-versioning))
1. If the **DATASET HISTORY** section is not opened, click it. 1. If the **DATASET HISTORY** section is not opened, click it.
1. If a snapshot is currently selected, click **RETURN TO CURRENT VERSION**. 1. If a snapshot is currently selected, click **RETURN TO CURRENT VERSION**.
1. Click **+ CREATE SNAPSHOT**. 1. Click **+ CREATE SNAPSHOT**.
@ -70,7 +70,7 @@ To create a version, you must be in the advanced (version tree) view.
Publish (make read-only) any Dataset version whose status is *Draft*. If the Dataset is in the simple structure, 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 publish the current version, then only the advanced view is available,
and you cannot create snapshots. and you cannot create snapshots.
**To publish a version, do the following:** **To publish a version, do the following:**
@ -86,24 +86,24 @@ Frame exports downloaded filtered frames as a JSON file.
**To export frames, do the following:** **To export frames, do the following:**
* In the Thumbnails area, click **EXPORT FRAMES**. The frames JSON file downloads. * In the Thumbnails area, click **EXPORT FRAMES**. The frames JSON file downloads.
### Modifying version names ### Modifying version names
**To modify a Dataset version name, do the following:** **To modify a Dataset version name, do the following:**
* At the top right of the Dataset page, hover over the Dataset version name, click <img src="/static/icons/ico-edit.svg" className="icon size-md space-sm" /> , edit the name, and then click <img src="/static/icons/ico-save.svg" 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/static/icons/ico-edit.svg" className="icon size-md space-sm" /> , edit the name, and then click <img src="/docs/latest/static/icons/ico-save.svg" className="icon size-md space-sm" /> (check).
### Modifying version descriptions ### Modifying version descriptions
**To modify a version description, do the following:** **To modify a version description, do the following:**
* Expand the **INFO** area, hover over the **Description**, click <img src="/static/icons/ico-edit.svg" className="icon size-md space-sm" />, * Expand the **INFO** area, hover over the **Description**, click <img src="/docs/latest/static/icons/ico-edit.svg" className="icon size-md space-sm" />,
edit the name, and then click <img src="/static/icons/ico-save.svg" className="icon size-md space-sm" /> (check). edit the name, and then click <img src="/docs/latest/static/icons/ico-save.svg" className="icon size-md space-sm" /> (check).
### Deleting versions ### Deleting versions
You can delete versions whose status is *Draft*. You can delete versions whose status is *Draft*.
**To delete the current version, do the following:** **To delete the current version, do the following:**

20
docs/hyperdatasets/webapp/webapp_exp_comparing.md
View File

@ -1,32 +1,32 @@
--- ---
title: Comparing Dataviews title: Comparing Dataviews
--- ---
In addition to [**ClearML**'s comparison features](../../webapp/webapp_exp_comparing.md), the **ClearML Enterprise** WebApp In addition to [**ClearML**'s comparison features](../../webapp/webapp_exp_comparing.md), the **ClearML Enterprise** WebApp
provides a deep comparison of input data selection criteria of experiment Dataviews, enabling to easily locate, visualize, and analyze differences. provides a deep comparison of input data selection criteria of experiment Dataviews, enabling to easily locate, visualize, and analyze differences.
## Selecting experiments ## Selecting experiments
**To select experiments to compare:** **To select experiments to compare:**
1. In the experiment's table, select the checkbox of each experiment to compare, or select the top checkbox for all experiments. 1. In the experiment's table, select the checkbox of each experiment to compare, or select the top checkbox for all experiments.
After selecting the second checkbox, the bottom bar appears. After selecting the second checkbox, the bottom bar appears.
1. In the bottom bar, click **COMPARE**. The comparison page appears, showing a column for each experiment and differences with 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. a highlighted background color. The experiment on the left is the base experiment. Other experiments compare to the base experiment.
## Dataviews (input data) ## Dataviews (input data)
**To locate the input data differences:** **To locate the input data differences:**
1. Click the **DETAILS** tab **>** Expand the **DATAVIEWS** section, or, in the header, click <img src="/static/icons/ico-previous-diff.svg" alt="Previous diff" className="icon size-md" /> 1. Click the **DETAILS** tab **>** Expand the **DATAVIEWS** section, or, in the header, click <img src="/docs/latest/static/icons/ico-previous-diff.svg" alt="Previous diff" className="icon size-md" />
(Previous diff) or <img src="/static/icons/ico-next-diff.svg" className="icon size-md space-sm" /> (Next diff). (Previous diff) or <img src="/docs/latest/static/icons/ico-next-diff.svg" className="icon size-md space-sm" /> (Next diff).
1. Expand any of the following sections: 1. Expand any of the following sections:
* **Augmentation** - On-the-fly data augmentation. * **Augmentation** - On-the-fly data augmentation.
* **Filtering** * **Filtering**
* Frame inclusion and exclusion rules based on ROI labels * Frame inclusion and exclusion rules based on ROI labels
* Frame metadata * Frame metadata
* Frame sources * Frame sources
* Number of instances of a rule matching ROIs in each frame * Number of instances of a rule matching ROIs in each frame
* Confidence levels. * Confidence levels.
* **Iteration** - Iteration controls. * **Iteration** - Iteration controls.
@ -34,4 +34,4 @@ provides a deep comparison of input data selection criteria of experiment Datavi
* **Mapping** - ROI label translation. * **Mapping** - ROI label translation.
* **View** * **View**
![image](../../img/hyperdatasets/web-app/compare_dataviews.png) ![image](../../img/hyperdatasets/web-app/compare_dataviews.png)

112
docs/hyperdatasets/webapp/webapp_exp_modifying.md
View File

@ -2,11 +2,11 @@
title: Modifying Dataviews title: Modifying Dataviews
--- ---
An experiment that has been executed can be [cloned](../../webapp/webapp_exp_reproducing.md), then the cloned experiment's An experiment that has been executed can be [cloned](../../webapp/webapp_exp_reproducing.md), then the cloned experiment's
execution details can be modified, and the modified experiment can be executed. execution details can be modified, and the modified experiment can be executed.
In addition to all the [**ClearML** tuning capabilities](../../webapp/webapp_exp_tuning.md), the **ClearML Enterprise WebApp** (UI) In addition to all the [**ClearML** tuning capabilities](../../webapp/webapp_exp_tuning.md), the **ClearML Enterprise WebApp** (UI)
enables modifying Dataviews, including: enables modifying Dataviews, including:
* [Selected Dataview](#selected-dataview) * [Selected Dataview](#selected-dataview)
* [Dataset versions](#selecting-dataset-versions) * [Dataset versions](#selecting-dataset-versions)
* [Frame filtering](#filtering-frames) * [Frame filtering](#filtering-frames)
@ -16,33 +16,33 @@ enables modifying Dataviews, including:
* [Input frame iteration controls](#iteration-controls) * [Input frame iteration controls](#iteration-controls)
The selection and control of input data can be modified in *Draft* experiments that are not [development experiments](../task.md#development-experiments). The selection and control of input data can be modified in *Draft* experiments that are not [development experiments](../task.md#development-experiments).
Do this by modifying the Dataview used by the experiment. The Dataview specifies the Dataset versions from which frames Do this by modifying the Dataview used by the experiment. The Dataview specifies the Dataset versions from which frames
are iterated and frame filters (see [Dataviews](webapp_dataviews.md). are iterated and frame filters (see [Dataviews](webapp_dataviews.md).
**To choose a Dataview**, do any of the following: **To choose a Dataview**, do any of the following:
* Create a new Dataview * Create a new Dataview
* Click **+** and then follow the instructions below to select Dataset versions, filter frames, map labels (label translation), * Click **+** and then follow the instructions below to select Dataset versions, filter frames, map labels (label translation),
and set label enumeration, data augmentation, and iteration controls. and set label enumeration, data augmentation, and iteration controls.
* Select a different Dataview already associated with the experiment. * Select a different Dataview already associated with the experiment.
* In the **SELECTED DATAVIEW** list, choose a Dataview. * In the **SELECTED DATAVIEW** list, choose a Dataview.
* Import a different Dataview associated with the same or another project. * Import a different Dataview associated with the same or another project.
* Click <img src="/static/icons/ico-import.svg" className="icon size-md space-sm" /> (**Import dataview**) and then * Click <img src="/docs/latest/static/icons/ico-import.svg" className="icon size-md space-sm" /> (**Import dataview**) and then
select **Import to current dataview** or **Import to aux dataview**. select **Import to current dataview** or **Import to aux dataview**.
:::note :::note
After importing a Dataview, it can be renamed and / or removed. After importing a Dataview, it can be renamed and / or removed.
::: :::
### Selecting Dataset versions ### Selecting Dataset versions
To input data from a different data source or different version of a data source, select a different Dataset version used To input data from a different data source or different version of a data source, select a different Dataset version used
by the Dataview. by the Dataview.
**To select Dataset versions for input data:** **To select Dataset versions for input data:**
@ -51,20 +51,20 @@ by the Dataview.
1. Do any of the following: 1. Do any of the following:
* Add a Dataset version - Input frames from another a version of another Dataset. * Add a Dataset version - Input frames from another a version of another Dataset.
* Click **+** * Click **+**
* Select a Dataset and a Dataset version * Select a Dataset and a Dataset version
* Remove a Dataset version - Do not input frames from a Dataset version. * Remove a Dataset version - Do not input frames from a Dataset version.
Select frames from as many Dataset versions as are needed. Select frames from as many Dataset versions as are needed.
1. Click **SAVE**. 1. Click **SAVE**.
## Filtering frames ## Filtering frames
Filtering of SingleFrames iterated by a Dataview for input to the experiment is accomplished by frame filters. Filtering of SingleFrames iterated by a Dataview for input to the experiment is accomplished by frame filters.
For more detailed information, see [Filtering](../dataviews.md#filtering). For more detailed information, see [Filtering](../dataviews.md#filtering).
**To modify frame filtering:** **To modify frame filtering:**
@ -74,34 +74,34 @@ For more detailed information, see [Filtering](../dataviews.md#filtering).
1. Select the Dataset version to which the frame filter applies. 1. Select the Dataset version to which the frame filter applies.
1. Add, change, or remove any combination of the following rules: 1. Add, change, or remove any combination of the following rules:
* ROI rule - Include or exclude frames containing any single ROI with any combination of labels in the Dataset * ROI rule - Include or exclude frames containing any single ROI with any combination of labels in the Dataset
version. Specify a range of the number of matching ROI (instances) per frame, and a range of confidence levels. version. Specify a range of the number of matching ROI (instances) per frame, and a range of confidence levels.
* Frame rule - Filter by frame metadata key-value pairs, or ROI labels. * Frame rule - Filter by frame metadata key-value pairs, or ROI labels.
* Source rule - Filter by frame `source` dictionary key-value pairs. * Source rule - Filter by frame `source` dictionary key-value pairs.
1. Optionally, debias input data by setting ratios for frames returned by the Dataview for each frame filter. These 1. Optionally, debias input data by setting ratios for frames returned by the Dataview for each frame filter. These
ratios allow adjusting an imbalance in input data. ratios allow adjusting an imbalance in input data.
1. Click **SAVE**. 1. Click **SAVE**.
## Mapping labels (label translation) ## Mapping labels (label translation)
Modify the ROI label mapping rules, which translate one or more input labels to another label for the output model. Labels Modify the ROI label mapping rules, which translate one or more input labels to another label for the output model. Labels
that are not mapped are ignored. that are not mapped are ignored.
**To modify label mapping:** **To modify label mapping:**
1. In the **MAPPING** section, click **EDIT** 1. In the **MAPPING** section, click **EDIT**
* Add (**+**) or edit a mapping: * Add (**+**) or edit a mapping:
1. Select the Dataset and version whose labels will be mapped. 1. Select the Dataset and version whose labels will be mapped.
1. Select one or more labels to map. 1. Select one or more labels to map.
1. Select or enter the label to map to in the output model. 1. Select or enter the label to map to in the output model.
* Remove (<img src="/static/icons/ico-trash.svg" className="icon size-md space-sm" />) a mapping. * Remove (<img src="/docs/latest/static/icons/ico-trash.svg" className="icon size-md space-sm" />) a mapping.
1. Click **SAVE** 1. Click **SAVE**
@ -114,17 +114,17 @@ Modify the label enumeration assigned to output models.
1. In the **LABELS ENUMERATION** section, click **EDIT**. 1. In the **LABELS ENUMERATION** section, click **EDIT**.
* Add (**+**) or edit an enumeration: * Add (**+**) or edit an enumeration:
* Select a label and then enter an integer for it. * Select a label and then enter an integer for it.
* Remove (<img src="/static/icons/ico-trash.svg" className="icon size-md space-sm" />) an enumeration. * Remove (<img src="/docs/latest/static/icons/ico-trash.svg" className="icon size-md space-sm" />) an enumeration.
1. Click **SAVE**. 1. Click **SAVE**.
## Data augmentation ## Data augmentation
Modify the on-the-fly data augmentation applied to frames input from the select Dataset versions and filtered by the frame filters. Data augmentation is applied in steps, where each step applies a method, operation, and strength. Modify the on-the-fly data augmentation applied to frames input from the select Dataset versions and filtered by the frame filters. Data augmentation is applied in steps, where each step applies a method, operation, and strength.
For more detailed information, see [Data Augmentation](../dataviews.md#data-augmentation). For more detailed information, see [Data Augmentation](../dataviews.md#data-augmentation).
**To modify data augmentation** **To modify data augmentation**
@ -132,14 +132,14 @@ For more detailed information, see [Data Augmentation](../dataviews.md#data-augm
1. In the **AUGMENTATION** section, click **EDIT**. 1. In the **AUGMENTATION** section, click **EDIT**.
* Add (**+**) or edit an augmentation step - Select a **METHOD**, **OPERATION**, and **STRENGTH**. * Add (**+**) or edit an augmentation step - Select a **METHOD**, **OPERATION**, and **STRENGTH**.
* Remove (<img src="/static/icons/ico-trash.svg" className="icon size-md space-sm" />) an augmentation step. * Remove (<img src="/docs/latest/static/icons/ico-trash.svg" className="icon size-md space-sm" />) an augmentation step.
1. Click **SAVE**. 1. Click **SAVE**.
## Iteration controls ## Iteration controls
Modify the frame iteration performed by the Dataview to control the order, number, timing, and reproducibility of frames Modify the frame iteration performed by the Dataview to control the order, number, timing, and reproducibility of frames
for training. for training.
For more detailed information, see [Iteration Control](../dataviews.md#iteration-control). For more detailed information, see [Iteration Control](../dataviews.md#iteration-control).
@ -152,15 +152,15 @@ For more detailed information, see [Iteration Control](../dataviews.md#iteration
* **Sequential** - Iterate SingleFrames in sorted order by context ID and timestamp. * **Sequential** - Iterate SingleFrames in sorted order by context ID and timestamp.
* **Random** - Iterate SingleFrames randomly using the random seed you can set (see Random Seed below). * **Random** - Iterate SingleFrames randomly using the random seed you can set (see Random Seed below).
1. Select the frame **REPETITION** option, either: 1. Select the frame **REPETITION** option, either:
* **Use Each Frame Once** * **Use Each Frame Once**
* **Limit Frames**
* **Limit Frames**
* **Infinite Iterations** * **Infinite Iterations**
1. Select the **RANDOM SEED** - If the experiment is rerun and the seed remains unchanged, the frames iteration is the same. 1. Select the **RANDOM SEED** - If the experiment is rerun and the seed remains unchanged, the frames iteration is the same.
1. For video, enter a **CLIP LENGTH** - For video data sources, in the number of sequential frames from a clip to iterate. 1. For video, enter a **CLIP LENGTH** - For video data sources, in the number of sequential frames from a clip to iterate.