diff --git a/docs/hyperdatasets/webapp/webapp_annotator.md b/docs/hyperdatasets/webapp/webapp_annotator.md index d3ab998b..8631621f 100644 --- a/docs/hyperdatasets/webapp/webapp_annotator.md +++ b/docs/hyperdatasets/webapp/webapp_annotator.md @@ -2,8 +2,8 @@ title: 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 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 (see [Annotating Images and Videos](#annotating-images-and-video)). ## Managing Annotation Tasks @@ -16,43 +16,43 @@ Use annotation tasks to efficiently organize the annotation of frames in Dataset **To create an annotation task:** 1. On the Annotator page, click **+ ADD NEW ANNOTATION**. -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 - annotation task also creates a child version of the selected version. The new child version's status is *Draft*, and +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 + 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. 1. Set the filters for the frames this annotation task presents to the annotator. * In the **SET FILTERS** list, choose either: - + * **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 and then add a Lucene query for this ROI label filter. + the number of instances. You can also click 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. 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. * **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. 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. Click **Create**. ### Completing annotation tasks To mark an annotation task as **Completed**: -* In the annotation task card, click (menu) **>** **Complete** **>** **CONFIRM**. +* In the annotation task card, click (menu) **>** **Complete** **>** **CONFIRM**. ### Deleting annotation tasks To delete an annotation task: -* In the annotation task card, click (menu) **>** **Delete** **>** **CONFIRM**. +* In the annotation task card, click (menu) **>** **Delete** **>** **CONFIRM**. ### Filtering annotation tasks @@ -63,18 +63,18 @@ There are two option for filtering 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 To View the Dataset version, filters, and iteration information: -* In the annotation task card, click (menu) **>** **Info** +* In the annotation task card, click (menu) **>** **Info** ## 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)). @@ -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 (menu) +1. On the Annotator page, click the annotation task card, or click (menu) and then click **Annotate**. 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. - * Rectangle mode - Click and then click the image, drag and release. - * Polygon mode - Click 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 and then click each key point. + * Rectangle mode - Click and then click the image, drag and release. + * Polygon mode - Click 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 and then click each key point. -1. In the new label area, choose or enter a label. -1. Optionally, add metadata. +1. In the new label area, choose or enter a label. +1. Optionally, add metadata. 1. Optionally, lock the annotation. #### Add frame labels 1. In **FRAME LABEL**, click **+ Add new**. -1. In the new label area, choose or enter a label. -1. Optionally, add metadata. +1. In the new label area, choose or enter a label. +1. Optionally, add metadata. 1. Optionally, lock the annotation. #### Copy / paste an annotations diff --git a/docs/hyperdatasets/webapp/webapp_datasets_frames.md b/docs/hyperdatasets/webapp/webapp_datasets_frames.md index 2d4c8a8c..308408fe 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets_frames.md +++ b/docs/hyperdatasets/webapp/webapp_datasets_frames.md @@ -2,18 +2,18 @@ title: Working with Frames --- -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). -Before opening the frame viewer, you can filter the frames by applying [simple](#simple-frame-filtering) or [advanced](#advanced-frame-filtering) -filtering logic. +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). +Before opening the frame viewer, you can filter the frames by applying [simple](#simple-frame-filtering) or [advanced](#advanced-frame-filtering) +filtering logic. ![image](../../img/hyperdatasets/frames_01.png) ## Frame viewer -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)), -frame metadata, the raw data source URI, as well as providing navigation and viewing tools. +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)), +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) @@ -23,18 +23,18 @@ Use frame viewer controls to navigate between frames in a Dataset Version, and c |Control Icon|Actions| |-----|------| -||Jump backwards (CTRL + Left). Jumps backwards by five frames.| -||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.| -||Go to the previous frame (Left Arrow).| -||Go to the next frame (Right Arrow).| -||Go to the next frame containing a non-filtered annotation (same filter as ).| -||Jump forwards (CTRL + Right). Jumps 5 frames forwards.| -||Reload the frame.| -||Undo changes.| -||Redo changes.| -||Autofit| -||Zoom in| -||Zoom out| +||Jump backwards (CTRL + Left). Jumps backwards by five frames.| +||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.| +||Go to the previous frame (Left Arrow).| +||Go to the next frame (Right Arrow).| +||Go to the next frame containing a non-filtered annotation (same filter as ).| +||Jump forwards (CTRL + Right). Jumps 5 frames forwards.| +||Reload the frame.| +||Undo changes.| +||Redo changes.| +||Autofit| +||Zoom in| +||Zoom out| |Percentage textbox|Zoom percentage| ### 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. * Optionally, filter annotations by confidence level using the Minimum confidence slider. * Add, change, and delete [annotations](#annotations) and [frame metadata](#frame-metadata). - + :::important To save frames changes at any time, click **SAVE** (below the annotation list area). ::: - + ### Viewing FrameGroups -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 +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 a dropdown list in the **Current Source** section. ![image](../../img/hyperdatasets/framegroup_01.png) @@ -71,27 +71,27 @@ a dropdown list in the **Current Source** section. ## Filtering frames ### Simple frame filtering -Simple frame filtering applies one annotation object (ROI) label and returns frames containing at least one annotation -with that label. +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:** * 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.
View a screenshot
- + ![image](../../img/hyperdatasets/frame_filtering_01.png) -
+
-
+
* 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 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 +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. @@ -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. - * To switch from the ROI dropdown list to a Lucene query mode, click . - + * To switch from the ROI dropdown list to a Lucene query mode, click . + * Frame rule - Enter a Lucene query using frame metadata fields in the format `meta.:`. - - * Source rule - Enter a Lucene query using frame metadata fields in the format `sources.:`. + + * Source rule - Enter a Lucene query using frame metadata fields in the format `sources.:`. ### Examples - + #### 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) - +
* 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. @@ -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) - +
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) - +
@@ -181,7 +181,7 @@ Filter by metadata using Lucene queries. ![image](../../img/hyperdatasets/frame_filtering_08.png) - +
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) - +
- + #### 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. @@ -210,11 +210,11 @@ Filter by sources using Lucene queries. ![image](../../img/hyperdatasets/frame_filtering_10.png) - +
Use Lucene queries in ROI label filters and frame rules. - + ## Annotations ### 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. Click one of the following modes and create a bounding area in the frame: - - * - Rectangle mode: Drag a - rectangle onto the frame. - - * - Ellipse mode: Drag an ellipse - onto the frame. - - * - Polygon mode: Click the polygon - vertices onto the frame. - - * - Key points mode: Click each - keypoint onto the frame. After the clicking the last keypoint, click the first again to close the bounding area. +1. Click one of the following modes and create a bounding area in the frame: - A new annotation is created. + * - Rectangle mode: Drag a + rectangle onto the frame. -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. + * - Ellipse mode: Drag an ellipse + onto the frame. + + * - Polygon mode: Click the polygon + vertices onto the frame. + + * - 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. 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. **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. Click **+ Add new**. 1. Enter a label. -1. Optionally, click . +1. Optionally, click . ### 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. **To modify annotation metadata:** - + * In the label, click edit and then in the popup modify the metadata dictionary (in JSON format). **To modify annotation colors:** - + * Modify the color of an area by clicking the circle in the label name and select a new color. - + **To lock annotations:** * All annotations - Above the annotations, click the lock / unlock. @@ -305,6 +305,6 @@ You can add annotations by drawing new bounding areas, and copying existing anno ## 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). diff --git a/docs/hyperdatasets/webapp/webapp_datasets_versioning.md b/docs/hyperdatasets/webapp/webapp_datasets_versioning.md index e6d41ac5..0c061726 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets_versioning.md +++ b/docs/hyperdatasets/webapp/webapp_datasets_versioning.md @@ -2,15 +2,15 @@ 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. -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 - + View snapshots in the simple version structure using either: - + * The simple view, a table of snapshots.
@@ -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 Draft, and snapshots appear in chronological order, with oldest at the top, and the most recent at the bottom. - +
Advanced view (version tree)
![image](../../img/hyperdatasets/web-app/dataset_simple_adv_02.png) -
+
### 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:** -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 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**. @@ -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, 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:** @@ -86,24 +86,24 @@ 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:** -* At the top right of the Dataset page, hover over the Dataset version name, click , edit the name, and then click (check). - +* At the top right of the Dataset page, hover over the Dataset version name, click , edit the name, and then click (check). + ### Modifying version descriptions **To modify a version description, do the following:** -* Expand the **INFO** area, hover over the **Description**, click , - edit the name, and then click (check). - +* Expand the **INFO** area, hover over the **Description**, click , + edit the name, and then click (check). + ### 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:** diff --git a/docs/hyperdatasets/webapp/webapp_exp_comparing.md b/docs/hyperdatasets/webapp/webapp_exp_comparing.md index 834655d1..112a6bbb 100644 --- a/docs/hyperdatasets/webapp/webapp_exp_comparing.md +++ b/docs/hyperdatasets/webapp/webapp_exp_comparing.md @@ -1,32 +1,32 @@ ---- +--- 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. -## Selecting experiments +## Selecting experiments **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. -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. ## Dataviews (input data) **To locate the input data differences:** -1. Click the **DETAILS** tab **>** Expand the **DATAVIEWS** section, or, in the header, click Previous diff - (Previous diff) or (Next diff). +1. Click the **DETAILS** tab **>** Expand the **DATAVIEWS** section, or, in the header, click Previous diff + (Previous diff) or (Next diff). 1. Expand any of the following sections: * **Augmentation** - On-the-fly data augmentation. -* **Filtering** +* **Filtering** * Frame inclusion and exclusion rules based on ROI labels * Frame metadata - * Frame sources + * Frame sources * Number of instances of a rule matching ROIs in each frame * Confidence levels. * **Iteration** - Iteration controls. @@ -34,4 +34,4 @@ provides a deep comparison of input data selection criteria of experiment Datavi * **Mapping** - ROI label translation. * **View** -![image](../../img/hyperdatasets/web-app/compare_dataviews.png) \ No newline at end of file +![image](../../img/hyperdatasets/web-app/compare_dataviews.png) diff --git a/docs/hyperdatasets/webapp/webapp_exp_modifying.md b/docs/hyperdatasets/webapp/webapp_exp_modifying.md index 2566037b..79e75d48 100644 --- a/docs/hyperdatasets/webapp/webapp_exp_modifying.md +++ b/docs/hyperdatasets/webapp/webapp_exp_modifying.md @@ -2,11 +2,11 @@ title: Modifying Dataviews --- -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. +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. -In addition to all the [**ClearML** tuning capabilities](../../webapp/webapp_exp_tuning.md), the **ClearML Enterprise WebApp** (UI) -enables modifying Dataviews, including: +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) * [Dataset versions](#selecting-dataset-versions) * [Frame filtering](#filtering-frames) @@ -16,33 +16,33 @@ enables modifying Dataviews, including: * [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 Dataset versions from which frames -are iterated and frame filters (see [Dataviews](webapp_dataviews.md). +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 +are iterated and frame filters (see [Dataviews](webapp_dataviews.md). **To choose a Dataview**, do any of the following: -* Create a new Dataview - - * Click **+** and then follow the instructions below to select Dataset versions, filter frames, map labels (label translation), +* Create a new Dataview + + * 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. - -* Select a different Dataview already associated with the experiment. - - * In the **SELECTED DATAVIEW** list, choose a Dataview. - -* Import a different Dataview associated with the same or another project. - - * Click (**Import dataview**) and then + +* Select a different Dataview already associated with the experiment. + + * In the **SELECTED DATAVIEW** list, choose a Dataview. + +* Import a different Dataview associated with the same or another project. + + * Click (**Import dataview**) and then select **Import to current dataview** or **Import to aux dataview**. - + :::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 -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. **To select Dataset versions for input data:** @@ -51,20 +51,20 @@ by the Dataview. 1. Do any of the following: * Add a Dataset version - Input frames from another a version of another Dataset. - - * Click **+** - - * Select a Dataset and a Dataset version - + + * Click **+** + + * Select a Dataset and 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. 1. Click **SAVE**. - + ## 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). **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. 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. * Frame rule - Filter by frame metadata key-value pairs, or ROI labels. * 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. 1. Click **SAVE**. - + ## 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 -that are not mapped are ignored. +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. **To modify label mapping:** 1. In the **MAPPING** section, click **EDIT** * Add (**+**) or edit a mapping: - + 1. Select the Dataset and version whose labels will be mapped. - + 1. Select one or more labels to map. - + 1. Select or enter the label to map to in the output model. - - * Remove () a mapping. + + * Remove () a mapping. 1. Click **SAVE** @@ -114,17 +114,17 @@ Modify the label enumeration assigned to output models. 1. In the **LABELS ENUMERATION** section, click **EDIT**. * Add (**+**) or edit an enumeration: - + * Select a label and then enter an integer for it. - - * Remove () an enumeration. + + * Remove () an enumeration. 1. Click **SAVE**. ## 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. - + For more detailed information, see [Data Augmentation](../dataviews.md#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**. * Add (**+**) or edit an augmentation step - Select a **METHOD**, **OPERATION**, and **STRENGTH**. - - * Remove () an augmentation step. - -1. Click **SAVE**. - + + * Remove () an augmentation step. + +1. Click **SAVE**. + ## 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 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. * **Random** - Iterate SingleFrames randomly using the random seed you can set (see Random Seed below). - + 1. Select the frame **REPETITION** option, either: - * **Use Each Frame Once** + * **Use Each Frame Once** + + * **Limit Frames** - * **Limit Frames** - * **Infinite Iterations** - + 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.