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

docs restructure - WIP

Browse Source
This commit is contained in:
alnoam
2025-02-20 20:02:18 +02:00
parent ae264a8c3b
commit 4327b43f58
11 changed files with 113 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/hyperdatasets/task.md
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).

4
docs/hyperdatasets/webapp/webapp_annotator.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

4
docs/hyperdatasets/webapp/webapp_datasets.md
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" />

4
docs/hyperdatasets/webapp/webapp_datasets_frames.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)

4
docs/hyperdatasets/webapp/webapp_datasets_versioning.md
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).

4
docs/hyperdatasets/webapp/webapp_dataviews.md
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.

4
docs/hyperdatasets/webapp/webapp_exp_comparing.md
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.

4
docs/hyperdatasets/webapp/webapp_exp_modifying.md
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.

4
docs/hyperdatasets/webapp/webapp_exp_track_visual.md
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).

2
docusaurus.config.js
View File

@@ -101,7 +101,7 @@ module.exports = {
position: 'left', // or 'right'
items: [
{
label: 'ClearMLopedia',
label: 'ClearML Basics',
to: '/docs/fundamentals/projects',
},
{

156
sidebars.js
View File

@@ -23,30 +23,8 @@ module.exports = {
'clearml_agent',
'clearml_agent/clearml_agent_dynamic_gpus',
'clearml_agent/clearml_agent_fractional_gpus',
{
type: 'category',
collapsible: true,
collapsed: true,
label: 'Cloud Autoscaling',
link: {type: 'doc', id: 'cloud_autoscaling/autoscaling_overview'},
items: [
'webapp/applications/apps_aws_autoscaler',
'webapp/applications/apps_gcp_autoscaler',
]
},
{
type: 'category',
collapsible: true,
collapsed: true,
label: 'Remote IDE',
link: {type: 'doc', id: 'remote_session'},
items: [
'apps/clearml_session',
{type: 'ref', id: 'webapp/applications/apps_ssh_session'},
{type: 'ref', id: 'webapp/applications/apps_jupyter_lab'},
{type: 'ref', id: 'webapp/applications/apps_vscode'}
]
},
'cloud_autoscaling/autoscaling_overview',
'remote_session'
]
},
{
@@ -76,28 +54,17 @@ module.exports = {
]
},
/*
'integrations/storage',
*/
],
usecaseSidebar: [
'getting_started/main',
{
type: 'category',
collapsible: true,
label: 'Where do I start?',
items: [
'getting_started/auto_log_exp',
'getting_started/track_tasks',
'getting_started/reproduce_tasks',
'getting_started/logging_using_artifacts',
{'MLOps and LLMOps': [
/*'getting_started/main',*/
'getting_started/auto_log_exp',
'getting_started/track_tasks',
'getting_started/reproduce_tasks',
'getting_started/logging_using_artifacts',
/* {'MLOps and LLMOps': [
'getting_started/mlops/mlops_second_steps',
]}
],
},
]}*/
'hpo',
{"Deploying Model Endpoints": [
{
@@ -120,10 +87,11 @@ module.exports = {
]
}
]},
{"Launch Remote Development Environments": [
'webapp/applications/apps_ssh_session',
'webapp/applications/apps_jupyter_lab',
'webapp/applications/apps_vscode',
{"Launch a Remote IDE": [
'apps/clearml_session',
{type: 'ref', id: 'webapp/applications/apps_ssh_session'},
{type: 'ref', id: 'webapp/applications/apps_jupyter_lab'},
{type: 'ref', id: 'webapp/applications/apps_vscode'}
]},
{
type: 'category',
@@ -178,6 +146,7 @@ module.exports = {
{'ClearML Task': ['guides/clearml-task/clearml_task_tutorial']},
{'ClearML Agent': ['guides/clearml_agent/executable_exp_containers', 'guides/clearml_agent/exp_environment_containers', 'guides/clearml_agent/reproduce_exp']},
{'Datasets': ['clearml_data/data_management_examples/data_man_cifar_classification', 'clearml_data/data_management_examples/data_man_python']},
{id: 'hyperdatasets/code_examples', type: 'doc', label: 'Hyper-Datasets'},
{'Distributed': ['guides/distributed/distributed_pytorch_example', 'guides/distributed/subprocess_example']},
{'Docker': ['guides/docker/extra_docker_shell_script']},
{'Frameworks': [
@@ -216,7 +185,6 @@ module.exports = {
{'Offline Mode':['guides/set_offline']},
{'Optimization': ['guides/optimization/hyper-parameter-optimization/examples_hyperparam_opt']},
{'Pipelines': ['guides/pipeline/pipeline_controller', 'guides/pipeline/pipeline_decorator', 'guides/pipeline/pipeline_functions']},
{'Reporting': ['guides/reporting/explicit_reporting','guides/reporting/3d_plots_reporting', 'guides/reporting/artifacts', 'guides/reporting/using_artifacts', 'guides/reporting/clearml_logging_example', 'guides/reporting/html_reporting',
'guides/reporting/hyper_parameters', 'guides/reporting/image_reporting', 'guides/reporting/manual_matplotlib_reporting', 'guides/reporting/media_reporting',
'guides/reporting/model_config', 'guides/reporting/pandas_reporting', 'guides/reporting/plotly_reporting',
@@ -227,7 +195,7 @@ module.exports = {
],
knowledgeSidebar: [
{'ClearML Fundamentals': [
{'Fundamentals': [
'fundamentals/projects',
'fundamentals/task',
'fundamentals/hyperparameters',
@@ -244,6 +212,7 @@ module.exports = {
items: [
'clearml_sdk/task_sdk',
'clearml_sdk/model_sdk',
'hyperdatasets/task',
'clearml_sdk/hpo_sdk',
'clearml_sdk/apiclient_sdk'
]
@@ -286,6 +255,33 @@ module.exports = {
},
]
},
{
type: 'category',
collapsible: true,
collapsed: true,
label: 'Hyper-Datasets',
link: {type: 'doc', id: 'hyperdatasets/overview'},
items: [
'hyperdatasets/dataset',
{
type: 'category',
collapsible: true,
collapsed: true,
label: 'Frames',
link: {type: 'doc', id: 'hyperdatasets/frames'},
items: [
'hyperdatasets/single_frames',
'hyperdatasets/frame_groups',
'hyperdatasets/sources',
'hyperdatasets/annotations',
'hyperdatasets/masks',
'hyperdatasets/previews',
'hyperdatasets/custom_metadata'
]
},
'hyperdatasets/dataviews',
]
},
{'Video Tutorials': [
'getting_started/video_tutorials/quick_introduction',
'getting_started/video_tutorials/core_component_overview',
@@ -504,12 +500,24 @@ module.exports = {
'webapp/webapp_model_viewing',
'webapp/webapp_model_comparing'
]},
{'Dataviews': [
'hyperdatasets/webapp/webapp_dataviews',
'hyperdatasets/webapp/webapp_exp_track_visual',
'hyperdatasets/webapp/webapp_exp_modifying',
'hyperdatasets/webapp/webapp_exp_comparing'
]},
'webapp/webapp_exp_sharing'
]},
{'Datasets': [
'webapp/datasets/webapp_dataset_page',
'webapp/datasets/webapp_dataset_viewing'
]},
{'Hyper-Datasets': [
'hyperdatasets/webapp/webapp_datasets',
'hyperdatasets/webapp/webapp_datasets_versioning',
'hyperdatasets/webapp/webapp_datasets_frames',
'hyperdatasets/webapp/webapp_annotator'
]},
{'Pipelines': [
'webapp/pipelines/webapp_pipeline_page',
'webapp/pipelines/webapp_pipeline_table',
@@ -523,7 +531,20 @@ module.exports = {
collapsed: true,
label: 'Orchestration',
link: {type: 'doc', id: 'webapp/webapp_workers_queues'},
items: ['webapp/webapp_orchestration_dash', 'webapp/resource_policies']
items: [
'webapp/webapp_orchestration_dash',
{
type: 'category',
collapsible: true,
collapsed: true,
label: 'Autoscalers',
items: [
'webapp/applications/apps_aws_autoscaler',
'webapp/applications/apps_gcp_autoscaler',
]
},
'webapp/resource_policies'
]
},
{
type: 'category',
@@ -574,38 +595,6 @@ module.exports = {
]
},
],
hyperdatasetsSidebar: [
'hyperdatasets/overview',
{'Frames': [
'hyperdatasets/frames',
'hyperdatasets/single_frames',
'hyperdatasets/frame_groups',
'hyperdatasets/sources',
'hyperdatasets/annotations',
'hyperdatasets/masks',
'hyperdatasets/previews',
'hyperdatasets/custom_metadata'
]},
'hyperdatasets/dataset',
'hyperdatasets/dataviews',
'hyperdatasets/task',
{'WebApp': [
{'Projects': [
'hyperdatasets/webapp/webapp_dataviews', 'hyperdatasets/webapp/webapp_exp_track_visual',
'hyperdatasets/webapp/webapp_exp_modifying', 'hyperdatasets/webapp/webapp_exp_comparing',
]
},
{'Datasets': [
'hyperdatasets/webapp/webapp_datasets',
'hyperdatasets/webapp/webapp_datasets_versioning',
'hyperdatasets/webapp/webapp_datasets_frames'
]
},
'hyperdatasets/webapp/webapp_annotator'
]
},
'hyperdatasets/code_examples'
],
installationSidebar: [
'clearml_sdk/clearml_sdk_setup',
{
@@ -623,6 +612,11 @@ module.exports = {
'clearml_agent/clearml_agent_scheduling'
]
},
{
type: 'doc',
label: 'Configuring Client Storage Access',
id: 'integrations/storage',
},
{
type: 'category',
collapsible: true,