From 6d33cd011e55f534f2574b240536bd286df9df79 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 22 Sep 2022 09:42:44 +0300 Subject: [PATCH] Small edits (#337) --- docs/clearml_data/clearml_data_cli.md | 2 +- .../data_management_examples/data_man_simple.md | 2 +- docs/hyperdatasets/dataviews.md | 2 +- docs/hyperdatasets/overview.md | 6 +++--- docs/hyperdatasets/webapp/webapp_datasets.md | 16 ++++++++-------- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/clearml_data/clearml_data_cli.md b/docs/clearml_data/clearml_data_cli.md index 1991d0fa..d37a10ed 100644 --- a/docs/clearml_data/clearml_data_cli.md +++ b/docs/clearml_data/clearml_data_cli.md @@ -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 diff --git a/docs/clearml_data/data_management_examples/data_man_simple.md b/docs/clearml_data/data_management_examples/data_man_simple.md index f84a5a7c..1f1b64d0 100644 --- a/docs/clearml_data/data_management_examples/data_man_simple.md +++ b/docs/clearml_data/data_management_examples/data_man_simple.md @@ -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. diff --git a/docs/hyperdatasets/dataviews.md b/docs/hyperdatasets/dataviews.md index ec1db875..ff8bb291 100644 --- a/docs/hyperdatasets/dataviews.md +++ b/docs/hyperdatasets/dataviews.md @@ -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"). diff --git a/docs/hyperdatasets/overview.md b/docs/hyperdatasets/overview.md index 308e3afc..eb80b236 100644 --- a/docs/hyperdatasets/overview.md +++ b/docs/hyperdatasets/overview.md @@ -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. diff --git a/docs/hyperdatasets/webapp/webapp_datasets.md b/docs/hyperdatasets/webapp/webapp_datasets.md index c7deefb2..900b3aa4 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets.md +++ b/docs/hyperdatasets/webapp/webapp_datasets.md @@ -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 Check mark `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.