Restructure docs for platform components and use case clarity (#1048)

This commit is contained in:
Noam Wasersprung
2025-02-23 17:33:55 +02:00
committed by GitHub
parent 535e08efa8
commit 567af28632
128 changed files with 4370 additions and 1404 deletions

View File

@@ -1,6 +1,10 @@
---
title: Tasks
title: Dataviews
---
:::important ENTERPRISE FEATURE
Dataviews available under the ClearML Enterprise plan.
:::
Hyper-Datasets extend the ClearML [**Task**](../fundamentals/task.md) with [Dataviews](dataviews.md).

View File

@@ -2,6 +2,10 @@
title: Annotation Tasks
---
:::important ENTERPRISE FEATURE
Annotation tasks are available under the ClearML Enterprise plan.
:::
Use the Annotations page to access and manage annotation Tasks.
Use annotation tasks to efficiently organize the annotation of frames in Dataset versions and manage the work of annotators

View File

@@ -2,6 +2,10 @@
title: Hyper-Datasets Page
---
:::important ENTERPRISE FEATURE
Hyper-Datasets are available under the ClearML Enterprise plan.
:::
Use the Hyper-Datasets Page to navigate between and manage hyper-datasets.
You can view the Hyper-Datasets page in Project view <img src="/docs/latest/icons/ico-project-view.svg" alt="Project view" className="icon size-md" />

View File

@@ -2,6 +2,10 @@
title: Working with Frames
---
:::important ENTERPRISE FEATURE
Hyper-Datasets are available under the ClearML Enterprise plan.
:::
View and edit SingleFrames in the Dataset page. After selecting a Hyper-Dataset version, the **Version Browser** shows a sample
of frames and enables viewing SingleFrames and FramesGroups, and editing SingleFrames, in the [frame viewer](#frame-viewer).
Before opening the frame viewer, you can filter the frames by applying [simple](webapp_datasets_versioning.md#simple-frame-filtering) or [advanced](webapp_datasets_versioning.md#advanced-frame-filtering)

View File

@@ -2,6 +2,10 @@
title: Dataset Versions
---
:::important ENTERPRISE FEATURE
Hyper-Datasets are available under the ClearML Enterprise plan.
:::
Use the Dataset versioning WebApp (UI) features for viewing, creating, modifying, and
deleting [Dataset versions](../dataset.md#dataset-versioning).

View File

@@ -2,6 +2,10 @@
title: The Dataview Table
---
:::important ENTERPRISE FEATURE
Dataviews are available under the ClearML Enterprise plan.
:::
The **Dataview table** is a [customizable](#customizing-the-dataview-table) list of Dataviews associated with a project.
Use it to view and create Dataviews, and access their info panels.

View File

@@ -2,6 +2,10 @@
title: Comparing Dataviews
---
:::important ENTERPRISE FEATURE
Dataviews are available under the ClearML Enterprise plan.
:::
In addition to [ClearML's comparison features](../../webapp/webapp_exp_comparing.md), the ClearML Enterprise WebApp
supports comparing input data selection criteria of task [Dataviews](../dataviews.md), enabling to easily locate, visualize, and analyze differences.

View File

@@ -2,6 +2,10 @@
title: Modifying Dataviews
---
:::important ENTERPRISE FEATURE
Dataviews are available under the ClearML Enterprise plan.
:::
A task that has been executed can be [cloned](../../webapp/webapp_exp_reproducing.md), then the cloned task's
execution details can be modified, and the modified task can be executed.

View File

@@ -2,6 +2,10 @@
title: Task Dataviews
---
:::important ENTERPRISE FEATURE
Dataviews are available under the ClearML Enterprise plan.
:::
While a task is running, and any time after it finishes, results are tracked and can be visualized in the ClearML
Enterprise WebApp (UI).