From c1ca87c278439cc1ec29c552bf1e01f378e14ecd Mon Sep 17 00:00:00 2001 From: revital Date: Thu, 20 Feb 2025 10:52:57 +0200 Subject: [PATCH] Adjust ToC: * Move ClearML Serving instructions and model launchers to Using ClearML * Add HPO SDK to ToC * Move most ClearML Agent tabs to "Setup" --- docs/clearml_agent/clearml_agent_setup.md | 2 +- sidebars.js | 75 +++++++++++------------ 2 files changed, 38 insertions(+), 39 deletions(-) diff --git a/docs/clearml_agent/clearml_agent_setup.md b/docs/clearml_agent/clearml_agent_setup.md index 2f460f19..6f8e36f5 100644 --- a/docs/clearml_agent/clearml_agent_setup.md +++ b/docs/clearml_agent/clearml_agent_setup.md @@ -9,7 +9,7 @@ If ClearML was previously configured, follow [this](#adding-clearml-agent-to-a-c ClearML Agent specific configurations ::: -To install ClearML Agent, execute +To install [ClearML Agent](../clearml_agent.md), execute ```bash pip install clearml-agent ``` diff --git a/sidebars.js b/sidebars.js index 2e0130ea..879b6fb4 100644 --- a/sidebars.js +++ b/sidebars.js @@ -27,15 +27,8 @@ module.exports = { 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' ] }, { @@ -87,34 +80,8 @@ module.exports = { 'webapp/applications/apps_streamlit', ] }, - { - type: 'category', - collapsible: true, - collapsed: true, - label: 'Model Deployment', - link: {type: 'doc', id: 'deploying_models'}, - items: [ - { - 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'] - }, - { - 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' - ] - } - ] - }, + 'deploying_models', + ] }, /* @@ -141,9 +108,25 @@ module.exports = { }, 'hpo', {"Deploying Model Endpoints": [ - 'webapp/applications/apps_embed_model_deployment', - 'webapp/applications/apps_model_deployment', - 'webapp/applications/apps_llama_deployment' + { + 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'] + }, + { + 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' + ] + } ]}, {"Launch Remote Development Environments": [ 'webapp/applications/apps_ssh_session', @@ -269,6 +252,7 @@ module.exports = { items: [ 'clearml_sdk/task_sdk', 'clearml_sdk/model_sdk', + 'clearml_sdk/hpo_sdk', 'clearml_sdk/apiclient_sdk' ] }, @@ -631,6 +615,21 @@ module.exports = { 'hyperdatasets/code_examples' ], installationSidebar: [ + { + type: 'category', + collapsible: true, + collapsed: true, + label: '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_services_mode', + 'clearml_agent/clearml_agent_docker', + 'clearml_agent/clearml_agent_scheduling' + ] + }, { type: 'category', collapsible: true,