-
Notifications
You must be signed in to change notification settings - Fork 188
[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.
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Rein Yang <[email protected]>
SamitHuang
left a comment
There was a problem hiding this 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
- How to add a Omni-modality model, e.g., qwen-omni, bagel,
- How to add a Diffusion-only model, e.g. qwen-image, where the model implementation is mainly composed by diffusion pipeline
|
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` |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay
|
@hsliuustc0106 please review |
Signed-off-by: root <[email protected]>
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
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)