ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-04-05 13:45:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix icon links

Browse Source
This commit is contained in:
allegroai 2021-06-21 15:23:21 +03:00
parent bc66f854d4
commit ca1d60b015
5 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -27,7 +27,7 @@ Use annotation tasks to efficiently organize the annotation of frames in Dataset
* **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="/docs/latest/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/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.
@ -46,13 +46,13 @@ Use annotation tasks to efficiently organize the annotation of frames in Dataset
To mark an annotation task as **Completed**: To mark an annotation task as **Completed**:
* 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**. * In the annotation task card, click <img src="/docs/latest/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="/docs/latest/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/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu) **>** **Delete** **>** **CONFIRM**.
### Filtering annotation tasks ### Filtering annotation tasks
@ -69,7 +69,7 @@ Sort the annotation tasks by either using **RECENT** or **NAME** from the drop-d
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="/docs/latest/static/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu) **>** **Info** * In the annotation task card, click <img src="/docs/latest/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> (menu) **>** **Info**
## Annotating Images and Video ## Annotating Images and Video
@ -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="/docs/latest/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/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,10 +91,10 @@ 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="/docs/latest/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/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="/docs/latest/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/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="/docs/latest/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/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.

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

@ -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="/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="/docs/latest/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-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/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-arrow-left.svg" className="icon size-md space-sm" />|Go to the previous frame (Left Arrow).| |<img src="/docs/latest/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-right.svg" className="icon size-md space-sm" />|Go to the next frame (Right Arrow).| |<img src="/docs/latest/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-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="/docs/latest/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/icons/ico-skip-previous.svg" className="icon size-md space-sm" />).|
|<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="/docs/latest/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-revert.svg" className="icon size-md space-sm" />|Reload the frame.| |<img src="/docs/latest/icons/ico-revert.svg" className="icon size-md space-sm" />|Reload the frame.|
|<img src="/docs/latest/static/icons/ico-undo.svg" className="icon size-md space-sm" />|Undo changes.| |<img src="/docs/latest/icons/ico-undo.svg" className="icon size-md space-sm" />|Undo changes.|
|<img src="/docs/latest/static/icons/ico-redo.svg" className="icon size-md space-sm" />|Redo changes.| |<img src="/docs/latest/icons/ico-redo.svg" className="icon size-md space-sm" />|Redo changes.|
|<img src="/docs/latest/static/icons/ico-reset_1.svg" className="icon size-md space-sm" />|Autofit| |<img src="/docs/latest/icons/ico-reset_1.svg" className="icon size-md space-sm" />|Autofit|
|<img src="/docs/latest/static/icons/ico-zoom-in.svg" className="icon size-md space-sm" />|Zoom in| |<img src="/docs/latest/icons/ico-zoom-in.svg" className="icon size-md space-sm" />|Zoom in|
|<img src="/docs/latest/static/icons/ico-zoom-out.svg" className="icon size-md space-sm" />|Zoom out| |<img src="/docs/latest/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
@ -122,7 +122,7 @@ 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="/docs/latest/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/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>`.
@ -227,16 +227,16 @@ You can add annotations by drawing new bounding areas, and copying existing anno
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="/docs/latest/static/icons/ico-rectangle-icon-purple.svg" className="icon size-md space-sm" /> - Rectangle mode: Drag a * <img src="/docs/latest/icons/ico-rectangle-icon-purple.svg" className="icon size-md space-sm" /> - Rectangle mode: Drag a
rectangle onto the frame. rectangle onto the frame.
* <img src="/docs/latest/static/icons/ico-ellipse-icon-purple.svg" className="icon size-md space-sm" /> - Ellipse mode: Drag an ellipse * <img src="/docs/latest/icons/ico-ellipse-icon-purple.svg" className="icon size-md space-sm" /> - Ellipse mode: Drag an ellipse
onto the 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 * <img src="/docs/latest/icons/ico-polygon-icon-purple.svg" className="icon size-md space-sm" /> - Polygon mode: Click the polygon
vertices onto the frame. 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 * <img src="/docs/latest/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. keypoint onto the frame. After the clicking the last keypoint, click the first again to close the bounding area.
A new annotation is created. A new annotation is created.
@ -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="/docs/latest/static/icons/ico-edit.svg" className="icon size-md space-sm" />. 1. Optionally, click <img src="/docs/latest/icons/ico-edit.svg" className="icon size-md space-sm" />.
### Annotation management ### Annotation management

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

@ -92,14 +92,14 @@ Frame exports downloaded filtered frames as a JSON file.
**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="/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). * 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 ### 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="/docs/latest/static/icons/ico-edit.svg" className="icon size-md space-sm" />, * Expand the **INFO** area, hover over the **Description**, 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/static/icons/ico-save.svg" className="icon size-md space-sm" /> (check). edit the name, and then click <img src="/docs/latest/icons/ico-save.svg" className="icon size-md space-sm" /> (check).
### Deleting versions ### Deleting versions

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

@ -18,8 +18,8 @@ provides a deep comparison of input data selection criteria of experiment Datavi
**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="/docs/latest/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/icons/ico-previous-diff.svg" alt="Previous diff" className="icon size-md" />
(Previous diff) or <img src="/docs/latest/static/icons/ico-next-diff.svg" className="icon size-md space-sm" /> (Next diff). (Previous diff) or <img src="/docs/latest/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.

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

@ -33,7 +33,7 @@ are iterated and frame filters (see [Dataviews](webapp_dataviews.md).
* 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="/docs/latest/static/icons/ico-import.svg" className="icon size-md space-sm" /> (**Import dataview**) and then * Click <img src="/docs/latest/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
@ -101,7 +101,7 @@ that are not mapped are ignored.
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="/docs/latest/static/icons/ico-trash.svg" className="icon size-md space-sm" />) a mapping. * Remove (<img src="/docs/latest/icons/ico-trash.svg" className="icon size-md space-sm" />) a mapping.
1. Click **SAVE** 1. Click **SAVE**
@ -117,7 +117,7 @@ Modify the label enumeration assigned to output models.
* Select a label and then enter an integer for it. * Select a label and then enter an integer for it.
* Remove (<img src="/docs/latest/static/icons/ico-trash.svg" className="icon size-md space-sm" />) an enumeration. * Remove (<img src="/docs/latest/icons/ico-trash.svg" className="icon size-md space-sm" />) an enumeration.
1. Click **SAVE**. 1. Click **SAVE**.
@ -133,7 +133,7 @@ For more detailed information, see [Data Augmentation](../dataviews.md#data-augm
* 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="/docs/latest/static/icons/ico-trash.svg" className="icon size-md space-sm" />) an augmentation step. * Remove (<img src="/docs/latest/icons/ico-trash.svg" className="icon size-md space-sm" />) an augmentation step.
1. Click **SAVE**. 1. Click **SAVE**.