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 (#225)

Browse Source
This commit is contained in:
pollfly
2022-04-07 11:49:11 +03:00
committed by GitHub
parent 5dbe070841
commit 37c43e0826
26 changed files with 206 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/hyperdatasets/webapp/webapp_datasets_frames.md
View File

@@ -245,11 +245,20 @@ Use Lucene queries in ROI label filters and frame rules.
## Masks
Use the **MASKS** panel to select a mask or multiple masks to apply over the frame.
Use the **MASKS** panel to select which masks to apply over the frame.
To view / hide a specific mask, click <img src="/docs/latest/icons/ico-show.svg" alt="Eye Show" className="icon size-md space-sm" />.
In order to view all masks, click **Show all** / **Hide all**.
Masks are applied over the image either by pixel segmentation or as an alpha channel:
* <img src="/docs/latest/icons/ico-segmentation.svg" alt="Pixel segmentation mode" className="icon size-md space-sm" /> Pixel
segmentation - Class labels are mapped onto the mask according to their pixel value definitions, and each
class is assigned a unique color.
* <img src="/docs/latest/icons/ico-alpha-mask.svg" alt="Alpha channel mode" className="icon size-md space-sm" /> Alpha
channel - Mask pixel values are translated to transparency. Additionally, a color can be applied to the mask to help
distinguish multiple masks. Click <img src="/docs/latest/icons/ico-mask-color-preview.svg" alt="Alpha color" className="icon size-md space-sm" /> to select
a color.
To adjust the transparency of a mask, use its opacity slider.
### Labels

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

@@ -6,19 +6,28 @@ 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 in the info panel. Dataview tables
can be filtered by name or name fragments and / or ID, by using the search bar.
Use it to view, create, and edit Dataviews in the info panel.
View the Dataviews table in table view <img src="/docs/latest/icons/ico-table-view.svg" alt="Table view" className="icon size-md space-sm" />
or in details view <img src="/docs/latest/icons/ico-split-view.svg" alt="Details view" className="icon size-md space-sm" />,
using the buttons on the top left of the page. Use the table view for a comparative view of your Dataviews according to
columns of interest. Use the details view to access a selected Dataview’s details, while keeping the Dataview list in view.
![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.
The Dataviews table includes the following columns:
* **DATAVIEW** - Dataview name.
* **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**
|Column|Description|Type|
|--|--|--|
|**DATAVIEW** | Dataview name | String|
|**USER** | User who created the Dataview | String|
|**STATUS** | The status of the Dataview, which can be *Draft* (editable) or *Published* (read-only)| String|
|**PROJECT** | The project name with which the dataview is associated| String|
|**CREATED** | Elapsed time since the Dataview was created| Date-time|
|**DESCRIPTION**| A description of the Dataview | String|
Dynamically order the columns by dragging a column heading
to a new position.
## Customizing the Dataviews Table
@@ -48,20 +57,20 @@ 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.
Access these actions with the context menu in any of the following ways:
* In the Dataviews table, right click a Dataview, or hover over a Dataview and click <img src="/docs/latest/icons/ico-dots-v-menu.svg" alt="Dot menu" className="icon size-md space-sm" />
* In a Dataview info panel, click the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Bar menu" className="icon size-md space-sm" />
| 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. |
| Details | Dataview details, including input datasets, label mapping, augmentation operations, and iteration control. |
| 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. |
| 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" />
in a Dataview's info panel).
Some of the actions mentioned in the chart above can be performed on multiple Dataviews at once.
Select multiple Dataviews, then use either the context menu, or the bar that appears at the bottom of the page, to perform
operations on the selected Dataviews. The context menu shows the number of Dataviews that can be affected by each action.