Skip to content

[Doc] Fix Qwen3-Omni modality documentation examples - #5173

Merged
hsliuustc0106 merged 3 commits into
vllm-project:mainfrom
psv666:fix/qwen3-omni-modalities-docs
Jul 18, 2026
Merged

hsliuustc0106 merged 3 commits into
vllm-project:mainfrom
psv666:fix/qwen3-omni-modalities-docs

Conversation

@psv666

@psv666 psv666 commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Fix incorrect modality descriptions and examples in the Qwen3-Omni online serving documentation.

Purpose

The Qwen3-Omni online serving docs contained several inaccuracies in the output-modality section that would mislead users into getting unexpected (or empty) responses:

  1. Modality table mislabeled ["audio"] as "Text + Audio" — ["audio"] actually produces audio-only output. "Text + Audio" requires explicitly passing ["text", "audio"]. Corrected the table row.

  2. The "Text + Audio" curl/Python examples used modalities=["audio"] — contradicting the section title. When ["text", "audio"] is requested the server returns two choices (index 0 = text, index 1 = audio), but the examples only decoded a single choice and used the wrong index. Updated the examples to pass ["text", "audio"], capture the full response, and extract text from choices[0] and audio from choices[1] (base64-decoded into output.wav).

  3. The speaker (audio-only) Python example referenced choices[1] — audio-only responses contain a single choice, so the correct index is choices[0].

These fixes apply consistently to both docs/user_guide/examples/online_serving/qwen3_omni.md and examples/online_serving/qwen3_omni/README.md.

Test Plan

  • Reviewed the rendered markdown diff for both files; both files make the same changes in the same sections.
  • Verified the modality table now matches the actual server behavior: ["text"] → text only, ["audio"] → audio only, ["text","audio"] → text + audio.
  • Verified the curl/Python snippets reference the correct choices indices for each modality combination.
  • (Optional) Manual end-to-end verification: start the server with Qwen/Qwen3-Omni-30B-A3B-Instruct, run the corrected ["text","audio"] curl example, confirm two choices are returned and output.wav plays audio.

vLLM Version: 0.24.0

vLLM-Omni Commit: 7aa5c9a

Test Result

Documentation-only change; no runtime code modified. Verified by diff inspection that both copies of the example are consistent and the described choices indices match the server's actual response layout.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

@hsliuustc0106 hsliuustc0106 added the documentation Improvements or additions to documentation label Jul 18, 2026
@amy-why-3459

Copy link
Copy Markdown
Collaborator

Thanks, LGTM.

@amy-why-3459 amy-why-3459 added the ready label to trigger buildkite CI label Jul 18, 2026
@hsliuustc0106
hsliuustc0106 merged commit e9991a5 into vllm-project:main Jul 18, 2026
7 checks passed
@psv666
psv666 deleted the fix/qwen3-omni-modalities-docs branch July 20, 2026 08:26
y-null pushed a commit to y-null/vllm-omni that referenced this pull request Jul 21, 2026
Signed-off-by: psv666 <2693925048@qq.com>
Co-authored-by: amy-why-3459 <wuhaiyan17@huawei.com>
Signed-off-by: y_null <y_null@qq.com>
bowieshi pushed a commit to bowieshi/vllm-omni that referenced this pull request Jul 22, 2026
Signed-off-by: psv666 <2693925048@qq.com>
Co-authored-by: amy-why-3459 <wuhaiyan17@huawei.com>
nagisa-kunhah pushed a commit to nagisa-kunhah/vllm-omni that referenced this pull request Jul 30, 2026
Signed-off-by: psv666 <2693925048@qq.com>
Co-authored-by: amy-why-3459 <wuhaiyan17@huawei.com>
khairulkabir1661 pushed a commit to khairulkabir1661/vllm-omni that referenced this pull request Sep 25, 2026
Signed-off-by: psv666 <2693925048@qq.com>
Co-authored-by: amy-why-3459 <wuhaiyan17@huawei.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready label to trigger buildkite CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants