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 (#724)

Browse Source
This commit is contained in:
pollfly
2023-12-03 14:27:46 +02:00
committed by GitHub
parent 4b02af91f7
commit 680bca6644
44 changed files with 131 additions and 131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -9,7 +9,7 @@ Use annotation tasks to efficiently organize the annotation of frames in Dataset
![Annotations page](../../img/annotation_page.png)
Click on an annotation task card to open the frame viewer, where you can view the task’s frames and annotate them.
Click on an annotation task card to open the frame viewer, where you can view the task's frames and annotate them.
## Annotation Task Actions
Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" /> on the top right
@@ -18,7 +18,7 @@ of an annotation task card to open its context menu and access annotation task a
![Annotation task card](../../img/annotation_task_card.png)
* **Annotate** - Go to annotation task frame viewer
* **Info** - View annotation task’s definitions: dataset versions, filters, and frame iteration specification
* **Info** - View annotation task's definitions: dataset versions, filters, and frame iteration specification
* **Complete** - Mark annotation task as Completed
* **Delete** - Delete annotation task
@@ -112,11 +112,11 @@ or the arrow keys on the keyboard). Closing the frame editor will prompt you to
| Icon (when applicable) | Action | Description |
|---|---|---|
|| Move annotation | Click on a bounded area and drag it. |
|| Resize annotation| Select an annotation, then click on a bounded area’s vertex and drag it. |
|| Resize annotation| Select an annotation, then click on a bounded area's vertex and drag it. |
|<img src="/docs/latest/icons/ico-metadata.svg" alt="edit metadata" className="icon size-md space-sm" />|Edit metadata|Hover over an annotation in the list and click the icon to open the edit window. Input the metadata dictionary in JSON format. This metadata is specific to the selected annotation, not the entire frame.|
|<img src="/docs/latest/icons/ico-lock-open.svg" alt="Lock annotation" className="icon size-md space-sm" />|Lock / Unlock annotation |Click the button on a specific annotation to make it uneditable. You can also click the button on top of the annotations list to lock all annotations in the frame.|
|<img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-sm space-sm" />|Delete annotation|Click the annotation or bounded area in the frame and then click the button to delete the annotation.|
|<img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />|Show/hide all annotations |Click the button to view the frame without annotations. When annotations are hidden, they can’t be modified. |
|<img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />|Show/hide all annotations |Click the button to view the frame without annotations. When annotations are hidden, they can't be modified. |
||Delete label |In the relevant annotation, click **x** on the label you want to remove.|
### Frame Labels

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

@@ -9,10 +9,10 @@ or in List view <img src="/docs/latest/icons/ico-flat-view.svg" alt="List view"
view, all hyper-datasets are shown side-by-side. In Project view, hyper-datasets are organized according to their projects, and
top-level projects are displayed. Click on a project card to view the project's hyper-datasets.
Click on a Hyper-Dataset card to open the dataset’s [version list](webapp_datasets_versioning.md), where you can view
Click on a Hyper-Dataset card to open the dataset's [version list](webapp_datasets_versioning.md), where you can view
and manage the dataset versions' lineage and contents.
Filter the hyper-datasets to find the one you’re looking for more easily. These filters can be applied by clicking <img src="/docs/latest/icons/ico-filter-off.svg" alt="Filter" className="icon size-md" />:
Filter the hyper-datasets to find the one you're looking for more easily. These filters can be applied by clicking <img src="/docs/latest/icons/ico-filter-off.svg" alt="Filter" className="icon size-md" />:
* My Work - Show only hyper-datasets that you created
* Tags - Choose which tags to filter by from a list of tags used in the hyper-datasets.
* Filter by multiple tag values using the **ANY** or **ALL** options, which correspond to the logical "AND" and "OR"
@@ -24,7 +24,7 @@ Filter the hyper-datasets to find the one you’re looking for more easily. Thes
## Project Cards
In Project view, project cards display a project’s summarized hyper-dataset information:
In Project view, project cards display a project's summarized hyper-dataset information:
<div class="max-w-50">
@@ -76,7 +76,7 @@ of a dataset card to open its context menu and access dataset actions:
</div>
* **Rename** - Change the dataset’s name
* **Rename** - Change the dataset's name
* **Add Tag** - Add label to the dataset to help easily classify groups of datasets.
* **Edit Metadata** - Modify dataset-level metadata. This will open the metadata edit window, where you can edit the section

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

