sidebars.ts
1 import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; 2 import { apiReferencePrefix } from './docusaurusConfigUtils'; 3 4 /** 5 * Creating a sidebar enables you to: 6 - create an ordered group of docs 7 - render a sidebar for each doc of that group 8 - provide next/previous navigation 9 10 The sidebars can be generated from the filesystem, or explicitly defined here. 11 12 Create as many sidebars as you want. 13 */ 14 const sidebars: SidebarsConfig = { 15 // By default, Docusaurus generates a sidebar from the docs folder structure 16 docsSidebar: [ 17 { 18 type: 'doc', 19 id: 'index', 20 className: 'sidebar-top-level-category', 21 }, 22 { 23 type: 'doc', 24 id: 'mlflow-3/index', 25 label: 'MLflow 3.0 Migration', 26 className: 'sidebar-top-level-category', 27 }, 28 { 29 type: 'category', 30 label: 'Getting Started', 31 className: 'sidebar-top-level-category', 32 items: [ 33 { 34 type: 'doc', 35 id: 'getting-started/intro-quickstart/index', 36 label: 'Quickstart', 37 }, 38 { 39 type: 'doc', 40 id: 'introduction/index', 41 label: 'Introduction', 42 }, 43 { 44 type: 'doc', 45 id: 'getting-started/running-notebooks/index', 46 }, 47 { 48 type: 'doc', 49 id: 'getting-started/databricks-trial/index', 50 }, 51 { 52 type: 'category', 53 label: 'More Tutorials', 54 items: [ 55 { 56 type: 'doc', 57 label: 'Hyperparameter Tuning Tutorial', 58 id: 'getting-started/quickstart-2/index', 59 }, 60 { 61 type: 'category', 62 label: 'Model Registry Tutorial', 63 items: [ 64 { 65 type: 'autogenerated', 66 dirName: 'getting-started/registering-first-model', 67 }, 68 ], 69 }, 70 { 71 type: 'doc', 72 id: 'getting-started/tracking-server-overview/index', 73 }, 74 ], 75 }, 76 ], 77 link: { 78 type: 'doc', 79 id: 'getting-started/index', 80 }, 81 }, 82 { 83 type: 'category', 84 label: 'Machine Learning 🧠', 85 className: 'sidebar-top-level-category', 86 collapsed: false, 87 items: [ 88 { 89 type: 'category', 90 label: 'LLM / GenAI', 91 items: [ 92 { 93 type: 'doc', 94 label: 'Overview', 95 id: 'llms/index', 96 }, 97 { 98 type: 'category', 99 label: 'Integrations', 100 items: [ 101 { 102 type: 'category', 103 label: 'OpenAI', 104 items: [ 105 { 106 type: 'autogenerated', 107 dirName: 'llms/openai', 108 }, 109 ], 110 link: { 111 type: 'doc', 112 id: 'llms/openai/index', 113 }, 114 }, 115 { 116 type: 'category', 117 label: 'LangChain', 118 items: [ 119 { 120 type: 'autogenerated', 121 dirName: 'llms/langchain', 122 }, 123 ], 124 link: { 125 type: 'doc', 126 id: 'llms/langchain/index', 127 }, 128 }, 129 { 130 type: 'category', 131 label: 'DSPy', 132 items: [ 133 { 134 type: 'autogenerated', 135 dirName: 'llms/dspy', 136 }, 137 ], 138 link: { 139 type: 'doc', 140 id: 'llms/dspy/index', 141 }, 142 }, 143 { 144 type: 'doc', 145 id: 'llms/llama-index/index', 146 label: 'LlamaIndex', 147 }, 148 { 149 type: 'category', 150 label: 'Transformers', 151 items: [ 152 { 153 type: 'autogenerated', 154 dirName: 'llms/transformers', 155 }, 156 ], 157 link: { 158 type: 'doc', 159 id: 'llms/transformers/index', 160 }, 161 }, 162 { 163 type: 'category', 164 label: 'Sentence Transformers', 165 items: [ 166 { 167 type: 'autogenerated', 168 dirName: 'llms/sentence-transformers', 169 }, 170 ], 171 link: { 172 type: 'doc', 173 id: 'llms/sentence-transformers/index', 174 }, 175 }, 176 { 177 type: 'link', 178 href: '/tracing/integrations/', 179 label: 'More', 180 }, 181 ], 182 }, 183 { 184 type: 'link', 185 label: 'Tracing (Observability)', 186 href: '/tracing/', 187 }, 188 { 189 type: 'category', 190 label: 'Evaluation', 191 link: { 192 type: 'doc', 193 id: 'llms/llm-evaluate/index', 194 }, 195 items: [ 196 { 197 type: 'autogenerated', 198 dirName: 'llms/llm-evaluate', 199 }, 200 ], 201 }, 202 { 203 type: 'doc', 204 label: 'Production Monitoring', 205 id: 'tracing/production', 206 }, 207 { 208 type: 'category', 209 label: 'ResponsesAgent', 210 items: [ 211 { 212 type: 'doc', 213 id: 'llms/responses-agent-intro/index', 214 label: 'ResponsesAgent Introduction', 215 }, 216 ], 217 }, 218 { 219 type: 'category', 220 label: 'ChatModel', 221 items: [ 222 { 223 type: 'doc', 224 id: 'llms/chat-model-intro/index', 225 label: 'What is ChatModel?', 226 }, 227 { 228 type: 'doc', 229 id: 'llms/chat-model-guide/index', 230 label: 'Advanced Guide', 231 }, 232 { 233 type: 'doc', 234 id: 'llms/custom-pyfunc-for-llms/index', 235 label: 'More Customization', 236 }, 237 ], 238 }, 239 { 240 type: 'category', 241 label: 'RAG', 242 items: [ 243 { 244 type: 'doc', 245 id: 'llms/rag/index', 246 label: 'What is RAG?', 247 }, 248 { 249 type: 'doc', 250 id: 'llms/rag/notebooks/index', 251 }, 252 ], 253 }, 254 { 255 type: 'link', 256 label: 'Prompt Engineering', 257 href: '/prompts', 258 }, 259 ], 260 link: { 261 type: 'doc', 262 id: 'llms/index', 263 }, 264 }, 265 { 266 type: 'category', 267 label: 'Deep Learning', 268 items: [ 269 { 270 type: 'autogenerated', 271 dirName: 'deep-learning', 272 }, 273 ], 274 link: { 275 type: 'doc', 276 id: 'deep-learning/index', 277 }, 278 }, 279 { 280 type: 'category', 281 label: 'Traditional ML', 282 items: [ 283 { 284 type: 'autogenerated', 285 dirName: 'traditional-ml', 286 }, 287 ], 288 link: { 289 type: 'doc', 290 id: 'traditional-ml/index', 291 }, 292 }, 293 ], 294 }, 295 { 296 type: 'category', 297 label: 'Build 🔨 ', 298 className: 'sidebar-top-level-category', 299 collapsed: false, 300 items: [ 301 { 302 type: 'category', 303 label: 'MLflow Tracking', 304 items: [ 305 { 306 type: 'doc', 307 id: 'tracking/index', 308 }, 309 /* Using link instead of doc to avoid duplicated select state in sidebar */ 310 { 311 type: 'link', 312 href: '/getting-started/intro-quickstart/', 313 label: 'Quickstart', 314 }, 315 { 316 type: 'doc', 317 id: 'tracking/autolog/index', 318 }, 319 { 320 type: 'link', 321 label: 'Tracking Server', 322 href: '/self-hosting/architecture', 323 }, 324 { 325 type: 'category', 326 label: 'Searching Runs & Experiments', 327 items: [ 328 { 329 type: 'doc', 330 id: 'search-runs/index', 331 }, 332 { 333 type: 'doc', 334 id: 'search-experiments/index', 335 }, 336 ], 337 }, 338 { 339 type: 'doc', 340 id: 'system-metrics/index', 341 }, 342 ], 343 link: { 344 type: 'doc', 345 id: 'tracking/index', 346 }, 347 }, 348 { 349 type: 'category', 350 label: 'MLflow Model', 351 items: [ 352 { 353 type: 'autogenerated', 354 dirName: 'model', 355 }, 356 ], 357 }, 358 { 359 type: 'category', 360 label: 'MLflow Prompts 🆕', 361 items: [ 362 { 363 type: 'doc', 364 label: 'Overview', 365 id: 'prompts/index', 366 }, 367 { 368 type: 'doc', 369 id: 'prompts/cm', 370 }, 371 { 372 type: 'doc', 373 id: 'prompts/evaluate', 374 }, 375 { 376 type: 'doc', 377 id: 'prompts/run-and-model', 378 }, 379 { 380 type: 'doc', 381 id: 'prompts/optimize-prompt', 382 }, 383 { 384 type: 'doc', 385 id: 'llms/prompt-engineering/index', 386 }, 387 ], 388 }, 389 ], 390 }, 391 { 392 type: 'category', 393 label: 'Evaluate & Monitor 📊', 394 className: 'sidebar-top-level-category', 395 collapsed: false, 396 items: [ 397 { 398 type: 'doc', 399 id: 'model-evaluation/index', 400 label: 'MLflow Evaluation', 401 }, 402 { 403 type: 'category', 404 label: 'MLflow Tracing (Observability)', 405 items: [ 406 { 407 type: 'autogenerated', 408 dirName: 'tracing', 409 }, 410 ], 411 link: { 412 type: 'doc', 413 id: 'tracing/index', 414 }, 415 }, 416 { 417 type: 'doc', 418 id: 'dataset/index', 419 label: 'MLflow Dataset', 420 }, 421 ], 422 }, 423 { 424 type: 'category', 425 label: 'Deploy 🚀', 426 className: 'sidebar-top-level-category', 427 collapsed: false, 428 items: [ 429 { 430 type: 'doc', 431 id: 'model-registry/index', 432 }, 433 { 434 type: 'category', 435 label: 'MLflow Serving', 436 items: [ 437 { 438 type: 'autogenerated', 439 dirName: 'deployment', 440 }, 441 ], 442 }, 443 { 444 type: 'category', 445 label: 'MLflow AI Gateway', 446 link: { 447 type: 'doc', 448 id: 'llms/deployments/index', 449 }, 450 items: [ 451 { 452 type: 'autogenerated', 453 dirName: 'llms/deployments', 454 }, 455 ], 456 }, 457 ], 458 }, 459 { 460 type: 'category', 461 label: 'Team Collaboration 👥', 462 className: 'sidebar-top-level-category', 463 collapsed: true, 464 items: [ 465 { 466 type: 'link', 467 href: '/self-hosting', 468 label: 'Self-Hosting', 469 }, 470 { 471 type: 'link', 472 href: '/#running-mlflow-for-ml-models-anywhere', 473 label: 'Managed Services', 474 }, 475 { 476 type: 'doc', 477 id: '/self-hosting/security/basic-http-auth', 478 label: 'Access Control', 479 }, 480 { 481 type: 'doc', 482 id: 'projects/index', 483 label: 'MLflow Projects', 484 }, 485 ], 486 }, 487 { 488 type: 'category', 489 label: 'API References', 490 className: 'sidebar-top-level-category', 491 collapsed: true, 492 items: [ 493 { 494 type: 'link', 495 label: 'Python API', 496 href: `${apiReferencePrefix()}api_reference/python_api/index.html`, 497 }, 498 { 499 type: 'link', 500 label: 'Java API', 501 href: `${apiReferencePrefix()}api_reference/java_api/index.html`, 502 }, 503 { 504 type: 'link', 505 label: 'R API', 506 href: `${apiReferencePrefix()}api_reference/R-api.html`, 507 }, 508 { 509 type: 'link', 510 label: 'REST API', 511 href: `${apiReferencePrefix()}api_reference/rest-api.html`, 512 }, 513 { 514 type: 'link', 515 label: 'CLI', 516 href: `${apiReferencePrefix()}api_reference/cli.html`, 517 }, 518 ], 519 }, 520 { 521 type: 'category', 522 label: 'More', 523 collapsed: true, 524 className: 'sidebar-top-level-category', 525 items: [ 526 { 527 type: 'link', 528 label: 'Contributing', 529 href: 'https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md', 530 }, 531 { 532 type: 'link', 533 label: 'MLflow Blogs', 534 href: 'https://mlflow.org/blog/index.html', 535 }, 536 { 537 type: 'doc', 538 id: 'plugins/index', 539 }, 540 ], 541 }, 542 ], 543 }; 544 545 export default sidebars;