ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Change headings to title caps (#62)

Browse Source
This commit is contained in:
pollfly
2021-09-09 13:17:46 +03:00
committed by GitHub
parent de82df937e
commit c2d8707572
77 changed files with 337 additions and 336 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/hyperdatasets/dataset.md
View File

@@ -80,7 +80,7 @@ myDataset = DatasetVersion.create_new_dataset(dataset_name='myDataset',
description='some description text')
```
### Accessing current Dataset
### Accessing Current Dataset
To get the current Dataset, use the `DatasetVersion.get_current` method.
@@ -134,7 +134,7 @@ a Dataset version that yields a parent with two children, or when publishing the
Manage Dataset versioning using the DatasetVersion class in the ClearML Enterprise SDK.
### Creating snapshots
### Creating Snapshots
If the Dataset contains only one version whose status is *Draft*, snapshots of the current version can be created.
When creating a snapshot, the current version becomes the snapshot (it keeps the same version ID),
@@ -143,7 +143,7 @@ and the newly created version (with its new version ID) becomes the current vers
To create a snapshot, use the `DatasetVersion.create_snapshot` method.
#### Snapshot naming
#### Snapshot Naming
In the simple version structure, ClearML Enterprise supports two methods for snapshot naming:
* **Timestamp naming** - If only the Dataset name or ID is provided, the snapshot is named `snapshot` with a timestamp
@@ -172,7 +172,7 @@ In the simple version structure, ClearML Enterprise supports two methods for sna
The newly created version (with a new version ID) becomes the current version, and its name is `Current`.
#### Current version naming
#### Current Version Naming
In the simple version structure, ClearML Enterprise supports two methods for current version naming:
@@ -189,7 +189,7 @@ myDataset = DatasetVersion.create_snapshot(dataset_name='MyDataset',
child_name='NewCurrentVersionName')
```
#### Adding metadata and comments
#### Adding Metadata and Comments
Add a metadata dictionary and / or comment to a snapshot.
@@ -201,7 +201,7 @@ myDataset = DatasetVersion.create_snapshot(dataset_name='MyDataset',
child_comment='some text comment')
```
### Creating child versions
### Creating Child Versions
Create a new version from any version whose status is *Published*.
@@ -230,7 +230,7 @@ myVersion = DatasetVersion.create_version(dataset_name='MyDataset',
raise_if_exists=True))
```
### Creating root-level parent versions
### Creating Root-level Parent Versions
Create a new version at the root-level. This is a version without a parent, and it contains no frames.
@@ -239,7 +239,7 @@ myDataset = DatasetVersion.create_version(dataset_name='MyDataset',
version_name='NewRootVersion')
```
### Getting versions
### Getting Versions
To get a version or versions, use the `DatasetVersion.get_version` and `DatasetVersion.get_versions`
methods, respectively.
@@ -279,7 +279,7 @@ myDatasetversion = DatasetVersion.get_version(dataset_name='MyDataset',
version_name='VersionName')
```
### Deleting versions
### Deleting Versions
Delete versions which are status *Draft* using the `Dataset.delete_version` method.
@@ -291,7 +291,7 @@ myDataset.delete_version(version_name='VersionToDelete')
```
### Publishing versions
### Publishing Versions
Publish (make read-only) versions which are status *Draft* using the `Dataset.publish_version` method. This includes the current version, if the Dataset is in
the simple version structure.