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

Small edits (#526)

Browse Source
This commit is contained in:
pollfly
2023-04-04 16:16:54 +03:00
committed by GitHub
parent 4700306b9d
commit 3b71c66636
21 changed files with 41 additions and 255 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/hyperdatasets/dataset.md
View File

@@ -9,7 +9,7 @@ and functionality for the following purposes:
* Integrating the powerful features of [Dataviews](dataviews.md) with an experiment
* [Annotating](webapp/webapp_datasets_frames.md#annotations) images and videos
Datasets consist of versions with SingleFrames and / or FrameGroups. Each Dataset can contain multiple versions, which
Datasets consist of versions with SingleFrames and/or FrameGroups. Each Dataset can contain multiple versions, which
can have multiple children that inherit their parent's contents.
Mask-labels can be defined globally, for a DatasetVersion. When defined this way, they will be applied to all masks in
@@ -158,7 +158,7 @@ versions are locked for further changes and which can be modified. See details [
Dataset versions can have either *Draft* or *Published* state.
A *Draft* version is editable, so frames can be added to and deleted and / or modified.
A *Draft* version is editable, so frames can be added to and deleted and/or modified.
A *Published* version is read-only, which ensures reproducible experiments and preserves the Dataset version contents.
Child versions can only be created from *Published* versions, as they inherit their predecessor version contents.
@@ -236,7 +236,7 @@ myDataset = DatasetVersion.create_snapshot(
#### Adding Metadata and Comments
Add a metadata dictionary and / or comment to a snapshot.
Add a metadata dictionary and/or comment to a snapshot.
For example:

8
docs/hyperdatasets/dataviews.md
View File

@@ -35,7 +35,7 @@ A frame filter contains the following criteria:
* Any combination of the following rules:
* ROI rule - Include or exclude frames containing at least one ROI with any combination of labels in the Dataset version.
Optionally, limit the number of matching ROIs (instances) per frame, and / or limit the confidence level of the label.
Optionally, limit the number of matching ROIs (instances) per frame, and/or limit the confidence level of the label.
For example: include frames containing two to four ROIs labeled `cat` and `dog`, with a confidence level from `0.8` to `1.0`.
* Frame rule - Filter by frame metadata key-value pairs, or ROI labels.
For example: if some frames contain the metadata
@@ -150,7 +150,7 @@ myDataView = DataView(iteration_order=IterationOrder.random, iteration_infinite=
### Adding Queries
To add a query to a DataView, use the [`DataView.add_query`](../references/hyperdataset/dataview.md#add_query) method
and specify Dataset versions, ROI and / or frame queries, and other criteria.
and specify Dataset versions, ROI and/or frame queries, and other criteria.
The `dataset_name` and `version_name` arguments specify the Dataset Version. The `roi_query` and `frame_query` arguments
specify the queries.
@@ -158,7 +158,7 @@ specify the queries.
* `frame_query` must be assigned a Lucene query.
Multiple queries can be added to the same or different Dataset versions, each query with the same or different ROI
and / or frame queries.
and/or frame queries.
You can retrieve the Dataview frames using [`DataView.to_list`](../references/hyperdataset/dataview.md#to_list),
[`DataView.to_dict`](../references/hyperdataset/dataview.md#to_dict), or [`DataView.get_iterator`](../references/hyperdataset/dataview.md#get_iterator)
@@ -286,7 +286,7 @@ list_of_frames = myDataView.to_list()
#### Frame Queries
Use frame queries to filter frames by ROI labels and / or frame metadata key-value pairs that a frame must include or
Use frame queries to filter frames by ROI labels and/or frame metadata key-value pairs that a frame must include or
exclude for the Dataview to return the frame.
**Frame queries** match frame meta key-value pairs, ROI labels, or both.

4
docs/hyperdatasets/webapp/webapp_dataviews.md
View File

@@ -39,11 +39,11 @@ Customize the table using any of the following:
* Dynamic column order - Drag a column title to a different position.
* Resize columns - Drag the column separator to change the width of that column. Double-click the column separator for automatic fit.
* Filter by user and / or status - When a filter is applied to a column, its filter icon will appear with a highlighted
* Filter by user and/or status - When a filter is applied to a column, its filter icon will appear with a highlighted
dot on its top right (<img src="/docs/latest/icons/ico-filter-on.svg" alt="Filter on" className="icon size-md" /> ). To
clear all active filters, click <img src="/docs/latest/icons/ico-filter-reset.svg" alt="Clear filters" className="icon size-md" />
in the top right corner of the table.
* Sort columns - By experiment name and / or elapsed time since creation.
* Sort columns - By experiment name and/or elapsed time since creation.
:::note
The following Dataviews-table customizations are saved on a **per-project** basis:

2
docs/hyperdatasets/webapp/webapp_exp_modifying.md
View File

@@ -34,7 +34,7 @@ enables modifying [Dataviews](webapp_dataviews.md), including:
select **Import to current dataview** or **Import as aux dataview**.
:::note
After importing a Dataview, it can be renamed and / or removed.
After importing a Dataview, it can be renamed and/or removed.
:::
### Selecting Dataset Versions

2
docs/hyperdatasets/webapp/webapp_exp_track_visual.md
View File

@@ -31,7 +31,7 @@ The **FILTERING** section lists the SingleFrame filters iterated by a Dataview,
Each frame filter is composed of:
* A Dataset version to input from
* ROI Rules for SingleFrames to include and / or exclude certain criteria.
* ROI Rules for SingleFrames to include and/or exclude certain criteria.
* Weights for debiasing input data.
Combinations of frame filters can implement complex querying.