-
Notifications
You must be signed in to change notification settings - Fork 96
[Docs] Add basic usage examples for diffusion #222
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
Conversation
Signed-off-by: samithuang <[email protected]>
docs/getting_started/quickstart.md
Outdated
| ## Offline Inference | ||
|
|
||
| Please refer to [offline inference](../user_guide/examples/offline_inference/qwen2_5_omni.md) | ||
| Text-to-image generation quickstart with vllm-omni: |
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 in the quickstart, we may need to provide two examples:
- Qwen-Image example: Text-to-image generation quickstart with vllm-omni
- Qwen3-Omni example: Omni-modality understanding and generation quickstart with vllm-omni
we need to make it better for users to undestand the usage of our API at the first glance.
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.
Agreed. Maybe this PR can be merged first. Then I will supplement a example for Qwen3-Omni in both offline and online. Besides, an online example for image generation is also needed.
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.
agreed. thanks for helping supplement
Co-authored-by: Hongsheng Liu <[email protected]> Signed-off-by: Samit <[email protected]>
Gaohan123
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.
LGTM, thanks!
PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS (AT THE BOTTOM) HAVE BEEN CONSIDERED.
Purpose
Provide a simpler example with less arguments to run image generatin with vllm-omni
Test Plan
run the basic usage code in the docs
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)