clearml-docs/docs/hyperdatasets/webapp/webapp_datasets.md

91 lines
4.0 KiB
Markdown
Raw Normal View History

2021-06-20 22:00:16 +00:00
---
2022-11-15 12:17:42 +00:00
title: Hyper-Datasets Page
2021-06-20 22:00:16 +00:00
---
2022-11-15 12:17:42 +00:00
Use the Hyper-Datasets Page to navigate between and manage hyper-datasets.
2021-06-20 22:00:16 +00:00
2023-03-15 13:11:34 +00:00
You can view the Hyper-Datasets page in Project view <img src="/docs/latest/icons/ico-project-view.svg" alt="Project view" className="icon size-md" />
or in List view <img src="/docs/latest/icons/ico-flat-view.svg" alt="List view" className="icon size-md" />. In List
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.
2023-12-03 12:27:46 +00:00
Click on a Hyper-Dataset card to open the dataset's [version list](webapp_datasets_versioning.md), where you can view
2022-11-15 12:17:42 +00:00
and manage the dataset versions' lineage and contents.
2021-06-20 22:00:16 +00:00
2023-12-03 12:27:46 +00:00
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" />:
2022-12-22 09:36:45 +00:00
* 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"
respectively. These options appear on the top of the tag list.
* Filter by the absence of a tag (logical "NOT") by clicking its checkbox twice. An X will appear in the tag's checkbox.
2021-06-20 22:00:16 +00:00
2022-11-15 12:17:42 +00:00
![Hyper-Dataset page](../../img/hyperdatasets/datasets_01.png)
2023-03-15 13:11:34 +00:00
## Project Cards
2023-12-03 12:27:46 +00:00
In Project view, project cards display a project's summarized hyper-dataset information:
2023-03-15 13:11:34 +00:00
2023-03-19 10:34:17 +00:00
<div class="max-w-50">
2023-03-15 13:11:34 +00:00
![Hyper-Dataset project card](../../img/hyperdatasets/hyperdataset_project_card.png)
2023-03-19 10:34:17 +00:00
</div>
2023-03-15 13:11:34 +00:00
* Project name
* Number of hyper-datasets in project
* Tags used by hyper-datasets in project
Click on a project card to view its hyper-datasets.
2022-11-15 12:17:42 +00:00
## Hyper-Dataset Cards
2023-03-15 13:11:34 +00:00
In List view, the Hyper-Dataset cards display summarized dataset information:
2022-11-15 12:17:42 +00:00
2023-03-19 10:34:17 +00:00
<div class="max-w-50">
2022-11-15 12:17:42 +00:00
![Hyper-Dataset card](../../img/hyperdatasets/hyperdataset_card.png)
2021-06-20 22:00:16 +00:00
2023-03-19 10:34:17 +00:00
</div>
2021-06-20 22:00:16 +00:00
* Dataset name
2022-11-15 12:17:42 +00:00
* Time since last update. Hover over elapsed time to view date of last update
2021-06-20 22:00:16 +00:00
* User updating the Dataset
* If the dataset contains dataset-level metadata, the card displays the <img src="/docs/latest/icons/ico-status-completed.svg" alt="Check mark" className="icon size-md space-sm" />
2022-11-15 12:17:42 +00:00
`Metadata` indicator, which opens the Metadata editor on click
2021-06-20 22:00:16 +00:00
* The number of versions in the Dataset
2022-11-15 12:17:42 +00:00
* The total number of frames in all versions of the Dataset. If an asterisk (\*) appears next to **FRAMES**, then you can hover over it and see the name of the version whose frames were last updated
* The percentage of frames annotated in all versions of the Dataset. If an asterisk (\*) appears next to **ANNOTATED**, then you can hover over it and see the name of the version whose frames were last annotated
* If the Dataset version's status is *Published*, then the Dataset's top labels appear (colors are editable). If the
2022-11-15 12:17:42 +00:00
Dataset version is *Draft*, then no labels appear
* Tags
2022-09-22 06:42:44 +00:00
:::note Change Label Color
2022-09-22 06:42:44 +00:00
To change the label color coding, hover over a label color, click the hand pointer, and then select a new color.
2021-06-20 22:00:16 +00:00
:::
2022-11-15 12:17:42 +00:00
### Hyper-Dataset Actions
2022-11-15 12:17:42 +00:00
Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" /> on the top right
of a dataset card to open its context menu and access dataset actions:
2021-06-20 22:00:16 +00:00
2022-11-15 12:17:42 +00:00
<div class="max-w-50">
2021-06-20 22:00:16 +00:00
2022-11-15 12:17:42 +00:00
![Hyper-Dataset context menu](../../img/webapp_hyperdataset_card_context_menu.png)
2021-06-20 22:00:16 +00:00
2022-11-15 12:17:42 +00:00
</div>
2021-06-20 22:00:16 +00:00
2023-12-03 12:27:46 +00:00
* **Rename** - Change the dataset's name
2022-11-15 12:17:42 +00:00
* **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
2021-06-20 22:00:16 +00:00
2022-11-15 12:17:42 +00:00
## Create New Hyper-Datasets
2021-06-20 22:00:16 +00:00
2023-09-21 10:52:36 +00:00
To create a Hyper-Dataset, click the **+ NEW DATASET** button in the top right of the page, which will open a
2022-11-15 12:17:42 +00:00
**New Dataset** modal.
2021-06-20 22:00:16 +00:00
2022-11-15 12:17:42 +00:00
![Hyper-Dataset creation modal](../../img/webapp_hyperdataset_creation.png)
2021-06-20 22:00:16 +00:00
2022-11-15 12:17:42 +00:00
This creates a new Hyper-Dataset that contains a single, empty draft version.