Skip to content

Conversation

@R2-Y
Copy link
Contributor

@R2-Y R2-Y commented Dec 23, 2025

PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS (AT THE BOTTOM) HAVE BEEN CONSIDERED.

Purpose

add a document to explain how to add a new multi stage model

Test Plan

Test Result


Essential Elements of an Effective PR Description Checklist
  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.
  • (Optional) Release notes update. If your change is user facing, please update the release notes draft.

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)

Copy link
Collaborator

@SamitHuang SamitHuang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think we should make at least two sub-docs, like

  1. How to add a Omni-modality model, e.g., qwen-omni, bagel,
  2. How to add a Diffusion-only model, e.g. qwen-image, where the model implementation is mainly composed by diffusion pipeline

@congw729
Copy link
Contributor

For the CI-DOCS failed, please build the doc locally and remove all errors/warnings. Even a warning will lead to a failed case.

Local Documentation Build

pip install -e ".[docs]"
mkdocs build
mkdocs serve

Signed-off-by: Rein Yang <[email protected]>
- **Code2Wav**: `vllm_omni/model_executor/models/qwen3_omni/qwen3_omni_code2wav.py`
- **Stage config**: `vllm_omni/model_executor/stage_configs/qwen3_omni_moe.yaml`
- **Input processors**: `vllm_omni/model_executor/stage_input_processors/qwen3_omni.py`
- **Registry**: `vllm_omni/model_executor/models/registry.py`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider also adding a reference file for qwen3-omni offline testing?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay

@R2-Y
Copy link
Contributor Author

R2-Y commented Dec 23, 2025

@hsliuustc0106 please review

@hsliuustc0106 hsliuustc0106 added the ready label to trigger buildkite CI label Dec 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready label to trigger buildkite CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants