[Doc] Adding models/pipelines/features Tutorial#1196
[Doc] Adding models/pipelines/features Tutorial#1196wtomin wants to merge 43 commits intovllm-project:mainfrom
Conversation
|
This is a much-needed tutorial. Excited to see this land. |
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive tutorial documentation for adapting HuggingFace models/pipelines to vLLM-Omni and supporting various advanced features including parallelism strategies and cache acceleration.
Changes:
- Reorganized parallelism documentation by moving detailed SP/CFG-Parallel content from
parallelism_acceleration.mdto dedicated feature-specific guides - Completely rewrote
adding_diffusion_model.mdwith step-by-step instructions, examples, and troubleshooting - Added five new feature tutorial documents covering tensor parallel, CFG parallel, sequence parallel, TeaCache, and Cache-DiT
- Updated navigation structure to include new "Advanced Features" section
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
docs/user_guide/diffusion/parallelism_acceleration.md |
Removed detailed implementation guides (moved to dedicated feature docs) |
docs/contributing/model/adding_diffusion_model.md |
Complete rewrite with comprehensive step-by-step guide for adding diffusion models |
docs/contributing/features/tensor_parallel.md |
New guide for adding Tensor Parallel support to transformers |
docs/contributing/features/teacache.md |
New guide for adding TeaCache acceleration support |
docs/contributing/features/sequence_parallel.md |
New guide for adding Sequence Parallel support (moved from parallelism_acceleration.md) |
docs/contributing/features/cfg_parallel.md |
New guide for adding CFG-Parallel support to pipelines (moved from parallelism_acceleration.md) |
docs/contributing/features/cache_dit.md |
New guide for adding Cache-DiT acceleration support |
docs/.nav.yml |
Added "Advanced Features" navigation section with links to new feature guides |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| --- | ||
|
|
||
| ### Step 4: Add Example Script |
There was a problem hiding this comment.
Add example and documentation? executable Python examples are at examples/(offline or online)/(task and modality)/*.{py|sh}, and documentations are at examples/(offline or online)/(task and modality)/*.md and docs/user_guide/examples/(offline or online)/*.md
There was a problem hiding this comment.
This is different from the supported_models and ...acceleration markdowns you have added below.
|
@dongbo910220 Comments are welcomed! I think you maybe interested in sp document. |
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
|
@hadipash Hello, I think you have worked on Tensor Parallel support for diffusion models. Can you give your comments? |
|
@mxuax @ZJY0516 @SamitHuang Please leave your comments or suggested changes. Thank you very much! |
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Co-authored-by: dongbo910220 <32610838+dongbo910220@users.noreply.github.com> Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
Signed-off-by: Didan Deng <33117903+wtomin@users.noreply.github.com>
|
LGTM. Very clear docs 👍 |

Comments are welcomed! Suggested changes are welcomed!
Purpose
It is important to have clear, easy-to-follow, tutorials on how to adapt huggingface models/pipelines to vLLM-Omni, and support various features:
The
HowToAddtutorial should at least cover the following content:Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.BEFORE SUBMITTING, PLEASE READ https://github.com/vllm-project/vllm-omni/blob/main/CONTRIBUTING.md (anything written below this line will be removed by GitHub Actions)