2021-05-13 23:48:51 +00:00
|
|
|
/**
|
|
|
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
|
|
|
*
|
|
|
|
|
* This source code is licensed under the MIT license found in the
|
|
|
|
|
* LICENSE file in the root directory of this source tree.
|
|
|
|
|
*
|
|
|
|
|
* @format
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
module.exports = {
|
|
|
|
|
mainSidebar: [
|
2024-11-07 10:17:26 +00:00
|
|
|
{
|
2025-02-23 15:33:55 +00:00
|
|
|
type: 'doc',
|
|
|
|
|
id: 'overview',
|
|
|
|
|
label: 'ClearML at a Glance',
|
2024-11-07 10:17:26 +00:00
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
type: 'category',
|
|
|
|
|
collapsible: true,
|
2025-02-23 15:33:55 +00:00
|
|
|
label: 'Infrastructure Control Plane (GPUaaS)',
|
2024-11-07 10:17:26 +00:00
|
|
|
items: [
|
2025-02-23 15:33:55 +00:00
|
|
|
'fundamentals/agents_and_queues',
|
|
|
|
|
'clearml_agent',
|
|
|
|
|
'clearml_agent/clearml_agent_dynamic_gpus',
|
|
|
|
|
'clearml_agent/clearml_agent_fractional_gpus',
|
|
|
|
|
'cloud_autoscaling/autoscaling_overview',
|
|
|
|
|
'remote_session'
|
2024-11-07 10:17:26 +00:00
|
|
|
]
|
2023-04-04 13:00:39 +00:00
|
|
|
},
|
2024-11-07 10:17:26 +00:00
|
|
|
{
|
|
|
|
|
type: 'category',
|
|
|
|
|
collapsible: true,
|
2025-02-23 15:33:55 +00:00
|
|
|
label: 'AI Development Center',
|
2024-11-07 10:17:26 +00:00
|
|
|
items: [
|
2025-02-23 15:33:55 +00:00
|
|
|
'clearml_sdk/clearml_sdk',
|
|
|
|
|
'pipelines/pipelines',
|
|
|
|
|
'clearml_data/clearml_data',
|
|
|
|
|
'hyper_datasets',
|
|
|
|
|
'model_registry',
|
2024-03-14 12:52:00 +00:00
|
|
|
]
|
|
|
|
|
},
|
2024-11-07 10:17:26 +00:00
|
|
|
{
|
|
|
|
|
type: 'category',
|
|
|
|
|
collapsible: true,
|
2025-02-23 15:33:55 +00:00
|
|
|
label: 'GenAI App Engine',
|
2024-11-07 10:17:26 +00:00
|
|
|
items: [
|
2025-02-23 15:33:55 +00:00
|
|
|
'deploying_clearml/enterprise_deploy/appgw',
|
|
|
|
|
'build_interactive_models',
|
|
|
|
|
'deploying_models',
|
|
|
|
|
'custom_apps'
|
2024-03-24 09:04:13 +00:00
|
|
|
]
|
|
|
|
|
},
|
2025-02-23 15:33:55 +00:00
|
|
|
],
|
|
|
|
|
usecaseSidebar: [
|
|
|
|
|
/*'getting_started/main',*/
|
|
|
|
|
'getting_started/auto_log_exp',
|
|
|
|
|
'getting_started/track_tasks',
|
|
|
|
|
'getting_started/reproduce_tasks',
|
|
|
|
|
'getting_started/logging_using_artifacts',
|
|
|
|
|
'getting_started/data_management',
|
|
|
|
|
'getting_started/remote_execution',
|
|
|
|
|
'getting_started/building_pipelines',
|
|
|
|
|
'hpo',
|
|
|
|
|
'clearml_agent/clearml_agent_docker_exec',
|
|
|
|
|
'clearml_agent/clearml_agent_base_docker',
|
|
|
|
|
'clearml_agent/clearml_agent_scheduling',
|
|
|
|
|
{"Deploying Model Endpoints": [
|
|
|
|
|
{
|
|
|
|
|
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'
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]},
|
|
|
|
|
{"Launching 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'}
|
|
|
|
|
]},
|
|
|
|
|
{"Building Interactive Model Demos": [
|
|
|
|
|
{type: 'ref', id: 'webapp/applications/apps_gradio'},
|
|
|
|
|
{type: 'ref', id: 'webapp/applications/apps_streamlit'},
|
|
|
|
|
]},
|
2025-02-24 09:00:38 +00:00
|
|
|
'getting_started/task_trigger_schedule',
|
2025-02-23 15:33:55 +00:00
|
|
|
{"Monitoring Project Progress": [
|
|
|
|
|
{type: 'ref', id: 'webapp/applications/apps_dashboard'},
|
|
|
|
|
]},
|
|
|
|
|
],
|
|
|
|
|
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'
|
2021-05-13 23:48:51 +00:00
|
|
|
],
|
|
|
|
|
guidesSidebar: [
|
|
|
|
|
'guides/guidemain',
|
2021-08-25 06:42:40 +00:00
|
|
|
{'Advanced': ['guides/advanced/execute_remotely', 'guides/advanced/multiple_tasks_single_process']},
|
2021-05-13 23:48:51 +00:00
|
|
|
{'Automation': ['guides/automation/manual_random_param_search_example', 'guides/automation/task_piping']},
|
2021-12-22 08:54:04 +00:00
|
|
|
{'ClearML Task': ['guides/clearml-task/clearml_task_tutorial']},
|
2023-10-18 09:18:45 +00:00
|
|
|
{'ClearML Agent': ['guides/clearml_agent/executable_exp_containers', 'guides/clearml_agent/exp_environment_containers', 'guides/clearml_agent/reproduce_exp']},
|
2023-04-04 13:16:54 +00:00
|
|
|
{'Datasets': ['clearml_data/data_management_examples/data_man_cifar_classification', 'clearml_data/data_management_examples/data_man_python']},
|
2025-02-23 15:33:55 +00:00
|
|
|
{id: 'hyperdatasets/code_examples', type: 'doc', label: 'Hyper-Datasets'},
|
2021-05-13 23:48:51 +00:00
|
|
|
{'Distributed': ['guides/distributed/distributed_pytorch_example', 'guides/distributed/subprocess_example']},
|
|
|
|
|
{'Docker': ['guides/docker/extra_docker_shell_script']},
|
|
|
|
|
{'Frameworks': [
|
2023-08-10 08:55:09 +00:00
|
|
|
'guides/frameworks/autokeras/autokeras_imdb_example',
|
2022-03-20 13:41:28 +00:00
|
|
|
'guides/frameworks/catboost/catboost',
|
2021-12-27 08:41:43 +00:00
|
|
|
'guides/frameworks/fastai/fastai_with_tensorboard',
|
2024-08-25 10:51:03 +00:00
|
|
|
{'Hugging Face': ['guides/frameworks/huggingface/transformers']},
|
2023-11-22 12:55:01 +00:00
|
|
|
{'Keras': ['guides/frameworks/keras/jupyter', 'guides/frameworks/keras/keras_tensorboard']},
|
2021-12-27 08:41:43 +00:00
|
|
|
'guides/frameworks/lightgbm/lightgbm_example',
|
|
|
|
|
'guides/frameworks/matplotlib/matplotlib_example',
|
|
|
|
|
'guides/frameworks/megengine/megengine_mnist',
|
2021-11-07 07:50:57 +00:00
|
|
|
{'PyTorch':
|
2022-01-13 07:32:04 +00:00
|
|
|
[
|
|
|
|
|
'guides/frameworks/pytorch/pytorch_distributed_example', 'guides/frameworks/pytorch/pytorch_matplotlib',
|
|
|
|
|
'guides/frameworks/pytorch/pytorch_mnist', 'guides/frameworks/pytorch/pytorch_tensorboard','guides/frameworks/pytorch/tensorboard_toy_pytorch',
|
2022-02-06 09:53:47 +00:00
|
|
|
'guides/frameworks/pytorch/pytorch_tensorboardx', 'guides/frameworks/pytorch/pytorch_abseil', 'guides/frameworks/pytorch/model_updating',
|
2021-11-07 07:50:57 +00:00
|
|
|
{'PyTorch Notebooks': [
|
2021-09-19 09:00:31 +00:00
|
|
|
{'Audio': ['guides/frameworks/pytorch/notebooks/audio/audio_classification_UrbanSound8K', 'guides/frameworks/pytorch/notebooks/audio/audio_preprocessing_example']},
|
|
|
|
|
{'Image': ['guides/frameworks/pytorch/notebooks/image/hyperparameter_search', 'guides/frameworks/pytorch/notebooks/image/image_classification_CIFAR10']},
|
|
|
|
|
{'Table': ['guides/frameworks/pytorch/notebooks/table/download_and_preprocessing', 'guides/frameworks/pytorch/notebooks/table/tabular_training_pipeline']},
|
|
|
|
|
{'Text': ['guides/frameworks/pytorch/notebooks/text/text_classification_AG_NEWS']}]
|
|
|
|
|
}
|
|
|
|
|
]
|
2021-05-13 23:48:51 +00:00
|
|
|
},
|
2021-12-27 17:51:46 +00:00
|
|
|
{'PyTorch Ignite': ['guides/frameworks/pytorch_ignite/integration_pytorch_ignite', 'guides/frameworks/pytorch_ignite/pytorch_ignite_mnist']},
|
2021-12-27 08:41:43 +00:00
|
|
|
'guides/frameworks/pytorch_lightning/pytorch_lightning_example',
|
2021-05-13 23:48:51 +00:00
|
|
|
{'Scikit-Learn': ['guides/frameworks/scikit-learn/sklearn_joblib_example', 'guides/frameworks/scikit-learn/sklearn_matplotlib_example']},
|
2021-10-21 09:22:42 +00:00
|
|
|
{'TensorBoardX': ['guides/frameworks/tensorboardx/tensorboardx', "guides/frameworks/tensorboardx/video_tensorboardx"]},
|
2021-05-13 23:48:51 +00:00
|
|
|
{
|
2023-08-01 14:05:53 +00:00
|
|
|
'TensorFlow': ['guides/frameworks/tensorflow/tensorboard_pr_curve', 'guides/frameworks/tensorflow/tensorboard_toy',
|
2021-05-13 23:48:51 +00:00
|
|
|
'guides/frameworks/tensorflow/tensorflow_mnist', 'guides/frameworks/tensorflow/integration_keras_tuner']
|
|
|
|
|
},
|
2022-01-02 14:23:06 +00:00
|
|
|
{'XGBoost': ['guides/frameworks/xgboost/xgboost_sample', 'guides/frameworks/xgboost/xgboost_metrics']}
|
2021-05-13 23:48:51 +00:00
|
|
|
]},
|
2021-06-20 22:00:16 +00:00
|
|
|
{'IDEs': ['guides/ide/remote_jupyter_tutorial', 'guides/ide/integration_pycharm', 'guides/ide/google_colab']},
|
2021-07-14 07:36:25 +00:00
|
|
|
{'Offline Mode':['guides/set_offline']},
|
2021-05-13 23:48:51 +00:00
|
|
|
{'Optimization': ['guides/optimization/hyper-parameter-optimization/examples_hyperparam_opt']},
|
2021-12-23 11:54:02 +00:00
|
|
|
{'Pipelines': ['guides/pipeline/pipeline_controller', 'guides/pipeline/pipeline_decorator', 'guides/pipeline/pipeline_functions']},
|
2021-10-21 13:01:55 +00:00
|
|
|
{'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',
|
2021-05-13 23:48:51 +00:00
|
|
|
'guides/reporting/hyper_parameters', 'guides/reporting/image_reporting', 'guides/reporting/manual_matplotlib_reporting', 'guides/reporting/media_reporting',
|
2022-02-06 09:53:47 +00:00
|
|
|
'guides/reporting/model_config', 'guides/reporting/pandas_reporting', 'guides/reporting/plotly_reporting',
|
2021-05-13 23:48:51 +00:00
|
|
|
'guides/reporting/scalar_reporting', 'guides/reporting/scatter_hist_confusion_mat_reporting', 'guides/reporting/text_reporting']},
|
2021-06-20 22:00:16 +00:00
|
|
|
{'Services': ['guides/services/aws_autoscaler', 'guides/services/cleanup_service', 'guides/services/slack_alerts']},
|
2021-05-13 23:48:51 +00:00
|
|
|
{'Storage': ['guides/storage/examples_storagehelper']},
|
|
|
|
|
{'Web UI': ['guides/ui/building_leader_board','guides/ui/tuning_exp']}
|
|
|
|
|
|
|
|
|
|
],
|
2025-02-23 15:33:55 +00:00
|
|
|
knowledgeSidebar: [
|
|
|
|
|
{'Fundamentals': [
|
|
|
|
|
'fundamentals/projects',
|
|
|
|
|
'fundamentals/task',
|
|
|
|
|
'fundamentals/hyperparameters',
|
|
|
|
|
'fundamentals/artifacts',
|
|
|
|
|
'fundamentals/models',
|
|
|
|
|
'fundamentals/logger',
|
|
|
|
|
]},
|
|
|
|
|
{
|
|
|
|
|
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',
|
|
|
|
|
'hyperdatasets/task',
|
|
|
|
|
'clearml_sdk/hpo_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',
|
|
|
|
|
{
|
|
|
|
|
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'
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
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',
|
|
|
|
|
'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'
|
|
|
|
|
]}
|
|
|
|
|
]},
|
|
|
|
|
],
|
2024-09-26 13:09:25 +00:00
|
|
|
rnSidebar: [
|
|
|
|
|
{'Server': [
|
|
|
|
|
{
|
|
|
|
|
'Open Source':
|
|
|
|
|
[
|
2025-01-01 08:24:09 +00:00
|
|
|
'release_notes/clearml_server/open_source/ver_2_0',
|
2025-01-21 11:15:23 +00:00
|
|
|
{
|
|
|
|
|
'Older Versions': [
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_1_17', 'release_notes/clearml_server/open_source/ver_1_16',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_1_15', 'release_notes/clearml_server/open_source/ver_1_14',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_1_13', 'release_notes/clearml_server/open_source/ver_1_12',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_1_11', 'release_notes/clearml_server/open_source/ver_1_10',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_1_9', 'release_notes/clearml_server/open_source/ver_1_8',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_1_7', 'release_notes/clearml_server/open_source/ver_1_6',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_1_5', 'release_notes/clearml_server/open_source/ver_1_4',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_1_3', 'release_notes/clearml_server/open_source/ver_1_2',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_1_1', 'release_notes/clearml_server/open_source/ver_1_0',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_0_17', 'release_notes/clearml_server/open_source/ver_0_16',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_0_15', 'release_notes/clearml_server/open_source/ver_0_14',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_0_13', 'release_notes/clearml_server/open_source/ver_0_12',
|
|
|
|
|
'release_notes/clearml_server/open_source/ver_0_11', 'release_notes/clearml_server/open_source/ver_0_10',
|
|
|
|
|
]
|
|
|
|
|
}
|
2024-09-26 13:09:25 +00:00
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
'Enterprise':
|
|
|
|
|
[
|
2025-02-06 17:20:50 +00:00
|
|
|
'release_notes/clearml_server/enterprise/ver_3_24',
|
2025-01-21 11:15:23 +00:00
|
|
|
{
|
|
|
|
|
'Older Versions': [
|
2025-02-23 15:33:55 +00:00
|
|
|
'release_notes/clearml_server/enterprise/ver_3_23', 'release_notes/clearml_server/enterprise/ver_3_22',
|
2025-01-21 11:15:23 +00:00
|
|
|
'release_notes/clearml_server/enterprise/ver_3_21', 'release_notes/clearml_server/enterprise/ver_3_20'
|
|
|
|
|
]
|
|
|
|
|
}
|
2024-09-26 13:09:25 +00:00
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]},
|
|
|
|
|
{'SDK': [
|
|
|
|
|
{
|
|
|
|
|
'Open Source':
|
|
|
|
|
[
|
2024-12-19 07:56:40 +00:00
|
|
|
'release_notes/sdk/open_source/ver_1_17',
|
2025-01-21 11:15:23 +00:00
|
|
|
{
|
|
|
|
|
'Older Versions': [
|
|
|
|
|
'release_notes/sdk/open_source/ver_1_16', 'release_notes/sdk/open_source/ver_1_15',
|
|
|
|
|
'release_notes/sdk/open_source/ver_1_14', 'release_notes/sdk/open_source/ver_1_13',
|
|
|
|
|
'release_notes/sdk/open_source/ver_1_12', 'release_notes/sdk/open_source/ver_1_11',
|
|
|
|
|
'release_notes/sdk/open_source/ver_1_10', 'release_notes/sdk/open_source/ver_1_9',
|
|
|
|
|
'release_notes/sdk/open_source/ver_1_8', 'release_notes/sdk/open_source/ver_1_7',
|
|
|
|
|
'release_notes/sdk/open_source/ver_1_6', 'release_notes/sdk/open_source/ver_1_5',
|
|
|
|
|
'release_notes/sdk/open_source/ver_1_4', 'release_notes/sdk/open_source/ver_1_3',
|
|
|
|
|
'release_notes/sdk/open_source/ver_1_2', 'release_notes/sdk/open_source/ver_1_1',
|
|
|
|
|
'release_notes/sdk/open_source/ver_1_0', 'release_notes/sdk/open_source/ver_0_17',
|
|
|
|
|
'release_notes/sdk/open_source/ver_0_16', 'release_notes/sdk/open_source/ver_0_15',
|
|
|
|
|
'release_notes/sdk/open_source/ver_0_14', 'release_notes/sdk/open_source/ver_0_13',
|
|
|
|
|
'release_notes/sdk/open_source/ver_0_12', 'release_notes/sdk/open_source/ver_0_11',
|
|
|
|
|
'release_notes/sdk/open_source/ver_0_10', 'release_notes/sdk/open_source/ver_0_9',
|
|
|
|
|
]
|
|
|
|
|
}
|
2024-09-26 13:09:25 +00:00
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
'Enterprise':
|
|
|
|
|
[
|
2025-01-21 11:15:23 +00:00
|
|
|
'release_notes/sdk/enterprise/ver_3_12',
|
|
|
|
|
{
|
|
|
|
|
'Older Versions': [
|
|
|
|
|
'release_notes/sdk/enterprise/ver_3_11',
|
|
|
|
|
'release_notes/sdk/enterprise/ver_3_10',
|
|
|
|
|
]
|
|
|
|
|
}
|
2024-09-26 13:09:25 +00:00
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]},
|
|
|
|
|
{'ClearML Agent':
|
|
|
|
|
[
|
2025-01-21 11:15:23 +00:00
|
|
|
'release_notes/clearml_agent/ver_1_9',
|
|
|
|
|
{
|
|
|
|
|
'Older Versions': [
|
|
|
|
|
'release_notes/clearml_agent/ver_1_8',
|
|
|
|
|
'release_notes/clearml_agent/ver_1_7', 'release_notes/clearml_agent/ver_1_6',
|
|
|
|
|
'release_notes/clearml_agent/ver_1_5', 'release_notes/clearml_agent/ver_1_4',
|
|
|
|
|
'release_notes/clearml_agent/ver_1_3', 'release_notes/clearml_agent/ver_1_2',
|
|
|
|
|
'release_notes/clearml_agent/ver_1_1', 'release_notes/clearml_agent/ver_1_0',
|
|
|
|
|
'release_notes/clearml_agent/ver_0_17', 'release_notes/clearml_agent/ver_0_16',
|
|
|
|
|
'release_notes/clearml_agent/ver_0_15', 'release_notes/clearml_agent/ver_0_14',
|
|
|
|
|
'release_notes/clearml_agent/ver_0_13', 'release_notes/clearml_agent/ver_0_12',
|
|
|
|
|
]
|
|
|
|
|
}
|
2024-09-26 13:09:25 +00:00
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{'ClearML Serving':
|
|
|
|
|
[
|
2025-01-21 11:15:23 +00:00
|
|
|
'release_notes/clearml_serving/ver_1_3',
|
|
|
|
|
{
|
|
|
|
|
'Older Versions': [
|
|
|
|
|
'release_notes/clearml_serving/ver_1_2',
|
|
|
|
|
'release_notes/clearml_serving/ver_1_1', 'release_notes/clearml_serving/ver_1_0',
|
|
|
|
|
]
|
|
|
|
|
}
|
2024-09-26 13:09:25 +00:00
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
],
|
2025-02-23 15:33:55 +00:00
|
|
|
referenceSidebar: [
|
|
|
|
|
{'SDK': [
|
2021-05-13 23:48:51 +00:00
|
|
|
'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',
|
2025-02-23 15:33:55 +00:00
|
|
|
{'Pipeline': [
|
|
|
|
|
'references/sdk/automation_controller_pipelinecontroller',
|
|
|
|
|
'references/sdk/automation_job_clearmljob'
|
|
|
|
|
]},
|
2021-11-07 13:07:48 +00:00
|
|
|
'references/sdk/scheduler',
|
|
|
|
|
'references/sdk/trigger',
|
2021-05-13 23:48:51 +00:00
|
|
|
{'HyperParameter Optimization': [
|
|
|
|
|
'references/sdk/hpo_optimization_hyperparameteroptimizer',
|
|
|
|
|
'references/sdk/hpo_optimization_gridsearch',
|
|
|
|
|
'references/sdk/hpo_optimization_randomsearch',
|
|
|
|
|
'references/sdk/hpo_optuna_optuna_optimizeroptuna',
|
|
|
|
|
'references/sdk/hpo_hpbandster_bandster_optimizerbohb',
|
|
|
|
|
'references/sdk/hpo_parameters_discreteparameterrange',
|
|
|
|
|
'references/sdk/hpo_parameters_uniformintegerparameterrange',
|
|
|
|
|
'references/sdk/hpo_parameters_uniformparameterrange',
|
|
|
|
|
'references/sdk/hpo_parameters_parameterset',
|
2025-02-23 15:33:55 +00:00
|
|
|
]},
|
|
|
|
|
{'Enterprise Hyper-Datasets': [
|
|
|
|
|
{'Hyper-Dataset': [
|
|
|
|
|
'references/hyperdataset/hyperdataset',
|
|
|
|
|
'references/hyperdataset/hyperdatasetversion'
|
2021-05-13 23:48:51 +00:00
|
|
|
]},
|
2025-02-23 15:33:55 +00:00
|
|
|
{'DataFrame': [
|
|
|
|
|
'references/hyperdataset/singleframe',
|
|
|
|
|
'references/hyperdataset/framegroup',
|
|
|
|
|
'references/hyperdataset/annotation',
|
|
|
|
|
]},
|
|
|
|
|
'references/hyperdataset/dataview',
|
2021-06-20 22:00:16 +00:00
|
|
|
]},
|
2025-02-23 15:33:55 +00:00
|
|
|
]},
|
|
|
|
|
{'CLI Tools': [
|
|
|
|
|
'apps/clearml_task',
|
|
|
|
|
{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',
|
2022-03-06 11:00:46 +00:00
|
|
|
{'Projects': [
|
2025-02-23 15:33:55 +00:00
|
|
|
'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'
|
|
|
|
|
]},
|
|
|
|
|
{'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'
|
|
|
|
|
]},
|
2022-03-06 11:00:46 +00:00
|
|
|
{'Datasets': [
|
2025-02-23 15:33:55 +00:00
|
|
|
'webapp/datasets/webapp_dataset_page',
|
|
|
|
|
'webapp/datasets/webapp_dataset_viewing'
|
|
|
|
|
]},
|
|
|
|
|
{'Hyper-Datasets': [
|
2022-03-06 11:00:46 +00:00
|
|
|
'hyperdatasets/webapp/webapp_datasets',
|
|
|
|
|
'hyperdatasets/webapp/webapp_datasets_versioning',
|
2025-02-23 15:33:55 +00:00
|
|
|
'hyperdatasets/webapp/webapp_datasets_frames',
|
|
|
|
|
'hyperdatasets/webapp/webapp_annotator'
|
|
|
|
|
]},
|
|
|
|
|
{'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',
|
|
|
|
|
{
|
|
|
|
|
type: 'category',
|
|
|
|
|
collapsible: true,
|
|
|
|
|
collapsed: true,
|
|
|
|
|
label: 'Autoscalers',
|
|
|
|
|
items: [
|
|
|
|
|
'webapp/applications/apps_aws_autoscaler',
|
|
|
|
|
'webapp/applications/apps_gcp_autoscaler',
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
'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'
|
2022-03-06 11:00:46 +00:00
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
]
|
2024-03-24 08:49:28 +00:00
|
|
|
},
|
2021-06-20 22:00:16 +00:00
|
|
|
],
|
2025-02-23 15:33:55 +00:00
|
|
|
installationSidebar: [
|
|
|
|
|
'clearml_sdk/clearml_sdk_setup',
|
|
|
|
|
{
|
|
|
|
|
type: 'category',
|
|
|
|
|
collapsible: true,
|
|
|
|
|
collapsed: true,
|
|
|
|
|
label: 'ClearML Agent',
|
|
|
|
|
items: [
|
|
|
|
|
'clearml_agent/clearml_agent_setup',
|
|
|
|
|
{
|
|
|
|
|
'Deployment': [
|
|
|
|
|
'clearml_agent/clearml_agent_deployment_bare_metal',
|
|
|
|
|
'clearml_agent/clearml_agent_deployment_k8s',
|
|
|
|
|
'clearml_agent/clearml_agent_deployment_slurm',
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
'clearml_agent/clearml_agent_execution_env',
|
|
|
|
|
'clearml_agent/clearml_agent_env_caching',
|
|
|
|
|
'clearml_agent/clearml_agent_services_mode',
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
type: 'doc',
|
|
|
|
|
label: 'Configuring Client Storage Access',
|
|
|
|
|
id: 'integrations/storage',
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
type: 'category',
|
|
|
|
|
collapsible: true,
|
|
|
|
|
collapsed: true,
|
|
|
|
|
label: 'Open Source Server',
|
|
|
|
|
link: {type: 'doc', id: 'deploying_clearml/clearml_server'},
|
|
|
|
|
items: [
|
|
|
|
|
{'Deployment Options': [
|
|
|
|
|
'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',
|
|
|
|
|
{'Server Upgrade Procedures': [
|
|
|
|
|
'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/architecture',
|
|
|
|
|
]},*/
|
|
|
|
|
{
|
|
|
|
|
'Enterprise Server Deployment': [
|
|
|
|
|
'deploying_clearml/enterprise_deploy/multi_tenant_k8s',
|
|
|
|
|
'deploying_clearml/enterprise_deploy/vpc_aws',
|
|
|
|
|
'deploying_clearml/enterprise_deploy/on_prem_ubuntu',
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
type: 'category',
|
|
|
|
|
collapsible: true,
|
|
|
|
|
collapsed: true,
|
|
|
|
|
label: 'ClearML Application Gateway',
|
|
|
|
|
items: [
|
|
|
|
|
'deploying_clearml/enterprise_deploy/appgw_install_compose',
|
|
|
|
|
'deploying_clearml/enterprise_deploy/appgw_install_k8s',
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
'deploying_clearml/enterprise_deploy/delete_tenant',
|
|
|
|
|
{
|
|
|
|
|
'Enterprise Applications': [
|
|
|
|
|
'deploying_clearml/enterprise_deploy/app_install_ubuntu_on_prem',
|
|
|
|
|
'deploying_clearml/enterprise_deploy/app_install_ex_server',
|
|
|
|
|
'deploying_clearml/enterprise_deploy/app_custom',
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
'User Management': [
|
|
|
|
|
'user_management/user_groups',
|
|
|
|
|
'user_management/access_rules',
|
|
|
|
|
'user_management/admin_vaults',
|
|
|
|
|
{
|
|
|
|
|
type: 'category',
|
|
|
|
|
collapsible: true,
|
|
|
|
|
collapsed: true,
|
|
|
|
|
label: 'Identity Provider Integration',
|
|
|
|
|
link: {type: 'doc', id: 'user_management/identity_providers'},
|
|
|
|
|
items: [
|
|
|
|
|
'deploying_clearml/enterprise_deploy/sso_saml_k8s',
|
|
|
|
|
'deploying_clearml/enterprise_deploy/sso_keycloak',
|
|
|
|
|
'deploying_clearml/enterprise_deploy/sso_active_directory'
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
]
|
|
|
|
|
},
|
2021-09-17 21:55:20 +00:00
|
|
|
],
|
2025-02-23 15:33:55 +00:00
|
|
|
bestPracticesSidebar: [
|
|
|
|
|
{
|
|
|
|
|
type: 'category',
|
|
|
|
|
collapsible: true,
|
|
|
|
|
label: 'Best Practices',
|
|
|
|
|
items: [
|
|
|
|
|
{
|
|
|
|
|
type: 'doc',
|
|
|
|
|
label: 'Data Scientists',
|
|
|
|
|
id: 'getting_started/ds/best_practices'
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
type: 'doc',
|
|
|
|
|
label: 'MLOps and LLMOps',
|
|
|
|
|
id: 'getting_started/mlops/mlops_best_practices'
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
type: 'doc',
|
|
|
|
|
label: 'Data Management',
|
|
|
|
|
id: 'clearml_data/best_practices'
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
},
|
2021-09-17 21:55:20 +00:00
|
|
|
]
|
2021-05-13 23:48:51 +00:00
|
|
|
};
|
