clearml-docs/docs/hyperdatasets/webapp/webapp_datasets.md
pollfly eb91aaa361
Update docs (#153)
* add info for clear filter, float behavior, and tag exclusion

* add data examples to guides

* fix typo

* fix filtering wording, and float admonition title

* add abort all children action

* dataset metadata initial

* fix expand icon

* initial new exp comparison window

* initial scalar full screen

* fix typo

* edit dataset version metada

* edit exp comparison and add missing alts to icons

* add info about dataset-level datasets

* add info about full screen mode

* HOCON >>> JSON

* HOCON >>> JSON

* dataset card edits

* edit fullscreen scalar mode

* edit fullscreen scalar plots

* edit pipeline example based on code fixes

* full screen scalar edit

* add context navigation

* Add experiment selection info

* experiment selection edit

* custom ui plugin

* datasets and versioning

* fix link
2022-01-10 11:45:29 +02:00

3.2 KiB

title
Datasets Page

The Datasets page offers the following functionalities:

  • Managing the ClearML Enterprise Datasets and versions, which connect raw data to the ClearML Enterprise platform
  • Using ClearML Enterprise's Git-like Dataset versioning features
  • Managing SingleFrames and FrameGroups.

image

Dataset Cards

Dataset cards show summary information about versions, frames, and labels in a Dataset, and the elapsed time since the Dataset was last update and the user doing the update. Dataset cards allow you to open a specific Dataset to perform Dataset versioning and frames management.

  • Dataset name
  • Elapsed time since the last update. Hover over elapsed time and view date of last update.
  • User updating the Dataset
  • If the dataset contains dataset-level metadata, the card displays the Check mark Metadata indicator, which is also a shortcut to edit the Dataset's metadata
  • The number of versions in the Dataset
  • The total number of frames in all versions of the Dataset. If an asterisk (*) appears next to FRAMES, then you can hover it and see the name of the version whose frames were last updated appears.
  • The percentage of frames annotated in all versions of the Dataset. If an asterisk (*) appears next to ANNOTATED, then you can hover it and see the name of the version whose frames were last annotated appears.
  • If the Dataset version's status is Published, then the Dataset's top labels appear (colors are editable). If the Dataset version is Draft, then no labels appear.

:::note Change Label Color To change the label color coding, hover over a label color, click thr hand pointer, and then select a new color. :::

Renaming a Dataset

  1. Click Bars menu
  2. Click Rename Edit pencil
  3. Edit the name
  4. Click Check mark

Editing Dataset-level Metadata

To edit the dataset-level metadata

  1. Open the metadata edit window in one the following ways:
    • Click Check mark Metadata
    • Click Bars menu, then click Edit Metadata Edit metadata
  2. Edit the section contents (JSON format)
  3. Click OK

Creating New Datasets

Create a new Dataset which will contain one version named Current. The new version will not contain any frames.

  • Click + NEW DATASET > Enter a name and optionally a description > CREATE DATASET.

Sort Datasets

  • In RECENT, choose either:

    • RECENT - Most recently update of the Datasets.
    • NAME - Alphabetically sort by Dataset name.