ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-05-22 04:56:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Edit sidebars (#959)

Browse Source
This commit is contained in:
pollfly 2024-11-07 12:17:26 +02:00 committed by GitHub
parent cb31edd2f1
commit 8026b1f474
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 207 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/clearml_agent.md
View File

@ -1,5 +1,5 @@
--- ---
title: Overview title: ClearML Agent
--- ---

2
docs/clearml_data/clearml_data.md
View File

@ -1,5 +1,5 @@
--- ---
title: Overview title: ClearML Data
--- ---
:::important :::important

2
docs/clearml_sdk/clearml_sdk.md
View File

@ -1,5 +1,5 @@
--- ---
title: Overview title: ClearML SDK
--- ---
The ClearML Python Package supports the [automatic logging](../fundamentals/logger.md#automatic-reporting) that documents The ClearML Python Package supports the [automatic logging](../fundamentals/logger.md#automatic-reporting) that documents

2
docs/clearml_serving/clearml_serving.md
View File

@ -1,5 +1,5 @@
--- ---
title: Overview title: ClearML Serving
--- ---
`clearml-serving` is a command line utility for model deployment and orchestration. `clearml-serving` is a command line utility for model deployment and orchestration.

2
docs/cloud_autoscaling/autoscaling_overview.md
View File

@ -1,5 +1,5 @@
--- ---
title: Overview title: Cloud Autoscaling
--- ---
<div class="vid" > <div class="vid" >

2
docs/configs/configuring_clearml.md
View File

@ -1,5 +1,5 @@
--- ---
title: Overview title: Configuring ClearML
--- ---
ClearML can be tailored to your requirements by setting configurations in a variety of methods. All ClearML and ClearML ClearML can be tailored to your requirements by setting configurations in a variety of methods. All ClearML and ClearML

2
docs/pipelines/pipelines.md
View File

@ -1,5 +1,5 @@
--- ---
title: Overview title: ClearML Pipelines
--- ---
Pipelines are a way to streamline and connect multiple processes, plugging the output of one process as the input of another. Pipelines are a way to streamline and connect multiple processes, plugging the output of one process as the input of another.

2
docs/remote_session.md
View File

@ -1,5 +1,5 @@
--- ---
title: Overview title: Remote IDE
--- ---
Machine Learning and Deep Learning development is sometimes more challenging than traditional software development. If Machine Learning and Deep Learning development is sometimes more challenging than traditional software development. If

2
docs/webapp/applications/apps_overview.md
View File

@ -1,5 +1,5 @@
--- ---
title: Overview title: ClearML Applications
--- ---
:::info Pro Plan Offering :::info Pro Plan Offering

2
docs/webapp/webapp_overview.md
View File

@ -1,5 +1,5 @@
--- ---
title: Overview title: WebApp
--- ---
The **ClearML Web UI** is the graphical user interface for the ClearML platform, which includes: The **ClearML Web UI** is the graphical user interface for the ClearML platform, which includes:

303
sidebars.js
View File

@ -35,51 +35,96 @@ module.exports = {
]}]}, ]}]},
{'ClearML Fundamentals': ['fundamentals/projects', 'fundamentals/task', 'fundamentals/hyperparameters', 'fundamentals/artifacts', 'fundamentals/logger', 'fundamentals/agents_and_queues', {'ClearML Fundamentals': ['fundamentals/projects', 'fundamentals/task', 'fundamentals/hyperparameters', 'fundamentals/artifacts', 'fundamentals/logger', 'fundamentals/agents_and_queues',
'fundamentals/hpo']}, 'fundamentals/hpo']},
{'ClearML SDK': ['clearml_sdk/clearml_sdk', 'clearml_sdk/task_sdk', 'clearml_sdk/model_sdk', 'clearml_sdk/apiclient_sdk']}, {
{'ClearML Agent': type: 'category',
['clearml_agent', 'clearml_agent/clearml_agent_setup', 'clearml_agent/clearml_agent_deployment', collapsible: true,
collapsed: true,
label: 'ClearML SDK',
link: {type: 'doc', id: 'clearml_sdk/clearml_sdk'},
items: ['clearml_sdk/task_sdk', 'clearml_sdk/model_sdk', 'clearml_sdk/apiclient_sdk']
},
{
type: 'category',
collapsible: true,
collapsed: true,
label: 'ClearML Agent',
link: {type: 'doc', id: 'clearml_agent'},
items: ['clearml_agent/clearml_agent_setup', 'clearml_agent/clearml_agent_deployment',
'clearml_agent/clearml_agent_execution_env', 'clearml_agent/clearml_agent_env_caching', 'clearml_agent/clearml_agent_execution_env', 'clearml_agent/clearml_agent_env_caching',
'clearml_agent/clearml_agent_dynamic_gpus', 'clearml_agent/clearml_agent_fractional_gpus', 'clearml_agent/clearml_agent_dynamic_gpus', 'clearml_agent/clearml_agent_fractional_gpus',
'clearml_agent/clearml_agent_services_mode', 'clearml_agent/clearml_agent_docker', 'clearml_agent/clearml_agent_services_mode', 'clearml_agent/clearml_agent_docker',
'clearml_agent/clearml_agent_scheduling' 'clearml_agent/clearml_agent_scheduling']
]}, },
{'Cloud Autoscaling': [ {
'cloud_autoscaling/autoscaling_overview', type: 'category',
{'Autoscaler Apps': [ collapsible: true,
collapsed: true,
label: 'Cloud Autoscaling',
link: {type: 'doc', id: 'cloud_autoscaling/autoscaling_overview'},
items: [
{'Autoscaler Apps': [
'webapp/applications/apps_aws_autoscaler', 'webapp/applications/apps_aws_autoscaler',
'webapp/applications/apps_gcp_autoscaler', 'webapp/applications/apps_gcp_autoscaler',
] ]
} }
] ]
}, },
{'ClearML Pipelines':['pipelines/pipelines', {
{"Building Pipelines": type: 'category',
collapsible: true,
collapsed: true,
label: 'ClearML Pipelines',
link: {type: 'doc', id: 'pipelines/pipelines'},
items: [{"Building Pipelines":
['pipelines/pipelines_sdk_tasks', 'pipelines/pipelines_sdk_function_decorators'] ['pipelines/pipelines_sdk_tasks', 'pipelines/pipelines_sdk_function_decorators']
} }
] ]
}, },
{'ClearML Data': ['clearml_data/clearml_data', 'clearml_data/clearml_data_cli', 'clearml_data/clearml_data_sdk', 'clearml_data/best_practices', {
{'Workflows': [ type: 'category',
'clearml_data/data_management_examples/workflows', collapsible: true,
'clearml_data/data_management_examples/data_man_simple', collapsed: true,
'clearml_data/data_management_examples/data_man_folder_sync', label: 'ClearML Data',
'clearml_data/data_management_examples/data_man_cifar_classification', link: {type: 'doc', id: 'clearml_data/clearml_data'},
'clearml_data/data_management_examples/data_man_python' items: ['clearml_data/clearml_data_cli', 'clearml_data/clearml_data_sdk', 'clearml_data/best_practices',
{
type: 'category',
collapsible: true,
collapsed: true,
label: 'Workflows',
link: {type: 'doc', id: 'clearml_data/data_management_examples/workflows'},
items: [
'clearml_data/data_management_examples/data_man_simple',
'clearml_data/data_management_examples/data_man_folder_sync',
'clearml_data/data_management_examples/data_man_cifar_classification',
'clearml_data/data_management_examples/data_man_python'
] ]
}, },
] ]
}, },
'hyper_datasets', 'hyper_datasets',
'model_registry', 'model_registry',
{'Remote IDE': [ {
'remote_session', type: 'category',
'apps/clearml_session', collapsible: true,
{type: 'ref', id: 'webapp/applications/apps_ssh_session'}, collapsed: true,
{type: 'ref', id: 'webapp/applications/apps_jupyter_lab'}, label: 'Remote IDE',
{type: 'ref', id: 'webapp/applications/apps_vscode'} 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'}
] ]
}, },
{'ClearML Serving':['clearml_serving/clearml_serving', 'clearml_serving/clearml_serving_setup', 'clearml_serving/clearml_serving_cli', 'clearml_serving/clearml_serving_tutorial']}, {
type: 'category',
collapsible: true,
collapsed: true,
label: 'ClearML Serving',
link: {type: 'doc', id: 'clearml_serving/clearml_serving'},
items: ['clearml_serving/clearml_serving_setup', 'clearml_serving/clearml_serving_cli', 'clearml_serving/clearml_serving_tutorial']
},
{'CLI Tools': [ {'CLI Tools': [
'apps/clearml_task', 'apps/clearml_task',
{type: 'ref', id: 'clearml_agent/clearml_agent_ref'}, {type: 'ref', id: 'clearml_agent/clearml_agent_ref'},
@ -112,86 +157,107 @@ module.exports = {
] ]
}, },
'integrations/storage', 'integrations/storage',
{'WebApp': [ {
'webapp/webapp_overview', 'webapp/webapp_home', type: 'category',
{ collapsible: true,
'Projects': [ collapsed: true,
'webapp/webapp_projects_page', label: 'WebApp',
'webapp/webapp_project_overview', link: {type: 'doc', id: 'webapp/webapp_overview'},
{ items: [
'Experiments': ['webapp/webapp_exp_table', 'webapp/webapp_exp_track_visual', 'webapp/webapp_exp_reproducing', 'webapp/webapp_exp_tuning', 'webapp/webapp_home',
'webapp/webapp_exp_comparing'] {
}, 'Projects': [
{ 'webapp/webapp_projects_page',
'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing', 'webapp/webapp_model_comparing'] 'webapp/webapp_project_overview',
}, {
'webapp/webapp_exp_sharing' 'Experiments': ['webapp/webapp_exp_table', 'webapp/webapp_exp_track_visual', 'webapp/webapp_exp_reproducing', 'webapp/webapp_exp_tuning',
] 'webapp/webapp_exp_comparing']
}, },
{ {
'Datasets':[ 'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing', 'webapp/webapp_model_comparing']
'webapp/datasets/webapp_dataset_page', 'webapp/datasets/webapp_dataset_viewing' },
] 'webapp/webapp_exp_sharing'
}, ]
{ },
'Pipelines':[ {
'webapp/pipelines/webapp_pipeline_page', 'webapp/pipelines/webapp_pipeline_table', 'webapp/pipelines/webapp_pipeline_viewing' 'Datasets':[
] 'webapp/datasets/webapp_dataset_page', 'webapp/datasets/webapp_dataset_viewing'
}, ]
'webapp/webapp_model_endpoints', },
'webapp/webapp_reports', {
{ 'Pipelines':[
'Orchestration': [ 'webapp/pipelines/webapp_pipeline_page', 'webapp/pipelines/webapp_pipeline_table', 'webapp/pipelines/webapp_pipeline_viewing'
'webapp/webapp_workers_queues', ]
'webapp/webapp_orchestration_dash', },
'webapp/resource_policies' 'webapp/webapp_model_endpoints',
] 'webapp/webapp_reports',
}, {
{ type: 'category',
'ClearML Applications': [ collapsible: true,
'webapp/applications/apps_overview', collapsed: true,
{ label: 'Orchestration',
"General": [ link: {type: 'doc', id: 'webapp/webapp_workers_queues'},
'webapp/applications/apps_hpo', items: ['webapp/webapp_orchestration_dash', 'webapp/resource_policies']
'webapp/applications/apps_dashboard', },
'webapp/applications/apps_task_scheduler', {
'webapp/applications/apps_trigger_manager', type: 'category',
] collapsible: true,
}, collapsed: true,
{ label: 'ClearML Applications',
"AI Dev": [ link: {type: 'doc', id: 'webapp/applications/apps_overview'},
'webapp/applications/apps_ssh_session', items: [
'webapp/applications/apps_jupyter_lab', {
'webapp/applications/apps_vscode', "General": [
] 'webapp/applications/apps_hpo',
}, 'webapp/applications/apps_dashboard',
{ 'webapp/applications/apps_task_scheduler',
"UI Dev": [ 'webapp/applications/apps_trigger_manager',
'webapp/applications/apps_gradio', ]
'webapp/applications/apps_streamlit' },
] {
}, "AI Dev": [
{ 'webapp/applications/apps_ssh_session',
"Deploy": [ 'webapp/applications/apps_jupyter_lab',
'webapp/applications/apps_embed_model_deployment', 'webapp/applications/apps_vscode',
'webapp/applications/apps_model_deployment' ]
] },
}, {
] "UI Dev": [
'webapp/applications/apps_gradio',
}, 'webapp/applications/apps_streamlit'
{ ]
"Settings": [ },
'webapp/settings/webapp_settings_overview', 'webapp/settings/webapp_settings_profile', {
'webapp/settings/webapp_settings_admin_vaults', 'webapp/settings/webapp_settings_users', "Deploy": [
'webapp/settings/webapp_settings_access_rules', 'webapp/settings/webapp_settings_id_providers', 'webapp/applications/apps_embed_model_deployment',
'webapp/settings/webapp_settings_resource_configs', 'webapp/settings/webapp_settings_usage_billing', 'webapp/applications/apps_model_deployment'
'webapp/settings/webapp_settings_storage_credentials' ]
] },
}, ]
},
{
type: 'category',
collapsible: true,
collapsed: true,
label: 'Settings',
link: {type: 'doc', id: 'webapp/settings/webapp_settings_overview'},
items: ['webapp/settings/webapp_settings_profile',
'webapp/settings/webapp_settings_admin_vaults', 'webapp/settings/webapp_settings_users',
'webapp/settings/webapp_settings_access_rules', 'webapp/settings/webapp_settings_id_providers',
'webapp/settings/webapp_settings_resource_configs', 'webapp/settings/webapp_settings_usage_billing',
'webapp/settings/webapp_settings_storage_credentials'
]
},
] ]
}, },
{'Configuring ClearML': ['configs/configuring_clearml', 'configs/clearml_conf', 'configs/env_vars']}, {
type: 'category',
collapsible: true,
collapsed: true,
label: 'Configuring ClearML',
link: {type: 'doc', id: 'configs/configuring_clearml'},
items: ['configs/clearml_conf', 'configs/env_vars']
},
{'User Management': [ {'User Management': [
'user_management/user_groups', 'user_management/user_groups',
'user_management/access_rules', 'user_management/access_rules',
@ -199,20 +265,27 @@ module.exports = {
'user_management/identity_providers' 'user_management/identity_providers'
] ]
}, },
{'ClearML Server': ['deploying_clearml/clearml_server', {
{ type: 'category',
'Deploying ClearML Server': ['deploying_clearml/clearml_server_aws_ec2_ami', 'deploying_clearml/clearml_server_gcp', collapsible: true,
collapsed: true,
label: 'ClearML Server',
link: {type: 'doc', id: 'deploying_clearml/clearml_server'},
items: [
{'Deploying ClearML Server':
['deploying_clearml/clearml_server_aws_ec2_ami', 'deploying_clearml/clearml_server_gcp',
'deploying_clearml/clearml_server_linux_mac', 'deploying_clearml/clearml_server_win', 'deploying_clearml/clearml_server_linux_mac', 'deploying_clearml/clearml_server_win',
'deploying_clearml/clearml_server_kubernetes_helm'] 'deploying_clearml/clearml_server_kubernetes_helm']
}, },
{ {'Upgrading ClearML Server':
'Upgrading ClearML Server':['deploying_clearml/upgrade_server_aws_ec2_ami','deploying_clearml/upgrade_server_gcp', ['deploying_clearml/upgrade_server_aws_ec2_ami','deploying_clearml/upgrade_server_gcp',
'deploying_clearml/upgrade_server_linux_mac', 'deploying_clearml/upgrade_server_win', 'deploying_clearml/upgrade_server_linux_mac', 'deploying_clearml/upgrade_server_win',
'deploying_clearml/upgrade_server_kubernetes_helm', 'deploying_clearml/upgrade_server_kubernetes_helm',
'deploying_clearml/clearml_server_es7_migration', 'deploying_clearml/clearml_server_mongo44_migration'] 'deploying_clearml/clearml_server_es7_migration', 'deploying_clearml/clearml_server_mongo44_migration']
}, },
'deploying_clearml/clearml_server_config', 'deploying_clearml/clearml_server_security' 'deploying_clearml/clearml_server_config', 'deploying_clearml/clearml_server_security'
]}, ]
},
//'Comments': ['Notes'], //'Comments': ['Notes'],

9
src/css/custom.css
View File

@ -357,6 +357,15 @@ html[data-theme="light"] [class^="sidebarLogo"] > img {
background-repeat: no-repeat; background-repeat: no-repeat;
} }
.menu__caret:hover {
background: transparent;
}
.menu__caret:before {
background-size: 1.25rem;
}
.navbar-sidebar .navbar-sidebar__back {color: var(--ifm-link-color);} .navbar-sidebar .navbar-sidebar__back {color: var(--ifm-link-color);}