Skip to content

[Docs] how to add a new multi stage model document #417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hsliuustc0106 merged 3 commits into from
Dec 24, 2025
+652 −1
Merged

[Docs] how to add a new multi stage model document #417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bfc81c
how to add a new multi stage model document
R2-Y Dec 23, 2025
e4d7a85
modify doc
R2-Y Dec 23, 2025
723f843
add testing reference
Dec 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.nav.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ nav:
flatten_single_child_sections: true
- Model Implementation:
- contributing/model/README.md
- contributing/model/adding_multi_stage_model.md
- CI: contributing/ci
- Tests: contributing/tests
- Design Documents:
Expand Down
20 changes: 19 additions & 1 deletion docs/contributing/model/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,20 @@
# Adding a New Model
Stay tuned for guidance on how to add a new model on vLLM-Omni!

This section provides comprehensive guidance on how to add a new model to vLLM-Omni.

## Documentation

- **[Adding a New Model Guide](adding_multi_stage_model.md)**: Complete step-by-step guide using Qwen3-Omni as an example

The guide covers:
- Directory structure and organization
- Implementing stage components (thinker, talker, code2wav)
- Creating the unified model class
- Model registration
- Stage configuration
- Stage input processors
- Testing strategies

## Quick Start

For a quick reference, see the [Adding a New Model Guide](adding_multi_stage_model.md) which walks through the complete implementation of Qwen3-Omni, a multi-stage omni-modality model.
Loading