diff --git a/docs/hyperdatasets/webapp/webapp_datasets.md b/docs/hyperdatasets/webapp/webapp_datasets.md index 5cc3d06f..e17307f3 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets.md +++ b/docs/hyperdatasets/webapp/webapp_datasets.md @@ -84,6 +84,8 @@ of a dataset card to open its context menu and access dataset actions: +* **Copy Dataset ID** +* **View Dataset Schema** - View the dataset's frame document schema. This shows the frames’ fields and their types. * **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 diff --git a/docs/hyperdatasets/webapp/webapp_datasets_frames.md b/docs/hyperdatasets/webapp/webapp_datasets_frames.md index 2fc0f836..9feacf2e 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets_frames.md +++ b/docs/hyperdatasets/webapp/webapp_datasets_frames.md @@ -22,6 +22,18 @@ and frame metadata, as well as view frame masks of your dataset version frames. ![Frame viewer](../../img/hyperdatasets/dataset_example_frame_editor.png#light-mode-only) ![Frame viewer](../../img/hyperdatasets/dataset_example_frame_editor_dark.png#dark-mode-only) +### Viewing FrameGroup Data + +FrameGroup information is organized across several panels in the Frame Viewer: +* **FrameGroup Details** – Displays all FrameGroup details except metadata. The details include: general fields (e.g. + `context_id`, dataset ID and version, timestamp, etc.) as well as annotation (e.g. `rois`, their `labels`, `confidence`, etc.) + * Click edit metadata to view the details in a larger window. + * Click view schema to view the dataset's frame document schema. This covers all possible fields in the dataset +* **FrameGroup Metadata** – Displays FrameGroup-level metadata. Displays only the contents of the `frame.meta` field—typically used for structured metadata or custom key-value data. + * Click edit metadata to modify the metadata field. +* **Annotations** - Review and modify frame annotations. For more information, see [Masks](#masks) and [Annotations](#annotations). + + ### Frame Viewer Controls Use frame viewer controls to navigate between frames in a Hyper-Dataset Version, and control frame changes and viewing. @@ -113,7 +125,7 @@ If an annotation applies to all frames in a FrameGroup, it is displayed with a ` -## Masks +## Masks Use the **MASKS** panel to select which masks to apply over the frame. diff --git a/docs/img/hyperdatasets/webapp_hyperdataset_card_context_menu.png b/docs/img/hyperdatasets/webapp_hyperdataset_card_context_menu.png index 46c08b79..319898ea 100644 Binary files a/docs/img/hyperdatasets/webapp_hyperdataset_card_context_menu.png and b/docs/img/hyperdatasets/webapp_hyperdataset_card_context_menu.png differ diff --git a/docs/img/hyperdatasets/webapp_hyperdataset_card_context_menu_dark.png b/docs/img/hyperdatasets/webapp_hyperdataset_card_context_menu_dark.png index fa98eac6..023c8fcc 100644 Binary files a/docs/img/hyperdatasets/webapp_hyperdataset_card_context_menu_dark.png and b/docs/img/hyperdatasets/webapp_hyperdataset_card_context_menu_dark.png differ diff --git a/static/icons/ico-code-file.svg b/static/icons/ico-code-file.svg new file mode 100644 index 00000000..2110ef24 --- /dev/null +++ b/static/icons/ico-code-file.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file