[diffusion] docs: consolidate diffusion documentation into docs#18095
[diffusion] docs: consolidate diffusion documentation into docs#18095hnyls2002 merged 12 commits intosgl-project:mainfrom
Conversation
Summary of ChangesHello @qianyue76, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly refactors the SGLang-Diffusion documentation by centralizing all related content into a dedicated Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request is a significant and well-executed refactoring that consolidates all SGLang-Diffusion documentation into a new, unified docs/diffusion/ directory. This greatly improves the organization and maintainability of the documentation. The changes include creating new documentation files, updating the main index to reflect the new structure, and thoughtfully adding redirection notices to old file locations for backward compatibility. My review focuses on ensuring the new documentation is clear, consistent, and that all links are correct. I've identified a few minor areas for improvement regarding link targets, formatting, and phrasing to enhance clarity.
|
@qianyue76 Nice down. Could we leave dLLM part unchange? Since dLLM is in SGLang main endpoint, but diffusion is totally different. |
|
|
||
| ## Diffusion LLM | ||
|
|
||
| For detailed documentation on diffusion language models (LLaDA), see [SGLang Diffusion Language Models](../diffusion/language_models/index.md). |
There was a problem hiding this comment.
Do not change dLLM related docs.
There was a problem hiding this comment.
I mean, please put dLLM near LLMs, do not put it under diffusion
| "A complete reference for the API is available in the [OpenAI API Reference](https://platform.openai.com/docs/guides/embeddings).\n", | ||
| "\n", | ||
| "This tutorial covers the embedding APIs for embedding models. For a list of the supported models see the [corresponding overview page](../supported_models/embedding_models.md)\n" | ||
| "This tutorial covers the embedding APIs for embedding models. For a list of the supported models see the [corresponding overview page](../supported_models/retrieval_ranking/embedding_models.md)" |
There was a problem hiding this comment.
Nice change to add a middle layer after /supported_models. Please make sure that all the links in our docs that refer to the /supported_models have been clearly changed.
There was a problem hiding this comment.
Thanks! I've checked the links and they seem to be correctly pointing to the new subdirectory structure.
|
|
||
| ## Diffusion LLM | ||
|
|
||
| For detailed documentation on diffusion language models (LLaDA), see [SGLang Diffusion Language Models](../diffusion/language_models/index.md). |
There was a problem hiding this comment.
I mean, please put dLLM near LLMs, do not put it under diffusion
docs/diffusion/api/openai_api.md
Outdated
| -H "Authorization: Bearer sk-proj-1234567890" | ||
| ``` | ||
|
|
||
| #### Download video content |
There was a problem hiding this comment.
In the long run, do not use any level 4 title. Just use ###. >=4 level please use ****.
docs/diffusion/contributing.md
Outdated
|
|
||
| This guide outlines the requirements for contributing to the SGLang Diffusion module (`sglang.multimodal_gen`). | ||
|
|
||
| ## 1. Commit Message Convention |
There was a problem hiding this comment.
If you already use title, then do not add a number in it. Just use:
## Commit Message Convention
…sion/ Closes sgl-project#18089 This commit consolidates all SGLang-Diffusion documentation from: - docs/supported_models/diffusion_models.md - docs/supported_models/diffusion_language_models.md - python/sglang/multimodal_gen/docs/ Into a new unified directory: - docs/diffusion/ Changes: - Create docs/diffusion/ with subdirectories for cache/ and language_models/ - Add new "SGLang Diffusion" section to docs/index.rst - Remove diffusion entries from "Supported Models" section - Add redirect notices to internal docs for backward compatibility - Update python/sglang/multimodal_gen/README.md links to point to new locations
- Create api/ directory for CLI and OpenAI API documentation - Create performance/ directory for optimization docs (caching, profiling, attention) - Merge installation_rocm.md into installation.md - Add performance/index.md overview page - Update all cross-references and internal redirects - Remove duplicate environment variables table from cache_dit.md - Add LLaDA cross-reference in server_arguments.md
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Incorporate non-diffusion changes from PR sgl-project#17888: - Reorganize docs/supported_models/ into categorized subdirectories: - extending/ - model extension docs - retrieval_ranking/ - embedding/rerank/classify models - specialized/ - reward models - text_generation/ - generative/multimodal models - Add new model support documentation: - Falcon H1, Hunyuan-Large to generative_models.md - Step3-VL, Qwen3-Omni to multimodal_language_models.md - Reformat support_new_models.md with improved structure - Update index files and references throughout docs - Keep diffusion docs in docs/diffusion/ with short redirect in text_generation/diffusion_language_models.md
0cb7c51 to
bae5657
Compare
- Remove dLLM link from server_arguments.md (keep dLLM near LLMs, not under diffusion) - Move dLLM documentation back to supported_models/text_generation/ - Remove numbered headings in contributing.md (use plain text headings) - Convert #### headings to bold text in diffusion docs (openai_api.md, cli.md, attention_backends.md, cache_dit.md)
|
As I mentioned, we shall merge:
Thanks so much for helping. |
|
@qianyue76 since #17888 is merged, and I think we can skip #18154. Could we start to finish this PR right now? |
|
zhaochenyang20
left a comment
There was a problem hiding this comment.
Basically, moved the docs. LGTM
eff453a to
bae5657
Compare
.. toctree::
:maxdepth: 1
:caption: SGLang Diffusion
xxxxxxxxxxxxxxxx |
…ion directories Docs have been consolidated into docs/diffusion/. Remove the old multimodal_gen/docs/ and supported_models/image_generation/ directories and update references in basic_usage/diffusion.md accordingly.
zhaochenyang20
left a comment
There was a problem hiding this comment.
Just move the files. Correct to me.
Update links to point to new docs/diffusion/ structure after consolidation. References: - PR #18095: sgl-project/sglang#18095 - Issue #18652: sgl-project/sglang#18652 Changes: - Updated multimodal_gen/docs/* links to docs.sglang.io/diffusion/* - Updated support_matrix.md -> compatibility_matrix.html - Updated install.md -> installation.html - Updated cli.md -> api/cli.html - Updated profiling.md -> performance/profiling.html Co-authored-by: Cursor <cursoragent@cursor.com>
…project#18095) Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: JiaxinD <djx2048@gmail.com>
…project#18095) Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: JiaxinD <djx2048@gmail.com>
…project#18095) Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: JiaxinD <djx2048@gmail.com>
#18089
Overview
Consolidate scattered SGLang-Diffusion documentation into a unified
docs/diffusion/directory with improved organization.Before
Documentation was scattered across multiple locations:
docs/supported_models/diffusion_models.md(1279 lines)docs/supported_models/diffusion_language_models.mdpython/sglang/multimodal_gen/docs/(14+ files including cli.md, openai_api.md, cache/, etc.)After
Key Changes
docs/diffusion/api/for interfaces,performance/for optimizationinstallation_rocm.mdintoinstallation.mdcache_dit.mdperformance/index.mdoverview pageFiles Changed
performance/index.md)installation_rocm.md)Motivation
Modifications
Accuracy Tests
Benchmarking and Profiling
Checklist
Review Process
/tag-run-ci-label,/rerun-failed-ci,/tag-and-rerun-ci