forked from clearml/clearml-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsidebars.js
252 lines (244 loc) · 15 KB
/
sidebars.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
/**
* 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: [
{'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': ['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'
]}]},
{'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',
{'Reference':
[
'clearml_agent/clearml_agent_ref', 'clearml_agent/clearml_agent_build',
'clearml_agent/clearml_agent_config', 'clearml_agent/clearml_agent_daemon',
'clearml_agent/clearml_agent_execute', 'clearml_agent/clearml_agent_list',
'clearml_agent/clearml_agent_env_var'
]
}
]
},
{'ClearML Pipelines':['pipelines/pipelines',
{"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']},]},
{'ClearML Serving':['clearml_serving/clearml_serving', 'clearml_serving/clearml_serving_setup', 'clearml_serving/clearml_serving_cli', 'clearml_serving/clearml_serving_tutorial']},
{'CLI Tools': ['apps/clearml_session', 'apps/clearml_task', 'apps/clearml_param_search']},
'integrations/libraries',
'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', 'webapp/webapp_exp_sharing']
},
{
'Models': ['webapp/webapp_model_table', 'webapp/webapp_model_viewing']
},
'webapp/webapp_archiving'
]
},
{
'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_workers_queues',
{
'ClearML Applications': [
'webapp/applications/apps_overview',
'webapp/applications/apps_gpu_compute',
'webapp/applications/apps_aws_autoscaler',
'webapp/applications/apps_gcp_autoscaler',
'webapp/applications/apps_hpo',
'webapp/applications/apps_dashboard'
]
},
'webapp/webapp_profile']
},
{'Configurations': ['configs/configuring_clearml', 'configs/clearml_conf', 'configs/env_vars']},
//'References': ['references/clearml_ref','references/clearml_agent_ref'],
{'ClearML Server': ['deploying_clearml/clearml_server',
{
'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_config_for_clearml_server', 'deploying_clearml/clearml_server_security'
]},
//'Comments': ['Notes'],
],
guidesSidebar: [
'guides/guidemain',
{'Advanced': ['guides/advanced/execute_remotely', 'guides/advanced/multiple_tasks_single_process']},
{'Automation': ['guides/automation/manual_random_param_search_example', 'guides/automation/task_piping']},
{'ClearML Task': ['guides/clearml-task/clearml_task_tutorial']},
{'ClearML Agent': ['guides/clearml_agent/executable_exp_containers', 'guides/clearml_agent/exp_environment_containers']},
{'Datasets': ['guides/datasets/data_man_cifar_classification', 'guides/datasets/data_man_python']},
{'Distributed': ['guides/distributed/distributed_pytorch_example', 'guides/distributed/subprocess_example']},
{'Docker': ['guides/docker/extra_docker_shell_script']},
{'Frameworks': [
{'Autokeras': ['guides/frameworks/autokeras/integration_autokeras', 'guides/frameworks/autokeras/autokeras_imdb_example']},
'guides/frameworks/catboost/catboost',
'guides/frameworks/fastai/fastai_with_tensorboard',
{'Keras': ['guides/frameworks/keras/jupyter', 'guides/frameworks/keras/keras_tensorboard']},
'guides/frameworks/lightgbm/lightgbm_example',
'guides/frameworks/matplotlib/matplotlib_example',
'guides/frameworks/megengine/megengine_mnist',
{'PyTorch':
[
'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',
'guides/frameworks/pytorch/pytorch_tensorboardx', 'guides/frameworks/pytorch/pytorch_abseil', 'guides/frameworks/pytorch/model_updating',
{'PyTorch Notebooks': [
{'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']}]
}
]
},
{'PyTorch Ignite': ['guides/frameworks/pytorch_ignite/integration_pytorch_ignite', 'guides/frameworks/pytorch_ignite/pytorch_ignite_mnist']},
'guides/frameworks/pytorch_lightning/pytorch_lightning_example',
{'Scikit-Learn': ['guides/frameworks/scikit-learn/sklearn_joblib_example', 'guides/frameworks/scikit-learn/sklearn_matplotlib_example']},
{'TensorBoardX': ['guides/frameworks/tensorboardx/tensorboardx', "guides/frameworks/tensorboardx/video_tensorboardx"]},
{
'Tensorflow': ['guides/frameworks/tensorflow/tensorboard_pr_curve', 'guides/frameworks/tensorflow/tensorboard_toy',
'guides/frameworks/tensorflow/tensorflow_mnist', 'guides/frameworks/tensorflow/integration_keras_tuner']
},
{'XGBoost': ['guides/frameworks/xgboost/xgboost_sample', 'guides/frameworks/xgboost/xgboost_metrics']}
]},
{'IDEs': ['guides/ide/remote_jupyter_tutorial', 'guides/ide/integration_pycharm', 'guides/ide/google_colab']},
{'Offline Mode':['guides/set_offline']},
{'Optimization': ['guides/optimization/hyper-parameter-optimization/examples_hyperparam_opt']},
{'Pipelines': ['guides/pipeline/pipeline_controller', 'guides/pipeline/pipeline_decorator', 'guides/pipeline/pipeline_functions']},
{'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',
'guides/reporting/hyper_parameters', 'guides/reporting/image_reporting', 'guides/reporting/manual_matplotlib_reporting', 'guides/reporting/media_reporting',
'guides/reporting/model_config', 'guides/reporting/pandas_reporting', 'guides/reporting/plotly_reporting',
'guides/reporting/scalar_reporting', 'guides/reporting/scatter_hist_confusion_mat_reporting', 'guides/reporting/text_reporting']},
{'Services': ['guides/services/aws_autoscaler', 'guides/services/cleanup_service', 'guides/services/slack_alerts']},
{'Storage': ['guides/storage/examples_storagehelper']},
{'Web UI': ['guides/ui/building_leader_board','guides/ui/tuning_exp']}
],
rnSidebar: {
'Release Notes': ['release_notes/ver_1_8', 'release_notes/ver_1_7', 'release_notes/ver_1_6', 'release_notes/ver_1_5',
'release_notes/ver_1_4', 'release_notes/ver_1_3', 'release_notes/ver_1_2','release_notes/ver_1_1',
'release_notes/ver_1_0', 'release_notes/ver_0_17', 'release_notes/ver_0_16', 'release_notes/ver_0_15', 'release_notes/ver_0_14',
'release_notes/ver_0_13', 'release_notes/ver_0_12', 'release_notes/ver_0_11', 'release_notes/ver_0_10',
'release_notes/ver_0_9',
],
},
sdkSidebar: [
'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']},
'references/sdk/scheduler',
'references/sdk/trigger',
{'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',
]},
],
hyperdatasetsSidebar: [
'hyperdatasets/overview',
{'Frames': [
'hyperdatasets/frames',
'hyperdatasets/single_frames',
'hyperdatasets/frame_groups',
'hyperdatasets/sources',
'hyperdatasets/annotations',
'hyperdatasets/masks',
'hyperdatasets/previews',
'hyperdatasets/custom_metadata'
]},
'hyperdatasets/dataset',
'hyperdatasets/dataviews',
'hyperdatasets/task',
{'WebApp': [
{'Projects': [
'hyperdatasets/webapp/webapp_dataviews', 'hyperdatasets/webapp/webapp_exp_track_visual',
'hyperdatasets/webapp/webapp_exp_modifying', 'hyperdatasets/webapp/webapp_exp_comparing',
]
},
{'Datasets': [
'hyperdatasets/webapp/webapp_datasets',
'hyperdatasets/webapp/webapp_datasets_versioning',
'hyperdatasets/webapp/webapp_datasets_frames'
]
},
'hyperdatasets/webapp/webapp_annotator'
]
}
],
sdkHyperDataset: [
{'HyperDataset': ['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',
]
};