@@ -177,11 +177,11 @@ or the arrow keys on the keyboard). Closing the frame editor will prompt you to
| Icon (when applicable) | Action | Description |
|---|---|---|
|| Move annotation | Click on a bounded area and drag it. |
|| Resize annotation| Select an annotation, then click on a bounded area’s vertex and drag it. |
|| Resize annotation| Select an annotation, then click on a bounded area's vertex and drag it. |
|<img src="/docs/latest/icons/ico-metadata.svg" alt="edit metadata" className="icon size-md space-sm" />|Edit metadata|Hover over an annotation in the list and click the icon to open the edit window. Input the metadata dictionary in JSON format. This metadata is specific to the selected annotation, not the entire frame.|
|<img src="/docs/latest/icons/ico-lock-open.svg" alt="Lock annotation" className="icon size-md space-sm" />|Lock / Unlock annotation |Click the button on a specific annotation to make it uneditable. You can also click the button on top of the annotations list to lock all annotations in the frame.|
|<img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-md space-sm" />|Delete annotation|Click the annotation or bounded area in the frame and then click the button to delete the annotation.|
|<img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />|Show/hide all annotations |Click the button to view the frame without annotations. When annotations are hidden, they can’t be modified. |
|<img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />|Show/hide all annotations |Click the button to view the frame without annotations. When annotations are hidden, they can't be modified. |
||Delete label |In the relevant annotation, click **x** on the label you want to remove.|
### Frame Labels

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

@@ -30,7 +30,7 @@ In tree view, parent versions that do not match the query where a child version
Access dataset version actions, by right-clicking a version, or through the menu button <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" /> (available on hover).
* **Rename** - Change the version’s name
* **Rename** - Change the version's name
* **Create New Version** - Creates a child version of a *Published* dataset version. The new version is created in a *draft*
state, and inherits all the parent version's frames
* **Delete** - Delete the version. Only *Draft* versions can be deleted.
@@ -66,7 +66,7 @@ the previews.
![Frame browser thumbnails](../../img/hyperdatasets/frame_browser_thumbnails.png)
Use the table view to list the version’s frames in a customizable table. Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" />
Use the table view to list the version's frames in a customizable table. Click <img src="/docs/latest/icons/ico-settings.svg" alt="Setting Gear" className="icon size-md" />
for column customization options.
![Frame browser list](../../img/hyperdatasets/frame_browser_list.png)
@@ -122,7 +122,7 @@ Multiple frame filters are applied with a logical OR operator.
For example, the dataset version in the image below has two frame filters. "Frame Filter 1" has the same two rules
described in the example above. "Frame Filter 2" specifies an ROI rule for the frame to contain an ROI with the label
`dog`. So the frames returned are those that match ALL of Frame Filter 1’s rules OR ALL of Frame Filter 2’s rules.
`dog`. So the frames returned are those that match ALL of Frame Filter 1's rules OR ALL of Frame Filter 2's rules.
![Multiple filters](../../img/hyperdatasets/multiple_filters.png)
@@ -193,7 +193,7 @@ Use the **Grouping** menu to select one of the following options:
* Group by URL - Show a single preview for all FrameGroups with the same context
#### Preview Source
When using multi-source FrameGroups, users can choose which of the FrameGroups’ sources will be displayed as the preview.
When using multi-source FrameGroups, users can choose which of the FrameGroups' sources will be displayed as the preview.
Select a source from the **PREVIEW SOURCE** menu.
Choose the `Default preview source` option to present the first available source.

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

@@ -11,7 +11,7 @@ to the specific task's **DATAVIEWS** tab (see [Experiment Dataviews](webapp_exp_
View the Dataviews table in table view <img src="/docs/latest/icons/ico-table-view.svg" alt="Table view" className="icon size-md space-sm" />
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your Dataviews according to
columns of interest. Use the details view to access a selected Dataview’s details, while keeping the Dataview list in view.
columns of interest. Use the details view to access a selected Dataview's details, while keeping the Dataview list in view.
Details view can also be accessed by double-clicking a specific Dataview in the table view to open its details view.
You can archive Dataviews so the Dataviews table doesn't get too cluttered. Click **OPEN ARCHIVE** on the top of the

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

@@ -16,7 +16,7 @@ The comparison page opens in the **DETAILS** tab, showing a column for each expe
## Dataviews
In the **Details** tab, you can view differences in the experiments’ nominal values. Each experiment’s information is
In the **Details** tab, you can view differences in the experiments' nominal values. Each experiment's information is
displayed in a column, so each field is lined up side-by-side. Expand the **DATAVIEWS**
section to view all the Dataview fields side-by-side (filters, iterations, label enumeration, etc.). The differences between the
experiments are highlighted. Obscure identical fields by switching on the `Hide Identical Fields` toggle.