sidebarsClassicML.ts
1 import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; 2 import { apiReferencePrefix } from './docusaurusConfigUtils'; 3 4 const sidebarsClassicML: SidebarsConfig = { 5 classicMLSidebar: [ 6 { 7 type: 'doc', 8 id: 'index', 9 className: 'sidebar-top-level-category', 10 label: 'MLflow', 11 }, 12 { 13 type: 'category', 14 label: 'Getting Started', 15 className: 'sidebar-top-level-category', 16 items: [ 17 { 18 type: 'doc', 19 id: 'getting-started/running-notebooks/index', 20 label: 'Set Up MLflow', 21 }, 22 { 23 type: 'doc', 24 id: 'getting-started/quickstart', 25 }, 26 { 27 type: 'doc', 28 id: 'getting-started/hyperparameter-tuning/index', 29 }, 30 { 31 type: 'doc', 32 id: 'getting-started/deep-learning', 33 }, 34 ], 35 link: { 36 type: 'doc', 37 id: 'getting-started/index', 38 }, 39 }, 40 { 41 type: 'category', 42 label: 'Machine Learning', 43 className: 'sidebar-top-level-category', 44 collapsed: false, 45 items: [ 46 { 47 type: 'category', 48 label: 'Traditional ML', 49 items: [ 50 { 51 type: 'category', 52 label: 'Tutorials', 53 items: [ 54 { 55 type: 'category', 56 label: 'Hyperparameter Tuning with MLflow and Optuna', 57 items: [ 58 { 59 type: 'doc', 60 id: 'traditional-ml/tutorials/hyperparameter-tuning/part1-child-runs/index', 61 }, 62 { 63 type: 'doc', 64 id: 'traditional-ml/tutorials/hyperparameter-tuning/part2-logging-plots/index', 65 }, 66 { 67 type: 'category', 68 label: 'Notebooks', 69 items: [ 70 { 71 type: 'doc', 72 id: 'traditional-ml/tutorials/hyperparameter-tuning/notebooks/hyperparameter-tuning-with-child-runs-ipynb', 73 }, 74 { 75 type: 'doc', 76 id: 'traditional-ml/tutorials/hyperparameter-tuning/notebooks/logging-plots-in-mlflow-ipynb', 77 }, 78 { 79 type: 'doc', 80 id: 'traditional-ml/tutorials/hyperparameter-tuning/notebooks/parent-child-runs-ipynb', 81 }, 82 ], 83 link: { 84 type: 'doc', 85 id: 'traditional-ml/tutorials/hyperparameter-tuning/notebooks/index', 86 }, 87 }, 88 ], 89 link: { 90 type: 'doc', 91 id: 'traditional-ml/tutorials/hyperparameter-tuning/index', 92 }, 93 }, 94 { 95 type: 'category', 96 label: 'Building Custom Python Function Models with MLflow', 97 items: [ 98 { 99 type: 'doc', 100 id: 'traditional-ml/tutorials/creating-custom-pyfunc/part1-named-flavors/index', 101 }, 102 { 103 type: 'doc', 104 id: 'traditional-ml/tutorials/creating-custom-pyfunc/part2-pyfunc-components/index', 105 }, 106 { 107 type: 'category', 108 label: 'Notebooks', 109 items: [ 110 { 111 type: 'doc', 112 id: 'traditional-ml/tutorials/creating-custom-pyfunc/notebooks/basic-pyfunc-ipynb', 113 label: 'Introduction to PythonModel', 114 }, 115 { 116 type: 'doc', 117 id: 'traditional-ml/tutorials/creating-custom-pyfunc/notebooks/introduction-ipynb', 118 label: 'Custom Model Basics', 119 }, 120 { 121 type: 'doc', 122 id: 'traditional-ml/tutorials/creating-custom-pyfunc/notebooks/override-predict-ipynb', 123 label: 'Customizing the `predict` method', 124 }, 125 ], 126 link: { 127 type: 'doc', 128 id: 'traditional-ml/tutorials/creating-custom-pyfunc/notebooks/index', 129 }, 130 }, 131 ], 132 link: { 133 type: 'doc', 134 id: 'traditional-ml/tutorials/creating-custom-pyfunc/index', 135 }, 136 }, 137 { 138 type: 'category', 139 label: 'Serving Multiple Models on a Single Endpoint with a Custom PyFunc Model', 140 items: [ 141 { 142 type: 'doc', 143 id: 'traditional-ml/tutorials/serving-multiple-models-with-pyfunc/notebooks/MME_Tutorial-ipynb', 144 label: 'Notebooks', 145 }, 146 ], 147 link: { 148 type: 'doc', 149 id: 'traditional-ml/tutorials/serving-multiple-models-with-pyfunc/index', 150 }, 151 }, 152 ], 153 }, 154 { 155 type: 'doc', 156 id: 'traditional-ml/sklearn/index', 157 label: 'Scikit-learn', 158 }, 159 { 160 type: 'doc', 161 id: 'traditional-ml/xgboost/index', 162 label: 'XGBoost', 163 }, 164 { 165 type: 'doc', 166 id: 'traditional-ml/sparkml/index', 167 label: 'SparkML', 168 }, 169 { 170 type: 'doc', 171 id: 'traditional-ml/prophet/index', 172 label: 'Prophet', 173 }, 174 ], 175 link: { 176 type: 'doc', 177 id: 'traditional-ml/index', 178 }, 179 }, 180 { 181 type: 'category', 182 label: 'Deep Learning', 183 items: [ 184 { 185 type: 'doc', 186 id: 'deep-learning/pytorch/index', 187 label: 'PyTorch', 188 }, 189 { 190 type: 'doc', 191 id: 'deep-learning/tensorflow/index', 192 label: 'TensorFlow', 193 }, 194 { 195 type: 'doc', 196 id: 'deep-learning/keras/index', 197 label: 'Keras', 198 }, 199 { 200 type: 'category', 201 label: 'Transformers', 202 items: [ 203 { 204 type: 'doc', 205 id: 'deep-learning/transformers/guide/index', 206 }, 207 { 208 type: 'doc', 209 id: 'deep-learning/transformers/large-models/index', 210 label: 'Working with Large Transformers Models', 211 }, 212 { 213 type: 'doc', 214 id: 'deep-learning/transformers/task/index', 215 label: 'Transformers Task Types', 216 }, 217 { 218 type: 'category', 219 label: 'Tutorials', 220 items: [ 221 { 222 type: 'doc', 223 id: 'deep-learning/transformers/tutorials/conversational/conversational-model-ipynb', 224 label: 'Introduction to Conversational Models', 225 }, 226 { 227 type: 'doc', 228 id: 'deep-learning/transformers/tutorials/conversational/pyfunc-chat-model-ipynb', 229 label: 'Custom Conversational Models', 230 }, 231 { 232 type: 'doc', 233 id: 'deep-learning/transformers/tutorials/fine-tuning/transformers-fine-tuning-ipynb', 234 label: 'Introduction to Fine Tuning', 235 }, 236 { 237 type: 'doc', 238 id: 'deep-learning/transformers/tutorials/fine-tuning/transformers-peft-ipynb', 239 label: 'Leveraging PEFT for Fine Tuning', 240 }, 241 { 242 type: 'doc', 243 id: 'deep-learning/transformers/tutorials/audio-transcription/whisper-ipynb', 244 label: 'Introduction to Audio Transcription', 245 }, 246 { 247 type: 'doc', 248 id: 'deep-learning/transformers/tutorials/prompt-templating/prompt-templating-ipynb', 249 label: 'Introduction to Prompt Templating', 250 }, 251 { 252 type: 'doc', 253 id: 'deep-learning/transformers/tutorials/text-generation/text-generation-ipynb', 254 label: 'Text Generation Models', 255 }, 256 { 257 type: 'doc', 258 id: 'deep-learning/transformers/tutorials/translation/component-translation-ipynb', 259 label: 'Translation Models', 260 }, 261 ], 262 link: { 263 type: 'doc', 264 id: 'deep-learning/transformers/tutorials/index', 265 }, 266 }, 267 ], 268 link: { 269 type: 'doc', 270 id: 'deep-learning/transformers/index', 271 }, 272 }, 273 { 274 type: 'category', 275 label: 'Sentence Transformers', 276 items: [ 277 { 278 type: 'category', 279 label: 'Tutorials', 280 items: [ 281 { 282 type: 'doc', 283 id: 'deep-learning/sentence-transformers/tutorials/quickstart/sentence-transformers-quickstart-ipynb', 284 label: 'Quickstart', 285 }, 286 { 287 type: 'doc', 288 id: 'deep-learning/sentence-transformers/tutorials/semantic-similarity/semantic-similarity-sentence-transformers-ipynb', 289 label: 'Semantic Similarity', 290 }, 291 { 292 type: 'doc', 293 id: 'deep-learning/sentence-transformers/tutorials/semantic-search/semantic-search-sentence-transformers-ipynb', 294 label: 'Semantic Search', 295 }, 296 { 297 type: 'doc', 298 id: 'deep-learning/sentence-transformers/tutorials/paraphrase-mining/paraphrase-mining-sentence-transformers-ipynb', 299 label: 'Paraphrase Mining', 300 }, 301 ], 302 }, 303 ], 304 link: { 305 type: 'doc', 306 id: 'deep-learning/sentence-transformers/index', 307 }, 308 }, 309 { 310 type: 'doc', 311 id: 'deep-learning/spacy/index', 312 label: 'spaCy', 313 }, 314 ], 315 link: { 316 type: 'doc', 317 id: 'deep-learning/index', 318 }, 319 }, 320 ], 321 }, 322 { 323 type: 'category', 324 label: 'Build ', 325 className: 'sidebar-top-level-category', 326 collapsed: false, 327 items: [ 328 { 329 type: 'category', 330 label: 'MLflow Tracking', 331 items: [ 332 { 333 type: 'doc', 334 id: 'tracking/quickstart/index', 335 }, 336 { 337 type: 'doc', 338 id: 'tracking/autolog/index', 339 label: 'Auto Logging', 340 }, 341 { 342 type: 'link', 343 label: 'Tracking Server', 344 href: '/self-hosting/architecture/tracking-server/', 345 }, 346 { 347 type: 'category', 348 label: 'Search', 349 items: [ 350 { 351 type: 'doc', 352 id: 'search/search-models/index', 353 }, 354 { 355 type: 'doc', 356 id: 'search/search-runs/index', 357 }, 358 { 359 type: 'doc', 360 id: 'search/search-experiments/index', 361 }, 362 ], 363 }, 364 { 365 type: 'doc', 366 id: 'tracking/system-metrics/index', 367 label: 'System Metrics', 368 }, 369 { 370 type: 'doc', 371 id: 'tracking/tracking-api/index', 372 label: 'Tracking APIs', 373 }, 374 ], 375 link: { 376 type: 'doc', 377 id: 'tracking/index', 378 }, 379 }, 380 { 381 type: 'category', 382 label: 'MLflow Model', 383 items: [ 384 { 385 type: 'autogenerated', 386 dirName: 'model', 387 }, 388 { 389 type: 'doc', 390 id: 'community-model-flavors/index', 391 label: 'Community-Managed Model Integrations', 392 }, 393 { 394 type: 'doc', 395 id: 'tracking/pickle-free-models/index', 396 label: 'Pickle-Free Model format', 397 }, 398 ], 399 }, 400 { 401 type: 'doc', 402 id: 'dataset/index', 403 label: 'MLflow Datasets', 404 }, 405 ], 406 }, 407 { 408 type: 'doc', 409 id: 'evaluation/index', 410 label: 'Evaluate', 411 className: 'sidebar-top-level-category', 412 }, 413 { 414 type: 'category', 415 label: 'Deploy', 416 className: 'sidebar-top-level-category', 417 items: [ 418 { 419 type: 'category', 420 label: 'MLflow Model Registry', 421 items: [ 422 { 423 type: 'autogenerated', 424 dirName: 'model-registry', 425 }, 426 ], 427 link: { 428 type: 'doc', 429 id: 'model-registry/index', 430 }, 431 }, 432 { 433 type: 'category', 434 label: 'MLflow Serving', 435 items: [ 436 { 437 type: 'doc', 438 id: 'deployment/deploy-model-locally/index', 439 }, 440 { 441 type: 'category', 442 label: 'Deploy MLflow Model to Kubernetes', 443 items: [ 444 { 445 type: 'doc', 446 id: 'deployment/deploy-model-to-kubernetes/tutorial', 447 }, 448 ], 449 link: { 450 type: 'doc', 451 id: 'deployment/deploy-model-to-kubernetes/index', 452 }, 453 }, 454 { 455 type: 'doc', 456 id: 'deployment/deploy-model-to-sagemaker/index', 457 }, 458 { 459 type: 'doc', 460 id: 'deployment/deploy-model-to-modal/index', 461 }, 462 ], 463 link: { 464 type: 'doc', 465 id: 'deployment/index', 466 }, 467 }, 468 { 469 type: 'doc', 470 id: 'docker/index', 471 label: 'Docker', 472 }, 473 ], 474 }, 475 { 476 type: 'category', 477 label: 'Team Collaboration', 478 className: 'sidebar-top-level-category', 479 collapsed: true, 480 items: [ 481 { 482 type: 'link', 483 href: '/self-hosting', 484 label: 'Self-Hosting', 485 }, 486 { 487 type: 'link', 488 href: '/ml/#running-mlflow-for-ml-models-anywhere', 489 label: 'Managed Services', 490 }, 491 { 492 type: 'link', 493 href: '/self-hosting/security/basic-http-auth', 494 label: 'Access Control', 495 }, 496 { 497 type: 'doc', 498 id: 'projects/index', 499 label: 'MLflow Projects', 500 }, 501 ], 502 }, 503 { 504 type: 'category', 505 label: 'API References', 506 className: 'sidebar-top-level-category', 507 collapsed: true, 508 items: [ 509 { 510 type: 'link', 511 label: 'Python API', 512 href: `${apiReferencePrefix()}api_reference/python_api/index.html`, 513 }, 514 { 515 type: 'link', 516 label: 'Java API', 517 href: `${apiReferencePrefix()}api_reference/java_api/index.html`, 518 }, 519 { 520 type: 'link', 521 label: 'R API', 522 href: `${apiReferencePrefix()}api_reference/R-api.html`, 523 }, 524 { 525 type: 'link', 526 label: 'REST API', 527 href: `${apiReferencePrefix()}api_reference/rest-api.html`, 528 }, 529 { 530 type: 'link', 531 label: 'CLI', 532 href: `${apiReferencePrefix()}api_reference/cli.html`, 533 }, 534 ], 535 }, 536 { 537 type: 'doc', 538 id: 'mlflow-3/index', 539 label: 'MLflow 3.0 Migration', 540 className: 'sidebar-top-level-category', 541 }, 542 { 543 type: 'category', 544 label: 'More', 545 collapsed: true, 546 className: 'sidebar-top-level-category', 547 items: [ 548 { 549 type: 'link', 550 label: 'Contributing', 551 href: 'https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md', 552 }, 553 { 554 type: 'link', 555 label: 'MLflow Blogs', 556 href: 'https://mlflow.org/blog/index.html', 557 }, 558 { 559 type: 'doc', 560 id: 'plugins/index', 561 label: 'MLflow Plugins', 562 }, 563 { 564 type: 'doc', 565 id: 'tutorials-and-examples/index', 566 label: 'External Tutorials', 567 }, 568 ], 569 }, 570 ], 571 }; 572 573 export default sidebarsClassicML;