diff --git a/docs/clearml_agent.md b/docs/clearml_agent.md index d58f01e1..b254754c 100644 --- a/docs/clearml_agent.md +++ b/docs/clearml_agent.md @@ -1,5 +1,5 @@ --- -title: Overview +title: ClearML Agent --- diff --git a/docs/clearml_data/clearml_data.md b/docs/clearml_data/clearml_data.md index ba56f6fe..cd7f3093 100644 --- a/docs/clearml_data/clearml_data.md +++ b/docs/clearml_data/clearml_data.md @@ -1,5 +1,5 @@ --- -title: Overview +title: ClearML Data --- :::important diff --git a/docs/clearml_sdk/clearml_sdk.md b/docs/clearml_sdk/clearml_sdk.md index d6b60637..d706a671 100644 --- a/docs/clearml_sdk/clearml_sdk.md +++ b/docs/clearml_sdk/clearml_sdk.md @@ -1,5 +1,5 @@ --- -title: Overview +title: ClearML SDK --- The ClearML Python Package supports the [automatic logging](../fundamentals/logger.md#automatic-reporting) that documents diff --git a/docs/clearml_serving/clearml_serving.md b/docs/clearml_serving/clearml_serving.md index 55a0aae5..79aceca6 100644 --- a/docs/clearml_serving/clearml_serving.md +++ b/docs/clearml_serving/clearml_serving.md @@ -1,5 +1,5 @@ --- -title: Overview +title: ClearML Serving --- `clearml-serving` is a command line utility for model deployment and orchestration. diff --git a/docs/cloud_autoscaling/autoscaling_overview.md b/docs/cloud_autoscaling/autoscaling_overview.md index 850e3f72..0366cbf0 100644 --- a/docs/cloud_autoscaling/autoscaling_overview.md +++ b/docs/cloud_autoscaling/autoscaling_overview.md @@ -1,5 +1,5 @@ --- -title: Overview +title: Cloud Autoscaling ---
diff --git a/docs/configs/configuring_clearml.md b/docs/configs/configuring_clearml.md index 211713b7..0f5a4ab8 100644 --- a/docs/configs/configuring_clearml.md +++ b/docs/configs/configuring_clearml.md @@ -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 diff --git a/docs/pipelines/pipelines.md b/docs/pipelines/pipelines.md index 2d26a68d..0b5f7089 100644 --- a/docs/pipelines/pipelines.md +++ b/docs/pipelines/pipelines.md @@ -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. diff --git a/docs/remote_session.md b/docs/remote_session.md index 66b1c7e7..ea96f705 100644 --- a/docs/remote_session.md +++ b/docs/remote_session.md @@ -1,5 +1,5 @@ --- -title: Overview +title: Remote IDE --- Machine Learning and Deep Learning development is sometimes more challenging than traditional software development. If diff --git a/docs/webapp/applications/apps_overview.md b/docs/webapp/applications/apps_overview.md index 0bbba367..a4b1e601 100644 --- a/docs/webapp/applications/apps_overview.md +++ b/docs/webapp/applications/apps_overview.md @@ -1,5 +1,5 @@ --- -title: Overview +title: ClearML Applications --- :::info Pro Plan Offering diff --git a/docs/webapp/webapp_overview.md b/docs/webapp/webapp_overview.md index 662ab98e..b847c14d 100644 --- a/docs/webapp/webapp_overview.md +++ b/docs/webapp/webapp_overview.md @@ -1,5 +1,5 @@ --- -title: Overview +title: WebApp --- The **ClearML Web UI** is the graphical user interface for the ClearML platform, which includes: diff --git a/sidebars.js b/sidebars.js index 76c5cd98..83c8cfb1 100644 --- a/sidebars.js +++ b/sidebars.js @@ -35,51 +35,96 @@ module.exports = { ]}]}, {'ClearML Fundamentals': ['fundamentals/projects', 'fundamentals/task', 'fundamentals/hyperparameters', 'fundamentals/artifacts', 'fundamentals/logger', 'fundamentals/agents_and_queues', 'fundamentals/hpo']}, - {'ClearML SDK': ['clearml_sdk/clearml_sdk', 'clearml_sdk/task_sdk', 'clearml_sdk/model_sdk', 'clearml_sdk/apiclient_sdk']}, - {'ClearML Agent': - ['clearml_agent', 'clearml_agent/clearml_agent_setup', 'clearml_agent/clearml_agent_deployment', + { + type: 'category', + 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_dynamic_gpus', 'clearml_agent/clearml_agent_fractional_gpus', 'clearml_agent/clearml_agent_services_mode', 'clearml_agent/clearml_agent_docker', - 'clearml_agent/clearml_agent_scheduling' - ]}, - {'Cloud Autoscaling': [ - 'cloud_autoscaling/autoscaling_overview', - {'Autoscaler Apps': [ + 'clearml_agent/clearml_agent_scheduling'] + }, + { + type: 'category', + 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_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'] } - ] + ] }, - {'ClearML Data': ['clearml_data/clearml_data', 'clearml_data/clearml_data_cli', 'clearml_data/clearml_data_sdk', 'clearml_data/best_practices', - {'Workflows': [ - 'clearml_data/data_management_examples/workflows', - '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' + { + type: 'category', + collapsible: true, + collapsed: true, + label: 'ClearML Data', + link: {type: 'doc', id: 'clearml_data/clearml_data'}, + 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', 'model_registry', - {'Remote IDE': [ - 'remote_session', - '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', + 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'} ] }, - {'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': [ 'apps/clearml_task', {type: 'ref', id: 'clearml_agent/clearml_agent_ref'}, @@ -112,86 +157,107 @@ module.exports = { ] }, 'integrations/storage', - {'WebApp': [ - 'webapp/webapp_overview', 'webapp/webapp_home', - { - 'Projects': [ - 'webapp/webapp_projects_page', - 'webapp/webapp_project_overview', - { - 'Experiments': ['webapp/webapp_exp_table', 'webapp/webapp_exp_track_visual', 'webapp/webapp_exp_reproducing', 'webapp/webapp_exp_tuning', - 'webapp/webapp_exp_comparing'] - }, - { - 'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing', 'webapp/webapp_model_comparing'] - }, - 'webapp/webapp_exp_sharing' - ] - }, - { - 'Datasets':[ - 'webapp/datasets/webapp_dataset_page', 'webapp/datasets/webapp_dataset_viewing' - ] - }, - { - 'Pipelines':[ - 'webapp/pipelines/webapp_pipeline_page', 'webapp/pipelines/webapp_pipeline_table', 'webapp/pipelines/webapp_pipeline_viewing' - ] - }, - 'webapp/webapp_model_endpoints', - 'webapp/webapp_reports', - { - 'Orchestration': [ - 'webapp/webapp_workers_queues', - 'webapp/webapp_orchestration_dash', - 'webapp/resource_policies' - ] - }, - { - 'ClearML Applications': [ - 'webapp/applications/apps_overview', - { - "General": [ - 'webapp/applications/apps_hpo', - 'webapp/applications/apps_dashboard', - 'webapp/applications/apps_task_scheduler', - 'webapp/applications/apps_trigger_manager', - ] - }, - { - "AI Dev": [ - 'webapp/applications/apps_ssh_session', - 'webapp/applications/apps_jupyter_lab', - 'webapp/applications/apps_vscode', - ] - }, - { - "UI Dev": [ - 'webapp/applications/apps_gradio', - 'webapp/applications/apps_streamlit' - ] - }, - { - "Deploy": [ - 'webapp/applications/apps_embed_model_deployment', - 'webapp/applications/apps_model_deployment' - ] - }, - ] - - }, - { - "Settings": [ - 'webapp/settings/webapp_settings_overview', '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' - ] - }, + { + type: 'category', + collapsible: true, + collapsed: true, + label: 'WebApp', + link: {type: 'doc', id: 'webapp/webapp_overview'}, + items: [ + 'webapp/webapp_home', + { + 'Projects': [ + 'webapp/webapp_projects_page', + 'webapp/webapp_project_overview', + { + 'Experiments': ['webapp/webapp_exp_table', 'webapp/webapp_exp_track_visual', 'webapp/webapp_exp_reproducing', 'webapp/webapp_exp_tuning', + 'webapp/webapp_exp_comparing'] + }, + { + 'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing', 'webapp/webapp_model_comparing'] + }, + 'webapp/webapp_exp_sharing' + ] + }, + { + 'Datasets':[ + 'webapp/datasets/webapp_dataset_page', 'webapp/datasets/webapp_dataset_viewing' + ] + }, + { + 'Pipelines':[ + 'webapp/pipelines/webapp_pipeline_page', 'webapp/pipelines/webapp_pipeline_table', 'webapp/pipelines/webapp_pipeline_viewing' + ] + }, + 'webapp/webapp_model_endpoints', + 'webapp/webapp_reports', + { + type: 'category', + collapsible: true, + collapsed: true, + label: 'Orchestration', + link: {type: 'doc', id: 'webapp/webapp_workers_queues'}, + items: ['webapp/webapp_orchestration_dash', 'webapp/resource_policies'] + }, + { + type: 'category', + collapsible: true, + collapsed: true, + label: 'ClearML Applications', + link: {type: 'doc', id: 'webapp/applications/apps_overview'}, + items: [ + { + "General": [ + 'webapp/applications/apps_hpo', + 'webapp/applications/apps_dashboard', + 'webapp/applications/apps_task_scheduler', + 'webapp/applications/apps_trigger_manager', + ] + }, + { + "AI Dev": [ + 'webapp/applications/apps_ssh_session', + 'webapp/applications/apps_jupyter_lab', + 'webapp/applications/apps_vscode', + ] + }, + { + "UI Dev": [ + 'webapp/applications/apps_gradio', + 'webapp/applications/apps_streamlit' + ] + }, + { + "Deploy": [ + 'webapp/applications/apps_embed_model_deployment', + 'webapp/applications/apps_model_deployment' + ] + }, + ] + }, + { + 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_groups', 'user_management/access_rules', @@ -199,20 +265,27 @@ module.exports = { 'user_management/identity_providers' ] }, - {'ClearML Server': ['deploying_clearml/clearml_server', - { - 'Deploying ClearML Server': ['deploying_clearml/clearml_server_aws_ec2_ami', 'deploying_clearml/clearml_server_gcp', + { + type: 'category', + 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_kubernetes_helm'] - }, - { - 'Upgrading ClearML Server':['deploying_clearml/upgrade_server_aws_ec2_ami','deploying_clearml/upgrade_server_gcp', + }, + {'Upgrading ClearML Server': + ['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_kubernetes_helm', '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'], diff --git a/src/css/custom.css b/src/css/custom.css index 29b18417..ec5f77ed 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -357,6 +357,15 @@ html[data-theme="light"] [class^="sidebarLogo"] > img { 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);}