@@ -5,7 +5,8 @@ title: Dataset Versions
Use the Dataset versioning WebApp (UI) features for viewing, creating, modifying, and
deleting [Dataset versions ](../dataset.md#dataset-versioning ).
## Dataset Version History
@@ -13,11 +14,21 @@ or list view <img src="/docs/latest/icons/ico-list-view.svg" alt="List view" cla
The tree view shows the lineage of the dataset's versions.
<div class="max-w-50">
</div>
The list view lists the dataset's versions chronologically by last update time.
<div class="max-w-50">
</div>
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.
@@ -27,7 +38,12 @@ all versions that match the query.
In tree view, parent versions that do not match the query where a child version does appear in a muted color.
<div class="max-w-50">
</div>
### Version Actions
@@ -43,7 +59,13 @@ Access dataset version actions, by right-clicking a version, or through the menu
When publishing a version, you can create an additional working copy. The new version is created in a * draft * state, and
inherits all the published version's frames.
<div class="max-w-75">
</div>
:::
## Version Data
@@ -67,12 +89,14 @@ Use the thumbnail view for a visual preview of the version's frames. You can inc
and decrease <img src="/docs/latest/icons/ico-zoom-out.svg" alt="Zoom out" className="icon size-md space-sm" /> the size of
the previews.
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.
The dataset version's frames can be filtered by multiple criteria. The resulting frames can be [exported as a JSON file ](#exporting-frames ).
@@ -88,11 +112,13 @@ Simple frame filtering returns frames containing at least one annotation with a
* The **FRAMES ** tab in the image below contains 101 frames.
* A simple label filter for `teddy bear` shows three frames, each containing at least one ROI labeled `teddy bear` .
</Collapsible>
@@ -121,7 +147,8 @@ A frame filter can contain a number of rules. For each frame filter, the rules a
The returned frames are those that match the first rule AND the second rule within the frame filter.
Create additional frame filters by clicking <img src="/docs/latest/icons/ico-add.svg" alt="Add new" className="icon size-md space-sm" />.
Multiple frame filters are applied with a logical OR operator.
@@ -130,7 +157,8 @@ For example, the dataset version in the image below has two frame filters. "Fram
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.
To clear all filters click <img src="/docs/latest/icons/ico-filter-reset.svg" alt="Clear filters" className="icon size-md" />.
@@ -141,28 +169,33 @@ To clear all filters click <img src="/docs/latest/icons/ico-filter-reset.svg" al
* Create one ROI rule for the `teddy bear` label, which shows the same three frames as the simple frame filter (above).
* In the ROI rule, add a second label. Add `partially_occluded` . Only frames containing at least one ROI labeled as both
`teddy bear` and `partially_occluded` match the filter.
* By opening a frame in the frame viewer, you can see an ROI labeled with both.
* To find frames that contain multiple ROIs, each with a different label, use separate ROI rules. Create an ROI rule for
the `teddy bear` label and, in the same filter, add another ROI rule for the `person` label. This will return all
frames that include at least one ROIs with a `person` label AND at least one (other) ROI with a `teddy bear` label.
* You can also exclude certain ROI labels. Create an ROI rule to include `teddy bear` and, in the same filter, an ROI
rule to exclude `person` . This will return all frames that include at least one ROI with the label `teddy bear` AND have
NO ROI with the `person` label
</Collapsible>
@@ -172,11 +205,13 @@ Filter by metadata using Lucene queries.
* Add a frame rule to filter by the metadata key `dangerous` for the value of `yes` .
* Open a frame in the frame viewer to see its metadata.
</Collapsible>
@@ -186,7 +221,8 @@ Filter by sources using Lucene queries.
* Add a source rule to filter for source URIs with wildcards.
Lucene queries can also be used in ROI label filters and frame rules.
@@ -204,7 +240,8 @@ Sort the dataset version’
Click <img src="/docs/latest/icons/ico-sort.svg" alt="Sort order" className="icon size-md space-sm" /> to toggle between ascending and descending sort orders.
### Exporting Frames
@@ -214,7 +251,12 @@ To export (download) the filtered frames as a JSON file, click <img src="/docs/l
frame browser configuration settings.
<div class="max-w-75">
</div>
#### Grouping Previews
@@ -223,10 +265,11 @@ Use the **Grouping** menu to set how to display frames that share a common prope
* * *Group by URL** - Show a single preview for all FrameGroups with the same context ID. For example, users can set the
same `context_id` to multiple FrameGroups that represent frames in a single video.
* * *Sample by Property** - Specify a frame or ROI property whose value to group frames by and set the number of frames
to preview for each group. For example, in the image below, frames are grouped by ROI labels. Each group displays six
to preview for each group. For example, in the image below, frames are grouped by ROI labels. Each group displays five
samples of frames that contain an ROI with the same label.
**To sample by property: **
1. In the **Grouping ** menu, click **Sample by Property **
@@ -240,12 +283,18 @@ samples of frames that contain an ROI with the same label.
to use in grouping by their properties. For example, in a Hyper-Dataset where ROIs have object labels and type labels,
view a sample of frames with different types of the same object by grouping frames according to `label.keyword`
with a match query for the object of interest.
<br/>
<div class="max-w-50">
</div>
The image below shows a sample of 3 frames which have ROIs of each type (`pedestrian` , `rider` , `sitting` ) of `person` .
:::note Property N/A group
If there are frames which have no value for the grouped by property, a sample of them will be provided as a final
group. If you sample according to an ROI property, this group will NOT include frames that have no ROIS at all.
@@ -273,7 +322,8 @@ Choose the `All sources` option to present all the FrameGroup’
shows annotations grouped by their respective sources. Additionally, annotation tools (e.g. create/delete/modify
annotations) are not available in this view.
:::note Unavailable Source
If a FrameGroup doesn't have the selected preview source, the preview displays the "Source not available" message.
@@ -298,7 +348,8 @@ be included in the calculation.
For example, calculating the distribution for the `label` ROI property, specifying `rois.confidence: 1` for ROI matching
will show the label distribution across only ROIs with a confidence level of 1.
By default, the ROI label distribution across the entire Hyper-Dataset version is shown.
The tab displays the following information
@@ -310,7 +361,8 @@ The tab displays the following information
* The pie chart visualizes this distribution. Hover over a chart segment and its associated property and count will
appear in a tooltip and its usage percentage will appear at the center of the chart.
## Metadata
**Metadata ** tab presents any additional metadata that has been attached to the dataset version.
@@ -321,7 +373,8 @@ The **Metadata** tab presents any additional metadata that has been attached to
1. Edit the section contents (JSON format)
1. Click **OK **
## Info
@@ -339,5 +392,6 @@ The **Info** tab presents a version's general information:
* Percentage of annotated frames
* Version description (editable, hover over element and click <img src="/docs/latest/icons/ico-edit.svg" alt="Edit pencil" className="icon size-md space-sm" />)
pollfly
GitHub