ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small edits (#128)

Browse Source
This commit is contained in:
pollfly
2021-12-02 19:53:37 +02:00
committed by GitHub
parent 3af0edb147
commit 49de7323ab
21 changed files with 269 additions and 185 deletions
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.
* **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
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.
the number of instances. You can also click <img src="/docs/latest/icons/ico-code.svg" alt="Code" 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.
@@ -46,13 +46,13 @@ Use annotation tasks to efficiently organize the annotation of frames in Dataset
To mark an annotation task as **Completed**:
* In the annotation task card, click <img src="/docs/latest/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" alt="Menu" className="icon size-md space-sm" /> (menu) **>** **Complete** **>** **CONFIRM**.
### Deleting Annotation Tasks
To delete an annotation task:
* In the annotation task card, click <img src="/docs/latest/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" alt="Menu" className="icon size-md space-sm" /> (menu) **>** **Delete** **>** **CONFIRM**.
### 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:
* In the annotation task card, click <img src="/docs/latest/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" alt="Menu" className="icon size-md space-sm" /> (menu) **>** **Info**
## Annotating Images and Video
@@ -82,7 +82,7 @@ depend upon the settings in the annotation task (see [Creating Annotation Tasks]
**To annotate frames:**
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)
1. On the Annotator page, click the annotation task card, or click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" /> (menu)
and then click **Annotate**.
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.
* 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/icons/ico-polygon-icon-purple.svg" className="icon size-md space-sm" /> and then click the image for the first vertex,
* Rectangle mode - Click <img src="/docs/latest/icons/ico-rectangle-icon-purple.svg" alt="Rectangle mode" className="icon size-md space-sm" /> and then click the image, drag and release.
* Polygon mode - Click <img src="/docs/latest/icons/ico-polygon-icon-purple.svg" alt="Polygon mode" 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.
* 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.
* Key points mode - Click <img src="/docs/latest/icons/ico-keypoint-icon-purple.svg" alt="Key points mode" className="icon size-md space-sm" /> and then click each key point.
1. In the new label area, choose or enter a label.
1. Optionally, add metadata.

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

@@ -67,7 +67,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) or [advanced frame filter](#advanced), 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 <span class="tr_gui">LOAD MORE</span>, if required.
1. Click the frame thumbnail. The frame editor appears.
1. Do any of the following:
* View frame details, including:
@@ -148,7 +148,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.
* 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" />.
* To switch from the ROI dropdown list to a Lucene query mode, click <img src="/docs/latest/icons/ico-edit.svg" alt="edit pencil" className="icon size-md space-sm" />.
* Frame rule - Enter a Lucene query using frame metadata fields in the format `meta.<key>:<value>`.

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

@@ -98,8 +98,8 @@ Frame exports downloaded filtered frames as a JSON file.
**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" 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).
* 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

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

@@ -19,7 +19,7 @@ provides a deep comparison of input data selection criteria of experiment Datavi
**To locate the input data differences:**
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/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" alt="Next diff" className="icon size-md space-sm" /> (Next diff).
1. Expand any of the following sections:
* **Augmentation** - On-the-fly data augmentation.

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

@@ -6,8 +6,8 @@ An experiment that has been executed can be [cloned](../../webapp/webapp_exp_rep
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)
enables modifying Dataviews, including:
* [Selected Dataview](#selected-dataview)
enables modifying [Dataviews](webapp_dataviews.md), including:
* [Selected Dataview](#selecting-dataviews)
* [Dataset versions](#selecting-dataset-versions)
* [Frame filtering](#filtering-frames)
* [Label mapping](#mapping-labels-label-translation)
@@ -15,10 +15,7 @@ enables modifying Dataviews, including:
* [Data augmentation](#data-augmentation)
* [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).
Do this by modifying the Dataview used by the experiment. The Dataview specifies the Hyper-Dataset versions from which frames
are iterated and frame filters (see [Dataviews](webapp_dataviews.md)).
## Selecting Dataviews
**To choose a Dataview**, do any of the following:
@@ -33,8 +30,8 @@ are iterated and frame filters (see [Dataviews](webapp_dataviews.md)).
* Import a different Dataview associated with the same or another project.
* 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**.
* Click <img src="/docs/latest/icons/ico-import.svg" alt="Import" className="icon size-md space-sm" /> (**Import dataview**) and then
select **Import to current dataview** or **Import as aux dataview**.
:::note
After importing a Dataview, it can be renamed and / or removed.
@@ -101,7 +98,7 @@ that are not mapped are ignored.
1. Select or enter the label to map to in the output model.
* Remove (<img src="/docs/latest/icons/ico-trash.svg" className="icon size-md space-sm" />) a mapping.
* Remove (<img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-md space-sm" />) a mapping.
1. Click **SAVE**
@@ -117,13 +114,13 @@ Modify the label enumeration assigned to output models.
* Select a label and then enter an integer for it.
* Remove (<img src="/docs/latest/icons/ico-trash.svg" className="icon size-md space-sm" />) an enumeration.
* Remove (<img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-md space-sm" />) an enumeration.
1. Click **SAVE**.
## Data Augmentation
Modify the on-the-fly data augmentation applied to frames input from the select Hyper-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 frame input from the select Hyper-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).
@@ -133,7 +130,7 @@ For more detailed information, see [Data Augmentation](../dataviews.md#data-augm
* Add (**+**) or edit an augmentation step - Select a **METHOD**, **OPERATION**, and **STRENGTH**.
* Remove (<img src="/docs/latest/icons/ico-trash.svg" className="icon size-md space-sm" />) an augmentation step.
* Remove (<img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-md space-sm" />) an augmentation step.
1. Click **SAVE**.
@@ -161,7 +158,7 @@ For more detailed information, see [Iteration Control](../dataviews.md#iteration
* **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 frame 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.