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

Update documentation (#193)

Browse Source
This commit is contained in:
pollfly
2022-03-06 13:00:46 +02:00
committed by GitHub
parent 6633ed6ce6
commit 1871e3da9a
32 changed files with 171 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/hyperdatasets/webapp/webapp_datasets_versioning.md
View File

@@ -244,10 +244,10 @@ Use the **Grouping** menu to select one of the following options:
#### Preview Source
When using multi-source FrameGroups, users can choose which of the FrameGroups’ sources will be displayed as the preview.
Use the **PREVIEW SOURCE** menu to select from the list of sources.
Select a source from the **PREVIEW SOURCE** menu.
Choose the `Default preview source` option to present the first available source.
:::note
If a FrameGroup doesn't have the selected preview source, the next available source will be used for the preview.
:::note Unavailable Source
If a FrameGroup doesn't have the selected preview source, the preview displays the "Source not available" message.
:::

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

@@ -6,16 +6,17 @@ title: The Dataviews Table
as well as the **DATAVIEWS** tab in the **All Projects** page.
The **Dataviews table** is a [customizable](#customizing-the-dataviews-table) list of Dataviews associated with a project.
Use it to [view, create, and edit Dataviews](#viewing-adding-and-editing-dataviews) in the info panel. Dataview tables
Use it to view, create, and edit Dataviews in the info panel. Dataview tables
can be filtered by name or name fragments and / or ID, by using the search bar.
![Dataviews table](../../img/hyperdatasets/dataviews_table_01.png)
![Dataviews table](../../img/hyperdatasets/webapp_dataviews_table.png)
The Dataviews table columns in their default order are below. Dynamically order the columns by dragging a column heading
to a new position.
* **DATAVIEW** - Dataview name.
* **USER** - User creating the Dataview.
* **USER** - User who created the Dataview.
* **Status** - The status of the Dataview, which can be *Draft* (editable) or *Published* (read-only).
* **CREATED** - Elapsed time since the Dataview was created.
* **DESCRIPTION**
@@ -24,12 +25,12 @@ to a new position.
The Dataviews table can be customized. Changes are persistent (cached in the browser), and represented in the URL.
Save customized settings in a browser bookmark, and share the URL with teammates.
Customize any combination of the following:
Customize the table using any of the following:
* Dynamic column ordering - Drag a column title to a different position.
* Filter by user
* 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
* Sort columns - By experiment name and / or elapsed time since creation.
* Column autofit - In the column heading, double click a resizer (column separator).
:::note
The following Dataviews-table customizations are saved on a **per project** basis:
@@ -48,11 +49,13 @@ all the Dataviews in the project. The customizations of these two views are save
The following table describes the actions that can be performed from the Dataviews table.
| ClearML Action | Description |
|---|---|--|
|---|---|
| View details | Dataview details, including input datasets, label mapping, augmentation operations, and iteration control. Click a Dataview and the info panel slides open. |
| Archive | To more easily work with active Dataviews, move a Dataview to the archive. See [Archiving Dataviews](#archiving-dataviews). |
| Clone | Make an exact copy of a Dataview. |
| Move to project | To organize work and improve collaboration, move a Dataview to another project. |
| Archive | To more easily work with active Dataviews, move a Dataview to the archive, removing it from the active Dataview table. |
| Restore | Action available in the archive. Restore a Dataview to the active Dataviews table. |
| Clone | Make an exact copy of a Dataview that is editable. |
| Move to project | To organize work and improve collaboration, move a Dataview to another project. |
| Publish | Publish a Dataview to prevent changes to it. *Published* Dataviews are read-only.|
| Custom action | When available, provides a mechanism to define your own custom action which will appear in the context menu. See [Custom UI Context Menu Actions](../../deploying_clearml/clearml_server_config.md#custom-ui-context-menu-actions).|
These actions can be accessed with the context menu (when right-clicking a Dataview or clicking the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" />
@@ -64,68 +67,11 @@ Select multiple Dataviews, then use either the context menu, or the bar that app
operations on the selected Dataviews. The context menu shows the number of Dataviews that can be affected by each action.
The same information can be found in the bottom menu, in a tooltip that appears when hovering over an action icon.
![Dataviews table batch operations](../../img/webapp_dataview_table_batch_operations.png)
![Dataviews table batch operations](../../img/hyperdatasets/webapp_dataviews_context_menu.png)
## Creating a Dataview
## Viewing, Adding, and Editing Dataviews
**To view, add, or edit a Dataview:**
1. Do one of the following:
* Create a new Dataview - Click **+ NEW DATAVIEW**.
* View or edit a Dataview - In the Dataview table, click the Dataview.
1. To edit sections of the Dataview, follow the steps on the "Modifying Dataviews" page for the following:
1. [Selecting Dataset versions](webapp_exp_modifying.md#selecting-dataset-versions)
1. [Filtering frames](webapp_exp_modifying.md#filtering-frames)
1. [Mapping labels (label translation)](webapp_exp_modifying.md#mapping-labels-label-translation) (if appropriate for
the data and experiment)
1. [Label enumeration](webapp_exp_modifying.md#label-enumeration)
1. [Data augmentation](webapp_exp_modifying.md#data-augmentation) (if appropriate for the data
and experiment)
1. [Iteration controls](webapp_exp_modifying.md#iteration-controls)
## Cloning Dataviews
Create an exact editable copy of a Dataview. For example, when tuning an experiment, clone a Dataview to apply the same
frame filters to different Dataset versions.
**To clone a Dataview:**
1. Do one of the following:
* In the Dataview table, right click a Dataview and then click **Clone**.
* If the info panel is opened, click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-lg space-sm" />
(menu) and then click **Clone**.
1. Select a project or accept the current project, enter a name, and optionally enter a description
1. Click **CLONE**.
## Archiving Dataviews
Archive Dataviews to more easily manage current work. Archived Dataviews do not appear on the active Dataviews table.
They only appear in the archive. After archiving, the Dataview can be restored from the archive later.
**To archive a Dataview:**
* In the Dataview table:
* Archive one Dataview - Right click the Dataview **>** **Archive**.
* Archive multiple Dataviews - Select the Dataview checkboxes **>** In the footer menu that appears at the bottom of
the page, click **ARCHIVE**.
* In the Dataview info panel - Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-lg space-sm" />
(menu) **>** **ARCHIVE**.
**To restore a Dataview:**
1. Go to the Dataview table of the archived Dataview or of the **All Projects** page
1. Click **OPEN ARCHIVE**
1. Do any of the following:
* In the Dataview table:
* Restore one Dataview - Right click the Dataview **>** **Restore**.
* Restore multiple Dataviews - Select the Dataview checkboxes **>** **Restore**.
* In the info panel, restore one Dataview - Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-lg space-sm" />
(menu) **>** **Restore**.
Create a new Dataview by clicking the **+ NEW DATAVIEW** button at the top right of the table, which open a
**NEW DATAVIEW** window.
![New Dataview window](../../img/webapp_dataview_new.png)

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

@@ -1,5 +1,5 @@
---
title: Viewing Experiments
title: Experiment Dataviews
---
While an experiment is running, and any time after it finishes, results are tracked and can be visualized in the ClearML
@@ -11,7 +11,7 @@ experiment, which can be viewed and [modified](webapp_exp_modifying.md) in the W
## Viewing an Experiment's Dataviews
In an experiment's page, go to the **DATAVIEWS** tab to view all the experiment's Dataview details, including:
* Input data [selection](#dataset-versions) and [filtering](#filtering)
* Input data [selection](#input) and [filtering](#filtering)
* ROI [mapping](#mapping) (label translation)
* [Label enumeration](#label-enumeration)
* On-the-fly [data augmentation](#augmentation)