Update docs (#1026)
Some checks are pending
CI / build (push) Waiting to run

This commit is contained in:
pollfly
2025-02-06 14:11:23 +02:00
committed by GitHub
parent 18d3209059
commit 30805e474d
14 changed files with 50 additions and 77 deletions

View File

@@ -159,11 +159,32 @@ To draw a new annotation:
A new annotation is created.
1. In the newly created annotation, select or type-in a label(s). Click the circle in the label name to select a
different label color.
1. In the newly created annotation, select or type-in the labels for this annotation.
You can use the **Default ROI Label(s)** list to automatically set labels to all new annotations.
:::info Annotation color
Each annotation label is automatically assigned a color based on its value. The annotation color is automatically
calculated based on the colors of its labels.
Click the color circle in the label name to manually set the label's color.
<div class="max-w-75">
![Set label color](../../img/annotation_label_color.png)
</div>
Click the color circle in the annotation header to manually set the annotations color and its opacity.
<div class="max-w-75">
![Set annotation color and opacity](../../img/annotation_label_opacity.png)
</div>
:::
#### Copying Frame Objects
You can copy existing annotations, and paste them to any frame of your choice:
1. Click the annotation or bounded area in the frame.

View File

@@ -8,16 +8,19 @@ deleting [Dataset versions](../dataset.md#dataset-versioning).
![Dataset versions page](../../img/hyperdatasets/web-app/dataset_versions.png)
## Dataset Version History
The WebApp (UI) presents your dataset version structure in list view <img src="/docs/latest/icons/ico-list-view.svg" alt="List view" className="icon size-md space-sm" />
or tree view <img src="/docs/latest/icons/ico-tree-view.svg" alt="Tree view" className="icon size-md space-sm" />.
The WebApp (UI) presents your dataset version structure in tree view <img src="/docs/latest/icons/ico-tree-view.svg" alt="Tree view" className="icon size-md space-sm" />
or list view <img src="/docs/latest/icons/ico-list-view.svg" alt="List view" className="icon size-md space-sm" />.
The tree view shows the lineage of the dataset's versions.
![Versions tree view](../../img/hyperdatasets/web-app/dataset_simple_adv_02.png)
The list view lists the dataset's versions chronologically by last update time.
![Versions list view](../../img/hyperdatasets/web-app/dataset_simple_adv_01.png)
The tree view shows the lineage of the dataset's versions.
![Versions tree view](../../img/hyperdatasets/web-app/dataset_simple_adv_02.png)
Click <img src="/docs/latest/icons/ico-sort.svg" alt="Sort order" className="icon size-md space-sm" /> to order the
dataset versions in ascending or descending order based on their last update time.
Use the search bar to find specific versions. You can query by version name, version description, or version ID. The search returns
all versions that match the query.

View File

@@ -78,7 +78,7 @@ Access these actions with the context menu in any of the following ways:
| ClearML Action | Description |
|---|---|
| Details | View Dataview details, including input datasets, label mapping, augmentation operations, and iteration control. Can also be accessed by double-clicking a Dataview in the Dataviews table. |
| Details | View Dataview details, including input datasets, label mapping, and iteration control. Can also be accessed by double-clicking a Dataview in the Dataviews table. |
| Archive | Move Dataview to the Dataview's archive. |
| Restore | Action available in the archive. Restore a Dataview to the active Dataviews table. |
| Delete | Action available in the archive. Permanently delete a Dataview. |

View File

@@ -12,7 +12,6 @@ enables modifying [Dataviews](webapp_dataviews.md), including:
* [Frame filtering](#filtering-frames)
* [Label mapping](#mapping-labels-label-translation)
* [Class label enumeration](#label-enumeration)
* [Data augmentation](#data-augmentation)
* [Input frame iteration controls](#iteration-controls)
## Selecting Dataviews
@@ -22,7 +21,7 @@ enables modifying [Dataviews](webapp_dataviews.md), including:
* Create a new Dataview
* Click **+** and then follow the instructions below to select Hyper-Dataset versions, filter frames, map labels (label translation),
and set label enumeration, data augmentation, and iteration controls.
and set label enumeration and iteration controls.
* Select a different Dataview already associated with the experiment.
@@ -118,22 +117,6 @@ Modify the label enumeration assigned to output models.
1. Click **SAVE**.
## Data Augmentation
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).
**To modify data augmentation**
1. In the **AUGMENTATION** section, click **EDIT**.
* Add (**+**) or edit an augmentation step - Select a **METHOD**, **OPERATION**, and **STRENGTH**.
* Remove (<img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-md space-sm" />) 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

View File

@@ -14,7 +14,6 @@ In an experiment's page, go to the **DATAVIEWS** tab to view all the experiment'
* Input data [selection](#input) and [filtering](#filtering)
* ROI [mapping](#mapping) (label translation)
* [Label enumeration](#label-enumeration)
* On-the-fly [data augmentation](#augmentation)
* [Iteration controls](#iteration-control)
![Dataview tab](../../img/hyperdatasets/web-app/dataview_tab.png)
@@ -52,13 +51,6 @@ For detailed information, see [Mapping ROI labels](../dataviews.md#mapping-roi-l
Assign label enumeration in the **LABELS ENUMERATION** area.
### Augmentation
On-the-fly data augmentation applied to SingleFrames, which does not create new data. Apply data Augmentation in steps,
where each step is composed of a method, an operation, and a strength.
For detailed information, see [Data augmentation](../dataviews.md#data-augmentation).
### Iteration Control
The input data iteration control settings determine the order, number, timing, and reproducibility of the Dataview iterating