ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-03-03 02:32:49 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Small edits (#337)

Browse Source
This commit is contained in:
pollfly 2022-09-22 09:42:44 +03:00 committed by GitHub
parent 7742942118
commit 6d33cd011e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/clearml_data/clearml_data_cli.md
View File

@ -129,7 +129,7 @@ clearml-data upload [-h] [--id ID] [--storage STORAGE] [--chunk-size CHUNK_SIZE]
## close
Finalize the dataset and makes it ready to be consumed. This automatically uploads all files that were not previously uploaded.
Finalize the dataset and make it ready to be consumed. This automatically uploads all files that were not previously uploaded.
Once a dataset is finalized, it can no longer be modified.
```bash

2
docs/clearml_data/data_management_examples/data_man_simple.md
View File

@ -165,5 +165,5 @@ You'll need to input the Dataset ID you received when created the dataset above
```
By using `clearml-data`, a clear lineage is created for the data. As seen in this example, when a dataset is closed, the
only way to add or remove data is to create a new dataset, and using the previous dataset as a parent. This way, the data
only way to add or remove data is to create a new dataset, and to use the previous dataset as a parent. This way, the data
is not reliant on the code and is reproducible.

2
docs/hyperdatasets/dataviews.md
View File

@ -368,7 +368,7 @@ myDataView.add_query(
ROI label translation (label mapping) enables combining labels for training, combining disparate datasets, and hiding
certain labels for training.
This example demonstrates consolidating two disparate Datasets. Two Dataset versions use `car` (lower case "c"), but a
This example demonstrates consolidating two disparate Datasets. Two Dataset versions use `car` (lower case "c"), but the
third uses `Car` (upper case "C").
The example maps `Car` (upper case "C") to `car` (lower case "c").

6
docs/hyperdatasets/overview.md
View File

@ -3,7 +3,7 @@ title: Hyper-Datasets
---
ClearML's Hyper-Datasets are an MLOps-oriented abstraction of your data, which facilitates traceable, reproducible model development
through parametrized data access and meta-data version control.
through parameterized data access and meta-data version control.
The basic premise is that a user-formed query is a full representation of the dataset used by the ML/DL process.
@ -24,9 +24,9 @@ A Hyper-Dataset is composed of the following components:
* [Datasets and Dataset Versions](dataset.md)
* [Dataviews](dataviews.md)
These components interact in a way that enables revising data and tracking and accessing all of its version.
These components interact in a way that enables revising data and tracking and accessing all of its versions.
Frames are the basics units of data in ClearML Enterprise. SingleFrames and FrameGroups make up a Dataset version.
Frames are the basic units of data in ClearML Enterprise. SingleFrames and FrameGroups make up a Dataset version.
Dataset versions can be created, modified, and removed. The different version are recorded and available,
so experiments, and their data are reproducible and traceable.

16
docs/hyperdatasets/webapp/webapp_datasets.md
View File

@ -12,22 +12,22 @@ The Datasets page offers the following functionalities:
## 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 cards show summary information about versions:
* 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 <img src="/docs/latest/icons/ico-status-completed.svg" alt="Check mark" className="icon size-md space-sm" />
`Metadata` indicator, which is also a shortcut to [edit the Dataset's metadata](#editing-dataset-level-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.
* The total number of frames in all versions of the Dataset. If an asterisk (\*) appears next to **FRAMES**, then you can hover over it and see the name of the version whose frames were last updated.
* The percentage of frames annotated in all versions of the Dataset. If an asterisk (\*) appears next to **ANNOTATED**, then you can hover over it and see the name of the version whose frames were last annotated.
* 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.
Dataset cards allow you to open a specific Dataset to perform Dataset versioning and frames management.
:::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.
To change the label color coding, hover over a label color, click the hand pointer, and then select a new color.
:::
### Renaming a Dataset
@ -59,8 +59,8 @@ Create a new Dataset which will contain one version named `Current`. The new ver
* In **RECENT**, choose either:
* **RECENT** - Most recently update of the Datasets.
* **NAME** - Alphabetically sort by Dataset name.
* **RECENT** - Sort by update time
* **NAME** - Sort alphabetically by Dataset name.