From 92d11b9d7e199e70cfb72a0b9bc902a75beb769c Mon Sep 17 00:00:00 2001 From: alnoam Date: Tue, 11 Feb 2025 11:38:21 +0200 Subject: [PATCH] docs restructure - initial version - WIP --- .../appgw_install_compose.md | 0 docs/deploying_clearml/appgw_install_k8s.md | 0 docs/getting_started/main.md | 6 +- docs/integrations/integrations.md | 0 docs/overview.md | 0 docusaurus.config.js | 48 +- sidebars.js | 659 ++++++++++-------- 7 files changed, 406 insertions(+), 307 deletions(-) create mode 100644 docs/deploying_clearml/appgw_install_compose.md create mode 100644 docs/deploying_clearml/appgw_install_k8s.md create mode 100644 docs/integrations/integrations.md create mode 100644 docs/overview.md diff --git a/docs/deploying_clearml/appgw_install_compose.md b/docs/deploying_clearml/appgw_install_compose.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/deploying_clearml/appgw_install_k8s.md b/docs/deploying_clearml/appgw_install_k8s.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/getting_started/main.md b/docs/getting_started/main.md index 99bdcdfb..9384a879 100644 --- a/docs/getting_started/main.md +++ b/docs/getting_started/main.md @@ -1,8 +1,4 @@ ---- -id: main -title: What is ClearML? -slug: / ---- +# What is ClearML? ClearML is an open-source, end-to-end AI Platform designed to streamline AI adoption and the entire development lifecycle. It supports every phase of AI development, from research to production, allowing users to diff --git a/docs/integrations/integrations.md b/docs/integrations/integrations.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 00000000..e69de29b diff --git a/docusaurus.config.js b/docusaurus.config.js index d78ff414..22f0ebbf 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -82,54 +82,48 @@ module.exports = { }, items: [ { - to: '/docs', - label: 'Docs', + to: '/docs/', + label: 'Overview', position: 'left', }, { - to:'/docs/hyperdatasets/overview', - label: 'Hyper-Datasets', - position: 'left', - }, - // {to: 'tutorials', label: 'Tutorials', position: 'left'}, - // Please keep GitHub link to the right for consistency. - {to: '/docs/guides', label: 'Examples', position: 'left'}, - //{to: '/docs/references', label: 'API', position: 'left'}, + to: '/docs/getting_started/main', + label: 'Setup', + position: 'left'}, { - label: 'References', + label: 'Developer Center', position: 'left', // or 'right' items: [ { - label: 'SDK', + label: 'ClearMLopedia', + to: '/docs/fundamentals/projects', + }, + { + label: 'References', to: '/docs/references/sdk/task', + }, { + label: 'Tutorials', + to: '/docs/guides', }, { - label: 'ClearML Agent', - to: '/docs/clearml_agent/clearml_agent_ref', + label: 'Integrations', + to: '/docs/integrations' }, { - label: 'Server API', - to: '/docs/references/api', + label: 'FAQ', + to: '/docs/faq', }, - { - label: 'Hyper-Datasets', - to: '/docs/references/hyperdataset', - }, - { label: 'Release Notes', to: '/docs/release_notes/clearml_server/open_source/ver_2_0', }, - { - label: 'Community Resources', - to: '/docs/community', - } + ], }, { - label: 'FAQ', + label: 'Community Resources', position: 'left', // or 'right' - to: '/docs/faq' + to: '/docs/community', }, { href: 'https://joinslack.clear.ml', diff --git a/sidebars.js b/sidebars.js index 7ae2d5a8..9e29f4fd 100644 --- a/sidebars.js +++ b/sidebars.js @@ -9,260 +9,112 @@ module.exports = { mainSidebar: [ - {'Getting Started': ['getting_started/main', { - 'Where do I start?': [{'Data Scientists': ['getting_started/ds/ds_first_steps', 'getting_started/ds/ds_second_steps', 'getting_started/ds/best_practices']}, - {'MLOps and LLMOps': ['getting_started/mlops/mlops_first_steps','getting_started/mlops/mlops_second_steps','getting_started/mlops/mlops_best_practices']}] - }, 'getting_started/architecture', {'Video Tutorials': - [ - 'getting_started/video_tutorials/quick_introduction', - 'getting_started/video_tutorials/core_component_overview', - 'getting_started/video_tutorials/experiment_manager_hands-on', - 'getting_started/video_tutorials/experiment_management_best_practices', - 'getting_started/video_tutorials/agent_remote_execution_and_automation', - 'getting_started/video_tutorials/hyperparameter_optimization', - 'getting_started/video_tutorials/pipelines_from_code', - 'getting_started/video_tutorials/pipelines_from_tasks', - 'getting_started/video_tutorials/clearml-data', - 'getting_started/video_tutorials/the_clearml_autoscaler', - 'getting_started/video_tutorials/hyperdatasets_data_versioning', - { - 'Hands-on MLOps Tutorials':[ - 'getting_started/video_tutorials/hands-on_mlops_tutorials/how_clearml_is_used_by_a_data_scientist', - 'getting_started/video_tutorials/hands-on_mlops_tutorials/how_clearml_is_used_by_an_mlops_engineer', - 'getting_started/video_tutorials/hands-on_mlops_tutorials/ml_ci_cd_using_github_actions_and_clearml' - ] - } - ]}]}, - {'ClearML Fundamentals': [ - 'fundamentals/projects', 'fundamentals/task', 'fundamentals/hyperparameters', - 'fundamentals/artifacts', 'fundamentals/models', 'fundamentals/logger', 'fundamentals/agents_and_queues', - 'fundamentals/hpo' - ] + { + type: 'doc', + id: 'overview', + label: 'ClearML at a glance', }, { 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'] - }, - { - type: 'category', - collapsible: true, - collapsed: true, - label: 'Cloud Autoscaling', - link: {type: 'doc', id: 'cloud_autoscaling/autoscaling_overview'}, + label: 'Infrastructure Control Plane (GPUaaS)', items: [ - {'Autoscaler Apps': [ - 'webapp/applications/apps_aws_autoscaler', - 'webapp/applications/apps_gcp_autoscaler', - ] - } - ] - }, - { - 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'] - } - ] - }, - { - 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', + 'fundamentals/agents_and_queues', { type: 'category', collapsible: true, collapsed: true, - label: 'Workflows', - link: {type: 'doc', id: 'clearml_data/data_management_examples/workflows'}, + label: 'ClearML Agent', + link: {type: 'doc', id: 'clearml_agent'}, 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' + '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' ] }, - ] - }, - 'hyper_datasets', - 'model_registry', - { - 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'} - ] - }, - { - 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'}, - {type: 'ref', id: 'clearml_data/clearml_data_cli'}, - 'apps/clearml_param_search', - {type: 'ref', id: 'apps/clearml_session'}, - {type: 'ref', id: 'clearml_serving/clearml_serving_cli'}, - ] - }, - {'Integrations': [ - 'integrations/autokeras', - 'integrations/catboost', - 'integrations/click', - 'integrations/fastai', - {"Hugging Face": ['integrations/transformers', 'integrations/accelerate']}, - 'integrations/hydra', 'integrations/jsonargparse', - 'integrations/keras', 'integrations/keras_tuner', - 'integrations/langchain', - 'integrations/lightgbm', 'integrations/matplotlib', - 'integrations/megengine', 'integrations/monai', 'integrations/tao', - {"OpenMMLab":['integrations/mmcv', 'integrations/mmengine']}, - 'integrations/optuna', - 'integrations/python_fire', 'integrations/pytorch', - 'integrations/ignite', - 'integrations/pytorch_lightning', - 'integrations/scikit_learn', 'integrations/seaborn', - 'integrations/splunk', - 'integrations/tensorboard', 'integrations/tensorboardx', 'integrations/tensorflow', - 'integrations/xgboost', 'integrations/yolov5', 'integrations/yolov8' - ] - }, - 'integrations/storage', - { - 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', - { - 'Tasks': ['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'}, + 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'} + ] + }, + ] + }, + { + type: 'category', + collapsible: true, + label: 'AI Development Center', + items: [ + 'clearml_sdk/clearml_sdk', + 'pipelines/pipelines', + 'clearml_data/clearml_data', + 'hyper_datasets', + 'model_registry', + ] + }, + { + type: 'category', + collapsible: true, + label: 'GenAI App Engine', + items: [ + { + 'UI Launchers': [ + 'webapp/applications/apps_gradio', + 'webapp/applications/apps_streamlit', + ] + }, + { + "Model Deployment": [ { - "General": [ - 'webapp/applications/apps_hpo', - 'webapp/applications/apps_dashboard', - 'webapp/applications/apps_task_scheduler', - 'webapp/applications/apps_trigger_manager', - ] + 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'] }, { - "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": [ + type: 'category', + collapsible: true, + collapsed: true, + label: 'Model Launchers', + items: [ 'webapp/applications/apps_embed_model_deployment', 'webapp/applications/apps_model_deployment', 'webapp/applications/apps_llama_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' + } ] }, ] }, - { - type: 'category', - collapsible: true, - collapsed: true, - label: 'Configuring ClearML', - link: {type: 'doc', id: 'configs/configuring_clearml'}, - items: ['configs/clearml_conf', 'configs/env_vars'] - }, +/* + + 'integrations/storage', {'User Management': [ 'user_management/user_groups', 'user_management/access_rules', @@ -270,32 +122,34 @@ module.exports = { 'user_management/identity_providers' ] }, - { - 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', - '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' - ] - }, - //'Comments': ['Notes'], - - - +*/ + ], + integrationsSidebar: [ + { + type: 'doc', + label: 'Overview', + id: 'integrations/integrations', + }, + 'integrations/autokeras', + 'integrations/catboost', + 'integrations/click', + 'integrations/fastai', + {"Hugging Face": ['integrations/transformers', 'integrations/accelerate']}, + 'integrations/hydra', 'integrations/jsonargparse', + 'integrations/keras', 'integrations/keras_tuner', + 'integrations/langchain', + 'integrations/lightgbm', 'integrations/matplotlib', + 'integrations/megengine', 'integrations/monai', 'integrations/tao', + {"OpenMMLab":['integrations/mmcv', 'integrations/mmengine']}, + 'integrations/optuna', + 'integrations/python_fire', 'integrations/pytorch', + 'integrations/ignite', + 'integrations/pytorch_lightning', + 'integrations/scikit_learn', 'integrations/seaborn', + 'integrations/splunk', + 'integrations/tensorboard', 'integrations/tensorboardx', 'integrations/tensorflow', + 'integrations/xgboost', 'integrations/yolov5', 'integrations/yolov8' ], guidesSidebar: [ 'guides/guidemain', @@ -352,6 +206,85 @@ module.exports = { {'Web UI': ['guides/ui/building_leader_board','guides/ui/tuning_exp']} ], + knowledgeSidebar: [ + {'ClearML Fundamentals': [ + 'fundamentals/projects', + 'fundamentals/task', + 'fundamentals/hyperparameters', + 'fundamentals/artifacts', + 'fundamentals/models', + 'fundamentals/logger', + 'fundamentals/hpo' + ]}, + { + 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 Pipelines', + link: {type: 'doc', id: 'pipelines/pipelines'}, + items: [{ + "Building Pipelines": [ + 'pipelines/pipelines_sdk_tasks', + 'pipelines/pipelines_sdk_function_decorators' + ] + }] + }, + { + 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' + ] + }, + ] + }, + {'Video Tutorials': [ + 'getting_started/video_tutorials/quick_introduction', + 'getting_started/video_tutorials/core_component_overview', + 'getting_started/video_tutorials/experiment_manager_hands-on', + 'getting_started/video_tutorials/experiment_management_best_practices', + 'getting_started/video_tutorials/agent_remote_execution_and_automation', + 'getting_started/video_tutorials/hyperparameter_optimization', + 'getting_started/video_tutorials/pipelines_from_code', + 'getting_started/video_tutorials/pipelines_from_tasks', + 'getting_started/video_tutorials/clearml-data', + 'getting_started/video_tutorials/the_clearml_autoscaler', + 'getting_started/video_tutorials/hyperdatasets_data_versioning', + {'Hands-on MLOps Tutorials': [ + 'getting_started/video_tutorials/hands-on_mlops_tutorials/how_clearml_is_used_by_a_data_scientist', + 'getting_started/video_tutorials/hands-on_mlops_tutorials/how_clearml_is_used_by_an_mlops_engineer', + 'getting_started/video_tutorials/hands-on_mlops_tutorials/ml_ci_cd_using_github_actions_and_clearml' + ]} + ]}, + ], rnSidebar: [ {'Server': [ { @@ -383,7 +316,7 @@ module.exports = { 'release_notes/clearml_server/enterprise/ver_3_24', { 'Older Versions': [ - 'release_notes/clearml_server/enterprise/ver_3_23','release_notes/clearml_server/enterprise/ver_3_22', + 'release_notes/clearml_server/enterprise/ver_3_23', 'release_notes/clearml_server/enterprise/ver_3_22', 'release_notes/clearml_server/enterprise/ver_3_21', 'release_notes/clearml_server/enterprise/ver_3_20' ] } @@ -456,15 +389,18 @@ module.exports = { ] } ], - sdkSidebar: [ + referenceSidebar: [ + {'SDK': [ 'references/sdk/task', 'references/sdk/logger', {'Model': ['references/sdk/model_model', 'references/sdk/model_inputmodel', 'references/sdk/model_outputmodel',]}, 'references/sdk/storage', 'references/sdk/dataset', - {'Pipeline': ['references/sdk/automation_controller_pipelinecontroller', - 'references/sdk/automation_job_clearmljob']}, + {'Pipeline': [ + 'references/sdk/automation_controller_pipelinecontroller', + 'references/sdk/automation_job_clearmljob' + ]}, 'references/sdk/scheduler', 'references/sdk/trigger', {'HyperParameter Optimization': [ @@ -477,10 +413,146 @@ module.exports = { 'references/sdk/hpo_parameters_uniformintegerparameterrange', 'references/sdk/hpo_parameters_uniformparameterrange', 'references/sdk/hpo_parameters_parameterset', + ]}, + {'Enterprise Hyper-Datasets': [ + {'Hyper-Dataset': [ + 'references/hyperdataset/hyperdataset', + 'references/hyperdataset/hyperdatasetversion' ]}, - ], - clearmlAgentSidebar: [ - 'clearml_agent/clearml_agent_ref', 'clearml_agent/clearml_agent_env_var' + {'DataFrame': [ + 'references/hyperdataset/singleframe', + 'references/hyperdataset/framegroup', + 'references/hyperdataset/annotation', + ]}, + 'references/hyperdataset/dataview', + ]}, + ]}, + {'CLI Tools': [ + 'apps/clearml_task', + {type: 'ref', id: 'clearml_agent/clearml_agent_ref'}, + {type: 'ref', id: 'clearml_data/clearml_data_cli'}, + 'apps/clearml_param_search', + {type: 'ref', id: 'apps/clearml_session'}, + {type: 'ref', id: 'clearml_serving/clearml_serving_cli'}, + ] }, + {'ClearML Agent': [ + 'clearml_agent/clearml_agent_ref', 'clearml_agent/clearml_agent_env_var' + ]}, + { + type: 'category', + collapsible: true, + collapsed: true, + label: 'Client Configuration', + link: {type: 'doc', id: 'configs/configuring_clearml'}, + items: [ + 'configs/clearml_conf', + 'configs/env_vars' + ] + }, + {'Server API': [ + 'references/api/index', + 'references/api/definitions', + 'references/api/login', + 'references/api/debug', + 'references/api/projects', + 'references/api/queues', + 'references/api/workers', + 'references/api/events', + 'references/api/models', + 'references/api/tasks', + ]}, + { + 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', + {'Tasks': [ + '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', + 'webapp/applications/apps_llama_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' + ] + }, + ] + }, ], hyperdatasetsSidebar: [ 'hyperdatasets/overview', @@ -514,22 +586,59 @@ module.exports = { }, 'hyperdatasets/code_examples' ], - sdkHyperDataset: [ - {'Hyper-Dataset': ['references/hyperdataset/hyperdataset', 'references/hyperdataset/hyperdatasetversion']}, - {'DataFrame': ['references/hyperdataset/singleframe', - 'references/hyperdataset/framegroup', 'references/hyperdataset/annotation',]}, - 'references/hyperdataset/dataview', - ], - apiSidebar: [ - 'references/api/index', - 'references/api/definitions', - 'references/api/login', - 'references/api/debug', - 'references/api/projects', - 'references/api/queues', - 'references/api/workers', - 'references/api/events', - 'references/api/models', - 'references/api/tasks', + installationSidebar: [ + { + 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' + ]}, + 'deploying_clearml/clearml_server_config', + 'deploying_clearml/clearml_server_security', + {'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' + ]}, + ] + }, + {'Getting Started': [ + 'getting_started/main', + {'Where do I start?': [ + {'Data Scientists': [ + 'getting_started/ds/ds_first_steps', + 'getting_started/ds/ds_second_steps', + 'getting_started/ds/best_practices' + ]}, + {'MLOps and LLMOps': [ + 'getting_started/mlops/mlops_first_steps', + 'getting_started/mlops/mlops_second_steps', + 'getting_started/mlops/mlops_best_practices' + ]} + ]}, + 'getting_started/architecture', + ]}, + { + type: 'category', + collapsible: true, + collapsed: true, + label: 'ClearML Application Gateway', + items: [ + 'deploying_clearml/appgw_install_compose', + 'deploying_clearml/appgw_install_k8s', + ] + }, ] };