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

114 lines
3.9 KiB
Markdown
Raw Normal View History

2021-06-20 22:00:16 +00:00
---
title: Dataset Versioning
---
2021-06-21 18:13:17 +00:00
Use the Dataset versioning WebApp (UI) features for viewing, creating, modifying, and
2021-06-20 22:00:16 +00:00
deleting Dataset versions.
2021-06-21 18:13:17 +00:00
From the Datasets page, click on one of the Datasets in order to see and work with its versions.
2021-06-20 22:00:16 +00:00
### Viewing snapshots
2021-06-21 18:13:17 +00:00
2021-06-20 22:00:16 +00:00
View snapshots in the simple version structure using either:
2021-06-21 18:13:17 +00:00
2021-06-20 22:00:16 +00:00
* The simple view, a table of snapshots.
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">Simple view (snapshot table)</summary>
<div className="cml-expansion-panel-content">
![image](../../img/hyperdatasets/web-app/dataset_simple_adv_01.png)
</div>
</details>
<br/>
* The advanced view, a tree of versions. The tree contains one version whose status is <i>Draft</i>, and snapshots appear in
chronological order, with oldest at the top, and the most recent at the bottom.
2021-06-21 18:13:17 +00:00
2021-06-20 22:00:16 +00:00
<details className="cml-expansion-panel screenshot">
<summary className="cml-expansion-panel-summary">Advanced view (version tree)</summary>
<div className="cml-expansion-panel-content">
![image](../../img/hyperdatasets/web-app/dataset_simple_adv_02.png)
2021-06-21 18:13:17 +00:00
</div>
2021-06-20 22:00:16 +00:00
</details>
### Creating snapshots
2021-06-21 18:13:17 +00:00
To create a snapshot, you must be in the simple (version table) view.
2021-06-20 22:00:16 +00:00
**To create a snapshot, do the following:**
2021-06-21 18:13:17 +00:00
1. If you are in the advanced view, click **Switch to Simple View** (In certain situations, this may not be possible,
see [Dataset Versioning](../dataset.md#dataset-versioning))
2021-06-20 22:00:16 +00:00
1. If the **DATASET HISTORY** section is not opened, click it.
1. If a snapshot is currently selected, click **RETURN TO CURRENT VERSION**.
1. Click **+ CREATE SNAPSHOT**.
1. Enter a version name, and optionally a description.
1. Click **CREATE**.
:::note
The WebApp (UI) does not currently support the automatic naming of snapshots with timestamps appended. You must provide a snapshot name.
:::
### Creating versions
To create a version, you must be in the advanced (version tree) view.
**To create a child version, do the following:**
1. If you are in the simple view, click **Switch to Advanced View**.
1. Click the (parent) version from which to create a child (inherit all frames).
1. Click **+ CREATE NEW VERSION**.
1. Enter a version name, and optionally a description.
1. Click **CREATE**.
### Publishing versions
Publish (make read-only) any Dataset version whose status is *Draft*. If the Dataset is in the simple structure,
and you publish the current version, then only the advanced view is available,
2021-06-21 18:13:17 +00:00
and you cannot create snapshots.
2021-06-20 22:00:16 +00:00
**To publish a version, do the following:**
1. If you are in the simple view, click **Switch to Advanced View**.
1. Click the version to publish.
1. Click **PUBLISH**.
1. Click **PUBLISH** again to confirm.
### Exporting frames
Frame exports downloaded filtered frames as a JSON file.
**To export frames, do the following:**
* In the Thumbnails area, click **EXPORT FRAMES**. The frames JSON file downloads.
2021-06-21 18:13:17 +00:00
2021-06-20 22:00:16 +00:00
### Modifying version names
**To modify a Dataset version name, do the following:**
2021-06-21 12:23:21 +00:00
* At the top right of the Dataset page, hover over the Dataset version name, click <img src="/docs/latest/icons/ico-edit.svg" className="icon size-md space-sm" /> , edit the name, and then click <img src="/docs/latest/icons/ico-save.svg" className="icon size-md space-sm" /> (check).
2021-06-21 18:13:17 +00:00
2021-06-20 22:00:16 +00:00
### Modifying version descriptions
**To modify a version description, do the following:**
2021-06-21 18:13:17 +00:00
* Expand the **INFO** area, hover over the **Description**, click <img src="/docs/latest/icons/ico-edit.svg" className="icon size-md space-sm" />,
2021-06-21 12:23:21 +00:00
edit the name, and then click <img src="/docs/latest/icons/ico-save.svg" className="icon size-md space-sm" /> (check).
2021-06-21 18:13:17 +00:00
2021-06-20 22:00:16 +00:00
### Deleting versions
2021-06-21 18:13:17 +00:00
You can delete versions whose status is *Draft*.
2021-06-20 22:00:16 +00:00
**To delete the current version, do the following:**
* If you are in the simple view, click **Switch to Advanced View**.
* Click the version to delete.
* Click **DELETE**.
* Click **DELETE** again to confirm.