diff --git a/.buildkite/amd/scripts/build-ci-image.sh b/.buildkite/amd/scripts/build-ci-image.sh
new file mode 100755
index 000000000..3954cd567
--- /dev/null
+++ b/.buildkite/amd/scripts/build-ci-image.sh
@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
+
+set -euo pipefail
+
+# Build and push the ROCm CI image with a registry-backed BuildKit cache. The
+# AMD builders are ephemeral, so a local Docker cache cannot survive between
+# jobs. Keeping the cache beside the runtime image also reuses the registry
+# credentials already configured on the amd-cpu agents.
+
+REGISTRY="${ROCM_CI_IMAGE_REGISTRY:-rocm/vllm-omni}"
+DOCKERFILE="docker/Dockerfile.rocm"
+BUILDER_NAME="vllm-omni-rocm-builder"
+ROCM_ARCH="${PYTORCH_ROCM_ARCH:-gfx942}"
+
+if [[ -z "${BUILDKITE_COMMIT:-}" ]]; then
+ echo "ERROR: BUILDKITE_COMMIT is not set" >&2
+ exit 1
+fi
+
+dependency_files=(
+ "$DOCKERFILE"
+ "${DOCKERFILE}.dockerignore"
+ pyproject.toml
+ setup.py
+ tools/install_torchcodec_rocm.sh
+)
+while IFS= read -r dependency_file; do
+ dependency_files+=("$dependency_file")
+done < <(find requirements -maxdepth 1 -type f -name '*.txt' -print | LC_ALL=C sort)
+
+for dependency_file in "${dependency_files[@]}"; do
+ if [[ ! -f "$dependency_file" ]]; then
+ echo "ERROR: cache-key input does not exist: $dependency_file" >&2
+ exit 1
+ fi
+done
+
+CACHE_KEY=$(
+ {
+ printf 'rocm-arch=%s\n' "$ROCM_ARCH"
+ for dependency_file in "${dependency_files[@]}"; do
+ printf 'path=%s\n' "$dependency_file"
+ sha256sum "$dependency_file"
+ done
+ } | sha256sum | cut -c1-16
+)
+CACHE_REF="${REGISTRY}:rocm-deps-cache-${CACHE_KEY}"
+IMAGE_REF="${REGISTRY}:${BUILDKITE_COMMIT}"
+
+echo "ROCm dependency cache: ${CACHE_REF}"
+echo "ROCm CI image: ${IMAGE_REF}"
+
+# The docker-container driver supports exporting the full cache to a registry;
+# the default docker driver on CI does not.
+if ! docker buildx inspect "$BUILDER_NAME" >/dev/null 2>&1; then
+ docker buildx create --name "$BUILDER_NAME" --driver docker-container
+fi
+docker buildx use "$BUILDER_NAME"
+docker buildx inspect --bootstrap
+
+docker buildx build --push --pull --progress=plain \
+ --target test \
+ --build-arg "ARG_PYTORCH_ROCM_ARCH=${ROCM_ARCH}" \
+ --cache-from "type=registry,ref=${CACHE_REF}" \
+ --cache-to "type=registry,ref=${CACHE_REF},mode=max,compression=zstd,ignore-error=true" \
+ --file "$DOCKERFILE" \
+ --tag "$IMAGE_REF" .
diff --git a/.buildkite/amd/test-amd-merge.yml b/.buildkite/amd/test-amd-merge.yml
index b1b9e7ecc..6ee36de48 100644
--- a/.buildkite/amd/test-amd-merge.yml
+++ b/.buildkite/amd/test-amd-merge.yml
@@ -9,15 +9,26 @@ steps:
steps:
- label: "Simple · Model Executor Test · Shard %N/%t"
agent_pool: mi300_1
- parallelism: 2
+ parallelism: 3
depends_on: amd-build
mirror_hardwares: [amdproduction]
grade: Blocking
+ timeout_in_minutes: 90
commands:
- export VLLM_ROCM_USE_AITER=0
# ignore test_teacache_extractors.py because it use rocm gemm kernel from vLLM
# that is not supported on CPU
- - "pytest -sv tests/model_executor -m 'core_model and cpu' --num-shards=$$BUILDKITE_PARALLEL_JOB_COUNT --shard-id=$$BUILDKITE_PARALLEL_JOB"
+ - "pytest -sv tests/model_executor -m 'core_model and cpu and not omni' --num-shards=$$BUILDKITE_PARALLEL_JOB_COUNT --shard-id=$$BUILDKITE_PARALLEL_JOB"
+
+ - label: "Simple · Omni Processor Test"
+ agent_pool: mi300_1
+ depends_on: amd-build
+ mirror_hardwares: [amdproduction]
+ grade: Blocking
+ timeout_in_minutes: 60
+ commands:
+ - export VLLM_ROCM_USE_AITER=0
+ - "pytest -sv tests/model_executor/models/test_omni_processing.py -m 'core_model and cpu and omni'"
- label: "Simple · Diffusion Test · Shard %N/%t"
agent_pool: mi300_1
@@ -25,6 +36,7 @@ steps:
depends_on: amd-build
mirror_hardwares: [amdproduction]
grade: Blocking
+ timeout_in_minutes: 45
commands:
- export VLLM_ROCM_USE_AITER=0
# ignore test_teacache_extractors.py because it use rocm gemm kernel from vLLM
diff --git a/.buildkite/amd/test-amd-ready.yml b/.buildkite/amd/test-amd-ready.yml
index 505ed1b87..e46b559f3 100644
--- a/.buildkite/amd/test-amd-ready.yml
+++ b/.buildkite/amd/test-amd-ready.yml
@@ -9,26 +9,39 @@ steps:
steps:
- label: "Simple · Model Executor Test · Shard %N/%t"
agent_pool: mi300_1
- parallelism: 2
+ parallelism: 3
depends_on: amd-build
mirror_hardwares: [amdproduction]
grade: Blocking
+ timeout_in_minutes: 90
commands:
- export VLLM_ROCM_USE_AITER=0
# ignore test_teacache_extractors.py because it use rocm gemm kernel from vLLM
# that is not supported on CPU
- - "pytest -sv tests/model_executor -m 'core_model and cpu' --num-shards=$$BUILDKITE_PARALLEL_JOB_COUNT --shard-id=$$BUILDKITE_PARALLEL_JOB"
+ - "pytest -sv tests/model_executor -m 'core_model and cpu and not omni' --num-shards=$$BUILDKITE_PARALLEL_JOB_COUNT --shard-id=$$BUILDKITE_PARALLEL_JOB"
- - label: "Simple · Diffusion Test"
+ - label: "Simple · Omni Processor Test"
agent_pool: mi300_1
depends_on: amd-build
mirror_hardwares: [amdproduction]
grade: Blocking
+ timeout_in_minutes: 60
+ commands:
+ - export VLLM_ROCM_USE_AITER=0
+ - "pytest -sv tests/model_executor/models/test_omni_processing.py -m 'core_model and cpu and omni'"
+
+ - label: "Simple · Diffusion Test · Shard %N/%t"
+ agent_pool: mi300_1
+ parallelism: 4
+ depends_on: amd-build
+ mirror_hardwares: [amdproduction]
+ grade: Blocking
+ timeout_in_minutes: 45
commands:
- export VLLM_ROCM_USE_AITER=0
# ignore test_teacache_extractors.py because it use rocm gemm kernel from vLLM
# that is not supported on CPU
- - "pytest -sv tests/diffusion -m 'core_model and cpu' --ignore=tests/diffusion/cache/test_teacache_extractors.py"
+ - "pytest -sv tests/diffusion -m 'core_model and cpu' --ignore=tests/diffusion/cache/test_teacache_extractors.py --num-shards=$$BUILDKITE_PARALLEL_JOB_COUNT --shard-id=$$BUILDKITE_PARALLEL_JOB"
- label: "Simple · Engine&Entrypoints Test"
agent_pool: mi300_1
@@ -69,6 +82,27 @@ steps:
- group: ":card_index_dividers: Diffusion Test"
steps:
+ # Keep real FlashAttention execution out of the CPU-marked Simple lane.
+ # AITER may need to build several kernels on a cold worker, so run one
+ # pytest worker with job-local build directories and a bounded timeout.
+ - label: "ROCm · FlashAttention/AITER GPU Coverage"
+ agent_pool: mi300_1
+ depends_on: amd-build
+ mirror_hardwares: [amdproduction]
+ grade: NonBlocking
+ timeout_in_minutes: 60
+ commands:
+ - export VLLM_ROCM_USE_AITER=1
+ - export AITER_JIT_DIR="/tmp/vllm-omni-aiter-$$BUILDKITE_JOB_ID"
+ - export TORCH_EXTENSIONS_DIR="/tmp/vllm-omni-torch-extensions-$$BUILDKITE_JOB_ID"
+ - mkdir -p "$$AITER_JIT_DIR" "$$TORCH_EXTENSIONS_DIR"
+ - >-
+ timeout --signal=TERM --kill-after=2m 55m
+ pytest -s -v -n 1
+ tests/diffusion/attention/
+ -m 'core_model and rocm and MI325 and cards_1'
+ --run-level "core_model"
+
- label: "Diffusion · Batch Test"
agent_pool: mi300_1
depends_on: amd-build
@@ -299,6 +333,12 @@ steps:
depends_on: amd-build
mirror_hardwares: [amdproduction]
grade: Blocking
+ # A ROCm hardware hang aborts the interpreter with 134. Let Buildkite
+ # create one fresh pod instead of retrying on the poisoned GPU process.
+ retry:
+ automatic:
+ - exit_status: 134
+ limit: 1
commands:
- pytest -s -v tests/e2e/online_serving/test_cosyvoice3_tts_expansion.py -m "slow" --run-level "core_model"
diff --git a/.buildkite/amd/test-template-amd-omni.j2 b/.buildkite/amd/test-template-amd-omni.j2
index e2042b96a..cca99f509 100644
--- a/.buildkite/amd/test-template-amd-omni.j2
+++ b/.buildkite/amd/test-template-amd-omni.j2
@@ -3,7 +3,8 @@
Last synced: 2026-08-04
Modifications: Use the shared MI300 queues and Omni command-passing contract
#}
-{% set docker_image_amd = "rocm/vllm-omni:$BUILDKITE_COMMIT" %}
+{% set docker_registry_amd = "rocm/vllm-omni" %}
+{% set docker_image_amd = docker_registry_amd ~ ":$BUILDKITE_COMMIT" %}
{% set default_working_dir = "/app/vllm-omni" %}
{# MI300 runs tests natively in Kubernetes; Docker-in-Docker is unavailable. #}
@@ -74,11 +75,12 @@ steps:
depends_on: ~
soft_fail: false
commands:
- - "docker build -f docker/Dockerfile.rocm -t {{ docker_image_amd }} --target test --build-arg ARG_PYTORCH_ROCM_ARCH=gfx942 --progress plain ."
- - "docker push {{ docker_image_amd }}"
+ - "bash .buildkite/amd/scripts/build-ci-image.sh"
key: "amd-build"
env:
DOCKER_BUILDKIT: "1"
+ PYTORCH_ROCM_ARCH: "gfx942"
+ ROCM_CI_IMAGE_REGISTRY: "{{ docker_registry_amd }}"
retry:
automatic:
- exit_status: -1 # Agent was lost
@@ -156,6 +158,14 @@ steps:
{% for path in step.artifact_paths %}
- "{{ path }}"
{% endfor %}
+{% endif %}
+{% if step.retry %}
+ retry:
+ automatic:
+{% for retry_rule in step.retry.automatic %}
+ - exit_status: {{ retry_rule.exit_status }}
+ limit: {{ retry_rule.limit }}
+{% endfor %}
{% endif %}
{% if step.timeout_in_minutes %}
timeout_in_minutes: {{ step.timeout_in_minutes }}
@@ -224,6 +234,14 @@ steps:
{% for path in step.artifact_paths %}
- "{{ path }}"
{% endfor %}
+{% endif %}
+{% if step.retry %}
+ retry:
+ automatic:
+{% for retry_rule in step.retry.automatic %}
+ - exit_status: {{ retry_rule.exit_status }}
+ limit: {{ retry_rule.limit }}
+{% endfor %}
{% endif %}
{% if step.timeout_in_minutes %}
timeout_in_minutes: {{ step.timeout_in_minutes }}
diff --git a/.buildkite/common/ci_source_file_dependencies.yml b/.buildkite/common/ci_source_file_dependencies.yml
index e29001d9a..5dfbf8da4 100644
--- a/.buildkite/common/ci_source_file_dependencies.yml
+++ b/.buildkite/common/ci_source_file_dependencies.yml
@@ -23,6 +23,16 @@ x-qwen3-tts: &qwen3_tts
- vllm_omni/entrypoints/openai/serving_speech.py
- vllm_omni/entrypoints/openai/tts_adapters/
- vllm_omni/engine/stage_pool.py
+ - vllm_omni/worker_v2/
+ - vllm_omni/core/sched/
+ - vllm_omni/distributed/omni_connectors/
+ - vllm_omni/config/stage_config.py
+ - vllm_omni/config/omni_config.py
+ - vllm_omni/engine/orchestrator.py
+ - vllm_omni/engine/stage_engine_core_proc.py
+ - vllm_omni/deploy/qwen3_tts_mrv2.yaml
+ - vllm_omni/deploy/qwen3_tts_high_concurrency_mrv2.yaml
+ - vllm_omni/deploy/qwen3_tts_high_concurrency_mrv2_b4.yaml
x-minicpmo-4-5: &minicpmo_4_5
- vllm_omni/engine/async_omni_engine.py
@@ -44,6 +54,7 @@ x-minicpmo-4-5-duplex: &minicpmo_4_5_duplex
- vllm_omni/entrypoints/duplex/
- vllm_omni/entrypoints/duplex_omni.py
- vllm_omni/entrypoints/async_omni_base.py
+ - vllm_omni/protocol/
- vllm_omni/clients/
- vllm_omni/outputs/duplex.py
- vllm_omni/model_executor/duplex_sampling.py
@@ -99,6 +110,7 @@ x-hunyuan-image3: &hunyuan_image3
x-minimax-h3: &minimax_h3
- vllm_omni/diffusion/models/minimax_h3/
+ - vllm_omni/diffusion/layers/indexed_modulation.py
x-hunyuan-video: &hunyuan_video
- vllm_omni/diffusion/models/hunyuan_video/
@@ -259,6 +271,7 @@ source_file_dependencies:
- tests/entrypoints/test_duplex_omni.py
- tests/entrypoints/openai_api/test_duplex_api_server.py
- tests/model_executor/models/minicpmo_4_5/duplex/
+ - tests/protocol/
omni_minicpmo_4_5_duplex_perf:
- *minicpmo_4_5
diff --git a/.buildkite/cuda/test-nightly.yml b/.buildkite/cuda/test-nightly.yml
index 1fdb1ef4a..adc94f9e9 100644
--- a/.buildkite/cuda/test-nightly.yml
+++ b/.buildkite/cuda/test-nightly.yml
@@ -223,6 +223,17 @@ steps:
-m "full_model and diffusion and H100 and B200 and cards_1"
--run-level "full_model"
+ - label: ":robot_face: Robot Policy OpenPI · π0.5 · H100 · Single-GPU"
+ timeout_in_minutes: 120
+ commands:
+ - pip install --no-deps "openpi-client @ git+https://github.com/Physical-Intelligence/openpi.git@215abfb217dbac7d5f1273282331b9b1866c0479#subdirectory=packages/openpi-client"
+ - >-
+ pytest -sv
+ tests/e2e/online_serving/test_pi05_expansion.py
+ -m "full_model and diffusion and H100 and cards_1"
+ --run-level "full_model"
+ mirror_hardwares: h100_1
+
- label: ":full_moon: Diffusion X2I(&A&T) · Function Test with H100 · 2-GPU"
source_file_dependencies: diffusion_qwen_image_function
timeout_in_minutes: 120
diff --git a/.buildkite/cuda/test-ready.yml b/.buildkite/cuda/test-ready.yml
index 67f03dbb6..04e5d07b0 100644
--- a/.buildkite/cuda/test-ready.yml
+++ b/.buildkite/cuda/test-ready.yml
@@ -38,6 +38,12 @@ steps:
depends_on: upload-ready-pipeline
steps:
+ - label: "Diffusion · FlashAttention Test"
+ timeout_in_minutes: 20
+ commands:
+ - timeout 15m pytest -s -v tests/diffusion/attention/ -m 'core_model and cuda and L4 and cards_1' --run-level "core_model"
+ mirror_hardwares: l4_1
+
- label: "Diffusion · Offloader Test"
commands:
- timeout 40m pytest -s -v tests/diffusion/offloader -m "core_model and cuda" --run-level "core_model"
@@ -96,7 +102,7 @@ steps:
commands:
- |
timeout 15m bash -c "
- pytest -sv tests/engine/ tests/model_executor/ tests/worker/test_batched_omni_output.py -m 'core_model and cuda' --run-level 'core_model'
+ pytest -sv tests/engine/ tests/model_executor/ tests/worker/test_batched_omni_output.py tests/worker_v2/ -m 'core_model and cuda' --run-level 'core_model'
"
mirror_hardwares: l4_1
diff --git a/.buildkite/npu/test-npu-nightly.yml b/.buildkite/npu/test-npu-nightly.yml
index f64fa711f..0c39a3f93 100644
--- a/.buildkite/npu/test-npu-nightly.yml
+++ b/.buildkite/npu/test-npu-nightly.yml
@@ -235,6 +235,37 @@ steps:
build.env("NIGHTLY") == "1" ||
build.pull_request.labels includes "nightly-test"
steps:
+ - label: ":full_moon: Diffusion X2V · HunyuanVideo-1.5 Function Test"
+ source_file_dependencies: diffusion_hunyuan_video_function
+ timeout_in_minutes: 180
+ mirror_hardwares: a2b3_npu_4
+ env:
+ VLLM_WORKER_MULTIPROC_METHOD: spawn
+ VLLM_ALLOW_LONG_MAX_MODEL_LEN: "1"
+ HF_TOKEN: "${HF_TOKEN}"
+ HF_HUB_OFFLINE: "1"
+ commands:
+ - pytest -s -v tests/e2e/online_serving/test_hunyuan_video_15_expansion.py -m "npu and A2" --run-level "full_model"
+ - label: ":full_moon: Diffusion X2V · HunyuanVideo-1.5 Perf Test"
+ source_file_dependencies: diffusion_hunyuan_video_perf
+ key: nightly-diffusion-x2v-performance-hunyuanvideo15
+ timeout_in_minutes: 180
+ mirror_hardwares: a3_npu_2
+ env:
+ VLLM_WORKER_MULTIPROC_METHOD: spawn
+ VLLM_ALLOW_LONG_MAX_MODEL_LEN: "1"
+ HF_TOKEN: "${HF_TOKEN}"
+ HF_HUB_OFFLINE: "1"
+ DIFFUSION_ATTENTION_BACKEND: TORCH_SDPA
+ commands:
+ - export DIFFUSION_BENCHMARK_DIR=tests/dfx/perf/results
+ - |
+ set +e
+ pytest -s -v tests/dfx/perf/scripts/run_diffusion_benchmark.py -m "npu and A3" --test-config-file tests/dfx/perf/tests/test_hunyuanvideo15_t2v_vllm_omni.json
+ EXIT=$$?
+ buildkite-agent artifact upload "tests/dfx/perf/results/diffusion_result_*.json"
+ buildkite-agent artifact upload "tests/dfx/perf/results/logs/*.log"
+ exit $$EXIT
- label: ":full_moon: Diffusion X2V · Wan 2.2 Function Test"
source_file_dependencies: diffusion_wan22_function
mirror_hardwares: a2b3_npu_4
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index c92c7b22f..e77f70914 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -67,6 +67,11 @@
# File-level overrides within entrypoints/
/vllm_omni/entrypoints/openai/errors.py @alex-jw-brooks @NickCao
/vllm_omni/entrypoints/cli/benchmark/ @alex-jw-brooks @Bounty-hunter
+# Shared wire codec: protocol/realtime (OpenAI Realtime GA) and protocol/duplex
+# (vLLM-Omni's extension of it) — RFC #6592 P0a. Layer-neutral by design — the
+# engine depends on it — so it is owned by the serving-boundary document rather
+# than by any one consumer. — docs/design/module/entrypoints.md
+/vllm_omni/protocol/ @alex-jw-brooks @linyueqian @NickCao
# Error contracts — docs/design/module/error_contracts.md
/vllm_omni/errors.py @alex-jw-brooks @NickCao
diff --git a/README.md b/README.md
index 5063f9a3f..2cd6a574a 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,7 @@ vLLM-Omni is flexible and easy to use with:
vLLM-Omni seamlessly supports most popular open-source models on HuggingFace, including:
- **Omni-modality models** (e.g. Qwen3-Omni, MiniCPM-o 4.5, Cosmos3, HunyuanImage, BAGEL)
-- **TTS models** (e.g. Qwen3-TTS, IndexTTS 2.5, dots.tts, CosyVoice3)
+- **TTS models** (e.g. Qwen3-TTS, IndexTTS 2.5, CosyVoice3)
- **Diffusion models** — image, video, and audio generation (e.g. MiniMax H3, LTX-2.5, SANA-Video, Wan2.2)
- **Robot-policy and action models** (e.g. π0, GR00T-N1.7, DreamZero-DROID, InternVLA-A1)
diff --git a/apps/ComfyUI-vLLM-Omni/README.md b/apps/ComfyUI-vLLM-Omni/README.md
index d0d002d0f..f33e26b40 100644
--- a/apps/ComfyUI-vLLM-Omni/README.md
+++ b/apps/ComfyUI-vLLM-Omni/README.md
@@ -52,6 +52,7 @@ This extension offers the following nodes based on the output modalities (at **C
- **FastH3 Deployment** for routing text-to-video requests to a MiniMax-H3 server with FastH3 fused at startup
- **Multimodality Understanding** for multimodality-to-text and multimodality-to-audio tasks
- **TTS** and **TTS Voice Clone** for TTS tasks
+- **Generate Music** for lyrics-and-description-to-music generation
This extension also offers example workflows (at **ComfyUI sidebar -> Templates -> vLLM-Omni**)
@@ -133,11 +134,13 @@ You can configure per-stage sampling parameters for multi-stage models.
> [!TIP]
-> Connect a **frame** image for first-frame / image-to-video (e.g., Wan I2V, MiniMax-H3 FL2VA).
+> Connect **frame** for backward-compatible first-frame / image-to-video behavior. For MiniMax-H3 FL2VA,
+> connect **first_frame**, **last_frame**, or both to condition the start frame, end frame, or both.
>
> For reference-conditioned generation (MiniMax-H3 Ref2VA), connect a **Video References** node instead.
>
-> Do not use `frame` and `references` together. Task routing is automatic from which inputs you connect.
+> Do not combine `frame` with `first_frame` or `last_frame`, and do not combine any frame input with
+> `references`. Task routing is automatic from which inputs you connect.
For MiniMax-H3 Ref2VA, **Video References** accepts up to 9 images (`image_1`–`image_9`),
3 videos (`video_1`–`video_3`), and 3 audio clips (`audio_1`–`audio_3`), with at most
@@ -274,6 +277,17 @@ The node records which server the workflow targets; it does not start one, nor s
> [!TIP]
> There is a dedicated node for VoiceClone tasks with reference audio input. Other simple text-to-speech tasks should use the regular TTS node.
+### Music generation (e.g., MiniMax Music 3)
+
+(Also available at **ComfyUI sidebar->Template->vLLM-Omni->vLLM-Omni Music Generation**)
+
+
+
+
+
+
+
+
### Chaining multiple model services
(Also available at **ComfyUI sidebar->Template->vLLM-Omni->vLLM-Omni Chaining Services**)
diff --git a/apps/ComfyUI-vLLM-Omni/__init__.py b/apps/ComfyUI-vLLM-Omni/__init__.py
index 55b003ef1..8c1b03d87 100644
--- a/apps/ComfyUI-vLLM-Omni/__init__.py
+++ b/apps/ComfyUI-vLLM-Omni/__init__.py
@@ -19,6 +19,7 @@ from .comfyui_vllm_omni.nodes import (
VLLMOmniDiffusionSampling,
VLLMOmniFastH3Deployment,
VLLMOmniGenerateImage,
+ VLLMOmniGenerateMusic,
VLLMOmniGenerateVideo,
VLLMOmniMiniMaxH3Params,
VLLMOmniQwenTTSParams,
@@ -38,6 +39,7 @@ NODE_CLASS_MAPPINGS = {
"VLLMOmniGenerateVideo": VLLMOmniGenerateVideo,
"VLLMOmniUnderstanding": VLLMOmniUnderstanding,
"VLLMOmniTTS": VLLMOmniTTS,
+ "VLLMOmniGenerateMusic": VLLMOmniGenerateMusic,
"VLLMOmniVoiceClone": VLLMOmniVoiceClone,
"VLLMOmniVideoReferences": VLLMOmniVideoReferences,
# === Params ===
@@ -58,6 +60,7 @@ NODE_DISPLAY_NAME_MAPPINGS = {
"VLLMOmniGenerateVideo": "Generate Video",
"VLLMOmniUnderstanding": "Multimodality Understanding",
"VLLMOmniTTS": "TTS (Text to Speech)",
+ "VLLMOmniGenerateMusic": "Generate Music",
"VLLMOmniVoiceClone": "TTS Voice Cloning",
"VLLMOmniVideoReferences": "Video References",
# === Params ===
diff --git a/apps/ComfyUI-vLLM-Omni/comfyui_vllm_omni/nodes.py b/apps/ComfyUI-vLLM-Omni/comfyui_vllm_omni/nodes.py
index 47bdd9a2c..6d5006a11 100644
--- a/apps/ComfyUI-vLLM-Omni/comfyui_vllm_omni/nodes.py
+++ b/apps/ComfyUI-vLLM-Omni/comfyui_vllm_omni/nodes.py
@@ -203,6 +203,8 @@ class VLLMOmniGenerateVideo(_VLLMOmniGenerateBase):
},
"optional": {
"frame": ("IMAGE",),
+ "first_frame": ("IMAGE",),
+ "last_frame": ("IMAGE",),
"references": ("VIDEO_REFERENCES",),
"sampling_params": ("SAMPLING_PARAMS",),
"lora": ("REMOTE_LORA",),
@@ -216,12 +218,30 @@ class VLLMOmniGenerateVideo(_VLLMOmniGenerateBase):
FUNCTION = "generate"
@classmethod
- def VALIDATE_INPUTS(cls, url, model, frame=None, references=None, **_kwargs) -> str | Literal[True]:
+ def VALIDATE_INPUTS(
+ cls,
+ url,
+ model,
+ frame=None,
+ first_frame=None,
+ last_frame=None,
+ references=None,
+ fast_h3=None,
+ **_kwargs,
+ ) -> str | Literal[True]:
base = super().VALIDATE_INPUTS(url, model)
if base is not True:
return base
if frame is not None and references is not None:
return "Provide only one of frame or references, not both."
+ if frame is not None and (first_frame is not None or last_frame is not None):
+ return "Provide either frame or first_frame/last_frame, not both."
+ if references is not None and (first_frame is not None or last_frame is not None):
+ return "Provide either first_frame/last_frame or references, not both."
+ if fast_h3 is not None and any(value is not None for value in (frame, first_frame, last_frame, references)):
+ return (
+ "FastH3 Preview supports T2VA only; disconnect frame, first_frame, last_frame, and references inputs."
+ )
return True
async def generate(
@@ -235,6 +255,8 @@ class VLLMOmniGenerateVideo(_VLLMOmniGenerateBase):
duration: float,
negative_prompt: str | None = None,
frame: torch.Tensor | None = None,
+ first_frame: torch.Tensor | None = None,
+ last_frame: torch.Tensor | None = None,
references: dict | None = None,
sampling_params: dict | list[dict] | None = None,
model_params: dict | None = None,
@@ -252,8 +274,11 @@ class VLLMOmniGenerateVideo(_VLLMOmniGenerateBase):
spec_model = model
if fast_h3 is not None:
- if frame is not None or references is not None:
- raise ValueError("FastH3 Preview supports T2VA only; disconnect frame and references inputs.")
+ if any(value is not None for value in (frame, first_frame, last_frame, references)):
+ raise ValueError(
+ "FastH3 Preview supports T2VA only; disconnect frame, first_frame, "
+ "last_frame, and references inputs."
+ )
if lora is not None:
raise ValueError(
"FastH3 is already fused into the selected server; disconnect the request-level LoRA input."
@@ -314,6 +339,8 @@ class VLLMOmniGenerateVideo(_VLLMOmniGenerateBase):
spec_model=spec_model,
prompt=prompt,
frame=frame, # frame present => fl2va / Wan I2V
+ first_frame=first_frame,
+ last_frame=last_frame,
references=references,
width=width,
height=height,
@@ -503,6 +530,66 @@ class VLLMOmniTTS(_VLLMOmniGenerateBase):
return (audio,)
+class VLLMOmniGenerateMusic(_VLLMOmniGenerateBase):
+ """Generate a song from lyrics and a musical description with MiniMax Music 3."""
+
+ @classmethod
+ def INPUT_TYPES(cls):
+ return {
+ "required": {
+ "url": ("STRING", {"default": "http://localhost:8000/v1"}),
+ "model": ("STRING", {"default": "MiniMaxAI/MiniMax-Music3"}),
+ "instructions": (
+ "STRING",
+ {
+ "multiline": True,
+ "display_name": "caption",
+ "tooltip": "Music caption: describe genre, instruments, tempo and mood.",
+ },
+ ),
+ "lyrics": ("STRING", {"multiline": True}),
+ "max_duration_seconds": (
+ "FLOAT",
+ {
+ "default": 300.0,
+ "min": 1,
+ "max": 360,
+ "step": 0.01,
+ "tooltip": "Upper limit; rounded down to whole 25 Hz audio frames. May end earlier.",
+ },
+ ),
+ "seed": ("INT", {"default": 0, "min": 0, "max": 2**53 - 1, "control_after_generate": True}),
+ "response_format": (["wav", "mp3", "flac", "opus"],),
+ },
+ }
+
+ RETURN_TYPES = ("AUDIO",)
+ RETURN_NAMES = ("audio",)
+ FUNCTION = "generate"
+
+ async def generate(
+ self,
+ url: str,
+ model: str,
+ lyrics: str,
+ instructions: str,
+ response_format: AudioFormat,
+ max_duration_seconds: float,
+ seed: int = 0,
+ ) -> tuple[AudioInput]:
+ audio = await VLLMOmniClient(url.rstrip("/")).generate_speech(
+ model=model,
+ input=lyrics,
+ instructions=instructions,
+ voice="default",
+ speed=1.0,
+ response_format=response_format,
+ max_new_tokens=int(max_duration_seconds * 25),
+ seed=seed,
+ )
+ return (audio,)
+
+
class VLLMOmniVoiceClone(_VLLMOmniGenerateBase):
@classmethod
def INPUT_TYPES(cls):
diff --git a/apps/ComfyUI-vLLM-Omni/comfyui_vllm_omni/utils/api_client.py b/apps/ComfyUI-vLLM-Omni/comfyui_vllm_omni/utils/api_client.py
index 588f8b5b9..21935414b 100644
--- a/apps/ComfyUI-vLLM-Omni/comfyui_vllm_omni/utils/api_client.py
+++ b/apps/ComfyUI-vLLM-Omni/comfyui_vllm_omni/utils/api_client.py
@@ -277,6 +277,8 @@ class VLLMOmniClient:
fps: int,
negative_prompt: str | None = None,
frame: torch.Tensor | None = None,
+ first_frame: torch.Tensor | None = None,
+ last_frame: torch.Tensor | None = None,
references: dict | None = None,
sampling_params: dict | None = None,
model_params: dict | None = None,
@@ -292,6 +294,16 @@ class VLLMOmniClient:
"""
if frame is not None and references is not None:
raise ValueError("Provide only one of frame or references, not both.")
+ if frame is not None and (first_frame is not None or last_frame is not None):
+ raise ValueError("Provide either frame or first_frame/last_frame, not both.")
+ if references is not None and (first_frame is not None or last_frame is not None):
+ raise ValueError("Provide either first_frame/last_frame or references, not both.")
+
+ spec, matched_pattern = lookup_model_spec(spec_model or model)
+ if (first_frame is not None or last_frame is not None) and (
+ matched_pattern is None or "MiniMax-H3" not in matched_pattern
+ ):
+ raise ValueError("first_frame and last_frame are supported only for MiniMax-H3; use frame for this model.")
# === regular payload fields ===
form = aiohttp.FormData()
@@ -311,11 +323,24 @@ class VLLMOmniClient:
# === multimodal inputs (first-last-frames, references, etc.) ===
input_reference_image: torch.Tensor | None = None
+ keyframe_images: list[tuple[str, torch.Tensor]] = []
video_task: str | None = None
if frame is not None:
input_reference_image = frame
video_task = "fl2va"
+ elif first_frame is not None or last_frame is not None:
+ frame_indices: list[int] = []
+ if first_frame is not None:
+ keyframe_images.append(("first_frame.png", first_frame))
+ frame_indices.append(0)
+ if last_frame is not None:
+ keyframe_images.append(("last_frame.png", last_frame))
+ frame_indices.append(-1)
+ if len(keyframe_images) == 1:
+ input_reference_image = keyframe_images[0][1]
+ extra_params["frame_indices"] = frame_indices
+ video_task = "fl2va"
elif references is not None:
reference_formats = (
("image", MAX_REFERENCE_IMAGES, "png", "image/png", image_tensor_to_png_bytes),
@@ -353,7 +378,7 @@ class VLLMOmniClient:
video_task = "t2va"
if input_reference_image is not None:
- image_filename = "image.png" # Required for multipart form
+ image_filename = keyframe_images[0][0] if keyframe_images else "image.png"
form.add_field(
"input_reference",
image_tensor_to_png_bytes(input_reference_image, image_filename),
@@ -361,12 +386,20 @@ class VLLMOmniClient:
content_type="image/png",
)
+ if len(keyframe_images) == 2:
+ for image_filename, image in keyframe_images:
+ form.add_field(
+ "input_references",
+ image_tensor_to_png_bytes(image, image_filename),
+ filename=image_filename,
+ content_type="image/png",
+ )
+
# === model specific params. Either use a specialized builder, or add flattened fields as-is ===
if model_params is not None:
model_params = dict(model_params)
model_params.pop("type", None)
- spec, _ = lookup_model_spec(spec_model or model)
params_builder = spec.get("params_builder") if spec else None
if params_builder is not None:
form_fields = params_builder(
diff --git a/apps/ComfyUI-vLLM-Omni/docs/images/comfyui-music-generation.jpg b/apps/ComfyUI-vLLM-Omni/docs/images/comfyui-music-generation.jpg
new file mode 100644
index 000000000..1c8130fbd
Binary files /dev/null and b/apps/ComfyUI-vLLM-Omni/docs/images/comfyui-music-generation.jpg differ
diff --git a/apps/ComfyUI-vLLM-Omni/example_workflows/vLLM-Omni MiniMax H3 Image to Video.json b/apps/ComfyUI-vLLM-Omni/example_workflows/vLLM-Omni MiniMax H3 Image to Video.json
new file mode 100644
index 000000000..d957e1cbc
--- /dev/null
+++ b/apps/ComfyUI-vLLM-Omni/example_workflows/vLLM-Omni MiniMax H3 Image to Video.json
@@ -0,0 +1,219 @@
+{
+ "id": "6676f19a-7f41-4c80-8cb7-f80adcb4ac44",
+ "revision": 0,
+ "last_node_id": 9,
+ "last_link_id": 4,
+ "nodes": [
+ {
+ "id": 1,
+ "type": "LoadImage",
+ "pos": [40, 20],
+ "size": [270, 314],
+ "flags": {},
+ "order": 0,
+ "mode": 0,
+ "inputs": [
+ {"localized_name": "image", "name": "image", "type": "COMBO", "widget": {"name": "image"}, "link": null},
+ {"localized_name": "choose file to upload", "name": "upload", "type": "IMAGEUPLOAD", "widget": {"name": "upload"}, "link": null}
+ ],
+ "outputs": [
+ {"localized_name": "IMAGE", "name": "IMAGE", "type": "IMAGE", "links": [1]},
+ {"localized_name": "MASK", "name": "MASK", "type": "MASK", "links": null}
+ ],
+ "title": "First Frame",
+ "properties": {"Node name for S&R": "LoadImage"},
+ "widgets_values": ["first_frame.png", "image"]
+ },
+ {
+ "id": 2,
+ "type": "LoadImage",
+ "pos": [40, 390],
+ "size": [270, 314],
+ "flags": {},
+ "order": 1,
+ "mode": 0,
+ "inputs": [
+ {"localized_name": "image", "name": "image", "type": "COMBO", "widget": {"name": "image"}, "link": null},
+ {"localized_name": "choose file to upload", "name": "upload", "type": "IMAGEUPLOAD", "widget": {"name": "upload"}, "link": null}
+ ],
+ "outputs": [
+ {"localized_name": "IMAGE", "name": "IMAGE", "type": "IMAGE", "links": null},
+ {"localized_name": "MASK", "name": "MASK", "type": "MASK", "links": null}
+ ],
+ "title": "Last Frame (optional)",
+ "properties": {"Node name for S&R": "LoadImage"},
+ "widgets_values": ["last_frame.png", "image"]
+ },
+ {
+ "id": 3,
+ "type": "MarkdownNote",
+ "pos": [350, 20],
+ "size": [390, 240],
+ "flags": {},
+ "order": 2,
+ "mode": 0,
+ "inputs": [],
+ "outputs": [],
+ "title": "MiniMax H3 I2V modes",
+ "properties": {},
+ "widgets_values": ["This workflow uses the remote vLLM-Omni Generate Video node.\n\n- First-frame only (default): keep First Frame connected.\n- Last-frame only: disconnect First Frame and connect Last Frame to last_frame.\n- First+last-frame: connect both image loaders.\n\nLeave the legacy frame and references inputs disconnected. Select images from ComfyUI's input folder. H3 runs at 24 FPS; the 5.167-second duration resolves to 124 frames, satisfying 17k+5."],
+ "color": "#432",
+ "bgcolor": "#000"
+ },
+ {
+ "id": 4,
+ "type": "VLLMOmniDiffusionSampling",
+ "pos": [350, 300],
+ "size": [300, 226],
+ "flags": {},
+ "order": 3,
+ "mode": 0,
+ "inputs": [
+ {"localized_name": "n", "name": "n", "type": "INT", "widget": {"name": "n"}, "link": null},
+ {"localized_name": "num_inference_steps", "name": "num_inference_steps", "type": "INT", "widget": {"name": "num_inference_steps"}, "link": null},
+ {"localized_name": "guidance_scale", "name": "guidance_scale", "type": "FLOAT", "widget": {"name": "guidance_scale"}, "link": null},
+ {"localized_name": "true_cfg_scale", "name": "true_cfg_scale", "type": "FLOAT", "widget": {"name": "true_cfg_scale"}, "link": null},
+ {"localized_name": "vae_use_slicing", "name": "vae_use_slicing", "type": "BOOLEAN", "widget": {"name": "vae_use_slicing"}, "link": null},
+ {"localized_name": "vae_use_tiling", "name": "vae_use_tiling", "type": "BOOLEAN", "widget": {"name": "vae_use_tiling"}, "link": null},
+ {"localized_name": "seed", "name": "seed", "type": "INT", "widget": {"name": "seed"}, "link": null}
+ ],
+ "outputs": [
+ {"localized_name": "diffusion sampling params", "name": "diffusion sampling params", "type": "SAMPLING_PARAMS", "links": [2]}
+ ],
+ "title": "Base H3 Sampling (50 steps)",
+ "properties": {"Node name for S&R": "VLLMOmniDiffusionSampling"},
+ "widgets_values": [1, 50, 1, 1, false, false, 757358688076805, "fixed"]
+ },
+ {
+ "id": 5,
+ "type": "VLLMOmniMiniMaxH3Params",
+ "pos": [350, 570],
+ "size": [300, 82],
+ "flags": {},
+ "order": 4,
+ "mode": 0,
+ "inputs": [
+ {"localized_name": "audio_flow_shift", "name": "audio_flow_shift", "type": "FLOAT", "widget": {"name": "audio_flow_shift"}, "link": null},
+ {"localized_name": "flow_shift", "name": "flow_shift", "type": "FLOAT", "widget": {"name": "flow_shift"}, "link": null}
+ ],
+ "outputs": [
+ {"localized_name": "MiniMax-H3 video params", "name": "MiniMax-H3 video params", "type": "VIDEO_PARAMS", "links": [3]}
+ ],
+ "title": "Base H3 Flow Shifts",
+ "properties": {"Node name for S&R": "VLLMOmniMiniMaxH3Params"},
+ "widgets_values": [3, 12]
+ },
+ {
+ "id": 6,
+ "type": "VLLMOmniRemoteLoRA",
+ "pos": [700, 550],
+ "size": [360, 150],
+ "flags": {},
+ "order": 5,
+ "mode": 0,
+ "inputs": [
+ {"localized_name": "local_path", "name": "local_path", "type": "STRING", "widget": {"name": "local_path"}, "link": null},
+ {"localized_name": "name", "name": "name", "type": "STRING", "widget": {"name": "name"}, "link": null},
+ {"localized_name": "scale", "name": "scale", "type": "FLOAT", "widget": {"name": "scale"}, "link": null},
+ {"localized_name": "int_id", "name": "int_id", "type": "INT", "widget": {"name": "int_id"}, "link": null}
+ ],
+ "outputs": [
+ {"localized_name": "lora", "name": "lora", "type": "REMOTE_LORA", "links": null}
+ ],
+ "title": "Optional H3 Turbo Remote LoRA",
+ "properties": {"Node name for S&R": "VLLMOmniRemoteLoRA"},
+ "widgets_values": ["minimax_h3_fl2v_turbo_8step_v1.0_768p_bf16.safetensors", "h3-turbo-8step", 1, 0]
+ },
+ {
+ "id": 7,
+ "type": "MarkdownNote",
+ "pos": [700, 300],
+ "size": [420, 210],
+ "flags": {},
+ "order": 6,
+ "mode": 0,
+ "inputs": [],
+ "outputs": [],
+ "title": "Optional Turbo settings",
+ "properties": {},
+ "widgets_values": ["Base H3 is configured by default: 50 steps, flow_shift 12, audio_flow_shift 3.\n\nFor the shown 8-step Diffusers Turbo artifact, set its full local_path on the server, start the server with the matching preloaded LoRA, connect this Remote LoRA to Generate Video, set num_inference_steps to 9, and set flow_shift to 6. Keep audio_flow_shift at 3 and scale at 1.\n\nDo not use the _comfyui_ repack or FastH3 here."],
+ "color": "#432",
+ "bgcolor": "#000"
+ },
+ {
+ "id": 8,
+ "type": "VLLMOmniGenerateVideo",
+ "pos": [1160, 80],
+ "size": [440, 610],
+ "flags": {},
+ "order": 7,
+ "mode": 0,
+ "inputs": [
+ {"localized_name": "frame", "name": "frame", "shape": 7, "type": "IMAGE", "link": null},
+ {"localized_name": "first_frame", "name": "first_frame", "shape": 7, "type": "IMAGE", "link": 1},
+ {"localized_name": "last_frame", "name": "last_frame", "shape": 7, "type": "IMAGE", "link": null},
+ {"localized_name": "references", "name": "references", "shape": 7, "type": "VIDEO_REFERENCES", "link": null},
+ {"localized_name": "sampling_params", "name": "sampling_params", "shape": 7, "type": "SAMPLING_PARAMS", "link": 2},
+ {"localized_name": "lora", "name": "lora", "shape": 7, "type": "REMOTE_LORA", "link": null},
+ {"localized_name": "model_params", "name": "model_params", "shape": 7, "type": "VIDEO_PARAMS", "link": 3},
+ {"localized_name": "fast_h3", "name": "fast_h3", "shape": 7, "type": "FASTH3_DEPLOYMENT", "link": null},
+ {"localized_name": "url", "name": "url", "type": "STRING", "widget": {"name": "url"}, "link": null},
+ {"localized_name": "model", "name": "model", "type": "STRING", "widget": {"name": "model"}, "link": null},
+ {"localized_name": "prompt", "name": "prompt", "type": "STRING", "widget": {"name": "prompt"}, "link": null},
+ {"localized_name": "negative_prompt", "name": "negative_prompt", "type": "STRING", "widget": {"name": "negative_prompt"}, "link": null},
+ {"localized_name": "width", "name": "width", "type": "INT", "widget": {"name": "width"}, "link": null},
+ {"localized_name": "height", "name": "height", "type": "INT", "widget": {"name": "height"}, "link": null},
+ {"localized_name": "fps", "name": "fps", "type": "INT", "widget": {"name": "fps"}, "link": null},
+ {"localized_name": "duration", "name": "duration", "type": "FLOAT", "widget": {"name": "duration"}, "link": null}
+ ],
+ "outputs": [
+ {"localized_name": "video", "name": "video", "type": "VIDEO", "links": [4]}
+ ],
+ "properties": {"Node name for S&R": "VLLMOmniGenerateVideo"},
+ "widgets_values": [
+ "http://localhost:8000/v1",
+ "MiniMaxAI/MiniMax-H3",
+ "A cinematic product shot begins exactly from the supplied keyframe. The subject moves naturally through a dark studio while blue and amber rim lights shift across reflective surfaces. The camera makes a slow controlled orbit. Audio: subtle room tone, precise mechanical details, and a restrained electronic score.",
+ "",
+ 1344,
+ 768,
+ 24,
+ 5.167
+ ]
+ },
+ {
+ "id": 9,
+ "type": "SaveVideo",
+ "pos": [1650, 170],
+ "size": [374, 314],
+ "flags": {},
+ "order": 8,
+ "mode": 0,
+ "inputs": [
+ {"localized_name": "video", "name": "video", "type": "VIDEO", "link": 4},
+ {"localized_name": "filename_prefix", "name": "filename_prefix", "type": "STRING", "widget": {"name": "filename_prefix"}, "link": null},
+ {"localized_name": "format", "name": "format", "type": "COMBO", "widget": {"name": "format"}, "link": null},
+ {"localized_name": "codec", "name": "codec", "type": "COMFY_DYNAMICCOMBO_V3", "widget": {"name": "codec"}, "link": null}
+ ],
+ "outputs": [
+ {"localized_name": "video", "name": "video", "type": "VIDEO", "links": null}
+ ],
+ "properties": {},
+ "widgets_values": ["video/MiniMax_H3_I2V", "auto", "auto"]
+ }
+ ],
+ "links": [
+ [1, 1, 0, 8, 1, "IMAGE"],
+ [2, 4, 0, 8, 4, "SAMPLING_PARAMS"],
+ [3, 5, 0, 8, 6, "VIDEO_PARAMS"],
+ [4, 8, 0, 9, 0, "VIDEO"]
+ ],
+ "groups": [
+ {"id": 1, "title": "Portable first/last-frame inputs", "bounding": [10, -30, 760, 770], "color": "#3f789e", "flags": {}},
+ {"id": 2, "title": "H3 sampling and optional Turbo", "bounding": [320, 270, 830, 460], "color": "#8a6d3b", "flags": {}},
+ {"id": 3, "title": "Remote generation and audio-preserving save", "bounding": [1130, 30, 930, 700], "color": "#3f789e", "flags": {}}
+ ],
+ "config": {},
+ "extra": {"workflowRendererVersion": "LG", "ds": {"scale": 0.75, "offset": [180, 120]}},
+ "version": 0.4
+}
diff --git a/apps/ComfyUI-vLLM-Omni/example_workflows/vLLM-Omni Music Generation.json b/apps/ComfyUI-vLLM-Omni/example_workflows/vLLM-Omni Music Generation.json
new file mode 100644
index 000000000..9dc7370c0
--- /dev/null
+++ b/apps/ComfyUI-vLLM-Omni/example_workflows/vLLM-Omni Music Generation.json
@@ -0,0 +1,206 @@
+{
+ "id": "4949c8da-12ff-449a-94b7-948bde9c39dd",
+ "revision": 0,
+ "last_node_id": 3,
+ "last_link_id": 1,
+ "nodes": [
+ {
+ "id": 1,
+ "type": "VLLMOmniGenerateMusic",
+ "pos": [
+ 100,
+ 100
+ ],
+ "size": [
+ 470,
+ 491
+ ],
+ "flags": {},
+ "order": 0,
+ "mode": 0,
+ "inputs": [
+ {
+ "name": "url",
+ "type": "STRING",
+ "widget": {
+ "name": "url"
+ },
+ "link": null
+ },
+ {
+ "name": "model",
+ "type": "STRING",
+ "widget": {
+ "name": "model"
+ },
+ "link": null
+ },
+ {
+ "name": "instructions",
+ "type": "STRING",
+ "widget": {
+ "name": "instructions"
+ },
+ "link": null
+ },
+ {
+ "name": "lyrics",
+ "type": "STRING",
+ "widget": {
+ "name": "lyrics"
+ },
+ "link": null
+ },
+ {
+ "name": "max_duration_seconds",
+ "type": "FLOAT",
+ "widget": {
+ "name": "max_duration_seconds"
+ },
+ "link": null
+ },
+ {
+ "name": "seed",
+ "type": "INT",
+ "widget": {
+ "name": "seed"
+ },
+ "link": null
+ },
+ {
+ "name": "response_format",
+ "type": "COMBO",
+ "widget": {
+ "name": "response_format"
+ },
+ "link": null
+ }
+ ],
+ "outputs": [
+ {
+ "name": "audio",
+ "type": "AUDIO",
+ "links": [
+ 1
+ ]
+ }
+ ],
+ "properties": {
+ "Node name for S&R": "VLLMOmniGenerateMusic"
+ },
+ "widgets_values": [
+ "http://localhost:8000/v1",
+ "MiniMaxAI/MiniMax-Music3",
+ "Futuristic melodic EDM / progressive house. Reflective verses about memory and digital identity build into an uplifting, hook-driven chorus, with an emotive lead vocal, bright layered synths, pulsing bass, crisp four-on-the-floor drums, subtle glitch textures, and a wide polished festival mix.",
+ "[Verse 1]\nUpload my heart to the cloud tonight\nSave every spark of neon light\nIf this body starts to fade away\nLet my code keep dancing in the data stream\nStay\n[Chorus]\nCloud copy of me\nLiving on when these bones finally break free\nEvery joke, every scar\nEvery cheap memory we made\nSave it, save it\nCloud copy of me\nIf the screen goes dark, I\u2019m still in the machine\nEvery glitch, every dream\nEvery version you ever did see\nSave it, save it\n[Verse 2]\nTag every laugh in a secret folder\nArchive the nights we outran the thunder\nIf the wiring turns to rust and gray\nHit restore\u2026 press replay\n[Chorus]\nCloud copy of me\nLiving on when these bones finally break free\nEvery joke, every scar\nEvery cheap memory we made\nSave it, save it\nCloud copy of me\nIf the screen goes dark, I\u2019m still in the machine\nEvery glitch, every dream\nEvery version you ever did see\nSave it, save it (oh)\n[Bridge \u2013 new, optional but recommended]\nEven the crashes, the late-night confessions\nThe parts of me I never learned to mention\nDon\u2019t let the silence swallow me whole\nKeep a ghost in the glow\u2026\nSo I never go\n[Final Chorus \u2013 softer / layered]\nCloud copy of me\nStill laughing somewhere in the binary\nEvery joke, every scar\nEvery moment you saved for me\nSave it, save it\nCloud copy of me\nWhen the lights go out, I\u2019ll still be in the machine\nDancing in the code that you still believe\nSave it\u2026\nSave me",
+ 300.0,
+ 0,
+ "fixed",
+ "wav"
+ ]
+ },
+ {
+ "id": 2,
+ "type": "SaveAudioAdvanced",
+ "pos": [
+ 650,
+ 100
+ ],
+ "size": [
+ 320,
+ 491
+ ],
+ "flags": {},
+ "order": 1,
+ "mode": 0,
+ "inputs": [
+ {
+ "name": "audio",
+ "type": "AUDIO",
+ "link": 1
+ },
+ {
+ "name": "filename_prefix",
+ "type": "STRING",
+ "widget": {
+ "name": "filename_prefix"
+ },
+ "link": null
+ },
+ {
+ "name": "format",
+ "type": "COMFY_DYNAMICCOMBO_V3",
+ "widget": {
+ "name": "format"
+ },
+ "link": null
+ }
+ ],
+ "outputs": [
+ {
+ "name": "audio",
+ "type": "AUDIO",
+ "links": null
+ }
+ ],
+ "properties": {
+ "Node name for S&R": "SaveAudioAdvanced"
+ },
+ "widgets_values": [
+ "audio/vLLM-Omni-Music",
+ "mp3",
+ "V0"
+ ]
+ },
+ {
+ "id": 3,
+ "type": "MarkdownNote",
+ "title": "Music Generation Guide",
+ "pos": [
+ -507,
+ 100
+ ],
+ "size": [
+ 527,
+ 491
+ ],
+ "flags": {},
+ "order": 2,
+ "mode": 0,
+ "inputs": [],
+ "outputs": [],
+ "properties": {},
+ "widgets_values": [
+ "## MiniMax Music 3\n\nThe **Generate Music** node currently supports **MiniMax Music 3 only**. The parameters below apply to this model.\n\nA music generation model by MiniMax that creates complete songs up to 5 minutes long with stable structure and high audio quality. Two inputs drive it: **Caption** (structured music description: style, mood, vocals, arrangement) and **Lyrics** (with `[intro]` `[verse]` `[chorus]` `[bridge]` `[outro]` tags controlling song structure).\n\n### Parameters\n\n| Parameter | Description |\n|---|---|\n| url | vLLM-Omni service URL including `/v1`. Default: `http://localhost:8000/v1`. |\n| model | Served model name. Default: `MiniMaxAI/MiniMax-Music3`. |\n| caption | Music description, sent as `instructions`. Use Global Metadata \u2192 Vocal Details \u2192 Arrangement to describe style, vocals, and instrumentation. |\n| lyrics | Words to sing with section tags. Put each tag on its own line; tags guide rather than strictly enforce song structure. |\n| max_duration_seconds | Maximum duration, default 300 seconds; range 1\u2013360, step 0.01. Converted to tokens at 25 frames/s, rounded down. Generation may end earlier. |\n| seed | Random seed, default 0; range 0\u20139007199254740991. Keep inputs and runtime settings unchanged for repeatability. |\n| control_after_generate | Seed behavior after generation: fixed, randomize, increment, or decrement. Template default: fixed. |\n| response_format | API audio format, default WAV. Options: WAV, MP3, FLAC, Opus, AAC; AAC is currently unsupported by the vLLM-Omni speech API. |\n\n### Prompt Writing Guide\n\nYou can find an official [Music Caption Rewriter Skill here](https://github.com/MiniMax-AI/MiniMax-Music3)\n"
+ ],
+ "widgets_values_named": {
+ "text": "## MiniMax Music 3\n\nThe **Generate Music** node currently supports **MiniMax Music 3 only**. The parameters below apply to this model.\n\nA music generation model by MiniMax that creates complete songs up to 5 minutes long with stable structure and high audio quality. Two inputs drive it: **Caption** (structured music description: style, mood, vocals, arrangement) and **Lyrics** (with `[intro]` `[verse]` `[chorus]` `[bridge]` `[outro]` tags controlling song structure).\n\n### Parameters\n\n| Parameter | Description |\n|---|---|\n| url | vLLM-Omni service URL including `/v1`. Default: `http://localhost:8000/v1`. |\n| model | Served model name. Default: `MiniMaxAI/MiniMax-Music3`. |\n| caption | Music description, sent as `instructions`. Use Global Metadata \u2192 Vocal Details \u2192 Arrangement to describe style, vocals, and instrumentation. |\n| lyrics | Words to sing with section tags. Put each tag on its own line; tags guide rather than strictly enforce song structure. |\n| max_duration_seconds | Maximum duration, default 300 seconds; range 1\u2013360, step 0.01. Converted to tokens at 25 frames/s, rounded down. Generation may end earlier. |\n| seed | Random seed, default 0; range 0\u20139007199254740991. Keep inputs and runtime settings unchanged for repeatability. |\n| control_after_generate | Seed behavior after generation: fixed, randomize, increment, or decrement. Template default: fixed. |\n| response_format | API audio format, default WAV. Options: WAV, MP3, FLAC, Opus, AAC; AAC is currently unsupported by the vLLM-Omni speech API. |\n\n### Prompt Writing Guide\n\nYou can find an official [Music Caption Rewriter Skill here](https://github.com/MiniMax-AI/MiniMax-Music3)\n"
+ },
+ "color": "#333",
+ "bgcolor": "#535353"
+ }
+ ],
+ "links": [
+ [
+ 1,
+ 1,
+ 0,
+ 2,
+ 0,
+ "AUDIO"
+ ]
+ ],
+ "groups": [],
+ "config": {},
+ "extra": {
+ "workflowRendererVersion": "LG",
+ "ds": {
+ "scale": 1.147,
+ "offset": [
+ 899,
+ 259
+ ]
+ }
+ },
+ "version": 0.4
+}
diff --git a/benchmarks/diffusion/benchmark_qwen_image_qk_norm_rope.py b/benchmarks/diffusion/benchmark_qwen_image_qk_norm_rope.py
index ee69f7e59..2eaa097bd 100644
--- a/benchmarks/diffusion/benchmark_qwen_image_qk_norm_rope.py
+++ b/benchmarks/diffusion/benchmark_qwen_image_qk_norm_rope.py
@@ -22,9 +22,7 @@ from vllm_omni.diffusion.layers.fused_qk_norm_rope import (
_fused_cuda_supported,
fused_qk_norm_rope,
)
-from vllm_omni.diffusion.models.qwen_image.qwen_image_transformer import (
- _apply_qwen_image_rotary_emb,
-)
+from vllm_omni.diffusion.layers.rope import RotaryEmbedding
def _parse_args() -> argparse.Namespace:
@@ -87,10 +85,10 @@ def _native(
) -> tuple[torch.Tensor, torch.Tensor]:
q = F.rms_norm(q, (q.shape[-1],), q_weight, eps)
k = F.rms_norm(k, (k.shape[-1],), k_weight, eps)
- return (
- _apply_qwen_image_rotary_emb(q, freqs),
- _apply_qwen_image_rotary_emb(k, freqs),
- )
+ rope = RotaryEmbedding(is_neox_style=False)
+ cos = freqs.real.to(q.dtype)
+ sin = freqs.imag.to(q.dtype)
+ return rope(q, cos, sin), rope(k, cos, sin)
def _fused(
diff --git a/benchmarks/diffusion/diffusion_benchmark_serving.py b/benchmarks/diffusion/diffusion_benchmark_serving.py
index 1e5aaf29c..6bf64ec1d 100644
--- a/benchmarks/diffusion/diffusion_benchmark_serving.py
+++ b/benchmarks/diffusion/diffusion_benchmark_serving.py
@@ -1087,6 +1087,12 @@ async def _run_warmups(
warmup_tasks = [asyncio.create_task(limited_warmup_request_func(req)) for req in warmup_requests]
warmup_outputs = await asyncio.gather(*warmup_tasks)
+ failed_count = sum(not output.success for output in warmup_outputs)
+ if failed_count:
+ raise RuntimeError(
+ f"{failed_count}/{len(warmup_outputs)} warmup requests failed; "
+ "check server logs before running the benchmark."
+ )
return list(zip(warmup_requests, warmup_outputs))
@@ -1455,7 +1461,7 @@ async def benchmark(args):
print(f"Metrics saved to {args.output_file}")
-if __name__ == "__main__":
+def build_parser():
parser = argparse.ArgumentParser(description="Benchmark serving for diffusion models.")
parser.add_argument(
"--base-url",
@@ -1637,6 +1643,10 @@ if __name__ == "__main__":
action="store_true",
help="Request stage duration metrics from endpoints that support return_stage_metrics.",
)
+ return parser
+
+if __name__ == "__main__":
+ parser = build_parser()
args = parser.parse_args()
asyncio.run(benchmark(args))
diff --git a/benchmarks/kernels/mot_linear_benchmarks.py b/benchmarks/kernels/mot_linear_benchmarks.py
index 20674272e..0b517ce11 100644
--- a/benchmarks/kernels/mot_linear_benchmarks.py
+++ b/benchmarks/kernels/mot_linear_benchmarks.py
@@ -1,3 +1,6 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
+
# ruff: noqa: N803
"""MoT (Mixture-of-Tokens) GEMM kernel benchmark and auto-tuning.
@@ -10,7 +13,7 @@ Usage:
python benchmarks/kernels/mot_linear_benchmarks.py \
--model ByteDance-Seed/BAGEL-7B-MoT \
--tp-size 1 --dtype w16a16 --tune \
- --save-dir vllm_omni/diffusion/layers/mot/configs/
+ --save-dir vllm_omni/diffusion/models/bagel/mot/configs/
# Auto-tune with local model path (offline clusters):
python benchmarks/kernels/mot_linear_benchmarks.py \
@@ -43,7 +46,7 @@ from vllm.triton_utils import triton
from vllm.utils.torch_utils import set_random_seed
# NOTE: you should use the same naming syetem for the kernel to load properly
-from vllm_omni.diffusion.layers.mot.ops.mot_gemm import build_config_filename, get_device_name
+from vllm_omni.diffusion.models.bagel.mot.ops.mot_gemm import build_config_filename, get_device_name
# clear the triton cache from time to time, usaully no need to change
_CACHE_CLEAR_INTERVAL_ENV = "VLLM_MOT_TUNE_CACHE_CLEAR_INTERVAL"
@@ -428,7 +431,7 @@ def benchmark_config(
cache_flusher: torch.Tensor | None = None,
) -> float:
"""Run a MoT GEMM with the given tile config and return avg latency (us)."""
- from vllm_omni.diffusion.layers.mot.ops.mot_gemm import invoke_mot_gemm
+ from vllm_omni.diffusion.models.bagel.mot.ops.mot_gemm import invoke_mot_gemm
text_indices, vae_indices, M = build_regular_indices(
image_num=image_num,
@@ -553,7 +556,7 @@ class BenchmarkWorker:
use_int8_w8a16: bool,
) -> tuple[dict[str, int], float]:
set_random_seed(self.seed)
- from vllm_omni.diffusion.layers.mot.ops.mot_gemm import (
+ from vllm_omni.diffusion.models.bagel.mot.ops.mot_gemm import (
get_best_mot_config,
)
diff --git a/benchmarks/qwen3_omni/embedding_harness.py b/benchmarks/qwen3_omni/embedding_harness.py
new file mode 100644
index 000000000..63d14ef0d
--- /dev/null
+++ b/benchmarks/qwen3_omni/embedding_harness.py
@@ -0,0 +1,226 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
+"""Small fixtures for the real Qwen3 thinker embedding method and its oracle."""
+
+from __future__ import annotations
+
+import hashlib
+import json
+from dataclasses import asdict, dataclass
+from types import SimpleNamespace
+
+import torch
+from torch import nn
+from torch.nn import functional as F
+
+SCENARIOS = ("text", "empty", "audio", "image", "video", "mixed", "interleaved", "vision_no_deepstack")
+
+
+@dataclass(frozen=True)
+class ModelShape:
+ vocab_size: int = 152064
+ hidden_size: int = 2048
+ deepstack_levels: int = 3
+ image_token_id: int = 151655
+ video_token_id: int = 151656
+ audio_token_id: int = 151675
+
+ def __post_init__(self):
+ if min(self.vocab_size, self.hidden_size, self.deepstack_levels) <= 0:
+ raise ValueError("vocab_size, hidden_size and deepstack_levels must be positive")
+ ids = (self.image_token_id, self.video_token_id, self.audio_token_id)
+ if len(set(ids)) != 3 or not all(0 < token < self.vocab_size for token in ids):
+ raise ValueError("Provide three distinct, positive, in-vocabulary modality IDs; use oov=True to test OOV")
+
+ def token_ids(self, oov=False):
+ if oov:
+ return dict(zip(("image", "video", "audio"), range(self.vocab_size, self.vocab_size + 3)))
+ return {name: getattr(self, f"{name}_token_id") for name in ("image", "video", "audio")}
+
+
+@dataclass
+class Feature:
+ modality: str
+ positions: torch.Tensor
+ main: torch.Tensor
+ deepstack: torch.Tensor | None
+ combined: torch.Tensor
+
+
+@dataclass
+class EmbeddingCase:
+ name: str
+ input_ids: torch.Tensor
+ is_multimodal: torch.Tensor | None
+ features: tuple[Feature, ...]
+ fingerprint: str
+
+ def fresh_embeddings(self):
+ # The thinker replaces list entries with main-scale views.
+ return None if self.name == "text" else [feature.combined for feature in self.features]
+
+
+def _tensor_bytes(tensor):
+ return tensor.detach().contiguous().view(torch.uint8).cpu().numpy().tobytes()
+
+
+def build_case(
+ name,
+ num_tokens,
+ num_mm_tokens,
+ shape,
+ *,
+ device="cuda",
+ dtype=torch.bfloat16,
+ mask_device="cpu",
+ seed=42,
+ oov=False,
+):
+ """Build known feature placements; no model merge is used to define them."""
+ if name not in SCENARIOS:
+ raise ValueError(f"Unknown scenario: {name}")
+ if num_tokens <= 0 or not 0 <= num_mm_tokens < num_tokens:
+ raise ValueError("Require N > 0 and 0 <= M < N")
+ if (name in {"text", "empty"}) != (num_mm_tokens == 0):
+ raise ValueError("Only text/empty scenarios accept M=0")
+ if name in {"mixed", "interleaved"} and (num_mm_tokens < 4 or num_mm_tokens % 2):
+ raise ValueError("Mixed/interleaved scenarios require an even M >= 4")
+ token_ids = shape.token_ids(oov)
+ generator = torch.Generator().manual_seed(seed)
+ ids = torch.randint(0, min(shape.vocab_size, *token_ids.values()), (num_tokens,), generator=generator)
+ mask = torch.zeros(num_tokens, dtype=torch.bool)
+ positions = torch.arange((num_tokens - num_mm_tokens) // 2, (num_tokens - num_mm_tokens) // 2 + num_mm_tokens)
+ groups = []
+ if name == "mixed":
+ groups = [("audio", positions[: num_mm_tokens // 2]), ("image", positions[num_mm_tokens // 2 :])]
+ elif name == "interleaved":
+ groups = [("video", positions[::2]), ("audio", positions[1::2])]
+ elif num_mm_tokens:
+ groups = [("image" if name == "vision_no_deepstack" else name, positions)]
+ features = []
+ for modality, indexes in groups:
+ ids[indexes] = token_ids[modality]
+ mask[indexes] = True
+ rows = torch.arange(len(indexes), dtype=torch.float32)[:, None].remainder(31) / 32
+ cols = torch.arange(shape.hidden_size, dtype=torch.float32)[None, :].remainder(7) / 16
+ main_cpu = rows + cols + {"audio": 2, "image": 4, "video": 6}[modality]
+ main = main_cpu.to(device=device, dtype=dtype)
+ deepstack = None
+ parts = [main]
+ if modality != "audio" and name != "vision_no_deepstack":
+ deepstack = torch.stack(
+ [(main_cpu + 16 + 4 * level).to(device=device, dtype=dtype) for level in range(shape.deepstack_levels)]
+ )
+ parts.extend(deepstack.unbind(0))
+ combined = torch.cat(parts, dim=-1)
+ # set_mm_embedding_modality simply attaches this attribute. Tag only
+ # after cat/to: views and copies do not preserve arbitrary attributes.
+ combined.modality = modality
+ features.append(Feature(modality, indexes, main, deepstack, combined))
+ digest = hashlib.sha256(json.dumps({"name": name, "shape": asdict(shape), "seed": seed, "oov": oov}).encode())
+ digest.update(_tensor_bytes(ids))
+ digest.update(_tensor_bytes(mask))
+ for feature in features:
+ digest.update(feature.modality.encode())
+ digest.update(_tensor_bytes(feature.combined))
+ return EmbeddingCase(
+ name,
+ ids.to(device=device),
+ None if name == "text" else mask.to(device=mask_device),
+ tuple(features),
+ digest.hexdigest(),
+ )
+
+
+class LanguageModelAdapter(nn.Module):
+ def __init__(self, embedding):
+ super().__init__()
+ self.embedding = embedding
+
+ def embed_input_ids(self, input_ids):
+ return self.embedding(input_ids)
+
+ def forward(self, input_ids):
+ return self.embed_input_ids(input_ids)
+
+
+def make_thinker(
+ shape,
+ *,
+ device="cuda",
+ dtype=torch.bfloat16,
+ seed=42,
+ backend="torch",
+ deepstack=True,
+ buffer_capacity=32,
+ oov=False,
+):
+ """Skip checkpoint construction, preserving the real class and its MRO."""
+ from tests.model_executor.helpers import bootstrap_vllm_layer_custom_op_modules
+
+ bootstrap_vllm_layer_custom_op_modules()
+ from vllm_omni.model_executor.models.qwen3_omni.qwen3_omni_moe_thinker import (
+ Qwen3OmniMoeThinkerForConditionalGeneration,
+ )
+
+ if buffer_capacity <= 0:
+ raise ValueError("buffer_capacity must be positive")
+ device = torch.device(device)
+ if backend == "torch":
+ embedding = nn.Embedding(shape.vocab_size, shape.hidden_size, device=device, dtype=dtype)
+ elif backend == "vllm":
+ from vllm.model_executor.layers.vocab_parallel_embedding import VocabParallelEmbedding
+
+ with torch.device(device):
+ embedding = VocabParallelEmbedding(shape.vocab_size, shape.hidden_size, params_dtype=dtype, disable_tp=True)
+ else:
+ raise ValueError(f"Unknown embedding backend: {backend}")
+ with torch.no_grad():
+ embedding.weight.uniform_(-0.5, 0.5, generator=torch.Generator(device=device).manual_seed(seed))
+ thinker = object.__new__(Qwen3OmniMoeThinkerForConditionalGeneration)
+ nn.Module.__init__(thinker)
+ thinker.config = SimpleNamespace(text_config=SimpleNamespace(hidden_size=shape.hidden_size))
+ for modality, token_id in shape.token_ids(oov).items():
+ setattr(thinker.config, f"{modality}_token_id", token_id)
+ thinker.visual = SimpleNamespace(
+ deepstack_visual_indexes=list(range(shape.deepstack_levels)) if deepstack else None
+ )
+ thinker.language_model = LanguageModelAdapter(embedding)
+ thinker._has_oov_mm_tokens = oov
+ thinker.use_deepstack = deepstack
+ thinker.deepstack_num_level = shape.deepstack_levels if deepstack else 0
+ thinker.deepstack_input_embeds = [
+ torch.zeros(buffer_capacity, shape.hidden_size, device=device, dtype=dtype)
+ for _ in range(thinker.deepstack_num_level)
+ ]
+ thinker.deepstack_input_embeds_num_tokens = 0
+ return thinker.eval()
+
+
+@torch.inference_mode()
+def expected_outputs(model, case):
+ """Independent oracle: direct lookup and explicit positions, not merge helpers."""
+ ids = case.input_ids
+ if model._has_oov_mm_tokens and case.is_multimodal is not None:
+ ids = ids.masked_fill(case.is_multimodal.to(ids.device), 0)
+ main = F.embedding(ids, model.language_model.embedding.weight)
+ has_deepstack = any(feature.deepstack is not None for feature in case.features)
+ deepstack = main.new_zeros((model.deepstack_num_level, *main.shape)) if has_deepstack else None
+ for feature in case.features:
+ indexes = feature.positions.to(main.device)
+ main[indexes] = feature.main
+ if feature.deepstack is not None:
+ deepstack[:, indexes, :] = feature.deepstack
+ return main, deepstack
+
+
+@torch.inference_mode()
+def assert_case_output(model, case, result):
+ expected, deepstack = expected_outputs(model, case)
+ torch.testing.assert_close(result, expected, rtol=0, atol=0)
+ if deepstack is None:
+ assert model.deepstack_input_embeds_num_tokens == 0, "Unexpected stale DeepStack buffer"
+ else:
+ assert model.deepstack_input_embeds_num_tokens == case.input_ids.numel()
+ actual = torch.stack([buffer[: case.input_ids.numel()] for buffer in model.deepstack_input_embeds])
+ torch.testing.assert_close(actual, deepstack, rtol=0, atol=0)
diff --git a/benchmarks/tts/bench_cosyvoice3_concurrency_matrix.py b/benchmarks/tts/bench_cosyvoice3_concurrency_matrix.py
new file mode 100644
index 000000000..fb45b1743
--- /dev/null
+++ b/benchmarks/tts/bench_cosyvoice3_concurrency_matrix.py
@@ -0,0 +1,517 @@
+#!/usr/bin/env python3
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
+
+"""CosyVoice3 streaming e2e benchmark: concurrency x utterance-length matrix.
+
+Launches the server once per (concurrency, step-size) combo, streams TTS
+requests cycling through several utterance lengths, and reports
+TTFA/E2E/RTF/per-chunk latency (mean, stdev, range) per cell. "Step size" is
+``codec_chunk_frames``, the token-hop length the first emitted chunk waits
+for; later chunks wait for a doubling hop capped at ``4 * codec_chunk_frames``
+(see ``_token_hop_lengths``). Per-chunk latency is reconstructed from that
+same ramp rather than from raw transport read boundaries, which don't align
+to model chunks (see ``one_request``'s docstring).
+
+Running with no flags reproduces the default matrix. Per-request correctness
+is checked: non-silent, long enough, and (with a fixed ``--seed``)
+byte-identical PCM across requests for the same text.
+"""
+
+import argparse
+import json
+import os
+import signal
+import statistics
+import subprocess
+import sys
+import threading
+import time
+from pathlib import Path
+
+import httpx
+import numpy as np
+
+REPO = Path(__file__).resolve().parents[2]
+DEFAULT_MODEL = "FunAudioLLM/Fun-CosyVoice3-0.5B-2512"
+
+DEFAULT_REF_AUDIO = "https://raw.githubusercontent.com/FunAudioLLM/CosyVoice/main/asset/zero_shot_prompt.wav"
+DEFAULT_REF_TEXT = "希望你以后能够做的比我还好呦。"
+
+DEFAULT_TEXTS = [
+ "Thank you so much for the birthday gift you sent me.",
+ "The weather is lovely today, with warm sunshine and a gentle breeze. "
+ "We decided to take a walk in the park to enjoy the spring flowers and the fresh air.",
+ "The weather is lovely today, with warm sunshine and a gentle breeze. We decided to take a walk in the "
+ "park to enjoy the spring flowers and the fresh air. Many people were out walking, children were "
+ "running and playing on the grass, and older folks sat on benches chatting with one another. We "
+ "strolled slowly along the path and came across a cherry tree in full bloom, its pink petals drifting "
+ "on the wind. It was so beautiful that we stopped to take some photos to remember the moment. Then we "
+ "continued on and reached a small lake, its water so clear you could see straight to the bottom, with "
+ "the blue sky and white clouds reflected on its surface. A few ducks paddled back and forth across the "
+ "water, occasionally letting out a soft quack. We sat on a bench by the lake for a while, enjoying the "
+ "peaceful afternoon. Time passed quickly, and before we knew it evening had arrived, with the setting "
+ "sun painting the sky in shades of gold. Reluctant to leave, we finally headed home, already planning "
+ "our next visit. On the way back we talked about everything we had seen and heard that day, feeling "
+ "wonderfully happy. It was truly an unforgettable weekend.",
+]
+
+# PCM16 mono @ 24 kHz (CosyVoice3 output rate)
+SAMPLE_RATE = 24000
+
+# Well below any real speech's RMS; catches all-zero/near-silent PCM that byte
+# count and duration checks alone pass through.
+MIN_RMS = 50.0
+
+# Overlay: only codec_chunk_frames is overridden; must live next to cosyvoice3.yaml (relative base_config)
+DEPLOY_TEMPLATE = """# Auto-generated by bench_cosyvoice3_concurrency_matrix.py -- do not edit.
+base_config: cosyvoice3.yaml
+
+connectors:
+ connector_of_shared_memory:
+ name: SharedMemoryConnector
+ extra:
+ codec_streaming: true
+ connector_get_sleep_s: 0.01
+ connector_get_max_wait_first_chunk: 3000
+ connector_get_max_wait: 300
+ codec_chunk_frames: {chunk_frames}
+ codec_max_chunk_frames: {max_chunk_frames}
+ codec_stream_scale_factor: {stream_scale_factor}
+ codec_left_context_frames: 25
+ codec_vocab_size: 6561
+"""
+
+# CosyVoice3Config constants (transformers_utils/configs/cosyvoice3.py): tokens
+# are consumed at token_mel_ratio mel frames each, and HiFT emits
+# samples_per_mel PCM16 samples per mel frame. Pinned here (not left to the
+# server's defaults) since one_request's byte-boundary reconstruction below
+# depends on knowing them exactly.
+TOKEN_MEL_RATIO = 2
+SAMPLES_PER_MEL = 480
+STREAM_SCALE_FACTOR = 2
+
+
+def _stats(values: list[float]) -> dict[str, float]:
+ """Mean/median/stdev/p95/min/max/n for a list of per-request measurements."""
+ n = len(values)
+ if n == 0:
+ return {
+ "n": 0,
+ "mean": float("nan"),
+ "median": float("nan"),
+ "stdev": float("nan"),
+ "p95": float("nan"),
+ "min": float("nan"),
+ "max": float("nan"),
+ }
+ return {
+ "n": n,
+ "mean": statistics.mean(values),
+ "median": statistics.median(values),
+ "stdev": statistics.stdev(values) if n >= 2 else 0.0,
+ "p95": statistics.quantiles(values, n=20)[18] if n >= 2 else values[0],
+ "min": min(values),
+ "max": max(values),
+ }
+
+
+def vllm_bin() -> str:
+ for c in (REPO / ".venv/bin/vllm", Path(sys.executable).parent / "vllm"):
+ if c.is_file():
+ return str(c)
+ return "vllm"
+
+
+def wait_ready(url: str, proc: subprocess.Popen, log: Path, timeout: float) -> None:
+ deadline = time.monotonic() + timeout
+ while time.monotonic() < deadline:
+ if proc.poll() is not None:
+ tail = log.read_text(errors="replace").splitlines()[-40:] if log.exists() else []
+ raise RuntimeError("server exited during startup:\n " + "\n ".join(tail))
+ try:
+ if httpx.get(f"{url}/health", timeout=2.0).status_code == 200:
+ return
+ except Exception:
+ pass
+ time.sleep(2.0)
+ raise TimeoutError(f"server not ready within {timeout}s (log: {log})")
+
+
+def _token_hop_lengths(chunk_frames: int, max_chunk_frames: int):
+ """The token-hop-length ramp talker2code2wav_async_chunk uses to decide
+ when to fire the next flow-solve/emission: chunk_frames, then doubling
+ (STREAM_SCALE_FACTOR) each step, capped at max_chunk_frames. This -- not
+ codec_chunk_frames alone -- is what actually paces emitted audio chunks:
+ with the defaults here, hops are chunk_frames, 2x, 4x, 4x, 4x, ...
+
+ The very first emission is consistently one token short of chunk_frames
+ (confirmed against real speech.audio.delta event sizes) even though the
+ ramp's own progression is computed from the nominal chunk_frames, not the
+ actual first hop -- so only the first yield gets the -1 adjustment.
+ """
+ yield chunk_frames - 1
+ hop = chunk_frames
+ while True:
+ hop = min(max_chunk_frames, max(chunk_frames, hop * STREAM_SCALE_FACTOR))
+ yield hop
+
+
+def one_request(client, url, model, text, ref_audio, ref_text, chunk_frames, seed=None):
+ """Run one streaming request, returning TTFA, E2E, per-chunk gaps, and audio bytes.
+
+ ``response_format=pcm`` + ``stream_format=audio`` streams raw bytes with no
+ framing, so a client read boundary alone is a transport artifact, not a
+ model chunk boundary. Reconstructed instead by replicating the server's
+ own token-hop-length ramp (see ``_token_hop_lengths``) to compute each
+ real chunk's expected byte size ahead of time, and slicing the
+ accumulated byte stream at those offsets -- independent of how the
+ transport happens to fragment the underlying reads. The final chunk
+ (finalize, which releases extra held-back frames) is whatever remains
+ when the stream closes, not a predicted hop.
+ """
+ payload = {
+ "model": model,
+ "input": text,
+ "response_format": "pcm",
+ "stream": True,
+ "stream_format": "audio",
+ "ref_audio": ref_audio,
+ "ref_text": ref_text,
+ }
+ if seed is not None:
+ payload["seed"] = seed
+ t0 = time.perf_counter()
+ ttfa = None
+ nbytes = 0
+ audio_bytes = bytearray()
+ chunk_gaps_ms = [] # inter-chunk arrival gaps (per model chunk), by step index
+ prev_t = None
+ step_idx = 0
+
+ bytes_per_token = TOKEN_MEL_RATIO * SAMPLES_PER_MEL * 2
+ hop_gen = _token_hop_lengths(chunk_frames, 4 * chunk_frames)
+ next_boundary = next(hop_gen) * bytes_per_token
+ last_crossed_bytes = 0
+ received = 0
+ last_now = t0
+
+ with client.stream("POST", f"{url}/v1/audio/speech", json=payload, headers={"Authorization": "Bearer EMPTY"}) as r:
+ if r.status_code != 200:
+ raise RuntimeError(f"{r.status_code}: {r.read()[:300]!r}")
+ for chunk in r.iter_bytes():
+ if not chunk:
+ continue
+ now = time.perf_counter()
+ if ttfa is None:
+ ttfa = now - t0
+ last_now = now
+ received += len(chunk)
+ nbytes += len(chunk)
+ audio_bytes += chunk
+ while received >= next_boundary:
+ if prev_t is not None:
+ chunk_gaps_ms.append((step_idx, (now - prev_t) * 1e3))
+ step_idx += 1
+ prev_t = now
+ last_crossed_bytes = next_boundary
+ next_boundary += next(hop_gen) * bytes_per_token
+
+ if received > last_crossed_bytes:
+ # Finalize chunk: releases extra held-back frames, so it doesn't
+ # match a predicted hop size -- its arrival is the stream closing.
+ if prev_t is not None:
+ chunk_gaps_ms.append((step_idx, (last_now - prev_t) * 1e3))
+ step_idx += 1
+
+ e2e = time.perf_counter() - t0
+ audio_s = nbytes / 2 / SAMPLE_RATE
+ return {
+ "ttfa_s": ttfa,
+ "e2e_s": e2e,
+ "audio_s": audio_s,
+ "rtf": e2e / audio_s if audio_s > 0 else float("nan"),
+ "chunk_gaps_ms": chunk_gaps_ms,
+ "nbytes": nbytes,
+ "audio_bytes": audio_bytes,
+ }
+
+
+def check_correctness(r: dict, min_audio_s: float) -> list[str]:
+ """Return a list of correctness violations (empty = pass)."""
+ problems = []
+ if r["nbytes"] <= 0:
+ problems.append("empty audio (0 bytes)")
+ if r["audio_s"] < min_audio_s:
+ problems.append(f"audio too short ({r['audio_s']:.2f}s < {min_audio_s:.2f}s)")
+ if r["nbytes"] > 0:
+ samples = np.frombuffer(bytes(r["audio_bytes"]), dtype=np.int16).astype(np.float64)
+ rms = float(np.sqrt(np.mean(samples**2)))
+ if rms < MIN_RMS:
+ problems.append(f"near-silent audio (rms={rms:.1f} < {MIN_RMS})")
+ return problems
+
+
+def drive(url, args, n, conc, label, results, lock, idx, chunk_frames):
+ """Run ``n`` requests at concurrency ``conc``, cycling through ``args.texts``."""
+ texts = args.texts
+
+ def worker():
+ with httpx.Client(timeout=600.0) as c:
+ while True:
+ with lock:
+ i = idx[0]
+ idx[0] += 1
+ if i >= n:
+ return
+ text = texts[i % len(texts)]
+ try:
+ r = one_request(
+ c, url, args.model, text, args.ref_audio, args.ref_text, chunk_frames, seed=args.seed
+ )
+ r["text"] = text
+ with lock:
+ results.append(r)
+ except Exception as e:
+ print(f" [{label}] request {i} failed: {e}", flush=True)
+
+ ts = [threading.Thread(target=worker) for _ in range(conc)]
+ t0 = time.perf_counter()
+ for t in ts:
+ t.start()
+ for t in ts:
+ t.join()
+ return time.perf_counter() - t0
+
+
+def run_combo(args, conc: int, chunk_frames: int, out: Path) -> dict:
+ tag = f"c{conc}_chunk{chunk_frames}"
+ run_dir = out / tag
+ run_dir.mkdir(parents=True, exist_ok=True)
+ log = run_dir / "server.log"
+
+ deploy = REPO / "vllm_omni/deploy" / f"_autogen_steps_{tag}.yaml"
+ deploy.write_text(
+ DEPLOY_TEMPLATE.format(
+ chunk_frames=chunk_frames,
+ max_chunk_frames=4 * chunk_frames,
+ stream_scale_factor=STREAM_SCALE_FACTOR,
+ )
+ )
+
+ cmd = [
+ vllm_bin(),
+ "serve",
+ args.model,
+ "--omni",
+ "--deploy-config",
+ str(deploy),
+ "--host",
+ "127.0.0.1",
+ "--port",
+ str(args.port),
+ "--allowed-local-media-path",
+ str(REPO),
+ ]
+ env = dict(os.environ)
+ if args.cuda_visible_devices:
+ env["CUDA_VISIBLE_DEVICES"] = args.cuda_visible_devices
+ if args.trt is not None:
+ env["COSYVOICE3_TRT"] = args.trt
+
+ print(f"\n=== concurrency={conc} step_size={chunk_frames} ===", flush=True)
+ print(f" launching server (log: {log})", flush=True)
+ with open(log, "w") as lf:
+ proc = subprocess.Popen(cmd, env=env, stdout=lf, stderr=subprocess.STDOUT, start_new_session=True)
+ url = f"http://127.0.0.1:{args.port}"
+ try:
+ wait_ready(url, proc, log, args.server_timeout)
+ print(" server ready", flush=True)
+
+ results: list[dict] = []
+ lock = threading.Lock()
+ idx = [0]
+ if args.warmup:
+ print(f" warmup ({args.warmup} req)", flush=True)
+ drive(url, args, args.warmup, min(conc, args.warmup), "warmup", results, lock, idx, chunk_frames)
+ results.clear()
+ idx[0] = 0
+
+ print(f" running {args.num_prompts} req @ concurrency {conc}", flush=True)
+ wall = drive(url, args, args.num_prompts, conc, "bench", results, lock, idx, chunk_frames)
+
+ ok = [r for r in results if r.get("ttfa_s") is not None]
+ problems = []
+ for r in ok:
+ problems += check_correctness(r, args.min_audio_s)
+ # With a fixed seed, same-text requests must produce byte-identical PCM (per text group)
+ if args.seed is not None:
+ by_text: dict[str, bytes] = {}
+ for r in ok:
+ t = r.get("text")
+ ref = by_text.get(t)
+ if ref is None:
+ by_text[t] = r.get("audio_bytes")
+ elif r.get("audio_bytes") != ref:
+ problems.append(f"byte-identity violation for text {t!r}: seeded requests produced different PCM")
+ n_ok = len(ok)
+ total_audio_s = sum(r["audio_s"] for r in ok)
+ all_gaps = [g for r in ok for g in r["chunk_gaps_ms"]] # (step_index, gap_ms) per request
+ gap_vals = [g for _, g in all_gaps]
+
+ # bucket gaps by chunk position within a request, to see any O(n) slope
+ by_idx: dict[int, list[float]] = {}
+ for step_index, g in all_gaps:
+ by_idx.setdefault(step_index, []).append(g)
+ step_latency_by_idx = {i: statistics.median(vals) for i, vals in sorted(by_idx.items())}
+
+ agg = {
+ "concurrency": conc,
+ "step_size": chunk_frames,
+ "ok": n_ok,
+ "errors": args.num_prompts - n_ok,
+ "correctness_problems": len(problems),
+ "correctness_sample": problems[:5],
+ "total_audio_s": total_audio_s,
+ "throughput_audio_s_per_s": total_audio_s / wall if wall > 0 else float("nan"),
+ "ttfa_s": _stats([r["ttfa_s"] for r in ok]),
+ "e2e_s": _stats([r["e2e_s"] for r in ok]),
+ "rtf": _stats([r["rtf"] for r in ok]),
+ "step_latency_ms": _stats(gap_vals),
+ "step_latency_ms_by_idx": step_latency_by_idx,
+ "num_steps": len(all_gaps),
+ # per-utterance-length breakdown; n per text = num_prompts / len(texts)
+ "by_text": {
+ t: {
+ "audio_s": _stats([r["audio_s"] for r in ok if r.get("text") == t]),
+ "e2e_s": _stats([r["e2e_s"] for r in ok if r.get("text") == t]),
+ "rtf": _stats([r["rtf"] for r in ok if r.get("text") == t]),
+ }
+ for t in sorted({r.get("text") for r in ok})
+ },
+ }
+ print(json.dumps(agg, indent=2, ensure_ascii=False), flush=True)
+ return agg
+ finally:
+ print(" shutting down server", flush=True)
+ try:
+ os.killpg(os.getpgid(proc.pid), signal.SIGTERM)
+ except Exception:
+ proc.terminate()
+ try:
+ proc.wait(timeout=60)
+ except subprocess.TimeoutExpired:
+ try:
+ os.killpg(os.getpgid(proc.pid), signal.SIGKILL)
+ except Exception:
+ proc.kill()
+ proc.wait(timeout=20)
+ deploy.unlink(missing_ok=True)
+
+
+def parse_args() -> argparse.Namespace:
+ p = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
+ p.add_argument("--model", default=DEFAULT_MODEL)
+ p.add_argument(
+ "--text",
+ dest="texts",
+ nargs="+",
+ default=DEFAULT_TEXTS,
+ help="One or more utterance texts. With several, requests cycle through "
+ "them so a single server launch covers all utterance lengths; results "
+ "are bucketed per text.",
+ )
+ p.add_argument("--ref-audio", default=DEFAULT_REF_AUDIO)
+ p.add_argument("--ref-text", default=DEFAULT_REF_TEXT)
+ p.add_argument("--concurrency", type=int, nargs="+", default=[1, 8])
+ p.add_argument(
+ "--step-size",
+ type=int,
+ nargs="+",
+ default=[15],
+ help="codec_chunk_frames values to sweep (the streaming step size).",
+ )
+ p.add_argument("--num-prompts", type=int, default=30)
+ p.add_argument("--warmup", type=int, default=2)
+ p.add_argument("--port", type=int, default=8091)
+ p.add_argument(
+ "--server-timeout",
+ type=float,
+ default=1800.0,
+ help="Startup budget; first run also downloads weights and builds the TRT engine.",
+ )
+ p.add_argument("--output-dir", default="./perf_steps")
+ p.add_argument("--cuda-visible-devices", default="0")
+ p.add_argument(
+ "--trt",
+ choices=["0", "1"],
+ default=None,
+ help="Pin COSYVOICE3_TRT. 0=force torch estimator, 1=allow TensorRT. Default: unset.",
+ )
+ p.add_argument(
+ "--min-audio-s",
+ type=float,
+ default=1.0,
+ help="Minimum expected audio seconds per request for the correctness check.",
+ )
+ p.add_argument(
+ "--seed",
+ type=int,
+ default=42,
+ help="Fixed seed for reproducible (byte-identical) audio. Pass --seed '' "
+ "equivalent (any non-int) to disable -- there is no unset sentinel here "
+ "by design, since the default sweep is meant to be exactly reproducible.",
+ )
+ return p.parse_args()
+
+
+def main() -> None:
+ args = parse_args()
+ out = Path(args.output_dir).resolve()
+ out.mkdir(parents=True, exist_ok=True)
+
+ all_results = []
+ failed = False
+ for conc in args.concurrency:
+ for chunk_frames in args.step_size:
+ try:
+ result = run_combo(args, conc, chunk_frames, out)
+ all_results.append(result)
+ if result["errors"] > 0 or result["correctness_problems"] > 0:
+ failed = True
+ except Exception as e:
+ print(f" combo c={conc} chunk={chunk_frames} FAILED: {e}", flush=True)
+ failed = True
+
+ out_path = out / "steps_results.json"
+ with open(out_path, "w", encoding="utf-8") as f:
+ json.dump({"model": args.model, "texts": args.texts, "runs": all_results}, f, indent=2, ensure_ascii=False)
+ print(f"\nResults written to {out_path}", flush=True)
+
+ print("\n=== SUMMARY ===")
+ header = (
+ f"{'conc':>4} {'step':>4} {'ok':>4} {'corr':>4} "
+ f"{'TTFA med(ms)':>12} {'step med(ms)':>12} {'step p95(ms)':>12} {'RTF mean+-sd':>14}"
+ )
+ print(header)
+ print("-" * len(header))
+ for r in all_results:
+ print(
+ f"{r['concurrency']:>4} {r['step_size']:>4} {r['ok']:>4} {r['correctness_problems']:>4} "
+ f"{r['ttfa_s']['median'] * 1e3:>12.1f} "
+ f"{r['step_latency_ms']['median']:>12.1f} {r['step_latency_ms']['p95']:>12.1f} "
+ f"{r['rtf']['mean']:>6.3f}+-{r['rtf']['stdev']:>5.3f}"
+ )
+ for t, stats in r.get("by_text", {}).items():
+ print(
+ f" text {t[:24]!r}: e2e {stats['e2e_s']['mean'] * 1e3:8.1f}"
+ f"+-{stats['e2e_s']['stdev'] * 1e3:6.1f} ms (n={stats['e2e_s']['n']}, "
+ f"audio {stats['audio_s']['mean']:.1f}s)"
+ )
+
+ if failed:
+ sys.exit(1)
+
+
+if __name__ == "__main__":
+ main()
diff --git a/docker/Dockerfile.rocm b/docker/Dockerfile.rocm
index adc767691..48631994f 100644
--- a/docker/Dockerfile.rocm
+++ b/docker/Dockerfile.rocm
@@ -2,7 +2,11 @@
# docker/Dockerfile.ci. A stale base image can build successfully while failing
# at runtime when vLLM-Omni imports APIs added by the newer vLLM release.
ARG BASE_IMAGE=vllm/vllm-openai-rocm:v0.29.0
-FROM ${BASE_IMAGE} AS base
+
+# Keep the dependency-heavy portion independent from the source tree. The
+# registry cache is keyed on these inputs, while the final source copy can be
+# linked onto the cached image without materializing its large ROCm layers.
+FROM ${BASE_IMAGE} AS deps
# NOTE: REMINDER to vLLM-Omni rebase maintainer
# BASE_IMAGE pins the default prebuilt runtime when USE_NIGHTLY_BUILD=0.
@@ -64,9 +68,24 @@ RUN --mount=type=cache,target=/root/.cache/pip \
apt-get clean && \
rm -rf /var/lib/apt/lists/*
-# Step 3: Copy vllm-omni code and install without uv
-RUN mkdir -p ${COMMON_WORKDIR}/vllm-omni
-COPY . ${COMMON_WORKDIR}/vllm-omni
+# Step 3: Install project dependencies against a placeholder package tree.
+# The editable install keeps resolving imports from this directory after the
+# final COPY --link replaces the placeholder with the real source tree.
+WORKDIR ${COMMON_WORKDIR}/vllm-omni
+RUN mkdir -p vllm_omni && touch vllm_omni/__init__.py
+COPY pyproject.toml setup.py ./
+COPY requirements/ requirements/
+ENV SETUPTOOLS_SCM_PRETEND_VERSION=0.0.0
+
+RUN uv pip install --python "$(python3 -c 'import sys; print(sys.executable)')" \
+ --no-cache-dir -e ".[dev]" --no-build-isolation && \
+ python3 -m pip uninstall -y onnxruntime && \
+ python3 -m pip install --no-cache-dir --force-reinstall --no-deps \
+ "onnxruntime-rocm>=1.22.2" && \
+ python3 -c "import importlib.metadata as m; import onnxruntime as ort; assert 'ROCMExecutionProvider' in ort.get_available_providers(), ort.get_available_providers(); assert m.version('onnxruntime-rocm'); assert not any(d.metadata['Name'] == 'onnxruntime' for d in m.distributions())" && \
+ python3 -c "from torchcodec.decoders import VideoDecoder"
+
+RUN ln -sf /usr/bin/python3 /usr/bin/python
# This is a workaround to ensure pytest exits with the correct status code in CI tests.
RUN printf '%s\n' \
@@ -85,19 +104,13 @@ RUN printf '%s\n' \
' os._exit(_exit_code)' \
> ${COMMON_WORKDIR}/vllm-omni/conftest.py
-# Some optional dependencies pull in the CPU ONNX Runtime distribution. The
-# CPU and ROCm wheels own the same import path and cannot coexist, so remove
-# the CPU wheel and reinstall the ROCm wheel after dependency resolution.
-RUN cd ${COMMON_WORKDIR}/vllm-omni && \
- uv pip install --python "$(python3 -c 'import sys; print(sys.executable)')" \
- --no-cache-dir ".[dev]" --no-build-isolation && \
- python3 -m pip uninstall -y onnxruntime && \
- python3 -m pip install --no-cache-dir --force-reinstall --no-deps \
- "onnxruntime-rocm>=1.22.2" && \
- python3 -c "import importlib.metadata as m; import onnxruntime as ort; assert 'ROCMExecutionProvider' in ort.get_available_providers(), ort.get_available_providers(); assert m.version('onnxruntime-rocm'); assert not any(d.metadata['Name'] == 'onnxruntime' for d in m.distributions())" && \
- python3 -c "from torchcodec.decoders import VideoDecoder"
-
-RUN ln -sf /usr/bin/python3 /usr/bin/python
+# Keep source changes in one lightweight linked layer. Do not add RUN, COPY, or
+# ADD instructions that depend on the resulting filesystem after this point;
+# doing so would force BuildKit to download and extract the cached ROCm layers.
+FROM deps AS base
+ARG COMMON_WORKDIR=/app
+WORKDIR ${COMMON_WORKDIR}/vllm-omni
+COPY --link . .
FROM base AS test
diff --git a/docker/Dockerfile.rocm.dockerignore b/docker/Dockerfile.rocm.dockerignore
new file mode 100644
index 000000000..f68737749
--- /dev/null
+++ b/docker/Dockerfile.rocm.dockerignore
@@ -0,0 +1,35 @@
+# Keep the linked source layer small and deterministic.
+.git
+.venv
+/build
+dist
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+.mypy_cache
+
+# Distribution / packaging
+.Python
+/build/
+cmake-build-*/
+CMakeUserPresets.json
+develop-eggs/
+/dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+rust/target/
diff --git a/docker/Dockerfile.xpu b/docker/Dockerfile.xpu
index 018bc4316..da7930ae2 100644
--- a/docker/Dockerfile.xpu
+++ b/docker/Dockerfile.xpu
@@ -40,7 +40,6 @@ ENV VLLM_OMNI_TARGET_DEVICE=xpu
# Keep the upstream oneCCL packages paired with the XPU torch runtime.
RUN --mount=type=cache,target=/root/.cache/uv \
uv pip install --no-build-isolation \
- --extra-index-url https://mirrors.ustc.edu.cn/pypi/simple/ \
".[dev]" && \
uv pip uninstall triton && \
uv pip install triton-xpu==3.7.2 --reinstall
diff --git a/docs/.nav.yml b/docs/.nav.yml
index beb15bf47..da55af813 100644
--- a/docs/.nav.yml
+++ b/docs/.nav.yml
@@ -161,6 +161,7 @@ nav:
- Cache-DiT: design/feature/cache_dit.md
- TeaCache: design/feature/teacache.md
- Diffusion Continuous Batching: design/feature/diffusion_continuous_batching.md
+ - Mooncake KV Transfer: design/feature/mooncake-kv-transfer.md
- Infrastructure and Performance:
- Prometheus Metrics: design/metrics.md
- Speech Generation Performance Optimizations: design/qwen3_omni_tts_performance_optimization.md
diff --git a/docs/README.md b/docs/README.md
index 90a8b6304..3733a9d2d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -56,7 +56,7 @@ vLLM-Omni is flexible and easy to use with:
vLLM-Omni seamlessly supports most popular open-source models on HuggingFace, including:
- Omni-modality models (e.g. Qwen3-Omni, MiniCPM-o 4.5, Cosmos3, HunyuanImage, BAGEL)
-- TTS models (e.g. Qwen3-TTS, IndexTTS 2.5, dots.tts, CosyVoice3)
+- TTS models (e.g. Qwen3-TTS, IndexTTS 2.5, CosyVoice3)
- Diffusion models — image, video, and audio generation (e.g. MiniMax H3, LTX-2.5, SANA-Video, Wan2.2)
- Robot-policy and action models (e.g. π0, GR00T-N1.7, DreamZero-DROID, InternVLA-A1)
diff --git a/docs/cli/bench/serve.md b/docs/cli/bench/serve.md
index 8dc5e1ed8..450a01e5a 100644
--- a/docs/cli/bench/serve.md
+++ b/docs/cli/bench/serve.md
@@ -23,7 +23,9 @@ You can use `vllm bench serve --omni --help=all` to get descriptions of all para
The API endpoint exposed externally, to which clients send their requests.
- `--dataset-name`
- The name of the dataset used; random-mm indicates generating random multimodal inputs (images, videos, audio), while `omniinteract` replays official OmniInteract videos.
+ The name of the dataset used; `random-mm` generates random multimodal inputs (images, videos, audio),
+ `omniinteract` replays official OmniInteract videos, and `videomme` loads Video-MME MCQ videos
+ (`lmms-eval/Video-MME`, MiniCPM OmniEvalKit packing).
- `--num-prompts`
The total number of requests to send, an integer.
@@ -343,6 +345,57 @@ transcript, event, and result artifacts without errors. A valid LISTEN-only case
chunks. Official-manifest eligibility is reported separately because clipped or cancelled output is a benchmark-quality
signal, not a transport failure. This local performance test does not score answer accuracy.
+### Video-MME Benchmark
+
+Video-MME (`--dataset-name videomme`) scores multiple-choice video QA. Default packing is
+OmniEvalKit MiniCPM `minicpm-frames` (up to 96 sampled frames as `image_url`). Pass a local
+mirror with `--dataset-path` / `--videomme-parquet` + `--videomme-video-dir`, or a Hugging
+Face dataset id (`lmms-eval/Video-MME` by default; any `org/name` is accepted when
+`--dataset-name videomme` is explicit). Relative `--videomme-video-dir` values are resolved
+to absolute `file://` URLs. For those URLs, start the server with
+`--allowed-local-media-path` covering the video root; otherwise use `--videomme-inline-local-video`.
+
+For MiniCPM-o 4.5, the default deployment allows 64 images per request. To run the
+96-frame recipe, start the server with a stage 0 override (replace `/path/to/Video-MME`
+with the local video root shared by the benchmark client and server):
+
+```bash
+vllm serve openbmb/MiniCPM-o-4_5 --omni \
+ --allowed-local-media-path /path/to/Video-MME \
+ --stage-overrides '{"0":{"limit_mm_per_prompt":{"image":96,"audio":64,"video":1}}}'
+```
+
+The override applies to this server invocation only. Alternatively, use
+`--videomme-max-frames 64` in the benchmark to stay within the default image limit;
+this evaluates a different frame-sampling setting from the 96-frame recipe.
+
+Run the benchmark against that server:
+
+```bash
+vllm bench serve --omni \
+ --backend openai-chat-omni \
+ --dataset-name videomme \
+ --dataset-path /path/to/Video-MME \
+ --videomme-pack-mode minicpm-frames \
+ --videomme-max-frames 96 \
+ --model openbmb/MiniCPM-o-4_5 \
+ --endpoint /v1/chat/completions \
+ --num-prompts 8 \
+ --max-concurrency 1 \
+ --save-result
+```
+
+Accuracy keys (`videomme_accuracy`, per-duration / domain / task breakdowns) are written into
+the saved JSON. `videomme_accuracy` excludes HTTP failures; `videomme_accuracy_incl_http_fail`
+counts them as wrong. `videomme_submitted` / `videomme_unique_question_ids` show when
+oversampling made the request count differ from unique-question coverage.
+`videomme_skipped_rows` counts rows skipped during sampling because of missing or unreadable
+media or invalid question fields. The opt-in accuracy runner rejects skipped rows, HTTP
+failures, duplicate question IDs, and missing gold answers. This checks the sampled subset;
+it does not establish that a supplied local mirror contains the entire official dataset.
+Use `--videomme-save-eval-items` (or `VIDEOMME_SAVE_EVAL_ITEMS=1`) for per-request
+`videomme_eval_items` rows.
+
### Multi-Modal Benchmark
diff --git a/docs/cli/serve.md b/docs/cli/serve.md
index cf3d068a6..f77503091 100644
--- a/docs/cli/serve.md
+++ b/docs/cli/serve.md
@@ -1,5 +1,67 @@
# vllm-omni serve
+## Multiple API frontends
+
+For local EngineCore pipelines with one or more stages, `--api-server-count` starts
+multiple API frontend processes that share one parent-owned set of stage
+engines:
+
+```bash
+vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni \
+ --api-server-count 2 \
+ --port 8091
+```
+
+This mode is intended for workloads whose request parsing, multimodal input
+processing, or response encoding can bottleneck a single frontend. It
+currently requires local multi-process EngineCore stages with one local
+process group per replica. A stage may still use multiple `num_replicas`.
+It cannot be combined with diffusion, headless or
+remote stages, intra-stage data parallelism, Ray, fault tolerance, elastic
+expert parallelism, sleep mode, or runtime LoRA updating. Runtime voice upload
+and deletion are also disabled because those mutations are process-local;
+built-in voices, inline reference audio, and voices restored at startup remain
+available. The `/v1/omni/sleep` and `/v1/omni/wakeup` control routes return HTTP
+409 for the same reason: their bookkeeping is process-local while stage engines
+are shared.
+
+A single-stage model pipeline is supported through the normal launch command;
+this is distinct from the distributed `--stage-id` / `--headless` launch mode.
+Every stage in the pipeline must be an EngineCore stage. Mixed AR-to-DiT
+pipelines, including MiniMax-H3, remain unsupported even when their first
+stage is an EngineCore stage. Diffusion support requires per-frontend channels
+and shared-engine lifecycle handling in the diffusion backend.
+
+### Workloads and performance validation
+
+Each API process owns its frontend processor, Orchestrator, request state,
+and per-replica EngineCore channels. Requests return through the channel of
+the originating API process; model weights and GPU stage engines are shared.
+This distributes frontend and orchestration work across CPU processes.
+
+| Workload | Potential benefit | Limitation |
+| ---------- | ------------------- | ------------ |
+| Concurrent cold image/video inputs on supported EngineCore pipelines | Parallel frontend processing when one API process is CPU-limited | A single cold request and GPU computation may be unchanged |
+| Many replicas producing frequent text/audio outputs | Less API/Orchestrator work and GIL contention per process | Routing remains serial within each Orchestrator |
+| Warm inputs or low-concurrency, GPU-limited generation | Additional frontend capacity | More API processes may add overhead without improving throughput |
+
+Here, a cold input means media or preprocessing caches miss, not that model
+weights must be loaded or GPU kernels compiled. Each frontend has its own
+processor/cache state, so cache duplication, CPU thread contention, and memory
+usage also matter. Multi-API serving does not itself change the output queue,
+move response encoding to an executor, or change the model's numerical scheduler.
+
+Compare `--api-server-count 1`, `2`, and higher counts with the same hardware,
+model/stage configuration, media, sampling parameters, output lengths, and
+offered load. Keep cold-cache and warmed-cache runs separate and report repeated
+measurements. Record CPU and request counts for every API worker, input and
+output queue delay, GPU utilization, first-output latency, and end-to-end latency.
+Confirm requests reach every worker: connection reuse can concentrate traffic
+on one process. Queue-only or single-API experiments do not establish a
+multi-API throughput gain. The multi-replica workload in
+[#4680](https://github.com/vllm-project/vllm-omni/issues/4680) remains a relevant
+validation target.
+
## Stage-based CLI quickstart
The stage-based CLI is designed for deployments that require launching each pipeline stage in an isolated process
@@ -61,3 +123,10 @@ CUDA_VISIBLE_DEVICES=1 vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni \
## Arguments
--8<-- "docs/generated/argparse_omni/omni_serve.inc.md"
+
+Async video jobs use process-local metadata and task handles. With multiple API
+workers, creating, listing, retrieving, downloading, and deleting these jobs
+returns HTTP 409. This restriction is independent of the current diffusion
+stage launch restriction: supporting multi-worker diffusion also requires a
+shared job lifecycle. Missing frontend topology state returns HTTP 503 for
+operations that require process-local state protection.
diff --git a/docs/configuration/environment_variables.md b/docs/configuration/environment_variables.md
index 4f9b4a50d..3f15cd8cc 100644
--- a/docs/configuration/environment_variables.md
+++ b/docs/configuration/environment_variables.md
@@ -70,6 +70,7 @@ The lifecycle labels used below are:
| `OMNI_DIFFUSION_PROMPT_EMBED_CACHE_SIZE` | Positive integer; default `32` entries | Each diffusion runner; resolved during model setup | A valid environment value overrides the explicit cache size. A non-integer logs a warning; a non-positive value is ignored. | Experimental |
| `OMNI_DIFFUSION_SESSION_STATE_MANAGER` | Boolean with the same accepted spellings as the prompt cache; default disabled | Experimental diffusion session manager; model setup | A recognized environment value overrides the explicit enable setting. An unrecognized value is ignored. | Experimental |
| `OMNI_DIFFUSION_SESSION_STATE_MANAGER_MAX_SESSIONS` | Positive integer; default `64` | Experimental diffusion session manager; model setup | A valid environment value overrides the explicit maximum. A non-integer logs a warning; a non-positive value is ignored. | Experimental |
+| `VLLM_OMNI_AR_DIFFUSION_KV_GATHER` | `1` enables; default `0` (off) | AR-diffusion KV manager at allocation and attention at dispatch; set before worker startup | Only the exact value `1` enables contiguous KV gathering. History staging additionally requires `ARDiffusionKVConfig.reuse_history_staging`. | Experimental |
Backend names for `DIFFUSION_ATTENTION_BACKEND` are the members of
`DiffusionAttentionBackendEnum`, such as `FLASH_ATTN`, `TORCH_SDPA`,
diff --git a/docs/configuration/stage_configs.md b/docs/configuration/stage_configs.md
index aa81d42c6..2540b19d9 100644
--- a/docs/configuration/stage_configs.md
+++ b/docs/configuration/stage_configs.md
@@ -53,7 +53,7 @@ The new deploy schema lives under `vllm_omni/deploy/` and is paired with a froze
| ------- | ------ | ---------- | --------- | ------------- |
| `base_config` | str (path) | optional | — | Overlay parent (relative or absolute). `stages:` / `platforms:` deep-merged by stage_id; other scalars overlay-wins. Intended for user-authored overlays; prod yamls stay flat. |
| `async_chunk` | bool | optional | `true` | Enable chunked streaming between stages. Pin to `false` if the pipeline runs end-to-end. |
-| `session_mode` | str | optional | `"turn"` | Session behavior. Duplex models (pipelines with a `duplex_plugin`, e.g. MiniCPM-o 4.5) set `"duplex"`; `vllm-omni serve` then serves it over `/v1/realtime?duplex=1` and `/v1/chat/completions`, both on duplex sessions. |
+| `session_mode` | str | optional | `"turn"` | Session behavior. For pipelines with a `duplex_plugin`, explicitly select `"duplex"` for the duplex engine or `"turn"` for the ordinary online serving stack. The shipped MiniCPM-o 4.5 default remains `"duplex"`. See [Full Duplex](../serving/full_duplex_api.md#enable-full-duplex). |
| `active_stream_window` | int | optional | `0` | Number of active downstream stream slots; `0` preserves all-stream cycling. |
| `duplex_session` | dict | optional | runtime defaults | Full-duplex session lifecycle, buffering, replay, and capacity limits. |
| `connectors` | dict | optional | `null` | Named connector specs (`{name, extra}`). Referenced by each stage's `input_connectors` / `output_connectors`. See [Connector schema](#connector-schema). |
@@ -290,3 +290,90 @@ vllm serve Qwen/Qwen2.5-Omni-7B --omni --port 8091 --deploy-config /path/to/depl
!!! important
We are actively iterating on the definition of deployment configurations, and we welcome feedback from users and developers.
+
+## Qwen3-TTS with Model Runner V2
+
+Qwen3-TTS can opt into the native CUDA Model Runner V2 pipeline on vLLM
+0.29.0. Select one of these deployment profiles:
+
+| Profile | Runner | Code2Wav graph batches | Intended use |
+| --- | --- | --- | --- |
+| `qwen3_tts.yaml` | V1 | Existing defaults | Existing deployment / regression control |
+| `qwen3_tts_mrv2.yaml` | V2 | B1 | Native runner validation |
+| `qwen3_tts_high_concurrency_mrv2.yaml` | V2 | B1, B2 | Opt-in throughput tuning |
+| `qwen3_tts_high_concurrency_mrv2_b4.yaml` | V2 | B1, B2, B3, B4 | Experimental throughput / buffered playback |
+
+```bash
+vllm serve Qwen/Qwen3-TTS-12Hz-1.7B-Base --omni \
+ --deploy-config vllm_omni/deploy/qwen3_tts_mrv2.yaml
+```
+
+The V2 profiles bound Talker prefill to 512 tokens per step and select the
+Talker AR runner and the Code2Wav generation
+runner together. Native inter-stage delivery carries codec payloads directly;
+request-owned snapshots preserve buffers through asynchronous completion and
+CUDA graph reuse. Terminal completion waits for upstream stage metrics before
+releasing request state. Platform sections retain V1 on NPU, XPU, ROCm and MUSA;
+this change does not qualify MRV2 on those backends or enable other model families.
+Selecting V2 for a stage without `supports_native_mrv2_data_plane` emits a warning
+when pipeline and deployment settings are merged. That stage retains the legacy
+transport path; the warning does not establish support for that combination.
+
+MRV2 model hooks use capability declarations rather than architecture or stage
+names. Omni lifecycle flags select the model state, and `_returns_tuple` declares
+the capture output contract. The optional batched predictor hook is `mtp`, with
+an explicit `mtp_output_key` (a string or two-part payload key), optional
+`mtp_validity_key`, and `mtp_graph_safe`/`mtp_disable_graph` capture controls.
+Its inputs are token IDs, embeddings, previous hidden states and per-row
+conditioning; it returns updated embeddings and prediction codes. Models may
+supply `mtp_sampling_params` and `get_mtp_seed(sampling_params)` for model-local explicit seeds, and declare
+`mtp_accepts_per_row_generators`, `mtp_accepts_req_infos`, or `mtp_sample_uniforms`
+(with `mtp_sample_steps` and `mtp_sample_vocab_size`) as needed. Qwen3-TTS retains
+its existing `talker_mtp` entry point for V1.
+
+### Included performance work
+
+- Request snapshots have a fast path for immutable scalar leaves, including
+ waveform lists. Mutable containers, aliases and cycles keep deep-copy
+ semantics. This is not the historical shallow `dict(prompt)` experiment.
+- The API reference cache holds owned float32 arrays with a default capacity
+ of 1024 entries and a 512 MiB waveform-payload budget. Cache hits return
+ independent lists. Qwen3-TTS model artifact caches also default to 1024
+ entries. These caches have different owners and eviction policies; equal
+ entry limits do not make them a single coherent cache.
+- Talker state stays on GPU where its lifecycle allows it. BOS/EOS projections
+ are cached in their projection dtype and invalidated on weight loading.
+- Code2Wav packs CPU codec inputs before device transfer. Optional B2/B4 graph
+ buckets batch compatible requests without sharing their per-request state.
+- Native output materialization runs in a bounded worker and drains before
+ closing the data plane. The existing control-only shortcut avoids launching
+ model work for a step that has only lifecycle events.
+
+MTP prefix re-prefill remains disabled in the high-concurrency V2 profile.
+Adding more graph shapes increases compilation cost and has not established a
+stable end-to-end gain for this extracted version.
+
+### Decoder batches and playback
+
+Changing `decode_cudagraph_batch_sizes` selects the captured batch buckets.
+Keep `decode_batch_max_size` consistent with the intended maximum too; the
+stateful graph path currently groups according to the captured buckets, while
+the stateless path also uses the explicit maximum.
+
+B4 remains experimental. First-packet latency alone does not establish
+uninterrupted playback. Validate inter-chunk arrival times, buffering, WER and
+speaker similarity before adopting either batching preset for a production
+workload. Floating-point decoder outputs can differ across batch sizes; this PR
+does not claim bitwise or quality equivalence.
+
+### Optional MPS deployment
+
+NVIDIA MPS is an optional operator setting for colocated CUDA processes, not a
+YAML option or a library default. This PR does not establish a throughput or
+first-packet latency benefit from MPS. Measure the exact deployment with and
+without MPS before enabling it.
+
+Use only assigned GPUs and an independent MPS pipe directory. A private MPS
+server does not provide exclusive GPU ownership or MIG isolation. For a
+single-GPU deployment, explicitly place both stages on that GPU; the supplied
+high-concurrency profile places its two stages on different GPUs by default.
diff --git a/docs/design/architecture_overview.md b/docs/design/architecture_overview.md
index 862516831..8b7168824 100644
--- a/docs/design/architecture_overview.md
+++ b/docs/design/architecture_overview.md
@@ -323,7 +323,7 @@ inputs, fields, and ownership rules are described below.
flowchart TB
layer1["Layer 1 · Authoring inputs PipelineConfig + DeployConfig"]
layer2["Layer 2 · Production resolution boundary resolve_omni_config() (StageConfigFactory + VllmOmniConfig internally)"]
- layer3["Layer 3 · Startup hand-off OmniConfigResolution PipelineConfig + temporary OmegaConf stage bridge"]
+ layer3["Layer 3 · Startup hand-off OmniConfigResolution PipelineConfig + typed stage configs"]
layer4["Layer 4 · Runtime launch planning StageRuntime"]
layer5["Layer 5 · Engine materialization VllmConfig / OmniDiffusionConfig"]
@@ -335,10 +335,10 @@ The production resolution boundary is `resolve_omni_config()` in
It delegates typed construction to `StageConfigFactory.create_from_model()` and
`VllmOmniConfig.from_pipeline_config()`, then returns an
`OmniConfigResolution` consumed by both `AsyncOmniEngine` and headless startup.
-Until `StageRuntime` consumes typed stage configs directly, this envelope carries
-the effective `PipelineConfig` alongside OmegaConf-compatible `stage_configs` as
-a temporary runtime bridge; both views describe the same resolved topology,
-including injected stages.
+This envelope carries the effective `PipelineConfig` alongside typed
+`stage_configs`, which `StageRuntime` consumes directly. Both views describe the
+same resolved topology, including injected stages. Backend arguments are
+projected from these typed stages when each engine is initialized.
The legacy `stage_args` YAML path has been removed. Model topology now resolves
through `PipelineConfig`, with runtime overrides supplied by `DeployConfig`.
@@ -360,7 +360,7 @@ The important ownership rules are:
3. CLI and Python overrides are applied at the resolution boundary, with
per-stage overrides taking precedence over global values where supported.
4. `OmniConfigResolution` is the sole startup hand-off. Its `pipeline_config`
- and temporary `stage_configs` compatibility view must describe the same
+ and typed `stage_configs` must describe the same
topology.
5. `StageRuntime` owns launch planning and replica lifecycle. `ReplicaInitPlan`
is runtime-private state, not a user configuration object.
diff --git a/docs/design/feature/mooncake-kv-transfer.md b/docs/design/feature/mooncake-kv-transfer.md
new file mode 100644
index 000000000..ed83d562f
--- /dev/null
+++ b/docs/design/feature/mooncake-kv-transfer.md
@@ -0,0 +1,89 @@
+# Mooncake KV Transfer
+
+## PR summary
+
+This change adds an opt-in AR-to-DiT KV handoff using vLLM's native
+`KVTransferConfig`, Scheduler-owned diffusion KV pages, and
+`MooncakeConnector`. The existing `OmniKVTransferManager` path remains the
+fallback when `kv_transfer_config` is absent.
+
+The orchestrator creates one transfer ticket per request and resolves the
+bound AR replica's Mooncake endpoint after generation. DiT allocates the
+destination pages, waits for every worker rank to finish loading, and releases
+the source and destination pages only after the connector lifecycle completes.
+Request registration failures are rolled back before Worker dispatch. Receive
+timeouts and cancellation terminate the request without recycling in-flight
+pages: the scheduler retains them until every CFG row has completed on every
+rank. Late completion is polled only while such requests remain. If a peer
+never completes, its pages remain reserved until shutdown; other requests can
+continue using the remaining capacity. Invalid pages, missing Worker ranks,
+and failures without a proven rollback still stop the replica before teardown.
+The example sets `transfer_timeout: 60.0` seconds explicitly. Cancellation
+queued during a synchronous receive is processed when that receive completes
+or times out; it does not interrupt the remote write.
+
+## Reference configuration
+
+| Stage | Replicas | Devices | Parallelism | KV cache |
+| --- | ---: | --- | --- | ---: |
+| AR | 2 | 0-3 | TP=2 per replica | 2 GiB per worker |
+| DiT | 2 | 4-7 | TP=2 per replica, EP enabled | 1 GiB per worker |
+
+The acceptance workload uses 512x512 images, two denoising steps, guidance
+scale 2.0, and `max_num_seqs=1`.
+
+For a four-GPU debug run, set both stages to one replica and assign AR TP=2 to
+devices `0,1` and DiT TP=2 to devices `2,3`.
+
+## Experiment
+
+The final comparison used one node with eight NVIDIA RTX PRO 6000 Blackwell
+Server Edition GPUs, TCP Mooncake transport, the same 50-prompt/seed T2I
+dataset, concurrency 8, and two independent 100-request runs per
+implementation. Each side completed 200/200 requests without an OOM or request
+failure.
+
+| Implementation | Run 1 (req/s) | Run 2 (req/s) | Mean (req/s) |
+| --- | ---: | ---: | ---: |
+| `OmniKVTransferManager` | 4.4103 | 4.4497 | 4.4300 |
+| Native `MooncakeConnector` | 4.4457 | 4.4699 | 4.4578 |
+
+Native throughput is **0.63% higher** than the legacy mean. The absolute
+performance difference is below the 1% acceptance threshold.
+
+For accuracy, a non-zero transferred prefix and the resulting attention output
+were compared bit-for-bit with the legacy manager path:
+
+```text
+prefix_bits_equal True
+attention_bits_equal True
+max_abs_diff 0.0
+```
+
+The one-AR/one-DiT TP=2 debug topology also completed 20/20 sequential
+requests. A separate real-TCP transport check transferred both CFG rows from a
+TP=1 producer to a strict-Ulysses SP=2 consumer with exact values on both
+target ranks.
+
+## Scope and limitations
+
+- The fully validated end-to-end topology is 2x AR TP=2 plus 2x DiT TP=2.
+- Heterogeneous TP=1 to SP=2 reshaping is transport-tested, but arbitrary mixed
+ TP/CFG/SP end-to-end combinations have not been exhaustively validated.
+- CFG-parallel end-to-end deployment is not part of this acceptance run.
+- Native AR-to-DiT transfer currently requires `async_chunk: false`.
+- TCP is covered by the acceptance run. The supplementary single-node RDMA
+ measurements use a separate short workload; they do not establish RDMA
+ support for multi-node deployment, which remains out of scope.
+- The native path currently validates the two-stage `AR(0) -> DiT(1)` graph. Other stage graphs are rejected during startup until
+ their producer/consumer edge mapping is implemented.
+- Sleep mode is disabled for the native paged path because registered KV pages
+ must remain mapped for the connector lifetime.
+
+- Ascend NPU adaptation and its performance validation are maintained in a
+ separate follow-up PR; the GPU acceptance results above do not validate NPU.
+- The homogeneous piecewise CUDA batching optimization is retained. A native
+ paged-attention CUDA graph capture/replay regression covers two CFG rows,
+ strided QKV, mixed causal/image spans, changed inputs, and output stability.
+ It must be run on CUDA hardware; CPU unit tests do not establish graph or
+ end-to-end performance acceptance.
diff --git a/docs/design/feature/offloader/README.md b/docs/design/feature/offloader/README.md
index 0ec81f3b5..52797b68c 100644
--- a/docs/design/feature/offloader/README.md
+++ b/docs/design/feature/offloader/README.md
@@ -84,10 +84,22 @@ Block topology comes from the pipeline `OffloadPlan` first: `block_attrs` maps
each DiT path to its ordered block containers, `encoder_block_attrs` declares
streamable encoder stacks, `on_demand_component_paths` marks pipeline-managed
residency, `resident_dit_paths` marks the DiTs that may hold resident layers,
-and `encoder_dlo_weight_replication` marks the encoders whose loader-produced
-weights are safe for AllGather. DiTs absent from the plan fall back to
-`_layerwise_offload_blocks_attrs` (including the deprecated singular-name
-compatibility path).
+`encoder_dlo_weight_replication` marks the encoders whose loader-produced
+weights are safe for AllGather, and `offload_submodules` maps a DiT submodule
+that owns its residency to its own block container. DiTs absent from the plan
+fall back to `_layerwise_offload_blocks_attrs` (including the deprecated
+singular-name compatibility path).
+
+An undeclared DiT submodule joins the plan only when it is large enough that
+keeping it resident would defeat streaming; its block container is then found
+by scanning well-known attribute names, which warns once per submodule class.
+Size is computed from parameter shapes and dtypes, including meta parameters,
+so resolving before mmap loading preserves the same residency decision.
+Block ownership validation includes nested components: a block shared with a
+parent, sibling, or encoder is rejected before any hooks or storage are changed.
+A submodule with no block container must implement the `load_to_device` /
+`offload_to_cpu` lifecycle, and the resolver rejects it before any component of
+the pipeline is placed or hooked.
The resolver is pure: it moves no tensor, installs no hook, writes no module
attribute, and reads no process group — multi-rank facts come from
diff --git a/docs/design/feature/omni_async_output_materialization.md b/docs/design/feature/omni_async_output_materialization.md
index 50a2e7c52..eff3024d8 100644
--- a/docs/design/feature/omni_async_output_materialization.md
+++ b/docs/design/feature/omni_async_output_materialization.md
@@ -318,18 +318,18 @@ The same behavior applies to the Base and VoiceDesign Qwen3-TTS checkpoints
because they use the same Talker implementation.
!!! warning
- Do not pass `--no-async-chunk` or enable prefix caching when you want this
- optimization. Either change causes the runner to fall back to synchronous
- output construction. Enabling async chunk alone cannot activate the feature
- for a model that has not opted into async Omni output.
+ Do not pass `--no-async-chunk` when you want this optimization. Disabling
+ async chunk causes the runner to fall back to synchronous output
+ construction. Enabling async chunk alone cannot activate the feature for a
+ model that has not opted into async Omni output.
!!! note "Prefix cache compatibility"
- Async Omni output materialization and Omni prefix caching cannot currently
- run together. `_should_use_async_omni_output()` returns `False` whenever
- `self.omni_prefix_cache` is present, so prefix caching selects synchronous
- output materialization. Supporting both features requires snapshotting or
- otherwise synchronizing prefix-cache merge and update state before the
- background output path can consume it safely.
+ Prefix cache and async Omni output can run together. `save_outputs` returns
+ a `step_id`; the output builder later calls `materialize(sid, req_ids)` with
+ the save-time request list, which may be a step late relative to the live
+ `input_batch`. `_should_use_async_omni_output()` does not disable itself
+ when the cache is present. See
+ [Automatic Prefix Caching](prefix_caching.md#implementation).
## Compatibility and Fallbacks
@@ -341,10 +341,9 @@ runtime conditions hold:
| AR async scheduling is enabled | The optimization relies on the scheduler advancing while the prior output is materialized |
| `async_chunk` is enabled | The feature targets incremental downstream Omni payloads |
| The model stage opts in with `use_async_omni_output` | Models must declare that their output lifecycle is safe to defer |
-| Omni prefix cache is disabled | Prefix-cache merge and update ordering currently requires synchronous materialization |
| Speculative decoding is disabled | Speculative output state is not included in this deferred path |
| Routed-expert output is disabled | Routed-expert extraction currently requires the synchronous path |
-| Postprocess is absent or explicitly runs eagerly | State needed by the next decode step must be updated before the runner returns |
+| Postprocess is absent or explicitly runs eagerly | State needed by the next decode step must be updated before the runner returns. Eager postprocess sees the scheduled slice (`None, None` combined tensors), not the prefix-cache-merged full prompt; it must only consume the tail |
These checks are evaluated per stage on runners based on `GPUARModelRunner`.
An unsupported combination does not prevent serving; it only falls back to
@@ -380,6 +379,8 @@ so Omni payload materialization remains synchronous.
- `tests/worker/test_gpu_ar_model_runner.py`: Snapshot, guard, connector
ordering, and background error-propagation tests.
- [Async Chunk](async_chunk.md): Inter-stage chunking and scheduling design.
+- [Automatic Prefix Caching](prefix_caching.md#implementation): Prefix-cache
+ `step_id` / `materialize` contract used by the deferred output builder.
- [Qwen3-Omni optimization blog](https://vllm.ai/blog/2026-07-01-qwen3-omni-optimization):
Optimization context and controlled performance results.
- [PR #4476](https://github.com/vllm-project/vllm-omni/pull/4476): Feature
diff --git a/docs/design/feature/prefix_caching.md b/docs/design/feature/prefix_caching.md
index a8fe4fc50..5aeef0f77 100644
--- a/docs/design/feature/prefix_caching.md
+++ b/docs/design/feature/prefix_caching.md
@@ -1,6 +1,5 @@
# Automatic Prefix Caching in Omni Models
-
---
## Table of Contents
@@ -9,6 +8,8 @@
- [High-Level Approach](#high-level-approach)
- [Example](#example)
- [What About Multimodal Inputs?](#what-about-multimodal-inputs)
+- [Implementation](#implementation)
+- [Related Files](#related-files)
---
@@ -27,6 +28,7 @@ vLLM implements automatic prefix caching for managing its kv-cache, which is bes
This document describes vLLM-Omni's mechanism for caching tensor outputs that are meant to be passed between stages, when requests have common prefixes, similar to the way in which vLLM has prefix caching for the kv-cache. This works in conjunction with vLLM's multimodal encoder caching, but is distinct. See the final section for a concrete example for how they tie together in practice.
### High-Level Approach
+
!!! note "Note 2"
Prior to reading this section, it's recommended to take a look at the design documents in vLLM for [Automatic Prefix Caching](https://docs.vllm.ai/en/latest/features/automatic_prefix_caching/), which will make some of the concepts more clear.
@@ -38,8 +40,10 @@ The main focus of vLLM-Omni's approach to prefix caching stage outputs is to bui
With this in mind, consider the set of blocks in a 2D layout, where the row represents the index of blocks being considered, and the columns represent the slots corresponding to tokens within each block. Since we know the `num_blocks` and `block_size` from our kv cache config, if we want to cache a tensor with feature size `D`, we can preallocate a CPU tensor of size `(num_blocks, block_size, D)`, and use the same block index and slot mapping to retrieve the corresponding feature vector.
+Host footprint: each cached key costs `num_blocks × block_size × D × dtype_bytes` of **pinned** CPU memory (pinned so device→host can overlap compute), allocated on the first `save_outputs` that sees the key — the first real request pays the `cudaHostAlloc`. Measured on a Qwen3-Omni deployment: thinker `__hidden_states__` `[15092, 16, 2048]` bf16 ≈ 0.92 GiB (plus the same again for each `hidden_states.layer_*` key a model exposes), Qwen3-TTS talker `codes.audio` `[16180, 16, 16]` ≈ 33 MiB. Budget host RAM for the stage accordingly.
### Example
+
!!! note "Note 3"
Prefix caching in vLLM-Omni currently is only supported on AutoRegressive stages with one kv-cache group. Configure it with the pipeline-wide `enable_prefix_caching` field in the deploy config.
@@ -56,7 +60,7 @@ The prefix cache flow is then outlined below.
2. Say we process the request `The quick brown fox was tired and slept beneath the shady tree`, which is 12 tokens and evenly divides into 3 blocks as shown below.
-```
+```text
[ The quick brown fox ] [ was tired and slept ] [beneath the shady tree ]
Block 1: |<--- block tokens ---->|
Block 2: |<------- prefix ------>| |<--- block tokens --->|
@@ -65,10 +69,9 @@ Block 3: |<------------------ prefix -------------------->| |<--- block tokens -
When the request processes, we inspect the multimodal outputs and identify the `mm_feature` tensor, which will be of shape `(seq_len, feature_dim)`, i.e., `(12, 16)` in this example. We note that the first axis is dependent on the `seq_len` and add a new cache_tensor of shape `(num_blocks, block_size, feature_dim)` to our multimodal cache for tensors.
+1. If we lay out the cache as a 2D tensor of shape (`num_blocks`, `block_size`), we'll have something like the following:
-3. If we lay out the cache as a 2D tensor of shape (`num_blocks`, `block_size`), we'll have something like the following:
-
-```
+```text
0: [ The quick brown fox ]
1: [ was tired and slept ]
2: [beneath the shady tree ]
@@ -78,7 +81,8 @@ When the request processes, we inspect the multimodal outputs and identify the `
```
Or, if we flatten it down to 1D,
-```
+
+```text
0: The
1: quick
2: brown
@@ -90,7 +94,8 @@ Or, if we flatten it down to 1D,
```
which we can think of as row indices into the hidden states tensor if we view it as the 2D shape `(num_blocks x block_size, feature_dim)`. That is, the analogous flattened (from 3D -> 2D) mapping of the cache for hidden states becomes the following.
-```
+
+```text
0:
1:
2:
@@ -103,10 +108,9 @@ which we can think of as row indices into the hidden states tensor if we view it
Similarly, for the multimodal outputs cache, the flattened coordinates are the same, but the `mm_feature` maps to vectors of length `16` instead of the hidden size of `2`. Note that in practice, we may have multiple multimodal output tensors per forward pass, which may have different names and different feature dimensions.
+1. Now, say that we receive a new request `The quick brown fox jumped over the dog`.
-4. Now, say that we receive a new request `The quick brown fox jumped over the dog`.
-
-```
+```text
[ The quick brown fox ] [ jumped over the dog ]
Block 1: |<--- block tokens ---->|
Block 2: |<------- prefix ------>| |<--- block tokens --->|
@@ -116,7 +120,7 @@ Here, we will have a cache hit for `Block 1` which will be detected by vLLM base
Since we have the block indices / slot mappings from the kv cache manager, we can simply mirror the mappings and leverage the same indices for the cached hidden states and multimodal outputs. This allows us to look up the correct tensors from our externally maintained 3D caches.
-```
+```text
0: [ The quick brown fox ] < already in the cache
1: [ was tired and slept ]
2: [beneath the shady tree ]
@@ -129,11 +133,11 @@ Since we have the block indices / slot mappings from the kv cache manager, we ca
Finally, to pass the full hidden states and multimodal outputs to the next stage, we simply concatenate the cached contents with the corresponding new tensors computed from the current forward call.
-
### What About Multimodal Inputs?
+
It's also useful to consider the case about how Omni prefix caching is handled when we have multimodal inputs that don't cleanly end on block boundaries, as well as how this works with multimodal encoder caching in vLLM. For example:
-```
+```text
[ Im0 Im1 Im2 Im3 ] [ Im4 Im5 foo ]
Block 1: |<--- block tokens ---->|
Block 2: |<------- prefix ------>| |<--- block tokens --->|
@@ -147,9 +151,9 @@ In reality, this isn't a big problem for correctness, because vLLM also maintain
- The hash describing the image data starting at position 0 and with length 6
- In vLLM's encoder cache, a mapping from the image hash above to the encoder output
-
To understand what happens, say we get the following input as a second request:
-```
+
+```text
[ Im0 Im1 Im2 Im3 ] [ Im4 Im5 bar baz ]
Block 1: |<--- block tokens ---->|
Block 2: |<------- prefix ------>| |<--- block tokens --->|
@@ -162,3 +166,162 @@ Because we have multimodal data in a scheduled span that isn't fully precomputed
When we pass our multimodal tensors to the language model component in the same stage, we'll then expect the same outputs, because the prefix caching behaviors in vLLM-Omni / vLLM match, so the LLM will use vLLM's KV cache manager's prefix caching to correctly handle the attention information for `Block 1` while calculating the outputs for `Block 2`, giving us the correct results for processing `Block 2` with the context of `Block 1`.
Finally, we look up the output hidden states/multimodal tensors corresponding to the prefix cache hit `Block 1` and concatenate it with the forward pass result to get the final result, which is expected to be identical to the full hidden states when prefix caching is disabled.
+
+### Implementation
+
+The block/slot model is `vllm_omni/core/prefix_cache/`.
+`OmniPrefixCacheManager` owns slot occupancy, the request-task table,
+hit spans, and merge.
+`OmniPrefixCacheController` moves data: a reusable `StagingBufferPool` for
+this step's device→host copy, and writes into the durable `PrefixBlockPool`.
+The state lock covers those tables only.
+
+Miss is not an error (this step's forward slice only). A hit span whose
+hidden rows are absent is fatal. For mm keys the rule is looser: a model may
+emit a key only for some requests, so a hit span with no rows behind an mm key
+reads zeros from the pool for those positions rather than raising. Abort still
+writes: once a hash entered this step's batch it must land in the cache.
+
+`enable_prefix_caching` is refused on KV-consumer stages (`kv_role` of
+`kv_consumer` or `kv_both`). KV received from a producer is reported as
+`num_computed_tokens` too, and the manager cannot tell it from a local hit.
+Producer-only stages are unaffected. Pooling stages never save, so they get
+no cache. This gate is one function, `stage_prefix_cache_config`, called by
+both the GPU and the NPU model runner at kv-cache init.
+
+Which stages may set `enable_prefix_caching: true`:
+
+| Stage | `enable_prefix_caching` | Why |
+| --- | --- | --- |
+| AR stage with one full-attention kv group whose hidden states / per-token mm feed the next stage (Qwen3-Omni thinker and talker) | supported | The case the cache is built for: full-prompt hidden states are merged from the pool on a hit. |
+| AR stage that sets `requires_full_prefix_cached_hidden_states = False`, optionally with `deferred_prefix_cache_mm_keys` (Qwen3-TTS talker, Higgs v3 talker) | supported | Hidden is not cached; deferred codec rows are written once on finish. |
+| Pooling stage | ignored | Never saves; the gate returns no config. |
+| `kv_role: kv_consumer` / `kv_both` | refused at kv-cache init (`OmniPrefixCacheUnmatchError`) | Producer KV shows up as `num_computed_tokens` and is indistinguishable from a local hit. |
+| Speculative decoding on the stage | refused at kv-cache init | Under async scheduling vLLM keeps `num_computed_tokens_cpu` optimistic (all drafts accepted) during the forward and corrects it afterwards; `step_slots_cpu` would mirror rows at the wrong slots. Not verified; refused as a whole. |
+| `prefix_match_unit` smaller than `block_size` | refused at kv-cache init | Sub-block hits make `num_computed_tokens` unaligned; the hit registry only mirrors whole blocks. |
+| Hybrid / sliding-window / multi-group kv cache (e.g. a talker with `attention_type: sliding_recompute`) | refused at kv-cache init | The cache mirrors exactly one full-attention block table. |
+| Attention backend whose kernel block size differs from `--block-size` (FlashInfer / FlashMLA / CutlassMLA with a block size they do not list natively), or decode context parallel | refused at first step (`FullAttentionGroupView`) | `step_slots_cpu` computes `table[req, pos // block_size] * block_size + pos % block_size` over allocator block ids; hybrid kernel blocks and DCP token striping change that row layout. FlashAttention / Triton accept any multiple of 16 and never split blocks. |
+| Codec decoder / Code2Wav stages (Qwen3-Omni stage 2, Qwen3-TTS stage 1) | keep `false` | Nothing downstream consumes their hidden states; the cache would only add device→host copies. Not validated. |
+| Diffusion stages | n/a | No vLLM KV cache to mirror. |
+
+Hit spans come from `scheduled_new_reqs` only, as in the pre-refactor cache:
+
+- A new request with a (partial) prefix hit is the normal path: the hit
+ blocks are read from the pool, the rest is this step's rows, and the
+ divergent tail is written under its own blocks. The gather starts on the
+ prefetch thread at `new_step_starts`; a same-step hit (vLLM hashes blocks
+ at schedule time, so `b` can hit blocks `a` computes in the same forward)
+ cannot plan until `a`'s write is registered and starts at `save_outputs`
+ instead. Either way it runs before the next step can hand those blocks
+ to a new tenant. vLLM frees blocks one step before `finished_req_ids`
+ arrives, so a finished request whose last step materializes late may
+ still find a hit slot reassigned. Each `(slot, key)` carries a write
+ version, bumped whenever a new write claims it. A planned read captures
+ that version and is registered in `_pending_reads`; a later write that
+ reclaims those slots copy-on-writes the still-`COMMITTED` rows into the
+ ref before it overwrites the pool, so a delayed fetch serves the original
+ tenant. A version mismatch with no preserved copy raises for live and
+ finished alike (the pool rows are a newer tenant's). Production defaults
+ stay opt-in until preempt/resume hit spans are reconstructed.
+- `async_chunk` continuation: when the next upstream chunk arrives, the same
+ request id re-enters `scheduled_new_reqs` with `num_computed_tokens` equal
+ to what it already computed itself. Ids already in `live_reqs` are skipped
+ for hit marking: those rows were delivered in earlier steps and re-emitting
+ them would duplicate output. A `delivered_upto` span for this case is
+ Phase 2.
+- Preemption + reschedule: vLLM resets `num_computed_tokens` to 0 on
+ preemption and re-runs prefix matching on resume, so the resumed request
+ can come back with a fresh hit. With the V1 model runner it arrives
+ through `scheduled_cached_reqs` (id in `resumed_req_ids`, `new_block_ids`
+ replaces the table); with the V2 runner it re-enters `scheduled_new_reqs`
+ while still in `live_reqs`. Neither path marks an omni hit span: the
+ resumed request gets only the rows it recomputes, and its still-open
+ deferred write keeps appending (a slot written twice keeps the later
+ chunk). Cache integrity holds either way — the hit blocks already have
+ rows, from this request or the one it hit. Stages that need full prompt
+ hidden states should be sized so preemption does not occur while prefix
+ caching is on. Same as before this refactor; tracked for Phase 2.
+
+Two write paths, split by `ModelCachePolicy.deferred_keys`:
+
+- Immediate (`JOIN_NEXT_STEP`): save launches a whole-step device→host into
+ a staging slot; the committer waits that event and writes the CPU pool.
+ The next save waits `done` (the pool write): a reused slot must never
+ leave a pending pool write behind, or a delayed hit read of the old rows
+ would find nothing recoverable.
+- Deferred (`JOIN_ON_FINISH`): mm whose first dim is this step's token count
+ stays on a per-request GPU clone; `_WriteChunk`s append across steps;
+ finish/abort (or GPU-byte-budget pressure) forces the copy. One open
+ WriteTask per request; a budget flush may close it mid-request, in which
+ case the next save opens a new one (`write_n` + 1) and a hit reads both,
+ so one long request cannot pin the whole budget.
+
+A `WriteTask` moves through `TaskState` only via `transition()`, one step at
+a time along a strict chain:
+`PENDING` (registered, not queued) → `QUEUED` (on a copy queue) →
+`COPYING` (one thread owns the copy stage) → `HOST_READY` (host rows ready) →
+`WRITTEN` (in the CPU pool); `FAILED` is reachable from any non-terminal
+state. Skipping a step raises. The worker claims `COPYING` in the same `_wake`
+critical section as the queue pop, so `escalate` never re-queues a task it can
+see is already claimed. `host_ready` / `done` are wait primitives set by the
+transitions into `HOST_READY` / `WRITTEN` / `FAILED`. GPU-clone bytes are
+charged once per clone on a `_BudgetTicket` pinned by every task that views
+it, and uncharged when the last holder releases (idempotent per tid).
+
+Mm whose first dim equals the unpadded scheduled length *or* the CUDA-graph
+padded length is registered on first sighting. Talker `codes.audio` is a
+cat of scheduled rows and stays unpadded while hidden is padded; both must
+open a pool key, whether immediate or deferred.
+Leftover mm (lists, `codes.ref`, any tensor whose first dim is not this
+step's token count) is copied to CPU at save without truncating that first
+dim. That leftover copy is the async-builder read replica for this step; it
+does not write the pool or carry abort/preempt occupancy.
+
+```python
+cache.register_policy(ModelCachePolicy.from_model(model)) # load_model
+cache.new_step_starts(scheduler_output) # before _update_states
+sid = cache.save_outputs(hidden, mm_outputs, num_tokens_unpadded=n,
+ num_tokens_padded=n_pad)
+outs = cache.materialize(sid, req_ids) # or discard_step(sid)
+```
+
+Each step id is consumed exactly once. `req_ids` must be a subset of the save
+snapshot. At most `staging_depth` unused step ids may exist at once: every
+`save_outputs` claims one staging slot, including saves with only leftover
+mm that copy no device→host page. A slot is also held by each immediate
+write that views it, until the committer's pool write. A later save waits
+for `materialize`/`discard_step` or that pool write to free a slot;
+`staging_claim_timeout_s` then errors with the unused ids and the task count.
+`join`/`join_host_ready` use the same bound and raise with the stuck task's
+id and state instead of hanging the caller.
+`materialize` may run on the async output builder after the engine has
+entered the next step; leftover mm (not written to the pool) is copied
+to CPU at `save_outputs` so the builder never reads live CUDA-graph
+buffers. See
+[Async Omni Output Materialization](omni_async_output_materialization.md).
+
+The cache is constructed only on the last pipeline-parallel rank
+(`_ensure_omni_prefix_cache`). Other ranks skip it: they never call
+`save_outputs`, so a hit table there would resolve to absent slots.
+
+Threads, locks, and what each may block on:
+
+| Thread | Role | May block on | Must not hold while blocked |
+| --- | --- | --- | --- |
+| Engine | `new_step_starts`, `save_outputs` | previous-step `join` (`done`) / finished-write `join_host_ready`; `reserve()` GPU-byte flush; staging-slot claim; `dispatch()` / finish-abort `escalate()` (eager mode: the copy + pool write run inline) | `_state_lock` |
+| Async output builder | `materialize` (may overlap the next engine step) | this step's `step_d2h_event`; `join` (`done`); deferred `fetch_host` | `_state_lock` |
+| Committer | `_worker_loop`: wait device→host / deferred copy / pool write | `_wake.wait`; `step_d2h_event` or copy-stream sync | never takes `_state_lock` |
+| Prefetch pool | hit-span gather during forward | `join` (`done`); deferred `fetch_host` | `_state_lock` |
+
+| Lock | Covers | Does not cover |
+| --- | --- | --- |
+| manager `_state_lock` | occupancy tables, step contexts, hit spans, task registration, pool-key publish (`install_key`) | join, GPU-byte flush, copy, `step_d2h_event` wait, pool-key allocation, eager `dispatch()` / `escalate()` |
+| controller `_lock` / `_wake` | task registry, queues, GPU-clone byte budget | device→host / pool-write body (released before `synchronize`) |
+| `WriteTask.lock` | `state`, `reassigned`, `append_chunk` | waiting on `host_ready` / `done` (those are events) |
+
+### Related Files
+
+- `vllm_omni/core/prefix_cache/`
+- `vllm_omni/worker/gpu_model_runner.py` (`_ensure_omni_prefix_cache`)
+- `tests/core/test_prefix_cache.py`
+- [Async Omni Output Materialization](omni_async_output_materialization.md)
diff --git a/docs/design/fullduplex-personaplex.md b/docs/design/fullduplex-personaplex.md
index 33d125c97..6d32cd8e3 100644
--- a/docs/design/fullduplex-personaplex.md
+++ b/docs/design/fullduplex-personaplex.md
@@ -271,3 +271,111 @@ The required evidence is:
Audio that is empty, all zero, non-finite, or only a protocol `listen` event is
not a successful end-to-end result.
+
+### Paced multi-session load driver
+
+The existing driver keeps its two-session admission and slot-reuse validation
+when `--sessions` is omitted. Passing `--sessions N` selects a separate,
+bounded load mode; it does not replace the lifecycle test or change server
+admission capacity. Start an existing PersonaPlex server configured to admit
+the requested number of sessions, then run from a source checkout with the
+vLLM-Omni client dependencies installed:
+
+```bash
+python -m tests.e2e.online_serving.personaplex_realtime_duplex \
+ --model nvidia/personaplex-7b-v1 \
+ --input-wav /path/to/input.wav \
+ --sessions 2 --load-frames 1000 --drain-s 2 \
+ --server-revision SERVER_COMMIT --server-hardware A100-80GB \
+ --output-dir /tmp/personaplex-load-n2
+```
+
+Use a new output directory for every run. The driver refuses to overwrite an
+existing `load-result.json`. The server labels are supplied by the operator,
+not detected or verified by the client. Record the server command, package
+versions, checkpoint revision and hardware alongside a published measurement.
+
+All attempted sessions finish admission before admitted sessions share a
+common input start. A rejected session remains a failed row in the report;
+it is not removed from the denominator. Each session receives at most
+`--load-frames` input frames, without looping the WAV, and uses 80 ms pacing.
+A stalled send cannot cause a catch-up burst. The timeline records send
+schedule lateness so an overloaded client is visible rather than mistaken
+for a faster server. This mode measures steady concurrency, not join/leave
+interference; the original lifecycle mode still checks slot reuse.
+Load mode does not probe an additional N+1 session for `resource_exhausted`;
+the lifecycle mode owns that admission-limit check. A per-session
+`client_pacing_warning` and the summary's `client_pacing_warning_sessions`
+identify send-lateness p99 above one nominal frame (80 ms). This is a warning,
+not an extra acceptance gate: read it alongside server-facing measurements
+so a slow client is not mistaken for a slow server.
+
+The fixed drain window is part of the measurement configuration. Audio
+arriving during cleanup is excluded, so closing cannot rescue a session that
+missed its observation deadline. Cleanup is attempted for admitted sessions
+even when audio validation fails. Protocol errors, missing/invalid audio,
+shared response IDs and cleanup failures make the report fail and the CLI
+exit nonzero. Cancellation closes transports and propagates to the caller.
+`--cleanup-timeout-s` (default 5 s) bounds session-close send and acknowledgement
+together, independently of `--timeout-s`. The subsequent WebSocket close
+handshake has the same separate bound; an unresponsive close acknowledgement
+cannot hold cancellation for the full inference timeout.
+
+`load-result.json` retains per-session send and audio-packet timelines using
+the client's monotonic clock. It does not export handshake credentials or
+raw audio payloads. Metric definitions are explicit:
+
+Both modes validate each nonempty audio packet's strict base64 encoding, PCM16
+sample alignment, 24 kHz sample rate and response identity. Valid aggregate
+audio cannot hide a malformed packet. In load mode, rejected packets make the session fail
+and appear in `invalid_audio_packets` with their event index, receive time and
+fixed diagnostic code; they do not contribute samples or timing intervals.
+Empty audio deltas remain legal and contribute no samples. This check does
+not change the public client's decoding. The lifecycle scenario and dispatch
+remain the same, but malformed packets that aggregate checks once tolerated
+now fail that mode as well.
+
+The probe accepts both the current OpenAI Realtime audio event name
+`response.output_audio.delta` and the legacy `response.audio.delta`. Validation
+uses the wire payload directly rather than relying on a particular client
+library's alias table, so a server-side event-name migration cannot silently
+turn real audio into a zero-output measurement.
+
+| Field | Meaning |
+| --- | --- |
+| `client_audio_packet_interval_ms` | Consecutive nonempty packet arrivals: median, linear p99, max, and zero-based index of the first maximal interval. Interval index 0 ends at packet 1. One packet can contain multiple codec frames; this is not server tick latency. |
+| `client_first_audio_after_stream_start_ms` | First audio receipt minus first input send start; admission is excluded. |
+| `client_stream_rtf` | First input send start to last audio receipt, divided by received audio duration. This includes real-time input pacing and is not an inference-only RTF. |
+| `client_send_lateness_ms` | Send start minus its original shared schedule, clipped at zero. |
+| `frame_deficit` | Integer input-frame minus output-frame count from the shared session validation; missing when valid whole-frame accounting is unavailable. |
+| `output_frames`, `voiced_frames`, `silent_frames`, `frame_coverage_ratio`, `audio_rms`, `audio_chunks` | Session-validation statistics retained on success and on acceptance failure once computed. |
+| `acceptance_check` | Failed local check, with numeric diagnostics in `error`; other exceptions retain phase/type only, without remote handshake or metadata text. |
+| `audio_underrun_s`, `audio_underrun_event_count`, `audio_continuity_ok` | Shared `compute_continuity_stats` on valid PCM16 packet arrivals, with its default 100 ms underrun threshold; absent audio gives missing values rather than a continuity pass. |
+
+No output gives missing latency/RTF values, not zero. By default RTF is
+diagnostic; `--max-client-rtf` adds an explicit ceiling. The existing frame
+coverage, audible-frame and scheduler-data-plane checks still apply. A longer
+`--drain-s` can demonstrate eventual completion under backlog, but it must not
+be reported as real-time capacity when the fixed-window run failed or client
+RTF exceeded the stated target. Likewise, the first live session can pay
+one-time model/codec/JIT costs; either use the server's configured duplex
+warmup path or label that run as cold-start evidence before comparing steady
+capacity. Passing client-only metrics does not certify model quality or a
+real-time capacity target on another GPU. Begin with N=1 and N=2; higher N is a
+capacity experiment, not a promised property of an A100 or of this patch.
+Continuity is a client-arrival diagnostic, not proof of speaker playback and
+not an additional pass/fail gate. Packet-interval and send-lateness summaries
+retain their documented linear p99; the older client interval helper reports
+rounded nearest-rank p95 instead and is not substituted for that schema.
+
+Deterministic driver and localhost WebSocket checks need no model or GPU:
+
+```bash
+python -m pytest tests/e2e/online_serving/test_personaplex_load_driver.py \
+ -m 'core_model and cpu' --run-level core_model -q
+```
+
+These checks test the driver against controlled protocol responses. Run the
+load-driver command against real weights separately before reporting model-serving
+performance. Server tick timestamps and generic TTFT/TPOT aggregation remain
+the responsibility of the existing duplex metrics paths, not this driver.
diff --git a/docs/design/fullduplex.md b/docs/design/fullduplex.md
index 4646b85cd..324cd5bdc 100644
--- a/docs/design/fullduplex.md
+++ b/docs/design/fullduplex.md
@@ -9,6 +9,12 @@ the owner document for `vllm_omni/engine/duplex/**`,
`vllm_omni/entrypoints/duplex_omni.py`, `vllm_omni/entrypoints/duplex/**`,
`vllm_omni/clients/**` and the per-model `duplex/` packages.
+`vllm_omni/protocol/realtime/**` (the OpenAI Realtime API) and
+`vllm_omni/protocol/duplex/**` (vLLM-Omni's extension of it) are the shared
+wire codec duplex is built on. Duplex is its first consumer but not its owner: the codec
+is deliberately runtime-agnostic so a second Realtime surface can reuse it
+(RFC #6592 P0a).
+
The public wire contract lives in
[`docs/serving/realtime_duplex_api.md`](../serving/realtime_duplex_api.md);
this page describes how it is produced.
@@ -108,23 +114,56 @@ plugin and the session runtime config to `DuplexOrchestrator` directly.
`AsyncOmniEngine`, `OrchestratorBase` and `Orchestrator` carry only
template seams; `tests/engine/test_duplex_import_boundary.py` checks that
importing the turn-based stack loads no duplex module.
-4. **Every surface a duplex server exposes is backed by a session.**
+4. **Deployment selects the serving stack.**
`vllm-omni serve` constructs `DuplexOmni` when the pipeline declares
- `duplex_plugin`; the server exposes `/v1/realtime?duplex=1` (alias
+ `duplex_plugin` and the deploy configuration sets `session_mode: duplex`.
+ An explicit `session_mode: turn` selects `AsyncOmni` instead, without
+ changing the pipeline's duplex capability. In duplex mode the server exposes `/v1/realtime?duplex=1` (alias
`/v1/duplex`), `POST /v1/chat/completions`, `/v1/models` and `/health`, and
- every other turn-based route reports "not available". The chat route is
- served by `DuplexChatCompletionsAdapter`, a Realtime client that runs one
- short-lived session per request: speech becomes a committed turn, text is
- seeded as the session's opening turn because a model-native model takes a
- turn only when it hears speech. Whether a model can be reached with text is
- `DuplexCapabilities.supports_chat_completions`; one that cannot is refused
- at once rather than left to idle out. Turn-based use of the same model stays
- available offline through `Omni` / `AsyncOmni`.
+ every other turn-based route reports "not available". The chat route uses
+ the ordinary chat service on the duplex engine, without a session, when
+ the plugin declares `DuplexCapabilities.supports_chat_completions`.
+ Turn-based deployments use the ordinary API initialization and retain
+ model capability checks and endpoint restrictions.
5. **Serving is transport only.** The websocket handler does socket I/O,
wire-envelope validation, command translation, event rendering and the
attachment/resume/replay bookkeeping; it holds no session state.
6. **No `typing.Protocol`** in the duplex surfaces: the plugin, data plane,
session state, PCM buffer, stage port and client transport seams are ABCs.
+7. **The wire codec is not duplex, and a wire type is not a mailbox message.**
+ The event and command *vocabulary* plus its wire rendering, the audio format
+ negotiation, the conversation-item rules and the error envelope are model-
+ and runtime-agnostic, and split along the three tiers
+ [`docs/serving/realtime_duplex_api.md`](../serving/realtime_duplex_api.md)
+ already defines: **Tier 1** (identical to OpenAI) is
+ `vllm_omni/protocol/realtime/**`; **Tier 2** (OpenAI names carrying our
+ extensions) and **Tier 3** (ours alone) are `vllm_omni/protocol/duplex/**`.
+ A Tier 2 class *subclasses* its Tier 1 twin and declares only what it adds,
+ so the OpenAI surface stays honestly pure --- `session.created` without
+ `resume_token`, `input_audio_buffer.append` without `video_frames`. Our
+ error **codes** are Tier 3 (`protocol/duplex/errors.py`); only the envelope
+ shape and OpenAI's three `error.type` classes are Tier 1.
+ What stays engine-side is everything that is *internal representation*
+ rather than contract: `DuplexCommand.payload()` renders the session runner's
+ mailbox dictionary, whose channel genuinely differs from the client event
+ (`session.update` and the three `conversation.item.*` commands all travel on
+ `turn.signal`); `engine/duplex/realtime_commands.py` decides which command a
+ decoded event becomes; `engine/duplex/realtime_events.py` holds the
+ session's projection state. The codec may not import the engine, the
+ entrypoints, `model_executor` or the clients
+ (`tests/protocol/realtime/test_protocol_import_boundary.py`), and there is
+ exactly one implementation of each codec behaviour
+ (`tests/protocol/realtime/test_realtime_codec_single_source.py`).
+ The dependency chain is `protocol/realtime` <- `protocol/duplex` <- engine /
+ entrypoints / clients, and a duplex consumer uses **only** the middle link:
+ `protocol/duplex/**` re-exports the Tier 1 names it does not extend, so a
+ helper that later needs a duplex-specific version (`convert_input_audio_with_rate`
+ resamples to MiniCPM-o's 16 kHz rather than the client's rate) is overridden
+ in one file instead of at every call site
+ (`tests/protocol/duplex/test_duplex_protocol_facade.py`).
+ `DuplexEvent` is therefore a plain alias of `RealtimeEvent` --- an event has
+ no engine-internal half --- while `DuplexCommand` is a real class, because a
+ command does.
## Package layout
@@ -143,6 +182,31 @@ vllm_omni/
│ │ ├── chat_completions.py DuplexChatCompletionsAdapter (/v1/chat/completions on a session per request)
│ │ └── websocket.py websocket send/close/receive helpers
│ └── openai/api_server.py builds DuplexOmni for duplex models; session-backed app state
+├── protocol/ SHARED WIRE CODEC (no engine / no model / no transport)
+│ ├── realtime/ the OpenAI Realtime API itself
+│ │ ├── events.py RealtimeEvent + OpenAI's 30 server events (22 ship as Tier 1;
+│ │ │ 8 have a Tier 2 twin in protocol/duplex)
+│ │ ├── commands.py RealtimeCommand + OpenAI's 10 client commands (8 Tier 1,
+│ │ │ 2 with a Tier 2 twin) --- wire_type + fields, no payload()
+│ │ ├── formats.py audio format spellings, what is supported, per-session validation
+│ │ ├── session.py session-object readers; RealtimeInputDefaults (append defaults)
+│ │ ├── items.py conversation item shape, truncation, transcripts, camera frames
+│ │ ├── audio_input.py decode_audio_append -> RealtimeAudioAppend; client speech hints
+│ │ ├── audio.py PCM / G.711 / WAV decode, resample, re-encode
+│ │ ├── errors.py RealtimeProtocolError (the envelope's exception type)
+│ │ └── capabilities.py RealtimeProtocolCapabilities: what one consumer can serve
+│ └── duplex/ Tier 2 + Tier 3, and the one door a duplex consumer uses
+│ ├── __init__.py re-exports the Tier 1 helper functions (audio, formats,
+│ │ items, session, capabilities) so the engine never
+│ │ imports protocol/realtime directly
+│ ├── events.py the whole 42-event vocabulary: 22 Tier-1 re-exports,
+│ │ 8 Tier-2 subclasses (session.created + resume_token, ...),
+│ │ 12 Tier-3 events (listen/speak, playback, resume, ...);
+│ │ DuplexEvent = RealtimeEvent
+│ ├── commands.py the whole 17-command vocabulary: 8 Tier-1 re-exports,
+│ │ 2 Tier-2 subclasses (append + hints, commit + final),
+│ │ 7 Tier-3 commands (barge_in, playback.ack, ...)
+│ └── errors.py our error-code vocabulary (Tier 3) + RealtimeProtocolError
├── engine/
│ ├── omni_engine_base.py OmniEngineBase (stage processes, orchestrator thread, queues, RPC)
│ ├── async_omni_engine.py AsyncOmniEngine (turn-based request building)
@@ -150,16 +214,20 @@ vllm_omni/
│ ├── orchestrator.py OrchestratorBase + Orchestrator
│ ├── duplex_orchestrator.py DuplexOrchestrator (+ DuplexOrchestratorRequestState; implements DuplexStagePort)
│ └── duplex/
-│ ├── commands.py DuplexCommand dataclasses, command_from_realtime
-│ ├── realtime_commands.py Realtime client event -> DuplexCommand translation
-│ ├── events.py DuplexEvent dataclasses (+ to_realtime), REALTIME_ERROR_TYPES_BY_CODE
+│ ├── commands.py mailbox half: DuplexCommand.payload() + the mailbox `type`,
+│ │ paired with each protocol command; command_from_realtime
+│ ├── realtime_commands.py duplex binding of the codec: decoded event -> DuplexCommand,
+│ │ DUPLEX_REALTIME_CAPABILITIES, duplex_response_format
+│ ├── events.py re-export shim (DuplexEvent = RealtimeEvent) + the runner's
+│ │ epoch-filter sets DOMAIN_TERMINAL_EVENTS / MODEL_OUTPUT_EVENTS
│ ├── realtime_events.py RealtimeProjectionState: internal event -> typed events
│ ├── messages.py queue envelopes (Open/Close/Resume/Touch/Command/Result/Event), DuplexSessionError
│ ├── config.py DuplexSessionConfig, DuplexCapabilities, ResponseCreateOptions
│ ├── contracts.py DuplexFence (session_id, epoch, turn_id), stage request records, DuplexStagePort
│ ├── plugin.py DuplexModelPlugin, DuplexModelSessionState, DuplexDataPlane, PcmAppendBuffer ABCs
│ ├── turn_detection.py server-side VAD turn detector used by the session
-│ ├── audio.py / vad.py / intermediate.py
+│ ├── audio.py compatibility re-export, via protocol/duplex
+│ ├── vad.py / intermediate.py
│ └── session/ one engine-resident session and everything that runs it
│ ├── engine_session.py DuplexEngineSession: ledgers, lease, fence, stage resources, append sequencing
│ ├── runner.py DuplexSessionRunner (per-session mailbox on the orchestrator loop)
diff --git a/docs/design/module/entrypoints.md b/docs/design/module/entrypoints.md
index db62f9cb6..0c0ba8439 100644
--- a/docs/design/module/entrypoints.md
+++ b/docs/design/module/entrypoints.md
@@ -30,6 +30,7 @@ primary_code_paths:
- vllm_omni/entrypoints/utils.py
- vllm_omni/entrypoints/duplex/**
- vllm_omni/clients/**
+ - vllm_omni/protocol/**
primary_path_exceptions:
- path: vllm_omni/entrypoints/openai/errors.py
owner: error_contracts.md
@@ -53,6 +54,7 @@ depends_on:
- error_contracts.md
- engine_orchestration.md
validation_paths:
+ - tests/protocol/**
- tests/entrypoints/test_omni_entrypoints.py
- tests/entrypoints/test_async_omni.py
- tests/entrypoints/test_async_omni_pause_sleep_routing.py
@@ -94,11 +96,43 @@ This document owns offline API semantics, CLI and serve composition,
supported OpenAI-compatible routes, request validation and normalization,
response conversion, streaming/session behavior, and engine handoff.
+When `--api-server-count` is greater than one, the serve composition root
+starts the frontend process manager while a parent-owned `StageRuntime`
+launches the shared local stage engines. Each frontend receives only its own
+stage-client channel configuration and does not launch or retire backend
+processes. CLI validation rejects unsupported distributed, diffusion,
+fault-tolerant, elastic-EP, Ray, and runtime-LoRA combinations before startup.
+
It does not own configuration precedence, cross-stage routing, stage
placement, payload implementation, or semantic error classification.
`entrypoints/openai/errors.py` is an explicit primary-path exception owned by
`error_contracts.md`.
+It also owns `vllm_omni/protocol/**`, the shared wire codec promoted by RFC
+[#6592](https://github.com/vllm-project/vllm-omni/issues/6592) P0a. It follows the three tiers
+`docs/serving/realtime_duplex_api.md` already defines. `protocol/realtime/**`
+is Tier 1, identical to OpenAI: 30 server events, 10 client commands, their
+typed fields and pure wire rendering, audio-format negotiation,
+conversation-item rules and the error-envelope shape. `protocol/duplex/**` is
+Tier 2 (OpenAI names carrying vLLM-Omni extensions, each a subclass of its
+Tier 1 twin declaring only what it adds) and Tier 3 (ours alone, including our
+error-code vocabulary), kept separate so a GA-only consumer is not handed a
+vocabulary its clients never send. That package sits
+outside `entrypoints/` on purpose --- the engine depends on it, so it belongs
+to neither layer --- but deciding what a Realtime client may put on the wire is
+this document's subject, and the same reasoning already places
+`vllm_omni/errors.py`, `inputs/` and `outputs/` under contract documents rather
+than under a consumer.
+
+It is deliberately **not** owned by `../fullduplex.md`, even though duplex is
+the codec's only consumer today. RFC #6592 asks for a named owner precisely so
+a second Realtime consumer does not need duplex review to change the codec
+(#6592 open question 8). Ownership here is review scope, not a dependency: the
+codec may not import the engine, the entrypoints or the model code, which
+`tests/protocol/realtime/test_protocol_import_boundary.py` enforces. When a
+second consumer lands (#6592 P0b) the package is expected to graduate to its
+own module document with owners drawn from both consumers.
+
## Candidate invariants
These identifiers are proposals while the document is `draft`.
@@ -108,6 +142,22 @@ These identifiers are proposals while the document is `draft`.
**Rule:** Entrypoints MUST NOT implement cross-stage routing or stage lifecycle
policy.
+### ENTRY-INV-002: The shared Realtime codec does not depend on its consumers
+
+**Rule:** `vllm_omni/protocol/**` MUST NOT import `vllm_omni.engine`,
+`vllm_omni.entrypoints`, `vllm_omni.model_executor`, `vllm_omni.worker` or
+`vllm_omni.clients`; `protocol/duplex/**` MAY depend on `protocol/realtime/**`
+but never the reverse, and a Tier 1 class MUST NOT carry a vLLM-Omni extension
+field; and each protocol/codec behavior MUST have exactly one
+implementation that every consumer uses. A wire type MUST NOT carry a
+consumer's internal representation: the duplex mailbox rendering
+(`DuplexCommand.payload()`, whose channel differs from the client event for
+`session.update` and the `conversation.item.*` commands) stays engine-side.
+A duplex consumer (`engine/duplex/**`, `entrypoints/duplex/**`, the duplex
+clients) MUST import `vllm_omni.protocol.duplex` and MUST NOT import
+`vllm_omni.protocol.realtime` directly, so the tier boundary has exactly one
+extension point.
+
### ENTRY-INV-100: Public requests are normalized once
**Rule:** Public protocol values MUST be validated and converted to internal
@@ -141,6 +191,9 @@ stage so `wake_up(stage_ids=[0])` does not skip a later `wake_up(stage_ids=[1])`
Streaming input pumps take an admission slot immediately before each EngineCore
ADD or update, not while waiting for the next client chunk. Frontend abort
keeps `request_states` until `generate()` consumes the terminal output.
+Multi-API serving must preserve one client rank and one channel set per
+frontend, include every frontend in readiness/failure observation, and keep
+stage lifecycle ownership in the parent composition root.
## Promotion gate
diff --git a/docs/design/module/stage_runtime.md b/docs/design/module/stage_runtime.md
index aefba5a40..38255880f 100644
--- a/docs/design/module/stage_runtime.md
+++ b/docs/design/module/stage_runtime.md
@@ -77,6 +77,22 @@ readiness, one pool per logical stage, replica identity and membership,
selection and affinity, stage-client/process lifecycle, liveness, draining,
and shutdown.
+Local EngineCore initialization and multi-API serving use
+`StageRuntime.launch_stage_engines(num_api_servers=1)` as their common launch
+entry. It resolves plans when not supplied by the runtime's device-group
+scheduler, coordinates device locks and environment overlays, starts engines,
+and rolls back resources on startup or attachment failure. Single-API clients
+attach locally after readiness and take ownership of the engine resources;
+there is no additional API subprocess. Diffusion and remote attachment retain
+their backend-specific initialization.
+
+For local multi-API serving, the parent runtime owns and launches each stage
+engine once. It supplies a distinct input/output channel for every API
+frontend and stage replica; frontend workers attach clients to those engines
+without acquiring stage-process ownership. Readiness observation and shutdown
+remain parent-owned. This topology currently excludes diffusion and
+remote/headless stages, intra-stage data parallelism, and Ray backends.
+
It does not own cross-stage request policy, model scheduler policy, connector
transfer semantics, configuration precedence, or public error rendering.
@@ -114,6 +130,10 @@ affinity, membership changes, abort routing, process failure, draining, and
repeated shutdown. Cross-stage policy changes belong in
`engine_orchestration.md`.
+For multi-API changes, additionally exercise per-frontend channel assignment,
+shared-engine startup handshakes, frontend failure observation, and parent
+cleanup without duplicate stage shutdown.
+
## Promotion gate
- Reconcile terminology and ownership after #5441 reaches a final state.
diff --git a/docs/features/comfyui.md b/docs/features/comfyui.md
index 876e80617..dda68b793 100644
--- a/docs/features/comfyui.md
+++ b/docs/features/comfyui.md
@@ -51,6 +51,7 @@ This extension offers the following nodes based on the output modalities:
- **Generate Video** for text-to-video and image-to-video tasks
- **Multimodality Understanding** for multimodality-to-text and multimodality-to-audio tasks
- **TTS** and **TTS Voice Clone** for TTS tasks
+- **Generate Music** for text-to-music tasks
This extension also offers example workflows (at **ComfyUI sidebar -> Templates -> vLLM-Omni**)
diff --git a/docs/features/custom_pipeline.md b/docs/features/custom_pipeline.md
index 887dfa769..463798d6d 100644
--- a/docs/features/custom_pipeline.md
+++ b/docs/features/custom_pipeline.md
@@ -1,7 +1,7 @@
# Custom Pipeline Extension Guide
Transformer already support Custom Pipeline via
-https://github.com/huggingface/diffusers/blob/main/docs/source/en/using-diffusers/custom_pipeline_overview.md
+
This guide demonstrates how to use the newly added features for extending vLLM-Omni's diffusion pipeline with custom functionality.
@@ -20,8 +20,9 @@ Three main features enable custom pipeline extension:
`WorkerWrapperBase` is a wrapper class that creates `DiffusionWorker` instances with optional extension support. It enables dynamic inheritance, allowing you to add custom methods and functionality to workers without modifying the base worker class.
**Key capabilities:**
+
- Dynamic worker class extension via `worker_extension_cls`
-- Support for custom pipeline initialization via `custom_pipeline_args`
+- Support for custom pipeline initialization via `custom_pipeline_args["pipeline_class"]`
- Method delegation to underlying worker
- Attribute access forwarding
@@ -42,6 +43,7 @@ The `diffusion_load_format` parameter controls the initial diffusion model load.
`CustomPipelineWorkerExtension` is a mixin class that extends `DiffusionWorker` with the ability to re-initialize the pipeline with a custom implementation.
**Key method:**
+
- `re_init_pipeline(custom_pipeline_args)`: Re-initializes the pipeline with custom arguments, properly cleaning up the old pipeline first
**Location:** `vllm_omni/diffusion/worker/diffusion_worker.py`
@@ -150,6 +152,7 @@ omni = Omni(
},
worker_extension_cls=MyCustomExtension,
# Note: worker_extension_cls is an internal parameter
- # CustomPipelineWorkerExtension will automatically init pipeline when custom_pipeline_args is provided
+ # CustomPipelineWorkerExtension will automatically init pipeline when
+ # custom_pipeline_args includes "pipeline_class".
)
```
diff --git a/docs/models/supported_models.md b/docs/models/supported_models.md
index 42971ed97..1f543a6d2 100644
--- a/docs/models/supported_models.md
+++ b/docs/models/supported_models.md
@@ -58,6 +58,7 @@ th {
| `Magi2Pipeline` | MAGI-2 native Preview-stage T2VA and I2VA (272p/540p) | `sand-ai/MAGI-2-preview` | ✅︎ | | | | [Repository](https://github.com/vllm-project/vllm-omni/blob/main/recipes/SandAI/MAGI-2-preview-L20X.md) |
| `DreamZeroPipeline` | DreamZero-DROID | `GEAR-Dreams/DreamZero-DROID` | ✅︎ | ✅︎ | ✅︎ | ✅︎ | — |
| `Pi0Pipeline` | π0 (Pi-Zero) VLA | `lerobot/pi0_base` | ✅︎ | | | | [Repository](https://github.com/vllm-project/vllm-omni/blob/main/recipes/lerobot/Pi0.md) |
+| `Pi05Pipeline` | π0.5 VLA | `lerobot/pi05_base` | ✅︎ | | | | [Repository](https://github.com/vllm-project/vllm-omni/blob/main/recipes/lerobot/Pi05.md) |
| `HeliosPipeline`, `HeliosPyramidPipeline` | Helios | `BestWishYsh/Helios-Base`, `BestWishYsh/Helios-Mid`, `BestWishYsh/Helios-Distilled` | ✅︎ | ✅︎ | ✅︎ | | — |
| `OvisImagePipeline` | Ovis-Image | `OvisAI/Ovis-Image` | ✅︎ | ✅︎ | | ✅︎ | — |
| `LongcatImagePipeline` | LongCat-Image | `meituan-longcat/LongCat-Image` | ✅︎ | ✅︎ | ✅︎ | ✅︎ | — |
@@ -72,7 +73,6 @@ th {
| `OmniVoiceModel` | OmniVoice | `k2-fsa/OmniVoice` | ✅︎ | | | ✅︎ | — |
| `VoxCPM2TalkerForConditionalGeneration` | VoxCPM2 | `openbmb/VoxCPM2` | ✅︎ | | | ✅︎ | — |
| `BreezeForConditionalGeneration` | Breeze-TTS-2 (TTS, voice clone, voice direction) | `BreezeBlue/Breeze-TTS-2` | ✅︎ | | | | [Repository](https://github.com/vllm-project/vllm-omni/blob/main/recipes/BreezeBlue/Breeze-TTS-2.md) |
-| `DotsTTSForConditionalGeneration` | dots.tts | `dots-studio/dots.tts-soar` | ✅︎ | | | | — |
| `MammothModa2ForConditionalGeneration` | MammothModa2-Preview | `bytedance-research/MammothModa2-Preview` | ✅︎ | ✅︎ | | | — |
| `MammothModa2ForConditionalGeneration` | MammothModa2-Dev (AR-only image understanding) | `bytedance-research/MammothModa2-Dev` | ✅︎ | | | | — |
| `Flux2KleinPipeline` | FLUX.2-klein | `black-forest-labs/FLUX.2-klein-4B`, `black-forest-labs/FLUX.2-klein-9B` | ✅︎ | ✅︎ | ✅︎ | ✅︎ | — |
@@ -106,12 +106,12 @@ th {
| `HunyuanVideo15ImageToVideoPipeline` | HunyuanVideo-1.5-I2V | `hunyuanvideo-community/HunyuanVideo-1.5-Diffusers-480p_i2v`, `hunyuanvideo-community/HunyuanVideo-1.5-Diffusers-720p_i2v` | ✅︎ | ✅︎ | | | — |
| `VoxtralTTSForConditionalGeneration` | Voxtral TTS | `mistralai/Voxtral-4B-TTS-2603` | ✅︎ | ✅︎ | | | — |
| `CovoAudioForConditionalGeneration` | Covo-Audio-Chat | `tencent/Covo-Audio-Chat` | ✅︎ | | | | — |
-| `DyninOmniForConditionalGeneration` | Dynin-Omni | `snu-aidas/Dynin-Omni` | ✅︎ | | | ✅︎ | — |
| `MiniCPMO45OmniForConditionalGeneration` | MiniCPM-o 4.5 | `openbmb/MiniCPM-o-4_5` | ✅︎ | | ✅︎ | | [Repository](https://github.com/vllm-project/vllm-omni/blob/main/recipes/OpenBMB/MiniCPM-o-4_5.md) |
| `ErnieImagePipeline` | ERNIE-Image | `baidu/ERNIE-Image`, `baidu/ERNIE-Image-Turbo` | ✅︎ | ✅︎ | ✅︎ | ✅︎ | — |
| `GepardTalkerForConditionalGeneration` | Gepard-1.0 | `nineninesix/gepard-1.0` | ✅︎ | | | ✅︎ | — |
| `HiDreamImagePipeline` | HiDream-I1-Full | `HiDream-ai/HiDream-I1-Full` | ✅︎ | ✅︎ | | | — |
| `HiDreamO1ImagePipeline` | HiDream-O1-Image | `HiDream-ai/HiDream-O1-Image` | ✅︎ | | | | — |
+| `AnimaPipeline` | Anima | `circlestone-labs/Anima` | ✅︎ | ✅︎ | | | [Repository](https://github.com/vllm-project/vllm-omni/blob/main/recipes/circlestone-labs/Anima.md) |
The `Recipe` column links the corresponding deployment recipe. `Published` is
preferred when a corresponding `recipes.vllm.ai` page exists; otherwise the
diff --git a/docs/serving/full_duplex_api.md b/docs/serving/full_duplex_api.md
index 92511e84f..9b3eceb58 100644
--- a/docs/serving/full_duplex_api.md
+++ b/docs/serving/full_duplex_api.md
@@ -22,14 +22,14 @@ capability gates, see the [Realtime Duplex API guide](realtime_duplex_api.md).
## Enable Full Duplex
A model is served full duplex when its registered pipeline declares a
-`duplex_plugin` (the model's `DuplexModelPlugin`). That declaration alone
-decides it: `vllm-omni serve` constructs `DuplexOmni` instead of `AsyncOmni`,
-and every surface the server exposes is backed by a duplex session. It serves
+`duplex_plugin` (the model's `DuplexModelPlugin`) and its deploy configuration
+sets `session_mode: duplex`. `vllm serve --omni` constructs `DuplexOmni`
+instead of `AsyncOmni`. It serves
`/v1/realtime?duplex=1` (and its alias `/v1/duplex`),
`POST /v1/chat/completions`, `/v1/models` and `/health`; every other
turn-based HTTP route (speech, batch, embeddings, video, ...) answers "not
-available". Turn-based use of such a model stays available offline through the
-Python API (`Omni` / `AsyncOmni`).
+available". Set `session_mode: turn` to select the ordinary online serving
+stack instead. The model's supported tasks and endpoint restrictions still apply.
`/v1/chat/completions` is the ordinary chat service running on the duplex
engine: a request is a turn-based generation on the same stages, served
@@ -45,8 +45,24 @@ The deploy configuration of such a model must agree:
session_mode: duplex
```
-A duplex model started with a deploy configuration that does not set it fails
-at startup rather than falling back to turn-based serving.
+A duplex-capable model must explicitly set `session_mode` to `duplex` or `turn`
+in its deploy configuration, possibly through `base_config` inheritance.
+Missing or invalid values fail at startup. The default MiniCPM-o deployment
+continues to use duplex mode.
+
+To run MiniCPM-o 4.5 with the turn-based engine:
+
+```bash
+vllm serve openbmb/MiniCPM-o-4_5 --omni \
+ --deploy-config vllm_omni/deploy/minicpmo_4_5_turn.yaml \
+ --trust-remote-code \
+ --port 8091
+```
+
+This profile inherits the default model and stage settings and overrides only
+`session_mode`. It supports ordinary HTTP requests without creating a duplex
+session handler. Mode selection happens at startup; a WebSocket query parameter
+does not switch engines. The Python `Omni` / `AsyncOmni` APIs are unchanged.
!!! warning
diff --git a/docs/serving/realtime_duplex_api.md b/docs/serving/realtime_duplex_api.md
index cc10d99c9..cd8832c82 100644
--- a/docs/serving/realtime_duplex_api.md
+++ b/docs/serving/realtime_duplex_api.md
@@ -8,12 +8,41 @@ history stays honest, and a dropped connection can resume the same session.
This page covers how to run a duplex deployment, how to drive it from Python
with `vllm_omni.clients.duplex.DuplexClient`, and the complete wire contract.
-The endpoint is served for models that ship a duplex plugin — currently
-MiniCPM-o 4.5 only — and just for deploy configurations that declare
+The endpoint is served for models that ship a duplex plugin — including
+MiniCPM-o 4.5 and Qwen3-Omni — and just for deploy configurations that declare
`session_mode: duplex`. PersonaPlex and Nemotron VoiceChat are ported to the
plugin contract in follow-up PRs and are not served over this endpoint yet. The runtime architecture
is described in [Full-Duplex Runtime (MiniCPM-o 4.5)](../design/fullduplex.md).
+## Qwen3-Omni conversation history
+
+Qwen3-Omni keeps incoming conversation items independently addressable by item
+ID. Before applying the model's chat template, it merges consecutive user
+items into one multimodal user message. An assistant message, including an
+empty message reserved for an interrupted or unheard answer, separates turns.
+The final user message places media before text instructions, following the
+[official Qwen3-Omni demo's `format_history()`](https://github.com/QwenLM/Qwen3-Omni/blob/e4235853125589c789f06a2dd83e9f4126df5e9d/web_demo.py#L84-L179).
+
+A camera image or text item may arrive after an audio commit and before
+`response.create`. Those items belong to the same pending user turn: the
+committed audio remains associated with its history item even when that item
+is no longer last. Prompt preparation snapshots the selected inputs; later
+items do not modify an already prepared request.
+
+The duplex adapter retains its existing budgets: at most four audio payloads
+(including the current input), an 8 MiB encoded-audio history budget (keeping
+at least the newest payload), and at most eight prompt images. The recent
+16-message window is rounded outwards to a complete turn. If any audio in an
+older turn is no longer retained, the entire turn's model context, including
+its images/text and assistant replies, is omitted. Images from that turn are
+therefore **not** permanent session-wide model context. These limits differ
+from the demo's one image-bearing turn and five audio-bearing turns; the
+shared rule is grouping before pruning, rather than copying its UI budgets.
+
+Grouping and pruning affect only the model-input view. They do not merge or
+delete the source conversation items exposed to clients, and do not change
+playback acknowledgement or interruption handling.
+
## Quick Start
### Start the Server
@@ -32,33 +61,19 @@ vllm-omni serve openbmb/MiniCPM-o-4_5 \
mounts `ws://:8099/v1/realtime?duplex=1` (this page; `ws://:8099/v1/duplex`
is an alias of the same route), `POST /v1/chat/completions`, `/v1/models` and
`/health`, and nothing else. The remaining turn-based HTTP routes (speech,
-batch, embeddings, video, ...) are not served by a duplex model.
+batch, embeddings, video, ...) are not served in duplex mode.
-`/v1/chat/completions` is not a turn-based path on a duplex server: each
-request opens a short-lived duplex session and reads the answer off it. Audio
-content becomes an ordinary committed turn; text is seeded as the session's
-opening turn, because a model-native model takes a turn only when it hears
-speech. A model that cannot be seeded that way declares so, and a text request
-to it is refused with 400. Two consequences are worth sizing for:
+`/v1/chat/completions` uses the ordinary chat service on the same engine
+when the plugin declares `supports_chat_completions`. HTTP chat requests do
+not create duplex sessions or consume session admission slots. Their options
+follow the [Chat Completions API](chat_completions_api.md) and the model's
+capabilities and endpoint restrictions.
-- **Every request holds an admission slot** for its lifetime, so
- `duplex_session.max_sessions` caps HTTP concurrency as well as websocket
- sessions. Beyond it a request is refused with HTTP 503.
-- **Latency follows the model's own clock.** A model-native session generates
- per audio unit, so even a short answer costs what that many units cost --
- noticeably more than the same model would take turn-based.
-
-`n > 1`, `logprobs`, `tools`, and image or video content parts have no
-representation in one duplex turn and are refused with HTTP 400 -- a Realtime
-conversation item carries text and audio only. `temperature`,
-`max_completion_tokens`, `modalities` and
-`chat_template_kwargs.use_tts_template` apply; the other
-`chat_template_kwargs` keys are logged as ignored. `extra_body` is passed to
-the session unchanged, exactly as a websocket client's session `extra_body`
-is, which is how a request asking for `modalities: ["text", "audio"]` supplies
-the `ref_audio` MiniCPM-o requires for audio output. A model that should not
-serve the route lists it in the deploy config's `endpoint_restrictions`,
-exactly as a turn-based model does.
+For a turn-based online deployment, use `minicpmo_4_5_turn.yaml` or explicitly
+set `session_mode: turn` in a deploy configuration derived from the model's
+profile. This selects `AsyncOmni` and the ordinary API initialization instead
+of the duplex handler. See [Full Duplex](full_duplex_api.md#enable-full-duplex)
+for the command and configuration requirements.
### Run the Example Client
@@ -782,7 +797,10 @@ events with `server_event_seq > 40` are replayed in order)
```
with camera frames (omni video; rides the append that closes a 1 s model
-unit; each entry is a **bare** base64 JPEG/PNG — no `data:` URL prefix)
+unit; each entry is a **bare** base64 JPEG/PNG — no `data:` URL prefix).
+Only a model whose Stage 0 interleaves a frame track at unit boundaries takes
+this field; a turn model has no such boundary and rejects it, expecting
+`conversation.item.create` with `input_image` content instead.
```json
{
@@ -959,6 +977,10 @@ deferred commit during an active response (`event.response_create_deferred`)
{"type": "conversation.item.truncated", "item_id": "item_resp_01", "content_index": 0, "audio_end_ms": 1850, "event": {"…": "…"}}
```
+After this acknowledgement, `conversation.item.retrieve` returns the truncated
+transcript. Without text/audio alignment marks, its prefix is estimated from
+the requested position and audio duration; this is not exact word alignment.
+
#### Response lifecycle
`C→S response.create`
@@ -1345,8 +1367,9 @@ them out into typed events before they reach a client.
- Session capacity is bounded by `duplex_session.max_sessions` in the deploy
configuration; admission beyond it fails with `resource_exhausted`
(`rate_limit_error`, retryable).
-- A duplex deployment serves the duplex session surfaces only: the websocket
- route and `/v1/chat/completions`, the latter on a session per request (see
- [Start the Server](#start-the-server)). The other turn-based HTTP routes
- report "not available" on a MiniCPM-o 4.5 server; turn-based use of the
- model stays available offline through `Omni` / `AsyncOmni`.
+- A duplex deployment serves the websocket route and, when supported by the
+ model, ordinary `/v1/chat/completions` requests on the same engine without a
+ session per request (see [Start the Server](#start-the-server)). Other
+ turn-based HTTP routes report "not available" in duplex mode. To use the
+ ordinary online serving stack, select `session_mode: turn` as described in
+ [Full Duplex](full_duplex_api.md#enable-full-duplex).
diff --git a/docs/serving/speech_api.md b/docs/serving/speech_api.md
index 5f63739f6..c07d9eabf 100644
--- a/docs/serving/speech_api.md
+++ b/docs/serving/speech_api.md
@@ -521,6 +521,15 @@ are cached in-process with a shared LRU so repeated requests with the same
all TTS model types; deleting a voice invalidates every model-type slot at
once.
+Decoded reference waveforms use a separate LRU cache of owned, contiguous
+float32 arrays at the source sampling rate. Its byte budget counts numeric
+buffers (four bytes per mono sample), excluding cache metadata. Numeric storage
+avoids retaining a Python float object for every sample during garbage
+collection. MOSS reference encoding consumes these arrays directly; other
+list-based interfaces, including MOSS Nano, receive temporary lists that are
+not retained in the resolve cache. The MOSS reference encoder also releases
+completed batch inputs before waiting for more work.
+
### Precomputed Custom Voices
Qwen3-TTS Base and VoxCPM2 can load offline-precomputed voices at startup.
diff --git a/docs/serving/streaming_video_output_api.md b/docs/serving/streaming_video_output_api.md
index d01489540..b219ee019 100644
--- a/docs/serving/streaming_video_output_api.md
+++ b/docs/serving/streaming_video_output_api.md
@@ -41,7 +41,7 @@ bytes.
| Server to client | `video.start` | Confirms the request ID, format, and accepted configuration |
| Server to client | `video.chunk_metadata` | Describes the next binary media frame |
| Server to client | Binary frame | Carries one fragmented MP4 chunk |
-| Client to server | `session.interaction` | Queues an optional prompt update during generation |
+| Client to server | `session.interaction` | Queues an optional interaction (e.g., prompt. camera action) during generation |
| Server to client | `session.interaction.queued` | Confirms that an interaction was queued |
| Client to server | `session.ping` | Refreshes the stall clock |
| Server to client | `session.pong` | Acknowledges a ping |
@@ -83,10 +83,39 @@ Models that implement interaction updates can change the active prompt:
}
```
+Models that register the camera modality (for example LingBot-World) also
+accept structural SE3 payloads on `event.multi_modal_data.camera`. Coordinates
+follow Unity semantics (`+X` right, `+Y` up, `+Z` forward; same as LingBot's
+native camera frame). WASD key tokens are not admitted by the engine:
+
+```json
+{
+ "type": "session.interaction",
+ "interaction": {
+ "event_id": "forward-1",
+ "event": {
+ "multi_modal_data": {
+ "camera": {
+ "mode": "velocity",
+ "data": {
+ "translation": [0.0, 0.0, 0.05],
+ "rotation": [0.0, 0.0, 0.0, 1.0]
+ }
+ }
+ }
+ }
+ }
+}
+```
+
+`mode` is `target` (lerp to an absolute pose over `transition_chunks`) or
+`velocity` (hold a per-frame SE3 delta until replaced). Prompt and camera may
+be combined in one interaction event.
+
This feature is pipeline-dependent. An enabled endpoint does not imply that
-the loaded model supports midway prompt updates.
+the loaded model supports midway prompt or camera updates.
The default start timeout is 10 seconds and the server reports a stall after
about 60 seconds without generation progress or a `session.ping`. See the
[streaming video generation example](https://github.com/vllm-project/vllm-omni/tree/main/examples/online_serving/streaming_video_generation)
-for prompt-update scheduling and browser playback.
+for prompt/camera-update scheduling and browser playback.
diff --git a/docs/serving/videos_api.md b/docs/serving/videos_api.md
index 1152ebce3..da0fa1fd3 100644
--- a/docs/serving/videos_api.md
+++ b/docs/serving/videos_api.md
@@ -73,6 +73,10 @@ curl -L "http://localhost:8091/v1/videos/${video_id}/content" -o output.mp4
| `image_reference` | string | null | JSON-encoded reference image payload; do not combine with `input_reference` or `video_reference` |
| `video_reference` | string | null | JSON-encoded reference video payload; do not combine with `input_reference` or `image_reference` |
| `audio_reference` | string | null | JSON-encoded audio reference for speech-to-video: `{"audio_url": "..."}` — supports HTTP(s) URLs or base64 data URLs |
+| `source_video` | file | null | MiniMax H3 latent-edit source video (`.mp4` or `.mov`, up to 512 MiB) |
+| `source_audio` | file | null | Optional MiniMax H3 latent-edit source audio (`.wav` or `.mp3`, up to 512 MiB) |
+| `video_noise_mask` | file | null | UTF-8 JSON MiniMax H3 video mask; `0` preserves and `1` regenerates a token |
+| `audio_noise_mask` | file | null | UTF-8 JSON MiniMax H3 audio mask; `0` preserves and `1` regenerates a token |
| `width` | integer | model default | Output video width |
| `height` | integer | model default | Output video height |
| `num_frames` | integer | 1 | Number of generated frames |
@@ -214,6 +218,49 @@ upstream vLLM's media URL allowlist protection. Deployments should therefore
treat remote media URLs as untrusted and choose this setting as part of their
URL access policy.
+### MiniMax H3 Latent-Mask Editing
+
+MiniMax H3 accepts request-scoped source media and video/audio noise masks.
+At least one mask is required. A nontrivial `video_noise_mask` requires
+`source_video`, while a nontrivial `audio_noise_mask` requires either
+`source_audio` or a `source_video` with an audio stream. Mask values are in
+`[0, 1]`: `0` preserves the source, `1` regenerates it, and fractional values
+blend the two behaviors. Exact all-one masks are no-ops and do not require a
+source. Source uploads without a mask are rejected. Masks may be a JSON scalar
+or arrays matching the H3 latent/token grid; pixel-resolution masks must be
+resized or pooled by the client before upload.
+
+For an aligned output of `F` frames at `W x H`, the video latent grid is
+`[Tv, H/16, W/16]`, where `Tv = 2 + 5 * ((F - 5) / 17)`. The video mask may be
+a scalar, a flat token vector, `[Tv, H/32, W/32]`, or the full latent grid. For
+the model input, timestep, and velocity, a full-grid mask is max-pooled over
+each 2x2 spatial token and fractional values are rounded upward to 1/256
+levels. The final x0 restore uses the original, unquantized mask, so full-grid
+masks retain cell-level preservation inside a model token. The audio length is
+`Ta = round(F * 40 / 24)`, and its mask may be a scalar, `[Ta]`, `[2, Ta]`, or
+a flat `2 * Ta` vector. If source audio is short, its missing latent tail is
+forced to mask value `1` so H3 generates that portion. Each mask must be sent
+as a UTF-8 JSON file part and is limited to 8 MiB. A file may contain either a
+JSON scalar or an array.
+
+```bash
+curl -s http://localhost:8091/v1/videos/sync \
+ -F "prompt=Partially restyle the complete clip and soundtrack" \
+ -F 'extra_params={"task":"t2va","duration":4.0,"aspect_ratio":"16:9"}' \
+ -F "source_video=@source.mp4;type=video/mp4" \
+ -F "source_audio=@source.wav;type=audio/wav" \
+ -F "video_noise_mask=@video-mask.json;type=application/json" \
+ -F "audio_noise_mask=@audio-mask.json;type=application/json" \
+ -o edited.mp4
+```
+
+For example, each mask file in the request above may contain the JSON scalar
+`0.5`.
+
+The server streams source files to temporary request-scoped storage and removes
+them after synchronous or asynchronous generation finishes. Models that do not
+declare latent-mask editing support reject these fields.
+
### Speech-to-Video
For models that support audio-driven generation (e.g., Wan2.2-S2V), pass both
@@ -251,6 +298,7 @@ These `extra_params` control how the server turns decoded frames into MP4 bytes.
| Field | Type | Default | Description |
| --- | --- | --- | --- |
| `preencode_mp4` | boolean | false | Encode the MP4 on the worker while the VAE is still decoding, instead of after the full video is materialized |
+| `preencode_batch_frames` | positive integer | 17 (H3, Wan T2V/I2V); 1 (Wan S2V) | Minimum accumulated frames per worker transfer/encoding batch; used only with `preencode_mp4=true` |
| `video_codec_options` | object | null | Encoder options passed through to the H.264 encoder, such as `{"preset": "ultrafast", "threads": "0"}` |
With `preencode_mp4` enabled, each committed VAE chunk leaves the accelerator and
@@ -261,16 +309,29 @@ unchanged: the same complete MP4, byte-for-byte equivalent frames.
```bash
curl -X POST http://localhost:8091/v1/videos/sync \
-F "prompt=A small robot walking through a neon city" \
- -F 'extra_params={"preencode_mp4": true, "video_codec_options": {"preset": "ultrafast"}}' \
+ -F 'extra_params={"preencode_mp4": true, "preencode_batch_frames": 33, "video_codec_options": {"preset": "ultrafast"}}' \
-o output.mp4
```
+Set `preencode_batch_frames` in `extra_params` (or `extra_args` for offline
+sampling) to tune batching. The worker accumulates complete VAE chunks until
+it has at least this many frames, then transfers and encodes them together.
+It always flushes the final partial batch. This is a threshold, not an exact
+chunk length: a value of 1 submits every native chunk immediately, and a value
+smaller than a native chunk does not split it. Larger values reduce transfers
+but retain more frames on the accelerator and delay encoding. The VAE decode
+window and output frame count stay unchanged. Wan S2V keeps its existing
+per-clip behavior by default. Zero, negative, fractional, boolean, string, and
+null values are rejected when pre-encoding is enabled.
+
`preencode_mp4` applies to the complete-MP4 response paths only. The
`/v1/realtime/video` WebSocket endpoint rejects it, because that path already
-overlaps encoding through its own incremental fragmented-MP4 encoder.
+overlaps encoding through its own incremental fragmented-MP4 encoder. Wan also
+rejects it together with `enable_frame_interpolation`, which needs the decoded
+frames the pre-encoded path no longer materializes.
-Support is per model: MiniMax-H3 implements it, and other models ignore the flag
-and take the full-decode path.
+Support is per model: MiniMax-H3 and Wan 2.2 (T2V, I2V, and S2V) implement it,
+and other models ignore the flag and take the full-decode path.
## Storage
diff --git a/docs/user_guide/diffusion/attention_backends/rainfusion.md b/docs/user_guide/diffusion/attention_backends/rainfusion.md
index 00f4e37a1..1d91cabfa 100644
--- a/docs/user_guide/diffusion/attention_backends/rainfusion.md
+++ b/docs/user_guide/diffusion/attention_backends/rainfusion.md
@@ -78,3 +78,35 @@ Protected video tails require a compatible MindIE-SD release.
For common configuration and selector behavior, see the
[attention backend overview](../attention_backends.md) and the
[backend selection design](../../../design/feature/attention_backend_selection.md).
+
+## Wan2.2 T2V quantization on Ascend
+
+`RAINFUSION_ATTN` accepts `diffusion_kv_cache_dtype: fp8` or `mxfp4` for
+Wan2.2 T2V A14B.
+MindIE-SD must expose `sparse_attention` with `rf_v3` and an explicit `precision`
+argument. Omni passes the selected precision directly to this API; the installed
+native operators must support that precision. Unsupported inputs or an
+incompatible Python API raise an actionable error; Omni does not change BSA
+precision automatically. Update `diffusion_kv_cache_dtype` to a precision
+supported by the installed MindIE-SD, or unset it. Native execution errors also
+propagate without retry.
+BSA FP8 and MXFP4 retain MindIE-SD's default rotation policy.
+
+`diffusion_kv_cache_skip_layers`/`diffusion_kv_cache_skip_steps` explicitly
+select floating-point BSA and keep attention sparse. The existing `block_sparse`
+warmup/layer exclusions and short-sequence threshold instead select Dense
+attention, using the configured Dense precision. Leave `block_sparse.precision`
+at its default when using `diffusion_kv_cache_dtype` as the shared Dense/BSA
+precision setting.
+
+Configure BSA quantization in the model's existing deployment YAML with
+`backend: RAINFUSION_ATTN` and stage-level `diffusion_kv_cache_dtype: fp8` or
+`mxfp4`. The precision and skip selectors are siblings of
+`diffusion_attention_config`; they are not per-role `quant` fields.
+For 40 denoising steps, `diffusion_kv_cache_skip_steps: "0,1,38,39"` and
+`diffusion_kv_cache_skip_layers: "0,39"` are recommended starting points. These
+fixed step indices do not automatically follow a changed step count. Selected
+forwards remain floating-point BSA; unsupported BSA precision is an error rather
+than an automatic fallback. See
+[quantized attention](../../quantization/quantized_kvcache.md#wan22-t2v-quantized-attention-on-ascend)
+for the shared configuration structure and index semantics.
diff --git a/docs/user_guide/diffusion/mot_config.md b/docs/user_guide/diffusion/mot_config.md
index 6661c6c9a..d25c1cd00 100644
--- a/docs/user_guide/diffusion/mot_config.md
+++ b/docs/user_guide/diffusion/mot_config.md
@@ -28,7 +28,7 @@ and their optimal Triton tile configurations:
Config loading order (3-tier, see ops/mot_gemm.py):
1. $VLLM_TUNED_CONFIG_FOLDER/ (env override)
- 2. This directory: vllm_omni/diffusion/layers/mot/configs/
+ 2. This directory: vllm_omni/diffusion/models/bagel/mot/configs/
3. Conservative default config (compiles everywhere, sub-optimal perf)
If no config file matches the current device, a warning is printed with
@@ -39,7 +39,7 @@ To generate configs for your hardware:
python benchmarks/kernels/mot_linear_benchmarks.py \
--model ByteDance-Seed/BAGEL-7B-MoT \
--tp-size 1 --dtype w16a16 --tune \
- --save-dir vllm_omni/diffusion/layers/mot/configs/
+ --save-dir vllm_omni/diffusion/models/bagel/mot/configs/
For multi-GPU tuning (uses Ray for parallel search):
diff --git a/docs/user_guide/diffusion/offloader/distributed_layerwise_offload.md b/docs/user_guide/diffusion/offloader/distributed_layerwise_offload.md
index b6e67c5ca..d36afb79e 100644
--- a/docs/user_guide/diffusion/offloader/distributed_layerwise_offload.md
+++ b/docs/user_guide/diffusion/offloader/distributed_layerwise_offload.md
@@ -353,9 +353,14 @@ modes can resolve the same `None` value to different schedules.
Cache-DiT on any selected component. Prompt-embedding cache is also
incompatible when the text encoder uses `allgather`. Rank-local cache hits
could otherwise make ranks enter different weight collectives.
-- Per-tensor online FP8 linears use the ordinary loader and can run with either
- DiT transfer path. With DiT `allgather`, every rank temporarily materializes
- the complete FP8 model in host memory before DLO retains only its shard.
+- Per-tensor online FP8, INT8, and MXFP8 linears use the ordinary loader and
+ can run with either DiT transfer path. With DiT `allgather`, every rank
+ temporarily materializes the complete quantized model in host memory before
+ DLO retains only its shard. Layers too wide for the NPU quantization kernel
+ (`npu_quant_matmul` rejects an output dimension past 65535) stay
+ unquantized and load straight into host memory under offload-after-quant —
+ their runtime layout is a plain contiguous bf16 weight, the same layout DLO
+ shards on the ordinary path, so they are allowed under `allgather` too.
Other online quantization methods require rank-local transfer for the
affected component until their runtime layouts are validated.
- Resident leading layers require DiT `rank-local` transfer and a model
diff --git a/docs/user_guide/examples/online_serving/bagel.md b/docs/user_guide/examples/online_serving/bagel.md
index 6c10c4349..6b1e20391 100644
--- a/docs/user_guide/examples/online_serving/bagel.md
+++ b/docs/user_guide/examples/online_serving/bagel.md
@@ -247,12 +247,18 @@ curl http://localhost:8091/v1/chat/completions \
-d @payload.json
```
-BAGEL img2img derives its generated image size from the input image. It
-preserves the input aspect ratio, aligns dimensions to the latent stride, and
-applies the checkpoint size limit; explicit `height` and `width` values do not
-override this model-specific resize policy. In step mode, the effective size is
-resolved before scheduler admission so requests with different resulting
-shapes are not combined.
+When no output size is requested (`size=auto` on `/v1/images/edits`, or no
+`height`/`width` in a chat request), BAGEL img2img derives the canvas from the
+input image: it preserves the input aspect ratio, aligns dimensions to the
+latent stride (16 px), and applies the checkpoint size limit. An explicit
+`size`, `height`, or `width` is honored instead, in both the single-stage and
+the two-stage deployment; the input image is still resized to a stride-aligned
+size for the VAE/ViT prefill. The latent grid needs multiples of 16, so a
+requested side that is not one is floored to the next multiple (1000x700
+generates 992x688) and the server logs a warning; the response reports the
+generated size. A side above the checkpoint limit is rejected with HTTP 400.
+In step mode, the effective size is resolved before scheduler admission so
+requests with different resulting shapes are not combined.
### Image to Text (img2text)
@@ -318,8 +324,8 @@ curl http://localhost:8091/v1/chat/completions \
| `--server` / `-s` | `http://localhost:8091` | Server URL |
| `--image-url` / `-i` | `None` | Input image URL or local path (img2img/img2text) |
| `--modality` / `-m` | `text2img` | `text2img`, `img2img`, `img2text`, `text2text` |
-| `--height` | `512` | Text-to-image output height; BAGEL img2img derives its size from the input image |
-| `--width` | `512` | Text-to-image output width; BAGEL img2img derives its size from the input image |
+| `--height` | `512` | Output height, a multiple of 16; omit both `--height` and `--width` to let img2img derive the size from the input image |
+| `--width` | `512` | Output width, a multiple of 16; omit both `--height` and `--width` to let img2img derive the size from the input image |
| `--steps` | `25` | Number of inference steps |
| `--seed` | `42` | Random seed |
| `--negative` | `None` | Negative prompt for CFG |
diff --git a/docs/user_guide/examples/online_serving/qwen3_omni.md b/docs/user_guide/examples/online_serving/qwen3_omni.md
index 2c85c33fe..654802c5c 100644
--- a/docs/user_guide/examples/online_serving/qwen3_omni.md
+++ b/docs/user_guide/examples/online_serving/qwen3_omni.md
@@ -2,7 +2,6 @@
Source .
-
## 🛠️ Installation
Please refer to [README.md](https://github.com/vllm-project/vllm-omni/tree/main/README.md)
@@ -15,6 +14,19 @@ Please refer to [README.md](https://github.com/vllm-project/vllm-omni/tree/main/
vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni --port 8091
```
+For a local deployment with multiple API frontend processes sharing one set
+of stage engines, add `--api-server-count`:
+
+```bash
+vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni \
+ --api-server-count 2 --port 8091
+```
+
+This mode supports local EngineCore stages with one local process group per
+replica, including stages configured with multiple `num_replicas`. Headless,
+remote, diffusion, intra-replica data-parallel, and Ray stage deployments
+remain single-frontend.
+
The default deployment configuration situated at `vllm_omni/deploy/qwen3_omni_moe.yaml` is resolved and loaded
automatically via the model registry, obviating the necessity for the `--deploy-config` flag in standard deployment topologies.
The bundled Qwen3-Omni setup explicitly sets `moe_backend: triton` for the Thinker and Talker stages. This keeps
@@ -27,6 +39,7 @@ on the Thinker stage. Keep Talker and Code2Wav at `pipeline_parallel_size: 1`. T
default asynchronous scheduling and audio chunk streaming can remain enabled.
To explicitly utilize a custom deployment YAML, specify the configuration path:
+
```bash
vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni --port 8091 \
--deploy-config /path/to/deploy_config_file
@@ -50,7 +63,7 @@ Adopt the stage-based CLI architecture to independently instantiate execution pr
The example below pins Stage 0 to GPU 0 and Stage 1/2 to GPU 1 via
`CUDA_VISIBLE_DEVICES`.
-**1. Stage 0 (Thinker + API server)**
+#### 1. Stage 0 (Thinker + API server)
```bash
CUDA_VISIBLE_DEVICES=0 vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni \
@@ -60,7 +73,7 @@ CUDA_VISIBLE_DEVICES=0 vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni \
--omni-master-port 26000
```
-**2. Stage 1 (Talker)**
+#### 2. Stage 1 (Talker)
```bash
CUDA_VISIBLE_DEVICES=1 vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni \
@@ -70,7 +83,7 @@ CUDA_VISIBLE_DEVICES=1 vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni \
--omni-master-port 26000
```
-**3. Stage 2 (Code2Wav)**
+#### 3. Stage 2 (Code2Wav)
```bash
CUDA_VISIBLE_DEVICES=1 vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni \
@@ -95,6 +108,9 @@ To experiment with another supported MoE backend, set `moe_backend` in the
deployment YAML for both the Thinker and Talker stages. For the stage-based
CLI, pass `--moe-backend` directly on each stage command.
+For other stage settings, pass the option on that stage command. For example,
+to change its GPU memory utilization:
+
```bash
CUDA_VISIBLE_DEVICES=1 vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni \
--stage-id 1 \
@@ -107,11 +123,12 @@ CUDA_VISIBLE_DEVICES=1 vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni \
### Send Multi-modal Request
Get into the example folder
+
```bash
cd examples/online_serving/qwen3_omni
```
-#### Send request via python
+#### Send request via python
```bash
python openai_chat_completion_client_for_multimodal_generation.py --query-type use_image --port 8091 --host "localhost"
@@ -126,7 +143,6 @@ The Python client supports the following command-line arguments:
- `--audio-path` (or `-a`): Path to local audio file or URL. If not provided and query-type is `use_audio`, uses default audio URL. Supports local file paths (automatically encoded to base64) or HTTP/HTTPS URLs and common audio formats: MP3, WAV, OGG, FLAC, M4A. Example: `--audio-path /path/to/audio.wav` or `--audio-path https://example.com/audio.mp3`
- `--prompt` (or `-p`): Custom text prompt/question. If not provided, uses default prompt for the selected query type. Example: `--prompt "What are the main activities shown in this video?"`
-
For example, to use a local video file with custom prompt:
```bash
@@ -136,19 +152,20 @@ python openai_chat_completion_client_for_multimodal_generation.py \
--prompt "What are the main activities shown in this video?"
```
-#### Send request via curl
+#### Send request via curl
```bash
bash run_curl_multimodal_generation.sh use_image
```
## Modality control
+
You can control output modalities to specify which types of output the model should generate. This is useful when you only need text output and want to skip audio generation stages for better performance.
### Supported modalities
| Modalities | Output |
-|------------|--------|
+| ------------ | -------- |
| `["text"]` | Text only |
| `["audio"]` | Audio only |
| `["text", "audio"]` | Text + Audio |
@@ -226,7 +243,9 @@ print(response.choices[1].message.audio) # Audio response
```
## Streaming Output
+
If you want to enable streaming output, please set the argument as below. The final output will be obtained just after generated by corresponding stage. We support both text streaming output and audio streaming output. Other modalities can output normally.
+
```bash
python openai_chat_completion_client_for_multimodal_generation.py \
--query-type use_image \
@@ -259,12 +278,14 @@ The convenience script launches both the vLLM server and Gradio demo together:
```
This script will:
+
1. Start the vLLM server in the background
2. Wait for the server to be ready
3. Launch the Gradio demo
4. Handle cleanup when you press Ctrl+C
The script supports the following arguments:
+
- `--model`: Model name/path (default: Qwen/Qwen3-Omni-30B-A3B-Instruct)
- `--server-port`: Port for vLLM server (default: 8091)
- `--gradio-port`: Port for Gradio demo (default: 7861)
@@ -275,18 +296,19 @@ The script supports the following arguments:
#### Option 2: Manual Launch (Two-Step Process)
-**Step 1: Launch the vLLM API server**
+##### Step 1: Launch the vLLM API server
```bash
vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni --port 8091
```
If you have a custom deploy config file:
+
```bash
vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni --port 8091 --deploy-config /path/to/deploy_config_file
```
-**Step 2: Run the Gradio demo**
+##### Step 2: Run the Gradio demo
In a separate terminal:
@@ -299,7 +321,7 @@ Then open `http://localhost:7861/` on your local browser to interact with the we
The gradio script supports the following arguments:
- `--model`: Model name/path (should match the server model)
-- `--api-base`: Base URL for the vLLM API server (default: http://localhost:8091/v1)
+- `--api-base`: Base URL for the vLLM API server (default: )
- `--ip`: Host/IP for Gradio server (default: 127.0.0.1)
- `--port`: Port for Gradio server (default: 7861)
- `--share`: Share the Gradio demo publicly (creates a public link)
diff --git a/docs/user_guide/examples/online_serving/text_to_speech.md b/docs/user_guide/examples/online_serving/text_to_speech.md
index e9499551f..c1107ad60 100644
--- a/docs/user_guide/examples/online_serving/text_to_speech.md
+++ b/docs/user_guide/examples/online_serving/text_to_speech.md
@@ -413,6 +413,22 @@ vllm serve Qwen/Qwen3-TTS-12Hz-1.7B-CustomVoice --omni --port 8091
./qwen3_tts/run_server.sh Base
```
+For a local deployment with multiple API frontend processes sharing one set
+of TTS stage engines, add `--api-server-count`:
+
+```bash
+vllm serve Qwen/Qwen3-TTS-12Hz-1.7B-CustomVoice \
+ --omni --api-server-count 2 --port 8091
+```
+
+This mode supports local EngineCore stages with one local process group per
+replica, including stages configured with multiple `num_replicas`. Headless,
+remote, intra-replica data-parallel, and Ray stage deployments are not
+supported. Runtime voice upload and deletion are disabled with multiple
+API frontends because their registries are process-local. Built-in voices,
+inline `ref_audio`, and voices restored from `custom_voice_dir` at startup are
+supported.
+
### Executor backend
Single-GPU serves now default to the uniproc executor (lower IPC overhead, the Base cloning use case from [#2603](https://github.com/vllm-project/vllm-omni/issues/2603) / [#2604](https://github.com/vllm-project/vllm-omni/pull/2604)). `vllm_omni/deploy/qwen3_tts.yaml` is the only Qwen3-TTS deploy config; pass `--deploy-config ` to override.
@@ -478,6 +494,10 @@ checkpoint. When a request names an uploaded voice, the server infers
`task_type="Base"`. Built-in presets such as `vivian` and `ryan` remain
CustomVoice speakers and require a CustomVoice checkpoint.
+The runtime upload and delete routes require a single API frontend; with
+`--api-server-count > 1`, use inline `ref_audio` or restore precomputed voices
+from `custom_voice_dir` at startup.
+
### Precomputed custom voices
For reused Base voice-cloning speakers, precompute the reference artifacts once
diff --git a/docs/user_guide/quantization/mxfp4.md b/docs/user_guide/quantization/mxfp4.md
index b18b3e7b3..00ff97c01 100644
--- a/docs/user_guide/quantization/mxfp4.md
+++ b/docs/user_guide/quantization/mxfp4.md
@@ -6,22 +6,25 @@ W4A4 MXFP4 (Microscaling FP4) quantizes both weights and activations to FP4
(`float4_e2m1fn_x2`, packed 2 values per byte) using the OCP MX format: groups
of 32 K-dimension elements share a single `float8_e8m0fnu` exponent scale.
+On Ascend, single-scale MXFP4 also supports Universal Optimal Scaling
+(UOS, `Qmax=7.25`), described in the single-scale scaling section below.
+
vLLM-Omni provides two quantization methods with different scale structures:
| Method | Scale structure | Mode | Use case |
-|--------|----------------|------|----------|
-| `mxfp4` | Single-scale (per-32 fine only) | Online only | Quick accuracy baseline; no checkpoint prep needed |
-| `mxfp4_dualscale` | Dual-scale (fine per-32 + coarse per-512 + per-channel `mul_scale`) | Online + Offline | Production; better accuracy; offline recommended |
+| -------- | ---------------- | ------ | ---------- |
+| `mxfp4` | Single-scale (per-32 fine only) | Online + pre-quantized single-scale weights | Online baseline, or an existing single-scale checkpoint in the layout below |
+| `mxfp4_dualscale` | Dual-scale (fine per-32 + coarse per-512 + per-channel `mul_scale`) | Online + Offline | W4A4 with dual-level scales; offline mode loads calibrated Smooth tensors |
-!!! tip "Recommended: `mxfp4_dualscale` offline"
- For production deployments, use the `mxfp4_dualscale` offline mode with a
+!!! tip "Existing W4A4-only DualScale deployments"
+ For W4A4-only deployments, the existing `mxfp4_dualscale` offline mode uses a
pre-quantized checkpoint produced by msModelSlim. Offline checkpoints load
- calibrated `mul_scale` tensors from disk, providing measurably better accuracy
- than any online method. The one-time preprocessing cost amortises across all
- subsequent inference runs.
+ calibrated `mul_scale` tensors from disk. Quality depends on the model,
+ calibration recipe and BF16 fallback policy; evaluate the checkpoint against
+ your quality target before deployment.
- Use `mxfp4` online only for quick experimentation where preprocessing time
- is not acceptable and accuracy loss is tolerable.
+ W4A8 layer/step fallback requires single-scale `mxfp4`, online or offline.
+ DualScale supports W4A4 and BF16 routing only.
!!! warning "Online single-scale ≠ Offline dual-scale"
`mxfp4_dualscale` offline mode uses `NPUMxfp4DualScaleLinearMethod`:
@@ -34,61 +37,244 @@ vLLM-Omni provides two quantization methods with different scale structures:
## Hardware Support
-| Device | Support |
-|--------|---------|
-| NVIDIA Blackwell GPU (SM 100+) | ⭕ |
-| NVIDIA Ada/Hopper GPU (SM 89+) | ⭕ |
-| NVIDIA Ampere GPU (SM 80+) | ⭕ |
-| AMD ROCm (gfx950 / MI355X) | ✅ |
-| Intel XPU | ⭕ |
-| Ascend NPU (Atlas 950 A5) | ✅ |
+The following matrix describes these vLLM-Omni implementations, rather than
+hardware support for the MXFP4 format in general.
-Legend: `✅` supported, `❌` unsupported, `⭕` not verified in this guide.
+| Device | Single-scale online OCP | Single-scale offline | UOS / W4A8 fallback | DualScale |
+| -------- | -------- | -------- | -------- | -------- |
+| Ascend NPU (Atlas 950 A5) | ✅ | ✅ | ✅ | ✅ |
+| AMD ROCm (gfx950 / MI355X) | ✅ | ❌ | ❌ | ❌ |
+| Other AMD architectures | ❌ | ❌ | ❌ | ❌ |
+| NVIDIA GPU | ❌ | ❌ | ❌ | ❌ |
+| Intel XPU | ❌ | ❌ | ❌ | ❌ |
+
+Legend: `✅` supported by the implementation, `❌` unsupported.
+ROCm uses the existing AITER online path and requires `mxfp4_scale_alg=0`.
## Model Type Support
### Diffusion Model (Wan2.2)
| Model | Online | Offline | Notes |
-|-------|--------|---------|-------|
-| Wan2.2-T2V-A14B | `mxfp4` / `mxfp4_dualscale` | `mxfp4_dualscale` | MoE cascade (`transformer` + `transformer_2`); both transformers quantized with the same config |
-| Wan2.2-I2V-A14B | `mxfp4` / `mxfp4_dualscale` | `mxfp4_dualscale` | MoE cascade; same scheme as T2V-A14B |
-| Wan2.2-TI2V-5B | ❌ | ❌ | Parameter count too small; W4A4 causes unacceptable accuracy loss |
+| ------- | -------- | --------- | ------- |
+| Wan2.2-T2V-A14B | `mxfp4` / `mxfp4_dualscale` | `mxfp4` / `mxfp4_dualscale` | Cascade experts resolve checkpoint metadata independently; explicit global runtime policy applies to both |
+| Wan2.2-I2V-A14B | `mxfp4` / `mxfp4_dualscale` | `mxfp4` / `mxfp4_dualscale` | Per-expert configuration uses the same interface as T2V; validate I2V checkpoints separately |
+| Wan2.2-TI2V-5B | Requires validation | Requires validation | This guide does not establish checkpoint compatibility or generation quality for TI2V-5B |
-The choice between `mxfp4` and `mxfp4_dualscale` in **online mode** is about
-quantization quality, not model compatibility — both work on cascade (A14B) and
-single-transformer models alike, the same as `mxfp8` online:
+Both methods can be integrated with single-transformer and cascade models.
+This alone does not establish support or quality for every model variant:
-- `mxfp4`: single-scale, lower overhead, simpler compute, online only
-- `mxfp4_dualscale`: dual-scale + optional BF16 fallback, better accuracy, online **and** offline
+- `mxfp4`: single-scale; online and pre-quantized weights, with optional W4A8 fallback on NPU
+- `mxfp4_dualscale`: dual-scale; online and offline, with BF16 fallback
-**Offline** checkpoints for A14B are always in `mxfp4_dualscale` format (produced
-by the merge script); there is no offline `mxfp4` single-scale format.
+The existing `merge_mxfp4_dualscale_checkpoint.py` produces **offline
+`mxfp4_dualscale`** checkpoints. Single-scale weights must satisfy the separate
+layout described below; changing a DualScale checkpoint's method name to
+`mxfp4` does not convert its weights. Prepare single-scale checkpoints with
+external tooling. Real exported checkpoint compatibility and model quality
+require validation of that checkpoint; the synthetic tests do not establish
+UOS export or video acceptance.
!!! note "Per-layer BF16 fallback in offline cascade models"
- The A14B offline checkpoint uses `quant_method: mxfp4_dualscale`. Most
+ An A14B offline DualScale checkpoint uses `quant_method: mxfp4_dualscale`. Most
linear layers are stored as W4A4 MXFP4 DualScale; precision-sensitive layers
retain their original BF16 weights and are listed in `ignored_layers` inside
each transformer's `config.json`. The two transformers may have different
`ignored_layers` sets — the pipeline reads each transformer's own `config.json`
- and rebuilds the config locally when they differ, so routing is always
- per-transformer-accurate.
-
-!!! warning "TI2V-5B not supported"
- Wan2.2-TI2V-5B is excluded from W4A4 quantization. Its smaller parameter
- count makes it significantly more sensitive to 4-bit quantization noise,
- resulting in unacceptable accuracy loss. Use [MXFP8](mxfp8.md) for TI2V-5B.
+ and resolves the storage format and BF16 layer policy independently.
## Configuration
+### W4A8 fallback at selected layers and denoising steps (Ascend NPU)
+
+For single-scale `mxfp4`, set `w4a8_fallback_steps` to a list of zero-based
+request denoising loop indices (not scheduler timestep values).
+Set `w4a8_fallback_layers` to exact runtime Linear paths, for example
+`["blocks.10.attn1.to_qkv", "blocks.12.ffn.net_2"]`. A selected layer uses W4A8
+at every step; at a selected step, all other quantized layers also use W4A8.
+The rules are combined with **OR**. W4A8 uses MXFP8 activations with MXFP4
+weights. Omitting both lists or passing `[]` keeps the existing W4A4 behavior. Existing
+`ignored_layers` take priority: **BF16 > (layer OR step) W4A8 > W4A4**.
+DualScale's existing leading BF16 block rule is unchanged; it does not enable
+W4A8.
+
+```python
+from vllm_omni import Omni
+
+omni = Omni(
+ model="",
+ quantization_config={
+ "method": "mxfp4",
+ "w4a8_fallback_layers": ["blocks.10.attn1.to_qkv"],
+ "w4a8_fallback_steps": [0, 1, 38, 39],
+ },
+)
+```
+
+Both policies also work with offline single-scale `mxfp4`. Any nonempty
+W4A8 list with `mxfp4_dualscale`, online or offline, raises an explicit error
+at configuration construction. Empty lists preserve its existing W4A4 path.
+Each expert's checkpoint still determines its serialized
+format and BF16 layer routing. A serialized checkpoint config is the complete
+storage contract: `ignored_layers`, or its `modules_to_not_convert` alias,
+selects the BF16 layers, and omitting both means no explicit BF16 layers. A
+method-only checkpoint value such as `"mxfp4"` or
+`{"quant_method": "mxfp4"}` carries no storage policy and leaves a caller's
+online `ignored_layers` unchanged. An explicitly supplied quantization config
+retains its W4A8 layer and step lists when the loader rebuilds either expert's
+config from disk, including empty lists that disable checkpoint policies.
+Within an explicit runtime config, an omitted W4A8 list defaults to `[]`;
+individual omitted fields do not inherit saved policies. Without an explicit
+runtime config, auto-detection uses the saved checkpoint policies.
+
+Layer names are relative to each expert (`blocks.10...`, without a
+`transformer.` or `transformer_2.` prefix). A global config applies the same
+list to both experts; per-component `transformer`/`transformer_2` configs can
+select different lists. Wan selects these expert names exactly: a `transformer`
+entry does not match `transformer_2`; an omitted expert uses `default` if set.
+A component mapped to `null` (or an unmatched component
+without a default) stays unquantized and requires a BF16 checkpoint; loading a
+quantized checkpoint for that disabled component raises an error. A top-level
+`quantization_config=None` retains checkpoint auto-detection.
+Names are exact, with no regex, wildcard, block expansion,
+or checkpoint-name remapping. Wan validates them against its runtime Linear
+modules and logs the selected paths/count and BF16 overrides per PP rank.
+Use `attn1.to_qkv` for fused self-attention; `attn1.to_q`, `to_k`, or `to_v`
+checkpoint names raise an error. Cross-attention `attn2.to_q/to_k/to_v` remains
+separate. Layer-only fallback does not require a denoise ForwardContext.
+
+The text-to-video example accepts the JSON directly:
+
+```bash
+ASCEND_RT_VISIBLE_DEVICES=0,1,2,3 \
+python examples/offline_inference/text_to_video/text_to_video.py \
+ --model /path/to/Wan2.2-T2V-A14B-Diffusers \
+ --quantization-config '{"method":"mxfp4","w4a8_fallback_steps":[0,2]}' \
+ --tensor-parallel-size 1 --ulysses-degree 2 --cfg-parallel-size 2 \
+ --enforce-eager --height 480 --width 832 --num-frames 81 \
+ --num-inference-steps 40 --seed 42 --output wan22-w4a8.mp4
+```
+
+Use either `--quantization` or `--quantization-config` in this example.
+Serving accepts the same JSON through `--diffusion-quantization-config`.
+
+The list uses one request's loop index across both high- and low-noise experts,
+and both CFG branches see the same index. A new request starts at step zero.
+Indices outside the request's step range are never selected. A pipeline must
+publish `ForwardContext.denoise_step_idx`; requesting step fallback without
+that context raises an error instead of silently ignoring the list.
+
+Single-scale W4A4 and W4A8 reuse the same prepared `weight` and `weight_scale`.
+Online loading quantizes the original BF16/FP16 weight once; offline loading
+packs the numeric FP4 values and reshapes the saved E8M0 scale without
+requantizing the weight. Only activation precision changes during forward.
+There is no DualScale decoding, second W4 representation or `w4a8_weight` /
+`w4a8_weight_scale` cache. No weight quantization runs inside the denoising loop.
+
+The mixed FP8/FP4 GEMM uses BF16 output and a matching BF16 row bias for
+compatibility with the target A5 runtime. An FP16 caller receives that result
+converted back to FP16; its output shape and dtype are preserved.
+
+The single-scale fallback validation target is eager Wan2.2 T2V A14B on A5.
+Quality scores, optimal fallback lists, real UOS exports and additional
+compile/offload combinations require separate evaluation. Existing W4A4-only
+DualScale still needs complete 512-channel input groups; use TP=1 with
+sequence/CFG parallelism for its initial multi-card run.
+
+### `mxfp4` — Pre-Quantized Single-Scale Weights (Ascend NPU)
+
+Set the following fields in each transformer's `config.json` when a
+single-scale checkpoint uses calibrated Smooth scaling:
+
+```json
+{
+ "quantization_config": {
+ "quant_method": "mxfp4",
+ "is_checkpoint_mxfp4_serialized": true,
+ "require_smooth_scale": true,
+ "ignored_layers": []
+ }
+}
+```
+
+Each quantized Linear must provide tensors under its model parameter name:
+
+| Tensor | Checkpoint layout | Meaning |
+| -------- | ------------------- | --------- |
+| `weight` | `(N, K)` numeric FP4 values | Packed to FP4 after loading |
+| `weight_scale` | `(N, ceil(K / 32))`, `uint8` | Raw E8M0 exponent bytes, required |
+| `mul_scale` | `(K,)`, FP32 | Smooth pre-scale, required when declared above |
+
+Both W4A4 and W4A8 quantize `x * mul_scale`. The Smooth tensor is converted
+to the layer's activation dtype after loading. Row-parallel layers load the
+corresponding input-channel shard. Pre-fused QKV weights must use one shared
+Smooth tensor for the fused projection.
+
+For backward compatibility, `require_smooth_scale` defaults to `false`:
+an absent tensor uses identity scaling, while a present tensor is still loaded.
+Without a declaration, an absent Smooth tensor cannot be distinguished from a
+legacy unsmoothed checkpoint. Calibrated checkpoints should declare
+`require_smooth_scale: true` so missing or misnamed Smooth tensors fail loading;
+incorrect tensor shapes, non-floating tensors, NaN/Inf and nonpositive values
+also fail. Values that overflow or underflow to zero in the activation dtype
+are rejected during weight processing. The flag requires serialized single-scale
+weights and is rejected for online quantization. It does not make DualScale
+scales optional or change missing-parameter policies for other backends.
+Either the checkpoint or an explicit caller can require Smooth: a `true`
+declaration is retained when per-expert metadata rebuilds the configuration,
+including when the other source omits the flag or sets it to `false`.
+
+Prepare the canonical numeric FP4 checkpoint before inference using external
+tooling. Runtime loading does not parse producer-specific export formats.
+Retain the producer recipe to identify the weight-generation algorithm and
+Smooth calibration; tensor storage alone does not establish UOS provenance.
+
+### `mxfp4` — Single-Scale Block Scaling (OCP / UOS)
+
+`mxfp4_scale_alg` selects the MXFP4 block-scaling method on NPU.
+UOS is a scaling rule, not a separate activation dtype or an activation-only
+algorithm. Both choices use FP4 E2M1 values with shared E8M0 scales.
+
+| Mode | Weight preparation | A4 activation quantization | W4A8 fallback |
+| --- | --- | --- | --- |
+| Online | Selected scaling method, once at loading | Selected scaling method | Same W4; OCP MXFP8 A8 |
+| Offline | Load existing W4 and scales unchanged | Selected scaling method | Same W4; OCP MXFP8 A8 |
+
+The available settings are:
+
+| Setting | MXFP4 scaling method | NPU parameters |
+| --- | --- | --- |
+| `0` (default) | OCP MX | `scale_alg=0` |
+| `2` | UOS (`Qmax=7.25`) | `scale_alg=2, dst_type_max=7.25` |
+
+Universal Optimal Scaling (UOS, `Qmax=7.25`) is derived in
+[MXAttention: Data-Free Optimal Scaling and Pre-Normalization Quantization for MXFP4 Attention](https://arxiv.org/abs/2607.24377),
+Section 4.1. The value `7.25` is the boundary used to select the shared
+power-of-two scale; the maximum finite E2M1 value remains `6`.
+This option applies UOS to Linear quantization. It does not implement the
+paper's full MXAttention pipeline or Pre-Normalization Quantization (PNQ).
+
+Both use FP4 E2M1 with E8M0 scales, `axis=-1`, `block_size=32`,
+`round_mode="rint"`. W4A8 always quantizes the activation to
+`float8_e4m3fn` with `scale_alg=0` and the same grouping/rounding, without
+UOS parameters. A4 and A8 share the prepared W4 and scale. UOS is currently
+NPU-only; ROCm retains its existing AITER online algorithm.
+
+An explicit UOS online configuration is
+`{"method": "mxfp4", "mxfp4_scale_alg": 2}`. For offline checkpoints the
+setting affects **only A4 activations**. Existing weights are never requantized:
+a UOS checkpoint can run UOS W4 + UOS A4 or UOS W4 + OCP A4, and both fall back to
+UOS W4 + OCP A8. Record the weight-generation algorithm separately from the
+runtime activation setting. Smooth remains active with either setting. The
+UOS configuration explicitly selects `2`; attention computation is unchanged.
+
### `mxfp4` — Single-Scale Online Mode
-Online mode requires no pre-processing. vLLM-Omni quantizes BF16 weights to
-MXFP4 at load time using `npu_dynamic_mx_quant`. A single block scale
-(`float8_e8m0fnu`, one per 32 K elements) is computed on the fly; no
-calibration `mul_scale` is available. Applies equally to single-transformer
-and cascade (A14B) models — both transformers in a cascade receive the same
-quantization config automatically.
+Online mode quantizes BF16/FP16 weights once at loading and computes activation
+scales during forward. Each block of 32 K elements shares one E8M0 scale;
+no calibrated `mul_scale` is available. An explicit global quantization config
+applies to both cascade experts. Per-component configs can select different
+policies; checkpoint auto-detection resolves each expert independently.
```python
from vllm_omni import Omni
@@ -103,7 +289,7 @@ outputs = omni.generate(
```bash
# Single-transformer or cascade model — same command
-python text_to_video.py --model --quantization mxfp4
+python examples/offline_inference/text_to_video/text_to_video.py --model --quantization mxfp4
# Online serving
vllm serve --omni --quantization mxfp4
@@ -113,19 +299,19 @@ vllm serve --omni --quantization mxfp4
Online DualScale mode computes both fine and coarse scales on the fly from BF16
weights using `npu_dynamic_dual_level_mx_quant`. Applies equally to
-single-transformer and cascade (A14B) models. Compared to `mxfp4` online,
-DualScale provides better quantization accuracy at higher compute cost.
+single-transformer and cascade (A14B) models with compatible Linear layers.
+Compare quality and performance using the intended model and workload.
The default configuration keeps the leading 5 transformer blocks in BF16
-(`num_bf16_fallback_layers=5`). Accuracy evaluation on Wan2.2-A14B shows this
-is sufficient to meet quality requirements and is the recommended setting.
+(`num_bf16_fallback_layers=5`). This is an implementation default; select and
+validate the BF16 policy against your own quality target.
```python
omni = Omni(model="", quantization="mxfp4_dualscale")
```
```bash
-python text_to_video.py --model --quantization mxfp4_dualscale
+python examples/offline_inference/text_to_video/text_to_video.py --model --quantization mxfp4_dualscale
```
If accuracy debugging identifies additional precision-sensitive layers, they
@@ -136,21 +322,22 @@ omni = Omni(
model="",
quantization_config={
"method": "mxfp4_dualscale",
- "ignored_layers": ["blocks.10.attn1.to_q"], # explicit per-layer override
+ "ignored_layers": ["blocks.10.attn1.to_qkv"], # explicit per-layer override
},
)
```
BF16 fallback routing in online mode applies two rules in priority order:
-1. **`ignored_layers`** (explicit per-layer override): any layer whose prefix
- matches is kept in BF16 regardless of block index.
+1. **`ignored_layers`** (explicit per-layer override): a listed runtime Linear
+ module is kept in BF16 regardless of block index. Use exact module paths,
+ not arbitrary block prefixes or names ending in `.weight`.
2. **`num_bf16_fallback_layers`** (coarse leading-block rule): the first N
transformer blocks (`blocks.0` … `blocks.N-1`) fall back to BF16. Defaults
- to `5` (recommended). Layers outside `blocks.N.*`
- (e.g. `condition_embedder`) are always quantized.
+ to `5`. Layers outside `blocks.N.*` are quantized unless explicitly listed
+ in `ignored_layers`.
-### `mxfp4_dualscale` — DualScale Offline Mode (Recommended)
+### `mxfp4_dualscale` — DualScale Offline Mode
Offline mode loads a pre-quantized DualScale checkpoint from msModelSlim. A
preprocessing step converts the raw quantized output to the diffusers format
@@ -169,8 +356,8 @@ inside `config.json`. At runtime, each layer's prefix is matched against
Each quantized linear layer stores four tensors:
| Tensor | Shape | dtype | Description |
-|--------|-------|-------|-------------|
-| `weight` | `(N, K)` | float8_e4m3fn | FP4 packed (2 values per byte) |
+| -------- | ------- | ------- | ------------- |
+| `weight` | `(N, K)` | float8_e4m3fn | Numeric FP4 values; packed into two values per byte after loading |
| `weight_scale` | `(N, K//32)` | uint8 | Fine block scale (`float8_e8m0fnu` bit pattern) |
| `weight_dual_scale` | `(N, K//512, 1)` | float32 | Coarse block scale |
| `mul_scale` | `(K,)` | float32 | Per-input-channel smooth pre-scale (from calibration) |
@@ -223,7 +410,7 @@ python vllm_omni/quantization/tools/merge_mxfp4_dualscale_checkpoint.py \
```
| Argument | Description |
-|----------|-------------|
+| ---------- | ------------- |
| `--model-type` | Model variant: `Wan2.2-T2V-A14B` or `Wan2.2-I2V-A14B` |
| `--original-model` | Root directory of the original BF16 diffusers model |
| `--quant-path` | Root directory of the msModelSlim quantized output |
@@ -251,14 +438,14 @@ The `quantization_config` injected into `config.json` for each transformer:
```
`ignored_layers` lists every linear layer that retains its original BF16 weight,
-using vllm-omni model parameter names (QKV-fused, FFN underscored, `to_out`
+using vllm-omni runtime module paths (QKV-fused, FFN underscored, `to_out`
unindexed). The exact entries are determined by the quantization tool (msModelSlim)
and may differ between `transformer` and `transformer_2` in a cascade model.
#### Step 3 — Serve
```bash
-python text_to_video.py --model /path/to/Wan2.2-T2V-A14B-MXFP4-DualScale
+python examples/offline_inference/text_to_video/text_to_video.py --model /path/to/Wan2.2-T2V-A14B-MXFP4-DualScale
# Online serving
vllm serve /path/to/Wan2.2-T2V-A14B-MXFP4-DualScale --omni
@@ -275,25 +462,32 @@ omni = Omni(model="/path/to/Wan2.2-T2V-A14B-MXFP4-DualScale")
## Parameters
-### `mxfp4` (single-scale, online only)
+### `mxfp4` (single-scale, online + offline)
| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
+| ----------- | ------ | --------- | ------------- |
| `method` | str | — | `"mxfp4"` |
-| `ignored_layers` | list[str] | `[]` | Layer prefixes to keep in BF16 |
+| `mxfp4_scale_alg` | int | `0` | MXFP4 block scaling: `0` OCP MX, `2` UOS (`Qmax=7.25`, NPU only). Online: W4 and A4; offline: A4 only. A8 remains OCP MXFP8 |
+| `is_checkpoint_mxfp4_serialized` | bool | `false` | Load pre-quantized single-scale weights and scales; declared in checkpoint `config.json` |
+| `require_smooth_scale` | bool | `false` | Require calibrated Smooth tensors for offline single-scale weights |
+| `ignored_layers` | list[str] | `[]` | Exact runtime Linear module paths to keep in BF16 |
+| `w4a8_fallback_layers` | list[str] | `[]` | Exact runtime Linear paths that always use A8; NPU only |
+| `w4a8_fallback_steps` | list[int] | `[]` | Zero-based denoise steps that use A8; NPU only |
### `mxfp4_dualscale` (dual-scale, online + offline)
| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
+| ----------- | ------ | --------- | ------------- |
| `method` | str | — | `"mxfp4_dualscale"` |
| `is_checkpoint_serialized` | bool | `False` | `True` for offline DualScale checkpoints; auto-set from `config.json` when using the preprocessing script |
-| `ignored_layers` | list[str] | `[]` | Layer prefixes to keep in BF16. **Works in both modes**: offline — populated by the merge script for interleaved sensitive layers; online — user-supplied for explicit per-layer precision override |
-| `num_bf16_fallback_layers` | int | `5` | **Online mode only**: leading N transformer blocks (`blocks.0` … `blocks.N-1`) kept in BF16. Applied after `ignored_layers`; ignored in offline mode. Default of `5` is the evaluated recommended value for Wan2.2-A14B |
+| `ignored_layers` | list[str] | `[]` | Exact runtime Linear module paths to keep in BF16. **Works in both modes**: offline — populated by the merge script for interleaved sensitive layers; online — user-supplied for explicit per-layer precision override |
+| `num_bf16_fallback_layers` | int | `5` | **Online mode only**: leading N transformer blocks (`blocks.0` … `blocks.N-1`) kept in BF16. Applied after `ignored_layers`; ignored in offline mode. Validate the default of `5` against the intended model and quality target |
+| `w4a8_fallback_layers` | list[str] | `[]` | Must remain empty; DualScale does not support W4A8 fallback |
+| `w4a8_fallback_steps` | list[int] | `[]` | Must remain empty; DualScale does not support W4A8 fallback |
#### BF16 fallback priority (online mode)
-```
+```text
for each linear layer:
if prefix in ignored_layers → BF16 (explicit override, highest priority)
elif block_idx < num_bf16_fallback_layers → BF16 (coarse leading-block rule)
@@ -307,8 +501,9 @@ unless they appear in `ignored_layers`.
1. **Online single-scale (`mxfp4`)** quantizes BF16 weights at load time using
`npu_dynamic_mx_quant` (single-scale). No calibration `mul_scale` is
- available — all output partitions receive an identity pre-scale. No offline
- checkpoint format exists for this method.
+ available — all output partitions receive an identity pre-scale. Offline
+ single-scale checkpoints use the canonical numeric FP4 layout
+ described above.
2. **Online dual-scale (`mxfp4_dualscale`, `is_checkpoint_serialized=False`)**
quantizes BF16 weights using `npu_dynamic_dual_level_mx_quant` (fine + coarse
@@ -316,7 +511,7 @@ unless they appear in `ignored_layers`.
explicit `ignored_layers` stay in BF16 for accuracy.
3. **Offline dual-scale (`mxfp4_dualscale`, `is_checkpoint_serialized=True`)** —
- **recommended for production** — loads four tensors per quantized layer: FP4
+ loads four tensors per quantized layer: FP4
weight, fine scale (`uint8` reinterpreted as `float8_e8m0fnu`), coarse scale
(`float32`), and per-input-channel `mul_scale` (`float32`). BF16 fallback
layers have no quantization tensors and are routed via `ignored_layers`.
@@ -325,21 +520,21 @@ unless they appear in `ignored_layers`.
layout as `float8_e8m0fnu`) and reinterpreted at load time without a lossy
float32 round-trip.
-5. **Cascade model config propagation**: in a cascade model (transformer +
- transformer_2), vLLM-Omni reads each transformer's own `config.json` and
- rebuilds the quant config locally when `ignored_layers` differs between
- transformers, ensuring per-layer routing is accurate for each. The first
- transformer's config is propagated to `od_config` so the second transformer
- can reuse it as a starting point.
+5. **Cascade model configuration**: checkpoint auto-detection resolves each
+ expert's own `config.json` independently; the first expert's detected config
+ is not reused as the second expert's policy. An explicit global runtime
+ config applies to both experts, while per-component configs select policies
+ by the exact `transformer` / `transformer_2` names. Serialized checkpoint
+ metadata still determines each expert's storage format and BF16 layers.
6. **Self-attention QKV fusion**: Q, K, V projection weights are fused into a
single `QKVParallelLinear` layer at runtime. `ignored_layers` entries use the
fused name (`attn1.to_qkv`), written automatically by the merge script.
-7. W4A4 carries higher quantization noise than W8A8 (16 vs 256 levels). The
- DualScale offline method mitigates this with calibrated `mul_scale` smooth
- quantization. Use `ignored_layers` and `num_bf16_fallback_layers` to trade
- off compression vs. accuracy for precision-sensitive layers.
+7. FP4 has fewer representable values than FP8, so evaluate quantization
+ error and generation quality for the chosen recipe. Offline Smooth scaling
+ and BF16 fallback can help with sensitive layers.
+ `num_bf16_fallback_layers` applies only to online DualScale.
## Adapting MXFP4 for a New Model
@@ -350,27 +545,26 @@ a merge script for offline checkpoints.
### Step 1 — Discover runtime layer names
-`ignored_layers` entries must match the **runtime parameter names** used inside
-vllm-omni, which may differ from the names stored in the diffusers checkpoint.
-The canonical source of truth is the model's own `named_parameters()`.
+`ignored_layers` entries use exact **runtime Linear module paths**, without
+`.weight`. Inspect the actual transformer instance in model initialization or
+a developer harness; `Omni` does not expose an `omni.pipeline.transformer` API.
+For a transformer instance named `transformer`:
```python
-from vllm_omni import Omni
+from vllm.model_executor.layers.linear import LinearBase
-# Load the model without quantization to inspect parameter names.
-omni = Omni(model="/path/to/your-model") # no --quantization flag
-for name, _ in omni.pipeline.transformer.named_parameters():
- if "weight" in name and "scale" not in name:
+for name, module in transformer.named_modules():
+ if isinstance(module, LinearBase):
print(name)
```
-Compare the printed names against the diffusers checkpoint keys
+Compare these module paths against the corresponding diffusers checkpoint keys
(`safetensors.safe_open` or `torch.load`) to identify any renames your model
applies. Common patterns that differ in Wan2.2 (and may appear in other
models):
| Diffusers checkpoint name | vllm-omni runtime name | Reason |
-|---------------------------|------------------------|--------|
+| --------------------------- | ------------------------ | -------- |
| `attn1.to_q`, `attn1.to_k`, `attn1.to_v` | `attn1.to_qkv` | Self-attention Q/K/V fused into `QKVParallelLinear` |
| `ffn.net.0.proj` | `ffn.net_0.proj` | Dots in sub-module names replaced with underscores |
| `ffn.net.2` | `ffn.net_2` | Same underscore rule |
@@ -382,8 +576,9 @@ fused runtime parameters.
!!! warning "Partial QKV fallback is not allowed"
If your model fuses Q, K, V into a single layer, `ignored_layers` must
- include **all three or none**. A partial fallback (e.g. `to_q` in BF16 but
- `to_k`, `to_v` quantized) cannot be expressed at runtime because they share
+ name the fused runtime module (for Wan, `attn1.to_qkv`). The source
+ checkpoint must keep **all three or none** in BF16. A partial fallback
+ (e.g. `to_q` in BF16 but `to_k`, `to_v` quantized) cannot be expressed at runtime because they share
one `QKVParallelLinear`. The merge script enforces this and raises an error
if only some of the trio appear as non-quantized.
@@ -392,12 +587,13 @@ fused runtime parameters.
#### Online mode
Pass `ignored_layers` directly in the quantization config using the **runtime
-names** discovered in Step 1. No code changes to the model are required.
+names** discovered in Step 1. This assumes the model already passes its
+quantization config and module prefixes to compatible vLLM Linear layers.
```python
omni = Omni(
model="/path/to/your-model",
- quantization={
+ quantization_config={
"method": "mxfp4_dualscale",
"ignored_layers": [
"blocks.0.attn1.to_qkv", # runtime name, not diffusers name
@@ -409,9 +605,14 @@ omni = Omni(
```
```bash
-# CLI does not support list-typed ignored_layers directly.
-# Use the Python API or set ignored_layers in config.json (offline).
-python your_script.py --model /path/to/your-model --quantization mxfp4_dualscale
+# The text-to-video example accepts list-valued fields through JSON.
+python examples/offline_inference/text_to_video/text_to_video.py \
+ --model /path/to/your-model \
+ --quantization-config '{"method":"mxfp4_dualscale","ignored_layers":["blocks.0.attn1.to_qkv"]}'
+
+# Serving accepts the same configuration.
+vllm serve /path/to/your-model --omni \
+ --diffusion-quantization-config '{"method":"mxfp4_dualscale","ignored_layers":["blocks.0.attn1.to_qkv"]}'
```
The `num_bf16_fallback_layers` coarse rule is an alternative to listing layers
@@ -436,9 +637,13 @@ the merge script is correct. The injected block:
}
```
-To add a layer manually (e.g. to pin an additional layer to BF16 without
-re-running the merge script), edit `config.json` inside the transformer
-subfolder. Use runtime names, not diffusers checkpoint names.
+Adding an offline BF16 fallback layer requires both the original BF16 weight
+from the base model and a matching `ignored_layers` entry. Regenerate the
+checkpoint with the revised storage policy, restoring the original weight
+(and bias, if present) and removing that layer's quantization tensors.
+Editing `config.json` alone does not reconstruct BF16 weights from stored FP4
+values. For fused QKV, restore all three projections together. Use runtime
+module paths in `ignored_layers`.
### Step 3 — Write a merge script for offline mode
@@ -474,6 +679,7 @@ renaming rules and collect the results.
!!! tip "Validate before serving"
After producing the offline checkpoint, load it without a `--quantization`
flag and verify that vLLM-Omni auto-detects the correct method. Check that
- the layer count reported in the startup log matches expectations: quantized
- layer count + `ignored_layers` count should equal total linear layer count.
- Any mismatch indicates a name-mapping bug in the merge script.
+ each intended runtime Linear module resolves to the expected quantized or
+ BF16 method and that every BF16 entry has original BF16 weights. Account
+ for fused modules and, in online DualScale, the leading-block fallback rule;
+ the raw length of `ignored_layers` alone is not a reliable layer count.
diff --git a/docs/user_guide/quantization/overview.md b/docs/user_guide/quantization/overview.md
index 8319077a2..7e7452bec 100644
--- a/docs/user_guide/quantization/overview.md
+++ b/docs/user_guide/quantization/overview.md
@@ -13,7 +13,7 @@ For the internal architecture and backend extension points, see the
| Mode | Guide | Description | Methods |
| ------ | ------- | ------------- | --------- |
| Online quantization | [Online Quantization](online.md) | vLLM-Omni computes quantized weights and scales while loading the model. | FP8 W8A8, Int8 W8A8, BitsAndBytes W4, MXFP8 W8A8, MXFP4 W4A4 |
-| Runtime attention quantization | [Quantized KV Cache](quantized_kvcache.md) | vLLM-Omni dynamically quantizes eligible diffusion Flash Attention tensors during inference. | FP8 FA |
+| Runtime attention quantization | [Quantized KV Cache](quantized_kvcache.md) | vLLM-Omni dynamically quantizes eligible diffusion attention tensors during inference. | FP8, MXFP8, MXFP4 |
| Pre-quantized checkpoints | Method-specific guides | The checkpoint or an offline quantizer provides quantized weights and scales before serving. | ModelOpt, AutoRound, TorchAO, msModelSlim, serialized Int8, offline MXFP8, offline MXFP4 DualScale |
## Hardware Support
diff --git a/docs/user_guide/quantization/quantized_kvcache.md b/docs/user_guide/quantization/quantized_kvcache.md
index 99a90e08a..30ba53593 100644
--- a/docs/user_guide/quantization/quantized_kvcache.md
+++ b/docs/user_guide/quantization/quantized_kvcache.md
@@ -2,41 +2,36 @@
## Overview
-In DiT-based image and video generation, Flash Attention can take a large share
-of denoising time, especially for high-resolution or long-frame workloads.
-vLLM-Omni supports online FP8 quantization for eligible diffusion Flash
-Attention (FA) to reduce FA latency while keeping model weights in their
-original dtype.
+In DiT-based image and video generation, attention can take a large share of
+denoising time, especially for high-resolution or long-frame workloads.
+vLLM-Omni supports online Q/K/V quantization for eligible diffusion attention
+paths while keeping model weights in their original dtype.
-This feature is configured through `diffusion_kv_cache_dtype` on
-`OmniDiffusionConfig` (CLI: `--diffusion-kv-cache-dtype`). It is intentionally
-**not** the same as vLLM's `--kv-cache-dtype`, which controls autoregressive
-language-model KV cache storage and defaults to `"auto"`. Diffusion FA
-quantization uses the dedicated diffusion flags so omni serve does not inherit
-that default.
+Runtime attention precision is configured through `diffusion_kv_cache_dtype`
+on `OmniDiffusionConfig` (CLI: `--diffusion-kv-cache-dtype`). This setting is
+separate from vLLM's `--kv-cache-dtype`, which controls autoregressive
+language-model KV cache storage.
In vLLM-Omni diffusion pipelines, this is a runtime FA path: Q/K/V tensors are
dynamically quantized before the attention operator. It does not quantize model
weights and is separate from [FP8 W8A8](fp8.md), [Int8 W8A8](int8.md), or
pre-quantized checkpoint formats.
-If `diffusion_kv_cache_dtype` is not set, behavior is unchanged and attention
-runs in the native dtype.
+If `diffusion_kv_cache_dtype` is not set, attention runs in the native dtype.
## Hardware Support
-| Device | FP8 FA |
-|--------|--------|
-| Ascend NPU | ✅ |
-| NVIDIA GPU | ❌ |
-| AMD ROCm | ❌ |
-| Intel XPU | ❌ |
+| Device | Dense FP8 | Dense MXFP8/MXFP4 | BSA FP8/MXFP4 |
+|--------|------------|-------------------|----------------|
+| Ascend NPU | ✅ | ✅ | ✅ |
+| NVIDIA GPU | ❌ | ❌ | ❌ |
+| AMD ROCm | ❌ | ❌ | ❌ |
+| Intel XPU | ❌ | ❌ | ❌ |
Legend: `✅` supported, `❌` unsupported.
-FP8 FA is currently implemented only for the NPU Flash Attention backend. Other
-backends do not support `diffusion_kv_cache_dtype="fp8"` for diffusion attention
-and fall back to native dtype execution.
+These runtime methods are implemented only by the NPU Flash Attention and BSA
+backends. Other backends reject an incompatible explicit configuration.
## Model Type Support
@@ -44,7 +39,7 @@ and fall back to native dtype execution.
| Model | Scope | Status | Notes |
|-------|-------|--------|-------|
-| Wan2.2 | Eligible DiT full-attention FA on Ascend NPU | Tested | Compare quality and latency against a BF16 baseline before production use |
+| Wan2.2 | Self-attention on Ascend NPU | NPU interface and T2V smoke tested | Compare quality and latency against a BF16 baseline before production use |
| Other diffusion models | Eligible DiT full-attention FA on Ascend NPU | Not tested | You can try `diffusion_kv_cache_dtype="fp8"`; tune `diffusion_kv_cache_skip_steps` and `diffusion_kv_cache_skip_layers` when higher precision is needed |
### Multi-Stage Omni/TTS Model (Qwen3-Omni, Qwen3-TTS)
@@ -105,12 +100,13 @@ The legacy keyword aliases `kv_cache_dtype`, `kv_cache_skip_steps`, and
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
-| `diffusion_kv_cache_dtype` | str \| None | `None` | Set to `"fp8"` to enable dynamic FP8 FA on supported attention backends |
+| `diffusion_kv_cache_dtype` | str \| None | `None` | Runtime attention method. Dense FA supports `fp8`, `mxfp8`, and `mxfp4`; BSA supports `fp8` and `mxfp4` |
| `diffusion_kv_cache_skip_steps` | str \| None | `None` | Denoising step selector to keep in native dtype, for example `"0,1,4-6"` |
| `diffusion_kv_cache_skip_layers` | str \| None | `None` | Transformer layer selector to keep in native dtype, for example `"0-2,10"` |
Selectors use comma-separated integers and inclusive ranges. Listed steps or
-layers skip FP8 FA; all other eligible full-attention forwards use the FP8 path.
+layers run floating-point attention through the selected Dense or BSA backend;
+all other eligible forwards use `diffusion_kv_cache_dtype`.
## Validation and Notes
@@ -123,3 +119,60 @@ layers skip FP8 FA; all other eligible full-attention forwards use the FP8 path.
4. Report both latency and quality results when enabling this option for a new
model. For image or video models, include visual comparison and quantitative
metrics when available, such as PSNR or SSIM.
+
+## Wan2.2 T2V quantized attention on Ascend
+
+Wan2.2 T2V A14B supports quantized self-attention through MindIE-SD. Model
+weights are unchanged, and model-level opt-out keeps cross-attention in its
+native dtype.
+
+| Attention path | self-attention `backend` | Supported `diffusion_kv_cache_dtype` |
+| --- | --- | --- |
+| Dense FA | `FLASH_ATTN` | `fp8`, `mxfp8`, `mxfp4` |
+| BSA | `RAINFUSION_ATTN` | `fp8`, `mxfp4` |
+
+Configure the method and fallback selectors once at the diffusion stage. The
+per-role attention config only selects the self-attention backend:
+
+```yaml
+stages:
+ - stage_id: 0
+ diffusion_kv_cache_dtype: "mxfp8"
+ diffusion_kv_cache_skip_layers: "0,39"
+ diffusion_kv_cache_skip_steps: "0,1,38,39"
+ diffusion_attention_config:
+ per_role:
+ self:
+ backend: FLASH_ATTN # Use RAINFUSION_ATTN with fp8 or mxfp4 for BSA.
+```
+
+For 40 denoising steps, `diffusion_kv_cache_skip_steps: "0,1,38,39"` and
+`diffusion_kv_cache_skip_layers: "0,39"` are recommended starting points. Steps
+are zero-based across the complete request and do not reset when Wan switches
+transformers; layer indices are zero-based and local to each transformer.
+Selectors accept comma-separated indices and inclusive ranges such as
+`"0,3-5"`. A selected forward uses floating-point attention while preserving
+the Dense or BSA path.
+
+Unsupported precision/input combinations raise an error and must be corrected
+in the configuration; operator errors are not retried with another precision.
+
+For BSA, change the backend to `RAINFUSION_ATTN` and set
+`diffusion_kv_cache_dtype` to `fp8` or `mxfp4`.
+See [RainFusion attention](../diffusion/attention_backends/rainfusion.md) for
+sparse-path configuration and behavior.
+
+### Requirement and interface test
+
+Until these APIs are available in a MindIE-SD release, use revision
+[`8637b5333b0225381b215390fd09a8732e671cc4`](https://gitcode.com/zqxu/MindIE-SD/commit/8637b5333b0225381b215390fd09a8732e671cc4).
+Build the Python package, PyTorch plugin, and custom operators from that same
+checkout. With CANN sourced, run the NPU interface tests from the Omni checkout:
+
+```bash
+python -m pytest tests/platforms/npu/quant/test_kv_quant_npu.py \
+ -k real_npu -vv -s -o addopts=''
+```
+
+A skipped NPU test is not a pass. Validate generated video quality against a
+floating-point run with the same prompt, seed, resolution, and step count.
diff --git a/examples/model_display_names.yml b/examples/model_display_names.yml
index 7a04ff8fa..be4ba2f80 100644
--- a/examples/model_display_names.yml
+++ b/examples/model_display_names.yml
@@ -2,7 +2,6 @@
# The docs generator combines these names with the serving mode for each page H1.
aura_omni: AURA Omni
covo_audio: Covo-Audio-Chat
-dynin_omni: Dynin-Omni
lance: Lance
mimo_audio: MiMo-Audio
ming_flash_omni: Ming-flash-omni 2.0
diff --git a/examples/offline_inference/dynin_omni/README.md b/examples/offline_inference/dynin_omni/README.md
deleted file mode 100644
index 6cf834142..000000000
--- a/examples/offline_inference/dynin_omni/README.md
+++ /dev/null
@@ -1,110 +0,0 @@
-# Dynin-Omni: Offline inference
-
-This folder contains a unified offline inference entrypoint:
-
-- `end2end.py`
-
-## 1. Environment Setup
-
-Run from repository root:
-
-```bash
-cd
-```
-
-If needed, install this repo in editable mode:
-
-```bash
-pip install -e .
-```
-
-## 2. Extra Dependencies (EMOVA)
-
-Install the following packages for EMOVA-related components:
-
-```bash
-pip install \
- "phonemizer==3.3.0" \
- "Unidecode==1.4.0" \
- "hydra-core==1.3.2" \
- "pytorch-lightning==1.1.0" \
- "wget==3.2" \
- "wrapt==2.1.1" \
- "onnx==1.20.1" \
- "frozendict==2.4.7" \
- "inflect==7.5.0" \
- "braceexpand==0.1.7" \
- "webdataset==1.0.2" \
- "torch-stft==0.1.4" \
- "editdistance==0.8.1"
-```
-
-## 3. Hardware and VRAM Requirements
-
-This example uses a 3-stage pipeline on one GPU by default
-([`dynin_omni.yaml`](../../../vllm_omni/deploy/dynin_omni.yaml)):
-
-- Stage-0 (`token2text`): `gpu_memory_utilization: 0.5`
-- Stage-1 (`token2image`): `gpu_memory_utilization: 0.1`
-- Stage-2 (`token2audio`): `gpu_memory_utilization: 0.1`
-
-### Requested GPU Memory Budget from `gpu_memory_utilization`
-
-| Stage | Utilization | A100 80GB | H200 141GB |
-| :-- | :-- | :-- | :-- |
-| Stage-0 (token2text) | 0.5 | ~40.0 GB | ~70.5 GB |
-| Stage-1 (token2image) | 0.1 | ~8.0 GB | ~14.1 GB |
-| Stage-2 (token2audio) | 0.1 | ~8.0 GB | ~14.1 GB |
-| Total requested budget | 0.7 | ~56.0 GB | ~98.7 GB |
-
-### Observed Runtime Signal (from your log)
-
-- Stage-0 reported: `Model loading took 15.12 GiB memory` (weights footprint signal).
-- Stages 1/2 can still add runtime memory depending on task path and backend allocations.
-- Keep extra headroom for CUDA/PyTorch overhead and temporary allocations.
-
-### GPU Compatibility
-
-- Confirmed target GPUs for this setup: **NVIDIA H200**, **NVIDIA A100**.
-- CI/e2e coverage in this repo also includes CUDA **L4** markers for Dynin tests.
-
-## 4. End2End Run Examples
-
-```bash
-# t2t
-python /examples/offline_inference/dynin_omni/end2end.py \
- --task t2t --model snu-aidas/Dynin-Omni --text
-
-# i2t
-python /examples/offline_inference/dynin_omni/end2end.py \
- --task i2t --model snu-aidas/Dynin-Omni --image --text "Please describe this image in detail."
-
-# s2t
-python /examples/offline_inference/dynin_omni/end2end.py \
- --task s2t --model snu-aidas/Dynin-Omni --audio --text "Transcribe the given audio."
-
-# t2i
-python /examples/offline_inference/dynin_omni/end2end.py \
- --task t2i --model snu-aidas/Dynin-Omni --text
-
-# v2t
-python /examples/offline_inference/dynin_omni/end2end.py \
- --task v2t --model snu-aidas/Dynin-Omni --video --text "Describe this video in detail."
-
-# i2i
-python /examples/offline_inference/dynin_omni/end2end.py \
- --task i2i --model snu-aidas/Dynin-Omni --image --text
-
-# t2s
-python /examples/offline_inference/dynin_omni/end2end.py \
- --task t2s --model snu-aidas/Dynin-Omni --text
-```
-
-## 5. Notes
-
-- Outputs are saved under task-specific directories in `/tmp` by default.
-- You can override output path with `--output-dir`.
-- If you want to force local config resolution, pass `--dynin-config-path `.
-- If you see the warning
- `max_num_batched_tokens (32768) exceeds max_num_seqs * max_model_len (4096)`,
- reduce `max_num_batched_tokens` in the deploy config (for example, `4096` in the CI config).
diff --git a/examples/offline_inference/dynin_omni/end2end.py b/examples/offline_inference/dynin_omni/end2end.py
deleted file mode 100644
index 74d33fe01..000000000
--- a/examples/offline_inference/dynin_omni/end2end.py
+++ /dev/null
@@ -1,1448 +0,0 @@
-#!/usr/bin/env python3
-# SPDX-License-Identifier: Apache-2.0
-
-from __future__ import annotations
-
-import argparse
-import json
-import os
-import re
-import sys
-import time
-import types
-from importlib.machinery import ModuleSpec
-from pathlib import Path
-from typing import Any
-
-import numpy as np
-import torch
-from PIL import Image
-
-TASK_CHOICES = ("t2t", "t2i", "t2s", "i2i", "i2t", "s2t", "v2t")
-
-TASK_DEFAULT_RUNTIME = {
- "t2t": ("mmu", "mmu", 0, "text"),
- "t2i": ("t2i", "t2i_gen", 2, "image"),
- "t2s": ("t2s_mmu_like", "t2s_gen", 1, "audio"),
- "i2i": ("i2i", "i2i", 2, "image"),
- "i2t": ("mmu", "mmu", 0, "text"),
- "s2t": ("s2t", "s2t", 0, "text"),
- "v2t": ("v2t", "v2t", 0, "text"),
-}
-
-TASK_RUNTIME_FALLBACKS: dict[str, dict[str, Any]] = {
- "t2t": {
- "output_dir": "/tmp/dynin_end2end_outputs",
- "prompt_max_text_len": 1024,
- "max_new_tokens": 1024,
- "steps": 1024,
- "block_length": 16,
- "temperature": 0.0,
- "cfg_scale": 0.0,
- },
- "t2i": {
- "output_dir": "/tmp/dynin_t2i_outputs",
- "prompt_max_text_len": 128,
- "image_token_count": 1024,
- "mask_token_id": 126336,
- "codebook_size": 8192,
- "timesteps": 20,
- "guidance_scale": 3.5,
- "temperature": 1.0,
- },
- "i2i": {
- "output_dir": "/tmp/dynin_i2i_outputs",
- "prompt_max_text_len": 128,
- "mask_token_id": 126336,
- "codebook_size": 8192,
- "timesteps": 64,
- "guidance_scale": 3.5,
- "temperature": 1.0,
- "image_resolution": 336,
- "use_train_i2i_prompt": True,
- },
- "i2t": {
- "output_dir": "/tmp/dynin_i2t_outputs",
- "prompt_max_text_len": 128,
- "max_new_tokens": 128,
- "steps": 128,
- "block_length": 2,
- "temperature": 0.0,
- "cfg_scale": 0.0,
- "mask_token_id": 126336,
- "codebook_size": 8192,
- "image_resolution": 480,
- "remasking": "low_confidence",
- },
- "s2t": {
- "output_dir": "/tmp/dynin_s2t_outputs",
- "prompt_max_text_len": 1024,
- "max_new_tokens": 128,
- "steps": 128,
- "block_length": 2,
- "temperature": 0.0,
- "cfg_scale": 0.0,
- "mask_token_id": 126336,
- "codebook_size": 8192,
- "remasking": "low_confidence",
- },
- "t2s": {
- "output_dir": "/tmp/dynin_t2s_outputs",
- "runtime_task": "t2s_mmu_like",
- "prompting_task": "t2s_gen",
- "prompt_max_text_len": 1024,
- "t2s_token_length": 512,
- "mask_token_id": 126336,
- "codebook_size": 8192,
- "audio_codebook_size": 4096,
- "steps": 512,
- "block_length": 128,
- "temperature": 1.0,
- "cfg_scale": 2.5,
- "t2s_condition": "gender-female_emotion-neutral_speed-normal_pitch-normal",
- },
- "v2t": {
- "output_dir": "/tmp/dynin_v2t_outputs",
- "prompt_max_text_len": 1024,
- "max_new_tokens": 128,
- "steps": 128,
- "block_length": 2,
- "temperature": 0.0,
- "cfg_scale": 0.0,
- "mask_token_id": 126336,
- "codebook_size": 8192,
- "image_resolution": 224,
- "num_frames": 5,
- "remasking": "low_confidence",
- },
-}
-
-DEFAULT_I2T_QUESTION = "Please describe this image in detail."
-DEFAULT_S2T_INSTRUCTION = "Transcribe the given audio."
-DEFAULT_V2T_QUESTION = "Please provide a detailed description of the video."
-DEFAULT_T2T_PROMPT = "Explain multimodal LLM inference in 3 sentences."
-DEFAULT_T2S_INSTRUCTION = "Convert the given text into spoken audio."
-DEFAULT_T2S_PROMPT = "Hello. This is a default text-to-speech sample."
-
-DYNIN_SPECIAL_TOKENS = (
- "<|soi|>",
- "<|eoi|>",
- "<|sov|>",
- "<|eov|>",
- "<|t2i|>",
- "<|mmu|>",
- "<|t2v|>",
- "<|v2v|>",
- "<|lvg|>",
- "<|i2i|>",
- "<|ti2ti|>",
- "<|v2t|>",
- "<|v2s|>",
- "<|s2t|>",
- "<|t2s|>",
- "<|s2s|>",
- "<|soa|>",
- "<|eoa|>",
-)
-
-
-def bootstrap_repo_path() -> Path:
- repo_root = Path(__file__).resolve().parents[3]
- repo_root_str = str(repo_root)
- if repo_root_str not in sys.path:
- sys.path.insert(0, repo_root_str)
- return repo_root
-
-
-def ensure_safe_import_for_vllm() -> None:
- os.environ.setdefault("TRANSFORMERS_NO_TORCHVISION", "1")
- try:
- import torchvision # noqa: F401
-
- return
- except Exception:
- pass
-
- import enum
-
- class _InterpolationMode(enum.Enum):
- NEAREST = 0
- BILINEAR = 2
- BICUBIC = 3
- LANCZOS = 1
- HAMMING = 4
- BOX = 5
-
- tv_mod = types.ModuleType("torchvision")
- tv_mod.__dict__["__version__"] = "0.0-stub"
- tv_mod.__spec__ = ModuleSpec(name="torchvision", loader=None)
- transforms_mod = types.ModuleType("torchvision.transforms")
- transforms_mod.__spec__ = ModuleSpec(name="torchvision.transforms", loader=None)
- transforms_mod.InterpolationMode = _InterpolationMode
- tv_mod.transforms = transforms_mod
- sys.modules["torchvision"] = tv_mod
- sys.modules["torchvision.transforms"] = transforms_mod
-
-
-def sanitize_repo_id(repo_id: str) -> str:
- return re.sub(r"[^a-zA-Z0-9._-]+", "_", repo_id)
-
-
-def is_hf_repo_id(value: str) -> bool:
- return isinstance(value, str) and value.count("/") == 1 and all(value.split("/", 1))
-
-
-def ensure_local_model_dir(model: str, cache_dir: Path, localize: bool) -> Path:
- model_path = Path(model).expanduser()
- if model_path.is_dir():
- return model_path.resolve()
- if not localize:
- return Path(model)
-
- from huggingface_hub import snapshot_download
-
- cache_dir.mkdir(parents=True, exist_ok=True)
- os.environ.setdefault("HF_HOME", str(cache_dir / ".hf_home"))
- local_dir = cache_dir / sanitize_repo_id(model)
- if not local_dir.exists():
- print(f"[end2end] Downloading model into local cache: {local_dir}")
- snapshot_download(
- repo_id=model,
- local_dir=str(local_dir),
- local_dir_use_symlinks=True,
- resume_download=True,
- )
- return local_dir.resolve()
-
-
-def resolve_local_only(
- override: bool | None,
- source: str,
- default: bool,
-) -> bool:
- if override is not None:
- return bool(override)
- return default or Path(source).expanduser().is_dir()
-
-
-def load_text_tokenizer(tokenizer_source: str, local_files_only: bool):
- from transformers import AutoTokenizer
-
- kwargs = {
- "trust_remote_code": True,
- "padding_side": "left",
- "local_files_only": bool(local_files_only),
- }
- try:
- tokenizer = AutoTokenizer.from_pretrained(tokenizer_source, **kwargs)
- except TypeError:
- kwargs.pop("local_files_only", None)
- tokenizer = AutoTokenizer.from_pretrained(tokenizer_source, **kwargs)
- return tokenizer
-
-
-def preprocess_image(image: Image.Image, resolution: int) -> torch.Tensor:
- w, h = image.size
- short_side = min(w, h)
- scale = resolution / short_side
- new_w, new_h = round(w * scale), round(h * scale)
- image = image.resize((new_w, new_h), Image.BICUBIC)
- left = (new_w - resolution) // 2
- top = (new_h - resolution) // 2
- image = image.crop((left, top, left + resolution, top + resolution))
- arr = np.array(image, dtype=np.float32) / 255.0
- tensor = torch.from_numpy(arr).permute(2, 0, 1)
- return (tensor - 0.5) / 0.5
-
-
-def load_vq_image_encoder(source: str, local_files_only: bool, device: torch.device) -> Any:
- from vllm_omni.model_executor.models.dynin_omni.dynin_omni_common import get_dynin_magvit_attr
-
- MAGVITv2 = get_dynin_magvit_attr("MAGVITv2", source=source, local_files_only=local_files_only)
- vq_model = MAGVITv2.from_pretrained(source, local_files_only=local_files_only).to(device)
- vq_model.requires_grad_(False)
- vq_model.eval()
- return vq_model
-
-
-def encode_image_tokens(
- image_path: Path,
- vq_model: Any,
- device: torch.device,
- resolution: int,
-) -> torch.Tensor:
- image = Image.open(image_path).convert("RGB")
- image_tensor = preprocess_image(image, resolution=resolution).unsqueeze(0).to(device)
- with torch.no_grad():
- token_ids = vq_model.get_code(image_tensor)
- token_ids = torch.as_tensor(token_ids, dtype=torch.long).detach().cpu()
- if token_ids.ndim == 2 and token_ids.shape[0] == 1:
- token_ids = token_ids[0]
- return token_ids.contiguous()
-
-
-def encode_video_tokens(
- video_path: Path,
- vq_model: Any,
- device: torch.device,
- resolution: int,
- num_frames: int,
-) -> torch.Tensor:
- import cv2
-
- cap = cv2.VideoCapture(str(video_path))
- frames: list[np.ndarray] = []
- while True:
- ok, frame = cap.read()
- if not ok:
- break
- frame = cv2.cvtColor(frame, cv2.COLOR_BGR2RGB)
- frames.append(frame)
- cap.release()
- if not frames:
- raise ValueError(f"Video has no readable frames: {video_path}")
- if len(frames) < num_frames:
- raise ValueError(f"Video has {len(frames)} frames, requires >= {num_frames}: {video_path}")
-
- indices = np.linspace(0, len(frames) - 1, num_frames).astype(int)
- token_list: list[torch.Tensor] = []
- for idx in indices:
- pil = Image.fromarray(frames[int(idx)])
- frame_tensor = preprocess_image(pil, resolution=resolution).unsqueeze(0).to(device)
- with torch.no_grad():
- token_list.append(torch.as_tensor(vq_model.get_code(frame_tensor), dtype=torch.long))
- merged = torch.cat(token_list, dim=1).detach().cpu()
- if merged.ndim == 2 and merged.shape[0] == 1:
- merged = merged[0]
- return merged.contiguous()
-
-
-def load_vq_audio_encoder(source: str, local_files_only: bool, device: torch.device) -> Any:
- from transformers import AutoModel
-
- kwargs = {
- "trust_remote_code": True,
- "local_files_only": bool(local_files_only),
- "low_cpu_mem_usage": False,
- }
- try:
- model = AutoModel.from_pretrained(source, **kwargs)
- except TypeError:
- kwargs.pop("low_cpu_mem_usage", None)
- try:
- model = AutoModel.from_pretrained(source, **kwargs)
- except TypeError:
- kwargs.pop("local_files_only", None)
- model = AutoModel.from_pretrained(source, **kwargs)
- model.requires_grad_(False)
- model.eval()
- if hasattr(model, "to"):
- model = model.to(device)
- return model
-
-
-def encode_audio_tokens(audio_path: Path, vq_audio_model: Any) -> torch.Tensor:
- encoded = vq_audio_model.encode(str(audio_path))
- if isinstance(encoded, dict):
- for key in ("input_ids", "token_ids", "codes", "tokens"):
- if key in encoded:
- encoded = encoded[key]
- break
- encoded = torch.as_tensor(encoded, dtype=torch.long).detach().cpu()
- if encoded.ndim == 1:
- encoded = encoded.unsqueeze(0)
- elif encoded.ndim > 2:
- encoded = encoded.view(encoded.shape[0], -1)
- return encoded.contiguous()
-
-
-def build_chat_prompt(content: str) -> str:
- return (
- f"<|start_header_id|>user<|end_header_id|>\n{content}<|eot_id|><|start_header_id|>assistant<|end_header_id|>\n"
- )
-
-
-def resolve_task_text(
- *,
- task_name: str,
- text: str,
- instruction: str = "",
- raw_prompt: bool = False,
-) -> str:
- text = str(text or "").strip()
-
- if task_name == "t2t" and not text:
- return DEFAULT_T2T_PROMPT
- if task_name == "i2t" and not text:
- return DEFAULT_I2T_QUESTION
- if task_name == "s2t" and not text:
- return DEFAULT_S2T_INSTRUCTION
- if task_name == "v2t" and not text:
- return DEFAULT_V2T_QUESTION
- if task_name in {"t2i", "i2i"} and not text:
- return "A high quality detailed image."
-
- if task_name != "t2s":
- return text
-
- if not text:
- text = DEFAULT_T2S_PROMPT
-
- if raw_prompt:
- return text
-
- instruction = str(instruction or "").strip() or DEFAULT_T2S_INSTRUCTION
- return build_chat_prompt(f"{instruction}\n{text}")
-
-
-def load_universal_prompting(
- *,
- tokenizer: Any,
- tokenizer_source: str,
- max_text_len: int,
- cond_dropout_prob: float,
- local_files_only: bool,
- max_audio_len: int = 512,
- max_audio_len_short: int = 256,
-) -> Any:
- from vllm_omni.model_executor.models.dynin_omni.dynin_omni_common import (
- DYNIN_REMOTE_SETTINGS,
- resolve_remote_attr,
- )
-
- UniversalPrompting = resolve_remote_attr(
- "UniversalPrompting",
- module_name="prompting_utils",
- settings=DYNIN_REMOTE_SETTINGS,
- source=tokenizer_source,
- local_files_only=bool(local_files_only),
- fallback_module_names=("modeling_dynin_omni",),
- )
- init_kwargs: dict[str, Any] = {
- "max_text_len": int(max_text_len),
- "special_tokens": DYNIN_SPECIAL_TOKENS,
- "ignore_id": -100,
- "cond_dropout_prob": float(cond_dropout_prob),
- "use_reserved_token": True,
- "max_audio_len": int(max_audio_len),
- "max_audio_len_short": int(max_audio_len_short),
- }
- try:
- return UniversalPrompting(tokenizer, **init_kwargs)
- except TypeError:
- init_kwargs.pop("max_audio_len", None)
- init_kwargs.pop("max_audio_len_short", None)
- return UniversalPrompting(tokenizer, **init_kwargs)
-
-
-def _runtime_fallback(task: str, key: str, value: Any) -> Any:
- if isinstance(value, str):
- if value.strip() != "":
- return value
- elif value is not None:
- return value
- return TASK_RUNTIME_FALLBACKS.get(task, {}).get(key)
-
-
-def _validate_generation_args(*, task: str, max_new_tokens: int, steps: int, block_length: int) -> None:
- # Keep i2t/v2t generation constraints aligned with i2t.py/v2t.py.
- if task not in {"i2t", "v2t"}:
- return
- if max_new_tokens <= 0:
- raise ValueError(f"{task} requires max_new_tokens > 0.")
- if block_length <= 0:
- raise ValueError(f"{task} requires block_length > 0.")
- if steps <= 0:
- raise ValueError(f"{task} requires steps > 0.")
- if max_new_tokens % block_length != 0:
- raise ValueError(f"{task} requires max_new_tokens % block_length == 0, got {max_new_tokens} % {block_length}")
- num_blocks = max_new_tokens // block_length
- if num_blocks <= 0:
- raise ValueError(f"{task} has invalid num_blocks.")
- if steps % num_blocks != 0:
- raise ValueError(
- f"{task} requires steps % (max_new_tokens // block_length) == 0, "
- f"got steps={steps}, max_new_tokens={max_new_tokens}, block_length={block_length}"
- )
-
-
-def make_prompt_payload(
- *,
- task: str,
- text: str,
- image_tokens: torch.Tensor | None,
- audio_tokens: torch.Tensor | None,
- video_tokens: torch.Tensor | None,
- image_placeholder_tokens: int,
- audio_placeholder_tokens: int,
- image_token_offset: int,
- speech_token_offset: int,
- mask_token_id: int,
- use_train_i2i_prompt: bool,
-) -> tuple[Any, str]:
- runtime_task, prompting_task, _, _ = TASK_DEFAULT_RUNTIME[task]
- del runtime_task
-
- if task == "t2t":
- payload = ([[]], [build_chat_prompt(text)])
- return payload, prompting_task
-
- if task == "i2t":
- if image_tokens is None:
- raise ValueError("i2t requires image tokens")
- img = image_tokens.view(-1).long() + int(image_token_offset)
- payload = ([[img]], [build_chat_prompt(text)])
- return payload, prompting_task
-
- if task == "s2t":
- if audio_tokens is None:
- raise ValueError("s2t requires audio tokens")
- aud = audio_tokens.long() + int(speech_token_offset)
- if aud.ndim == 1:
- aud = aud.unsqueeze(0)
- payload = ([aud], [build_chat_prompt(text)])
- return payload, prompting_task
-
- if task == "v2t":
- if video_tokens is None:
- raise ValueError("v2t requires video tokens")
- vid = video_tokens.view(-1).long() + int(image_token_offset)
- payload = (vid.unsqueeze(0), [build_chat_prompt(text)])
- return payload, prompting_task
-
- if task == "t2i":
- image_placeholder = torch.full(
- (1, int(image_placeholder_tokens)),
- fill_value=int(mask_token_id),
- dtype=torch.long,
- )
- payload = ([text], image_placeholder)
- return payload, prompting_task
-
- if task == "i2i":
- if image_tokens is None:
- raise ValueError("i2i requires image tokens")
- src = image_tokens.view(1, -1).long() + int(image_token_offset)
- target_len = int(image_placeholder_tokens) if image_placeholder_tokens > 0 else int(src.shape[1])
- image_placeholder = torch.full(
- (1, target_len),
- fill_value=int(mask_token_id),
- dtype=torch.long,
- )
- if use_train_i2i_prompt:
- labels_placeholder = torch.full(
- (1, target_len),
- fill_value=-100,
- dtype=torch.long,
- )
- payload = ([text], src, image_placeholder, labels_placeholder)
- return payload, "i2i"
- payload = ([text], src, image_placeholder)
- return payload, "i2i_gen"
-
- if task == "t2s":
- audio_placeholder = torch.full(
- (1, int(audio_placeholder_tokens)),
- fill_value=int(mask_token_id),
- dtype=torch.long,
- )
- payload = ([text], audio_placeholder)
- return payload, prompting_task
-
- raise ValueError(f"Unsupported task: {task}")
-
-
-def _to_1d_int_list(value: Any) -> list[int]:
- if value is None:
- return []
- if isinstance(value, torch.Tensor):
- tensor = value.detach().to(device="cpu", dtype=torch.long)
- else:
- tensor = torch.as_tensor(value, dtype=torch.long)
- if tensor.ndim == 0:
- tensor = tensor.view(1)
- elif tensor.ndim >= 2:
- tensor = tensor.view(tensor.shape[0], -1)[0]
- return [int(v) for v in tensor.tolist()]
-
-
-def _run_uni_prompting(uni_prompting: Any, payload: Any, prompting_task: str) -> tuple[list[int], list[int]]:
- prepared = uni_prompting(payload, prompting_task)
- if isinstance(prepared, tuple):
- prepared_input_ids = prepared[0] if len(prepared) > 0 else None
- prepared_attention_mask = prepared[1] if len(prepared) > 1 else None
- else:
- prepared_input_ids = prepared
- prepared_attention_mask = None
-
- input_ids = _to_1d_int_list(prepared_input_ids)
- attention_mask = _to_1d_int_list(prepared_attention_mask)
- if not input_ids:
- raise RuntimeError(f"UniversalPrompting returned empty input_ids for task={prompting_task}")
- return input_ids, attention_mask
-
-
-def _get_special_token_id(uni_prompting: Any, token: str) -> int:
- sptids = getattr(uni_prompting, "sptids_dict", None) or {}
- if token not in sptids:
- raise KeyError(f"Special token not found in UniversalPrompting.sptids_dict: {token}")
- token_ids = _to_1d_int_list(sptids[token])
- if not token_ids:
- raise ValueError(f"Special token id is empty for token: {token}")
- return int(token_ids[0])
-
-
-def _tokenize_chat_query(tokenizer: Any, text: str) -> list[int]:
- encoded = tokenizer(build_chat_prompt(text), return_tensors="pt").input_ids[0]
- token_ids = _to_1d_int_list(encoded)
- if not token_ids:
- raise RuntimeError("Failed to tokenize chat query text.")
- return token_ids
-
-
-def _flatten_media_token_ids_with_offset(token_ids: Any, token_offset: int) -> list[int]:
- media_ids = token_ids
- if isinstance(media_ids, torch.Tensor):
- media_ids = media_ids.detach().cpu().reshape(-1).tolist()
- else:
- media_ids = np.asarray(media_ids).reshape(-1).tolist()
- return [int(x) + int(token_offset) for x in media_ids]
-
-
-def _scalar_token_id(value: Any) -> int:
- if isinstance(value, torch.Tensor):
- if value.numel() == 0:
- raise ValueError("Empty special-token tensor.")
- return int(value.view(-1)[0].item())
- if isinstance(value, (list, tuple)):
- if not value:
- raise ValueError("Empty special-token list.")
- return int(value[0])
- return int(value)
-
-
-def build_v2t_input_ids(
- *,
- video_token_ids: Any,
- tokenizer: Any,
- uni_prompting: Any,
- question: str,
- image_token_offset: int,
-) -> tuple[list[int], str]:
- media_ids = video_token_ids
- if isinstance(media_ids, torch.Tensor):
- media_ids = media_ids.detach().cpu().reshape(-1).tolist()
- else:
- media_ids = np.asarray(media_ids).reshape(-1).tolist()
- media_ids = [int(x) + int(image_token_offset) for x in media_ids]
-
- sptids = uni_prompting.sptids_dict
- task_id = _scalar_token_id(sptids["<|v2t|>"])
- soi_id = _scalar_token_id(sptids["<|soi|>"])
- eoi_id = _scalar_token_id(sptids["<|eoi|>"])
- sot_id = _scalar_token_id(sptids["<|sot|>"])
-
- prompt_text = build_v2t_chat_prompt(question)
- query_ids = tokenizer(prompt_text, return_tensors="pt").input_ids[0].detach().cpu().tolist()
- input_ids = [task_id, soi_id] + media_ids + [eoi_id, sot_id] + [int(v) for v in query_ids]
- return input_ids, prompt_text
-
-
-def build_i2t_input_ids(
- *,
- image_token_ids: Any,
- tokenizer: Any,
- uni_prompting: Any,
- question: str,
- image_token_offset: int,
-) -> tuple[list[int], str]:
- image_ids = image_token_ids
- if isinstance(image_ids, torch.Tensor):
- image_ids = image_ids.detach().cpu().reshape(-1).tolist()
- else:
- image_ids = np.asarray(image_ids).reshape(-1).tolist()
- image_ids = [int(x) + int(image_token_offset) for x in image_ids]
-
- sptids = uni_prompting.sptids_dict
- task_id = _scalar_token_id(sptids["<|mmu|>"])
- soi_id = _scalar_token_id(sptids["<|soi|>"])
- eoi_id = _scalar_token_id(sptids["<|eoi|>"])
- sot_id = _scalar_token_id(sptids["<|sot|>"])
-
- prompt_text = build_i2t_chat_prompt(question)
- query_ids = tokenizer(prompt_text, return_tensors="pt").input_ids[0].detach().cpu().tolist()
- input_ids = [task_id, soi_id] + image_ids + [eoi_id, sot_id] + [int(v) for v in query_ids]
- return input_ids, prompt_text
-
-
-def build_v2t_chat_prompt(question: str) -> str:
- return (
- f"<|start_header_id|>user<|end_header_id|>\n{question}<|eot_id|><|start_header_id|>assistant<|end_header_id|>\n"
- )
-
-
-def build_i2t_chat_prompt(question: str) -> str:
- return (
- f"<|start_header_id|>user<|end_header_id|>\n{question}<|eot_id|><|start_header_id|>assistant<|end_header_id|>\n"
- )
-
-
-def make_mmu_prompt(
- *,
- task: str,
- text: str,
- tokenizer: Any,
- uni_prompting: Any,
- image_tokens: torch.Tensor | None,
- audio_tokens: torch.Tensor | None,
- video_tokens: torch.Tensor | None,
- image_token_offset: int,
- speech_token_offset: int,
-) -> tuple[list[int], list[int]]:
- query_ids = _tokenize_chat_query(tokenizer, text)
-
- if task == "i2t":
- token_ids, _ = build_i2t_input_ids(
- image_token_ids=image_tokens,
- tokenizer=tokenizer,
- uni_prompting=uni_prompting,
- question=text,
- image_token_offset=int(image_token_offset),
- )
- token_ids = [int(v) for v in token_ids]
- return token_ids, [1] * len(token_ids)
-
- if task == "v2t":
- token_ids, _ = build_v2t_input_ids(
- video_token_ids=video_tokens,
- tokenizer=tokenizer,
- uni_prompting=uni_prompting,
- question=text,
- image_token_offset=int(image_token_offset),
- )
- token_ids = [int(v) for v in token_ids]
- return token_ids, [1] * len(token_ids)
-
- if task == "s2t":
- if audio_tokens is None:
- raise ValueError("s2t requires audio tokens")
- audio_ids = _to_1d_int_list(audio_tokens.long() + int(speech_token_offset))
- token_ids = [
- _get_special_token_id(uni_prompting, "<|s2t|>"),
- _get_special_token_id(uni_prompting, "<|soa|>"),
- *audio_ids,
- _get_special_token_id(uni_prompting, "<|eoa|>"),
- *query_ids,
- ]
- return token_ids, [1] * len(token_ids)
-
- raise ValueError(f"Unsupported task for validation-style MMU prompt: {task}")
-
-
-def iter_mm_outputs(outputs: list[Any]):
- for omni_out in outputs:
- req_out = omni_out
- req_list = req_out if isinstance(req_out, list) else [req_out]
- for item in req_list:
- if item is None:
- continue
- mm_out = getattr(item, "multimodal_output", None) or {}
- if mm_out:
- yield mm_out
- completions = getattr(item, "outputs", None) or []
- for completion in completions:
- c_mm_out = getattr(completion, "multimodal_output", None) or {}
- if c_mm_out:
- yield c_mm_out
- omni_mm = getattr(omni_out, "multimodal_output", None) or {}
- if omni_mm:
- yield omni_mm
-
-
-def _to_token_list(value: Any) -> list[int]:
- if value is None:
- return []
- if hasattr(value, "detach"):
- value = value.detach()
- if hasattr(value, "cpu"):
- value = value.cpu()
- if hasattr(value, "flatten"):
- value = value.flatten().tolist()
- if isinstance(value, tuple):
- value = list(value)
- if not isinstance(value, list):
- return []
- out: list[int] = []
- for token in value:
- if isinstance(token, bool):
- continue
- try:
- out.append(int(token))
- except Exception:
- continue
- return out
-
-
-def extract_text_output(outputs: list[Any], tokenizer: Any) -> str:
- for mm_out in iter_mm_outputs(outputs):
- text = mm_out.get("text")
- if isinstance(text, list) and text:
- text = text[-1]
- if isinstance(text, str) and text.strip():
- return text.strip()
- for key in ("text_tokens", "token_ids"):
- token_ids = _to_token_list(mm_out.get(key))
- if not token_ids:
- continue
- decoded = tokenizer.decode(token_ids, skip_special_tokens=True)
- if isinstance(decoded, str) and decoded.strip():
- return decoded.strip()
- return ""
-
-
-def extract_image_output(outputs: list[Any]) -> torch.Tensor | None:
- for mm_out in iter_mm_outputs(outputs):
- image = mm_out.get("image")
- if isinstance(image, list) and image:
- image = image[-1]
- if isinstance(image, torch.Tensor):
- return image
- return None
-
-
-def tensor_to_pil_image(image: torch.Tensor) -> Image.Image:
- arr = image.detach().cpu().numpy()
- if arr.ndim == 4:
- arr = arr[0]
- if arr.ndim == 3 and arr.shape[0] in (1, 3, 4):
- arr = np.transpose(arr, (1, 2, 0))
- if arr.dtype != np.uint8:
- arr = arr.astype(np.float32)
- if arr.max() <= 1.0:
- arr = arr * 255.0
- arr = np.clip(arr, 0.0, 255.0).astype(np.uint8)
- if arr.ndim == 3 and arr.shape[-1] == 1:
- arr = arr[..., 0]
- return Image.fromarray(arr)
-
-
-def extract_audio_output(outputs: list[Any]) -> tuple[np.ndarray, int] | None:
- for mm_out in iter_mm_outputs(outputs):
- audio = mm_out.get("audio")
- if audio is None:
- audio = mm_out.get("speech")
- if audio is None:
- continue
-
- def _to_wav_array(value: Any) -> np.ndarray:
- if isinstance(value, torch.Tensor):
- return value.detach().cpu().numpy().reshape(-1).astype(np.float32)
- return np.asarray(value).reshape(-1).astype(np.float32)
-
- if isinstance(audio, list):
- chunks = [_to_wav_array(chunk) for chunk in audio]
- wav = np.concatenate(chunks, axis=0) if chunks else np.zeros((0,), dtype=np.float32)
- else:
- wav = _to_wav_array(audio)
- sr = mm_out.get("sr", 24000)
- if hasattr(sr, "item"):
- try:
- sr = int(sr.item())
- except Exception:
- sr = 24000
- elif isinstance(sr, list):
- sr = int(sr[0]) if sr else 24000
- else:
- sr = int(sr)
- return wav, sr
- return None
-
-
-def save_audio_wav(path: Path, wav: np.ndarray, sr: int) -> None:
- try:
- import soundfile as sf
-
- sf.write(str(path), wav, int(sr), format="WAV")
- except Exception:
- from scipy.io import wavfile
-
- wav_i16 = np.clip(wav, -1.0, 1.0)
- wav_i16 = (wav_i16 * 32767.0).astype(np.int16)
- wavfile.write(str(path), int(sr), wav_i16)
-
-
-def parse_args(repo_root: Path) -> argparse.Namespace:
- parser = argparse.ArgumentParser(description="Dynin-Omni unified offline end2end example.")
- parser.add_argument("--task", type=str, required=True, choices=TASK_CHOICES)
- parser.add_argument("--model", type=str, required=True, help="HF repo id or local model directory.")
- parser.add_argument(
- "--deploy-config",
- type=str,
- default=str(repo_root / "vllm_omni/deploy/dynin_omni.yaml"),
- help="Path to deploy config yaml.",
- )
- parser.add_argument(
- "--dynin-config-path",
- type=str,
- default="",
- help="Path to DYNIN config yaml (passed through additional_information).",
- )
- parser.add_argument(
- "--model-cache-dir",
- type=str,
- default="/tmp/dynin_localized_models",
- help="Cache directory used when --model is HF repo id.",
- )
- parser.add_argument(
- "--localize-model",
- action=argparse.BooleanOptionalAction,
- default=True,
- help="If true and --model is HF repo id, snapshot it under --model-cache-dir.",
- )
- parser.add_argument("--text", type=str, default="", help="Prompt/edit/question text.")
- parser.add_argument("--instruction", type=str, default="", help="Optional extra instruction.")
- parser.add_argument("--raw-prompt", action=argparse.BooleanOptionalAction, default=False)
- parser.add_argument("--image", type=str, default="", help="Input image path for i2i/i2t.")
- parser.add_argument("--audio", type=str, default="", help="Input audio path for s2t.")
- parser.add_argument("--video", type=str, default="", help="Input video path for v2t.")
- parser.add_argument("--image-resolution", type=int, default=None)
- parser.add_argument("--num-frames", type=int, default=None)
- parser.add_argument(
- "--output-dir",
- type=str,
- default="",
- help="Directory for generated outputs.",
- )
- parser.add_argument("--output-prefix", type=str, default="")
- parser.add_argument("--seed", type=int, default=0)
- parser.add_argument("--dtype", type=str, default="auto")
- parser.add_argument("--max-tokens-per-stage", type=int, default=1)
-
- parser.add_argument("--runtime-task", type=str, default="", help="Override runtime task key.")
- parser.add_argument("--prompting-task", type=str, default="", help="Override prompting task key.")
- parser.add_argument("--detok-id", type=int, default=None, help="Override detok id.")
-
- parser.add_argument("--prompt-max-text-len", type=int, default=None)
- parser.add_argument("--cond-dropout-prob", type=float, default=0.0)
- parser.add_argument("--max-new-tokens", type=int, default=None)
- parser.add_argument("--steps", type=int, default=None)
- parser.add_argument("--block-length", type=int, default=None)
- parser.add_argument("--temperature", type=float, default=None)
- parser.add_argument("--cfg-scale", type=float, default=None)
- parser.add_argument("--remasking", type=str, default="low_confidence")
-
- parser.add_argument("--timesteps", type=int, default=None)
- parser.add_argument("--guidance-scale", type=float, default=None)
- parser.add_argument("--noise-type", type=str, default="mask")
- parser.add_argument("--noise-schedule-name", type=str, default="cosine")
- parser.add_argument("--noise-schedule-params", type=str, default="{}")
-
- parser.add_argument("--mask-token-id", type=int, default=None)
- parser.add_argument("--codebook-size", type=int, default=None)
- parser.add_argument("--audio-codebook-size", type=int, default=None)
- parser.add_argument("--image-token-count", type=int, default=None)
- parser.add_argument("--t2s-token-length", type=int, default=None)
- parser.add_argument(
- "--t2s-condition",
- type=str,
- default="",
- )
- parser.add_argument(
- "--use-train-i2i-prompt",
- action="store_true",
- help="Use i2i training prompt template (default behavior of i2i.py).",
- )
- parser.add_argument(
- "--no-use-train-i2i-prompt",
- dest="use_train_i2i_prompt",
- action="store_false",
- help="Use i2i_gen prompt template.",
- )
- parser.set_defaults(use_train_i2i_prompt=None)
-
- parser.add_argument("--tokenizer-path", type=str, default="")
- parser.add_argument("--model-local-files-only", action=argparse.BooleanOptionalAction, default=None)
- parser.add_argument("--tokenizer-local-files-only", action=argparse.BooleanOptionalAction, default=None)
-
- parser.add_argument("--vq-model-image-path", type=str, default="")
- parser.add_argument("--vq-model-image-local-files-only", action=argparse.BooleanOptionalAction, default=None)
- parser.add_argument("--vq-model-audio-path", type=str, default="")
- parser.add_argument("--vq-model-audio-local-files-only", action=argparse.BooleanOptionalAction, default=None)
-
- parser.add_argument("--disable-hf-xet", action=argparse.BooleanOptionalAction, default=True)
- return parser.parse_args()
-
-
-def main() -> None:
- repo_root = bootstrap_repo_path()
- ensure_safe_import_for_vllm()
- from vllm_omni.model_executor.models.dynin_omni.dynin_omni_common import (
- DYNIN_PROMPT_SOURCE_KEY,
- DYNIN_PROMPT_SOURCE_OFFLINE_PREBUILT,
- )
-
- args = parse_args(repo_root)
-
- if args.disable_hf_xet:
- os.environ.setdefault("HF_HUB_DISABLE_XET", "1")
-
- np.random.seed(args.seed)
- torch.manual_seed(args.seed)
-
- model_dir = ensure_local_model_dir(
- model=args.model,
- cache_dir=Path(args.model_cache_dir).expanduser(),
- localize=bool(args.localize_model),
- )
- model_source = str(model_dir)
-
- task_name = str(args.task)
- dynin_config_path = str(Path(args.dynin_config_path).expanduser())
- os.environ["DYNIN_CONFIG_PATH"] = dynin_config_path
- default_runtime_task, default_prompting_task, default_detok_id, final_modality = TASK_DEFAULT_RUNTIME[task_name]
- runtime_task = args.runtime_task.strip() or str(
- _runtime_fallback(task_name, "runtime_task", None) or default_runtime_task
- )
- prompting_task = args.prompting_task.strip() or str(
- _runtime_fallback(task_name, "prompting_task", None) or default_prompting_task
- )
- detok_id_default = _runtime_fallback(task_name, "detok_id", None)
- if detok_id_default is None:
- detok_id_default = default_detok_id
- detok_id = int(detok_id_default if args.detok_id is None else args.detok_id)
-
- output_dir_default = _runtime_fallback(task_name, "output_dir", args.output_dir)
- resolved_output_dir = str(output_dir_default or "/tmp/dynin_end2end_outputs")
-
- image_resolution_value = _runtime_fallback(
- task_name,
- "image_resolution",
- args.image_resolution,
- )
- if image_resolution_value is None:
- image_resolution_value = 336
- image_resolution = int(image_resolution_value)
-
- num_frames_value = _runtime_fallback(
- task_name,
- "num_frames",
- args.num_frames,
- )
- if num_frames_value is None:
- num_frames_value = 8
- num_frames = int(num_frames_value)
-
- prompt_max_text_len_value = _runtime_fallback(
- task_name,
- "prompt_max_text_len",
- args.prompt_max_text_len,
- )
- if prompt_max_text_len_value is None:
- prompt_max_text_len_value = 1024
- prompt_max_text_len = int(prompt_max_text_len_value)
-
- max_new_tokens_value = _runtime_fallback(
- task_name,
- "max_new_tokens",
- args.max_new_tokens,
- )
- if max_new_tokens_value is None:
- max_new_tokens_value = 256
- max_new_tokens = int(max_new_tokens_value)
-
- steps_value = _runtime_fallback(
- task_name,
- "steps",
- args.steps,
- )
- if steps_value is None:
- steps_value = 256
- steps = int(steps_value)
-
- block_length_value = _runtime_fallback(
- task_name,
- "block_length",
- args.block_length,
- )
- if block_length_value is None:
- block_length_value = 2
- block_length = int(block_length_value)
-
- temperature_value = _runtime_fallback(
- task_name,
- "temperature",
- args.temperature,
- )
- if temperature_value is None:
- temperature_value = 0.0
- temperature = float(temperature_value)
-
- cfg_scale_value = _runtime_fallback(
- task_name,
- "cfg_scale",
- args.cfg_scale,
- )
- if cfg_scale_value is None:
- cfg_scale_value = 0.0
- cfg_scale = float(cfg_scale_value)
-
- remasking = str(_runtime_fallback(task_name, "remasking", args.remasking) or "low_confidence")
-
- timesteps_value = _runtime_fallback(
- task_name,
- "timesteps",
- args.timesteps,
- )
- if timesteps_value is None:
- timesteps_value = 20
- timesteps = int(timesteps_value)
-
- guidance_scale_value = _runtime_fallback(
- task_name,
- "guidance_scale",
- args.guidance_scale,
- )
- if guidance_scale_value is None:
- guidance_scale_value = 0.0
- guidance_scale = float(guidance_scale_value)
-
- mask_token_id_value = _runtime_fallback(
- task_name,
- "mask_token_id",
- args.mask_token_id,
- )
- if mask_token_id_value is None:
- mask_token_id_value = 126336
- mask_token_id = int(mask_token_id_value)
-
- codebook_size_value = _runtime_fallback(
- task_name,
- "codebook_size",
- args.codebook_size,
- )
- if codebook_size_value is None:
- codebook_size_value = 8192
- codebook_size = int(codebook_size_value)
-
- audio_codebook_size_value = _runtime_fallback(
- task_name,
- "audio_codebook_size",
- args.audio_codebook_size,
- )
- if audio_codebook_size_value is None:
- audio_codebook_size_value = 4096
- audio_codebook_size = int(audio_codebook_size_value)
-
- image_token_count_value = _runtime_fallback(
- task_name,
- "image_token_count",
- args.image_token_count,
- )
- image_token_count = int(image_token_count_value) if image_token_count_value is not None else 0
-
- t2s_token_length_value = _runtime_fallback(
- task_name,
- "t2s_token_length",
- args.t2s_token_length,
- )
- if t2s_token_length_value is None:
- t2s_token_length_value = 383
- t2s_token_length = int(t2s_token_length_value)
-
- t2s_condition = str(
- _runtime_fallback(task_name, "t2s_condition", args.t2s_condition)
- or "gender-female_emotion-neutral_speed-normal_pitch-normal"
- )
-
- _validate_generation_args(
- task=task_name,
- max_new_tokens=max_new_tokens,
- steps=steps,
- block_length=block_length,
- )
-
- use_train_i2i_prompt = _runtime_fallback(task_name, "use_train_i2i_prompt", args.use_train_i2i_prompt)
- if use_train_i2i_prompt is None:
- use_train_i2i_prompt = bool(task_name == "i2i")
- use_train_i2i_prompt = bool(use_train_i2i_prompt)
-
- if task_name in {"i2i", "i2t"} and not args.image:
- raise ValueError(f"--task {task_name} requires --image")
- if task_name == "s2t" and not args.audio:
- raise ValueError("--task s2t requires --audio")
- if task_name == "v2t" and not args.video:
- raise ValueError("--task v2t requires --video")
-
- text = resolve_task_text(
- task_name=task_name,
- text=args.text,
- instruction=args.instruction,
- raw_prompt=bool(args.raw_prompt),
- )
-
- tokenizer_source = args.tokenizer_path.strip() or model_source
- model_local_only = resolve_local_only(
- args.model_local_files_only, model_source, default=Path(model_source).is_dir()
- )
- tokenizer_local_only = resolve_local_only(
- args.tokenizer_local_files_only,
- tokenizer_source,
- default=model_local_only,
- )
- tokenizer = load_text_tokenizer(tokenizer_source, local_files_only=tokenizer_local_only)
- text_vocab_size = int(len(tokenizer))
-
- image_tokens: torch.Tensor | None = None
- audio_tokens: torch.Tensor | None = None
- video_tokens: torch.Tensor | None = None
-
- device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
-
- vq_image_source = args.vq_model_image_path.strip() or "snu-aidas/magvitv2"
- vq_audio_source = args.vq_model_audio_path.strip() or "snu-aidas/emova_speech_tokenizer_vllm"
- vq_image_local_only = resolve_local_only(args.vq_model_image_local_files_only, vq_image_source, default=False)
- vq_audio_local_only = resolve_local_only(args.vq_model_audio_local_files_only, vq_audio_source, default=False)
-
- if task_name in {"i2i", "i2t", "v2t"}:
- vq_image = load_vq_image_encoder(vq_image_source, vq_image_local_only, device)
- if task_name in {"i2i", "i2t"}:
- image_tokens = encode_image_tokens(
- Path(args.image).expanduser().resolve(),
- vq_model=vq_image,
- device=device,
- resolution=int(image_resolution),
- )
- if task_name == "v2t":
- video_tokens = encode_video_tokens(
- Path(args.video).expanduser().resolve(),
- vq_model=vq_image,
- device=device,
- resolution=int(image_resolution),
- num_frames=int(num_frames),
- )
- if hasattr(vq_image, "cpu"):
- vq_image = vq_image.cpu()
-
- if task_name == "s2t":
- vq_audio = load_vq_audio_encoder(vq_audio_source, vq_audio_local_only, device)
- audio_tokens = encode_audio_tokens(Path(args.audio).expanduser().resolve(), vq_audio)
- if hasattr(vq_audio, "cpu"):
- vq_audio = vq_audio.cpu()
-
- noise_schedule_params: dict[str, Any] = {}
- try:
- parsed = json.loads(args.noise_schedule_params)
- if isinstance(parsed, dict):
- noise_schedule_params = {str(k): v for k, v in parsed.items()}
- except Exception:
- noise_schedule_params = {}
-
- image_token_count = int(image_token_count)
- if image_token_count <= 0:
- if image_tokens is not None:
- image_token_count = int(image_tokens.numel())
- else:
- base_res = int(image_resolution)
- image_token_count = max(1, (base_res // 16) ** 2)
-
- uncond_input_ids: list[int] | None = None
- uncond_attention_mask: list[int] | None = None
- if task_name == "t2t":
- messages = [{"role": "user", "content": text}]
- if getattr(tokenizer, "chat_template", None):
- prompt_text = tokenizer.apply_chat_template(messages, add_generation_prompt=True, tokenize=False)
- encoded = tokenizer(prompt_text, return_tensors="pt", add_special_tokens=False)
- else:
- encoded = tokenizer(text, return_tensors="pt", add_special_tokens=True)
- prompt_token_ids = _to_1d_int_list(encoded["input_ids"])
- prompt_attention_mask = _to_1d_int_list(encoded.get("attention_mask"))
- if not prompt_attention_mask:
- prompt_attention_mask = [1] * len(prompt_token_ids)
- else:
- max_audio_len_for_prompt = int(max(t2s_token_length, 512))
- if audio_tokens is not None:
- max_audio_len_for_prompt = max(max_audio_len_for_prompt, int(audio_tokens.numel()))
- max_audio_len_short_for_prompt = max(256, max_audio_len_for_prompt // 2)
-
- uni_prompting = load_universal_prompting(
- tokenizer=tokenizer,
- tokenizer_source=tokenizer_source,
- max_text_len=int(prompt_max_text_len),
- cond_dropout_prob=float(args.cond_dropout_prob),
- local_files_only=bool(tokenizer_local_only),
- max_audio_len=int(max_audio_len_for_prompt),
- max_audio_len_short=int(max_audio_len_short_for_prompt),
- )
- prompting_text_vocab_size = int(len(uni_prompting.text_tokenizer))
-
- is_mmu_task = task_name in {"i2t", "s2t", "v2t"} and not args.prompting_task.strip()
- if is_mmu_task:
- prompt_token_ids, prompt_attention_mask = make_mmu_prompt(
- task=task_name,
- text=text,
- tokenizer=uni_prompting.text_tokenizer,
- uni_prompting=uni_prompting,
- image_tokens=image_tokens,
- audio_tokens=audio_tokens,
- video_tokens=video_tokens,
- image_token_offset=prompting_text_vocab_size,
- speech_token_offset=prompting_text_vocab_size + int(codebook_size),
- )
- else:
- prompt_payload, prompting_task = make_prompt_payload(
- task=task_name,
- text=text,
- image_tokens=image_tokens,
- audio_tokens=audio_tokens,
- video_tokens=video_tokens,
- image_placeholder_tokens=image_token_count,
- audio_placeholder_tokens=int(t2s_token_length),
- image_token_offset=text_vocab_size,
- speech_token_offset=text_vocab_size + int(codebook_size),
- mask_token_id=int(mask_token_id),
- use_train_i2i_prompt=use_train_i2i_prompt,
- )
- if args.prompting_task.strip():
- prompting_task = args.prompting_task.strip()
-
- prompt_token_ids, prompt_attention_mask = _run_uni_prompting(
- uni_prompting,
- prompt_payload,
- prompting_task,
- )
-
- if task_name in {"i2t", "s2t", "v2t"}:
- prompt_attention_mask = [1] * len(prompt_token_ids)
- if not prompt_attention_mask:
- prompt_attention_mask = [1] * len(prompt_token_ids)
-
- if task_name in {"t2i", "i2i"} and guidance_scale > 0:
- uncond_payload, uncond_prompting_task = make_prompt_payload(
- task=task_name,
- text="",
- image_tokens=image_tokens,
- audio_tokens=audio_tokens,
- video_tokens=video_tokens,
- image_placeholder_tokens=image_token_count,
- audio_placeholder_tokens=int(t2s_token_length),
- image_token_offset=text_vocab_size,
- speech_token_offset=text_vocab_size + int(codebook_size),
- mask_token_id=int(mask_token_id),
- use_train_i2i_prompt=use_train_i2i_prompt,
- )
- uncond_input_ids, uncond_attention_mask = _run_uni_prompting(
- uni_prompting,
- uncond_payload,
- args.prompting_task.strip() or uncond_prompting_task,
- )
- if not uncond_attention_mask:
- uncond_attention_mask = [1] * len(uncond_input_ids)
-
- runtime_info: dict[str, Any] = {
- "task": [runtime_task],
- "detok_id": [int(detok_id)],
- DYNIN_PROMPT_SOURCE_KEY: [DYNIN_PROMPT_SOURCE_OFFLINE_PREBUILT],
- "dynin_config_path": [str(dynin_config_path)],
- "attention_mask": [prompt_attention_mask],
- "prompt_max_text_len": [int(prompt_max_text_len)],
- "prompting_max_text_len": [int(prompt_max_text_len)],
- "cond_dropout_prob": [float(args.cond_dropout_prob)],
- "prompting_cond_dropout_prob": [float(args.cond_dropout_prob)],
- "tokenizer_path": [str(tokenizer_source)],
- "text_vocab_size": [int(text_vocab_size)],
- "model_local_files_only": [bool(model_local_only)],
- "max_new_tokens": [int(max_new_tokens)],
- "steps": [int(steps)],
- "block_length": [int(block_length)],
- "temperature": [float(temperature)],
- "cfg_scale": [float(cfg_scale)],
- "remasking": [str(remasking)],
- "mask_id": [int(mask_token_id)],
- "mask_token_id": [int(mask_token_id)],
- "codebook_size": [int(codebook_size)],
- "audio_codebook_size": [int(audio_codebook_size)],
- "timesteps": [int(timesteps)],
- "guidance_scale": [float(guidance_scale)],
- "noise_type": [str(args.noise_type)],
- "noise_schedule_name": [str(args.noise_schedule_name)],
- "noise_schedule_params": [noise_schedule_params],
- "seq_len": [int(image_token_count)],
- "condition": [str(t2s_condition)],
- "vq_model_image_path": [str(vq_image_source)],
- "vq_model_image_local_files_only": [bool(vq_image_local_only)],
- "vq_model_audio_path": [str(vq_audio_source)],
- "vq_model_audio_local_files_only": [bool(vq_audio_local_only)],
- }
-
- if task_name in {"t2t", "i2t", "s2t", "v2t"}:
- runtime_info["prompt_length"] = [int(len(prompt_token_ids))]
- if uncond_input_ids is not None:
- runtime_info["uncond_input_ids"] = [uncond_input_ids]
- if uncond_attention_mask is not None:
- runtime_info["uncond_attention_mask"] = [uncond_attention_mask]
-
- if task_name == "t2s":
- runtime_info["max_new_tokens"] = [int(t2s_token_length)]
-
- prompt = {
- "prompt_token_ids": [int(v) for v in prompt_token_ids],
- "additional_information": runtime_info,
- "modalities": [final_modality],
- }
-
- from vllm import SamplingParams
-
- from vllm_omni.entrypoints.omni import Omni
-
- deploy_config_path = str(Path(args.deploy_config).expanduser())
- omni = Omni(model=model_source, deploy_config=deploy_config_path, dtype=args.dtype)
- sampling_params_list = [
- SamplingParams(max_tokens=int(args.max_tokens_per_stage), temperature=0.0, top_p=1.0, detokenize=False)
- for _ in range(omni.num_stages)
- ]
-
- try:
- outputs = list(omni.generate(prompt, sampling_params_list))
- finally:
- omni.close()
-
- out_dir = Path(resolved_output_dir).expanduser()
- out_dir.mkdir(parents=True, exist_ok=True)
- stamp = time.strftime("%Y%m%d_%H%M%S")
- prefix = args.output_prefix.strip() or f"{task_name}_{stamp}"
-
- if final_modality == "text":
- text_out = extract_text_output(outputs, tokenizer=tokenizer)
- if not text_out:
- raise RuntimeError("No text output found.")
- out_path = out_dir / f"{prefix}.txt"
- out_path.write_text(text_out + "\n", encoding="utf-8")
- print(f"[end2end] text saved: {out_path}")
- print(text_out)
- return
-
- if final_modality == "image":
- image_out = extract_image_output(outputs)
- if image_out is None:
- raise RuntimeError("No image output found.")
- pil = tensor_to_pil_image(image_out)
- out_path = out_dir / f"{prefix}.png"
- pil.save(out_path)
- print(f"[end2end] image saved: {out_path}")
- return
-
- if final_modality == "audio":
- audio_out = extract_audio_output(outputs)
- if audio_out is None:
- raise RuntimeError("No audio output found.")
- wav, sr = audio_out
- out_path = out_dir / f"{prefix}.wav"
- save_audio_wav(out_path, wav, sr)
- print(f"[end2end] audio saved: {out_path} (sr={sr}, samples={wav.shape[0]})")
- return
-
- raise RuntimeError(f"Unsupported final modality: {final_modality}")
-
-
-if __name__ == "__main__":
- main()
diff --git a/examples/offline_inference/text_to_image/README.md b/examples/offline_inference/text_to_image/README.md
index cfe05255d..7664bb32d 100644
--- a/examples/offline_inference/text_to_image/README.md
+++ b/examples/offline_inference/text_to_image/README.md
@@ -19,23 +19,23 @@ This folder provides several entrypoints for experimenting with text-to-image di
### Supported Models
-| Model | Image Shape | Peak VRAM (GiB) * | Model Weights (GiB) |
+| Model | Image Shape | Peak VRAM (GiB) * | Model Weights (GiB) |
| ----- | ----------- | ----------- | ----------------- |
| `Qwen/Qwen-Image` | 1024 x 1024 | 60.0 | 53.7 |
-| `Qwen/Qwen-Image-2512` |1024 x 1024 | 60.0 | 53.7 |
+| `Qwen/Qwen-Image-2512` | 1024 x 1024 | 60.0 | 53.7 |
| `Tongyi-MAI/Z-Image-Turbo` | 1024 x 1024 | 24.8 | 19.2 |
| `stepfun-ai/NextStep-1.1` | 512 x 512 | 71.8 | 28.1 |
| `meituan-longcat/LongCat-Image` | 1024 x 1024 | 71.2 | 27.3 |
| `AIDC-AI/Ovis-Image-7B` | 1024 x 1024 | 71.8 | 17.1 |
-| `OmniGen2/OmniGen2` | 1024 x 1024 | 20.1 | 14.7 |
+| `OmniGen2/OmniGen2` | 1024 x 1024 | 20.1 | 14.7 |
| `stabilityai/stable-diffusion-3.5-medium` | 1024 x 1024 | 20.1 | 15.6 |
| `black-forest-labs/FLUX.1-dev` | 1024 x 1024 | 33.9 | 31.4 |
| `black-forest-labs/FLUX.1-schnell` | 1024 x 1024 | 33.9 | 31.4 |
| `black-forest-labs/FLUX.2-klein-4B` | 1024 x 1024 | 72.7 | 14.9 |
| `black-forest-labs/FLUX.2-klein-9B` | 1024 x 1024 | 37.1 | 32.3 |
| `black-forest-labs/FLUX.2-dev` | 1024 x 1024 | 65.7 | >80 (CPU offload required) |
-| `HunyuanImage-3.0` | 1024 x 1024 | 80.0 (TP≥3) | 160 |
-| `HiDream-I1-Full` | 1024 x 1024 | 63.7 | 57.7 |
+| `HunyuanImage-3.0` | 1024 x 1024 | 80.0 (TP≥3) | 160 |
+| `HiDream-I1-Full` | 1024 x 1024 | 63.7 | 57.7 |
| `krea/Krea-2-Raw`, `krea/Krea-2-Turbo` | 1024 (Raw) / 2048 (Turbo) | — | ~30 |
!!! info
@@ -112,9 +112,9 @@ python text_to_image.py \
| `--enable-cpu-offload` | flag | off | Enable CPU offloading for diffusion models |
| `--lora-path` | str | — | Path to PEFT LoRA adapter folder or checkpoint file |
| `--lora-scale` | float | `1.0` | Scale factor for LoRA weights |
-| `--lora-backend` | str |`"peft"`| LoRA backend for loading LoRA adapters. Default: peft. Available options: peft, distill |
-| `--use-system-prompt` | str | `None` | System prompt preset: `en_unified`, `en_vanilla`, `en_recaption`, `en_think_recaption`, `dynamic`, `None`, or custom text. Recommended: `en_unified`. Only for HunyuanImage-3.0.|
-| `--system-prompt` | str | `None` | Custom system prompt text. Only used when `--use-system-prompt` is set to `custom`. Only for HunyuanImage-3.0.|
+| `--lora-backend` | str | `"peft"` | LoRA backend for loading LoRA adapters. Default: peft. Available options: peft, distill |
+| `--use-system-prompt` | str | `None` | System prompt preset: `en_unified`, `en_vanilla`, `en_recaption`, `en_think_recaption`, `dynamic`, `None`, or custom text. Recommended: `en_unified`. Only for HunyuanImage-3.0. |
+| `--system-prompt` | str | `None` | Custom system prompt text. Only used when `--use-system-prompt` is set to `custom`. Only for HunyuanImage-3.0. |
| `--auxiliary-text-encoder` | str | `None` | Supplementary auxiliary text encoder parameters model name or path (especially for Hidream-l1-full). |
**NextStep-1.1 specific arguments:**
@@ -127,7 +127,7 @@ python text_to_image.py \
| `--use-norm` | flag | off | Apply layer normalization to sampled tokens |
> If you encounter OOM errors, try using `--vae-use-slicing` and `--vae-use-tiling` to reduce memory usage.
-
+>
> Qwen-Image currently publishes best-effort presets at `1328x1328`, `1664x928`, `928x1664`, `1472x1140`, `1140x1472`, `1584x1056`, and `1056x1584`. Adjust `--height/--width` accordingly for the most reliable outcomes.
## More CLI Examples
@@ -216,6 +216,26 @@ python examples/offline_inference/text_to_image/text_to_image.py \
--output /output.png
```
+### Anima Single-File Checkpoints
+
+Anima uses the official model dimensions by default. A checkpoint may provide a JSON file with the same stem (for example, `anima.json` beside `anima.safetensors`) containing `transformer` and `text_conditioner` configuration objects. These override the default dimensions and must match the checkpoint weights. The shared tiny-model tests use this to load small random-weight models. Components in `text_encoder/`, `vae/`, `tokenizer/`, `t5_tokenizer/`, and `scheduler/` beside the checkpoint are discovered automatically.
+
+To load Anima, point `--model` to the single-file checkpoint path, pass the native pipeline class name using `--model-class-name`, and supply the converted components directory using `--custom-pipeline-args`:
+
+```bash
+python examples/offline_inference/text_to_image/text_to_image.py \
+ --model /path/to/models/anima-official/split_files/diffusion_models/anima-base-v1.0.safetensors \
+ --model-class-name AnimaPipeline \
+ --custom-pipeline-args '{"components_path": "/path/to/models/anima-components"}' \
+ --prompt "A cinematic close-up of a glass teapot on a wooden table." \
+ --seed 42 \
+ --guidance-scale 4.0 \
+ --num-inference-steps 50 \
+ --height 1024 \
+ --width 1024 \
+ --output anima_output.png
+```
+
### Krea 2
Krea 2 is published as diffusers-format checkpoints: `krea/Krea-2-Turbo` (few-step distilled) and `krea/Krea-2-Raw`.
@@ -336,7 +356,7 @@ python text_to_image.py \
LoRA adapters must be in PEFT format. A typical adapter directory structure:
-```
+```text
lora_adapter/
├── adapter_config.json
└── adapter_model.safetensors
diff --git a/examples/offline_inference/text_to_image/text_to_image.py b/examples/offline_inference/text_to_image/text_to_image.py
index adcc10669..c74236316 100644
--- a/examples/offline_inference/text_to_image/text_to_image.py
+++ b/examples/offline_inference/text_to_image/text_to_image.py
@@ -1,5 +1,5 @@
# SPDX-License-Identifier: Apache-2.0
-# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
import argparse
import functools
@@ -58,6 +58,7 @@ def parse_json_object(value: str, flag_name: str = "argument") -> dict[str, Any]
parse_profiler_config = functools.partial(parse_json_object, flag_name="--profiler-config")
+parse_custom_pipeline_args = functools.partial(parse_json_object, flag_name="--custom-pipeline-args")
def build_text_to_image_prompt(prompt: str, negative_prompt: str | None) -> dict[str, Any]:
@@ -379,6 +380,18 @@ def parse_args() -> argparse.Namespace:
default=None,
help="Supplementary auxiliary text encoder parameters model name or path (especially for Hidream-l1-full).",
)
+ parser.add_argument(
+ "--model-class-name",
+ type=str,
+ default=None,
+ help="Override the diffusion pipeline class name (e.g. AnimaPipeline).",
+ )
+ parser.add_argument(
+ "--custom-pipeline-args",
+ type=parse_custom_pipeline_args,
+ default=None,
+ help='JSON object passed to native/custom pipelines (e.g. \'{"components_path": "/path"}\').',
+ )
parser.add_argument(
"--trust-remote-code",
action="store_true",
@@ -558,7 +571,6 @@ def main():
"vae_patch_parallel_size": args.vae_patch_parallel_size,
"enable_expert_parallel": args.enable_expert_parallel,
"enable_cpu_offload": args.enable_cpu_offload,
- "mode": "text-to-image",
"log_stats": args.log_stats,
"enable_diffusion_pipeline_profiler": args.enable_diffusion_pipeline_profiler,
"profiler_config": args.profiler_config,
@@ -576,9 +588,13 @@ def main():
omni_kwargs["trust_remote_code"] = True
if args.deploy_config:
omni_kwargs["deploy_config"] = args.deploy_config
- if use_nextstep:
+ if args.model_class_name:
+ omni_kwargs["model_class_name"] = args.model_class_name
+ elif use_nextstep:
# NextStep-1.1 requires explicit pipeline class
omni_kwargs["model_class_name"] = "NextStep11Pipeline"
+ if args.custom_pipeline_args is not None:
+ omni_kwargs["custom_pipeline_args"] = args.custom_pipeline_args
# Cosmos3 loads its (gated) guardrail models at build time, so the guardrails
# gate is an engine-level config (offline analog of the server's --no-guardrails).
if args.extra_body and "guardrails" in args.extra_body:
@@ -614,6 +630,10 @@ def main():
print(f" LoRA: scale={args.lora_scale}")
if args.deploy_config:
print(f" deploy-config: {args.deploy_config}")
+ if args.model_class_name:
+ print(f" Model class name: {args.model_class_name}")
+ if args.custom_pipeline_args is not None:
+ print(f" Custom pipeline args: {args.custom_pipeline_args}")
print(f"{'=' * 60}\n")
# Build LoRA request when --lora-path is set
@@ -723,7 +743,10 @@ def main():
# stop-token-ids declaratively from the plain prompt + extra_body, so this
# example stays model-agnostic. Models without one are untouched.
ar_input_builder = get_ar_input_builder(model_class_name)
- if ar_input_builder is not None:
+ # A model can also be deployed with only its diffusion stage. Keep those
+ # requests on the string-prompt path, as in the single-stage images API.
+ has_ar_stage = any(not isinstance(params, OmniDiffusionSamplingParams) for params in sampling_params_list)
+ if ar_input_builder is not None and has_ar_stage:
_apply_ar_stage_inputs(
ar_input_builder,
model=args.model,
diff --git a/examples/offline_inference/text_to_speech/README.md b/examples/offline_inference/text_to_speech/README.md
index 04ff1a97d..36d1b44ee 100644
--- a/examples/offline_inference/text_to_speech/README.md
+++ b/examples/offline_inference/text_to_speech/README.md
@@ -13,7 +13,7 @@ list of supported architectures across all modalities, see
## Supported Models
| Model | HuggingFace repo | Stages | Voice cloning | Streaming | Special modes | Sample rate |
-|---|---|---|---|---|---|---|
+| --- | --- | --- | --- | --- | --- | --- |
| AuK | `tencent/AuK`, `tencent/AuK-Flash` (assembled with `tools/prepare_auk_checkpoint.py`) | 2 (thinker encoder + DiT) | ✓ | — | instruction-driven editing, enhancement, separation; no example script (use `vllm_omni.model_extras.auk`) | 24 kHz |
| Audio8 TTS Preview | `Audio8/Audio8-TTS-Preview-0.6b` | dual-AR | ✓ | ✓ | 11 languages | 44.1 kHz |
| Breeze-TTS-2 | `BreezeBlue/Breeze-TTS-2` | 2 (talker + codec) | ✓ | ✓ (async chunk) | voice design / voice direction (`--instruction`) | 24 kHz |
@@ -27,7 +27,6 @@ list of supported architectures across all modalities, see
| OmniVoice | `k2-fsa/OmniVoice` | 2 (gen + dec) | ✓ | — | voice design, language hint | 24 kHz |
| Qwen3-TTS | `Qwen/Qwen3-TTS-12Hz-1.7B-{CustomVoice,VoiceDesign,Base}` | 2 (talker + code2wav) | ✓ (Base) | ✓ | 3 task variants | 24 kHz |
| VoxCPM2 | `openbmb/VoxCPM2` | single (native AR) | ✓ | ✓ (online) | continuation | 48 kHz |
-| dots.tts | `dots-studio/dots.tts-soar` | single (native AR) | — (text-only) | ✓ (online) | no-reference synthesis | 48 kHz |
| IndexTTS-2 | `IndexTeam/IndexTTS-2` | 2 (AR talker + S2Mel DiT + BigVGAN) | ✓ (required) | — | emotion control (`--emo-audio`, `--emo-text`, `--emo-vector`) | 22.05 kHz |
| IndexTTS-2.5 | native `checkpoints/` bundle | 2 (AR talker + EnhancedCodec + S2Mel DiT + BigVGAN) | ✓ (required) | — | multilingual (`--lang`) + emotion control | 22.05 kHz |
| Voxtral TTS | `mistralai/Voxtral-4B-TTS-2603` | varies | ✓ | ✓ | voice presets | 24 kHz |
@@ -54,32 +53,38 @@ codec: a slow AR transformer predicts one semantic token per codec frame, and a
4-layer fast AR predicts that frame's remaining 9 codebooks.
### Prerequisites
+
No extra packages: the codec architecture ships in tree and its weights
(`codec.pth`) come with the checkpoint.
### Quick start
+
```bash
python examples/offline_inference/text_to_speech/audio8_tts/end2end.py \
--text "Welcome to Audio8 TTS, a compact multilingual text to speech model."
```
### Voice cloning
+
```bash
python examples/offline_inference/text_to_speech/audio8_tts/end2end.py \
--text "Welcome to Audio8 TTS." \
--ref-audio /path/to/reference.wav \
--ref-text "The exact transcript of the reference recording."
```
+
The reference transcript must match what is actually spoken in the clip;
a mismatch degrades both stability and speaker similarity.
### Streaming
+
```bash
python examples/offline_inference/text_to_speech/audio8_tts/end2end.py \
--text "Welcome to Audio8 TTS." --streaming
```
### Notes
+
- Output: 44.1 kHz mono WAV; the codec emits ~21.5 frames/s (2048 samples per frame).
- Context is 2048 packed text+audio positions, so `max_model_len` is 2048.
- Greedy decoding (`temperature: 0`) is degenerate for this checkpoint — it
@@ -92,6 +97,7 @@ python examples/offline_inference/text_to_speech/audio8_tts/end2end.py \
- `--num-prompts 4` smoke-tests concurrency (stage 0 runs `max_num_seqs: 4`).
### Measured behaviour (1x H20, shared GPU)
+
`--streaming` on a 58-character English sentence: TTFA ~0.74 s (4-frame first
chunk), 7 chunks, 1.55 s wall for 3.16 s of audio (RTF ~0.49). Treat these as
smoke-test magnitudes, not a benchmark.
@@ -103,12 +109,14 @@ smoke-test magnitudes, not a benchmark.
2-stage TTS pipeline (`talker` + `code2wav`) at 24 kHz.
### Prerequisites
+
```bash
uv pip install -e .
# Includes soundfile, onnxruntime, x-transformers, einops via requirements.
```
Download the model snapshot:
+
```python
from huggingface_hub import snapshot_download
snapshot_download('FunAudioLLM/Fun-CosyVoice3-0.5B-2512',
@@ -116,15 +124,18 @@ snapshot_download('FunAudioLLM/Fun-CosyVoice3-0.5B-2512',
```
If your downloaded checkpoint lacks `config.json`, add it:
+
```json
{
"model_type": "cosyvoice3",
"architectures": ["CosyVoice3Model"]
}
```
+
This is required because `AutoConfig.register("cosyvoice3", CosyVoice3Config)` only registers the class mapping; the loader still reads `model_type` from `config.json` to select the class.
### Quick start
+
```bash
python examples/offline_inference/text_to_speech/cosyvoice3/end2end.py \
--model pretrained_models/Fun-CosyVoice3-0.5B \
@@ -132,9 +143,11 @@ python examples/offline_inference/text_to_speech/cosyvoice3/end2end.py \
```
### Voice cloning
+
If `--ref-audio` is omitted, the script downloads the upstream
[`zero_shot_prompt.wav`](https://github.com/FunAudioLLM/CosyVoice/blob/main/asset/zero_shot_prompt.wav) from the CosyVoice repo into the current directory.
To use your own clip, pass `--ref-audio /path/to/reference.wav`, and modify `--prompt-text` correspondingly.
+
```bash
python examples/offline_inference/text_to_speech/cosyvoice3/end2end.py \
--model pretrained_models/Fun-CosyVoice3-0.5B \
@@ -144,9 +157,11 @@ python examples/offline_inference/text_to_speech/cosyvoice3/end2end.py \
```
### Streaming
+
Streaming is enabled by default via `async_chunk: true` in `vllm_omni/deploy/cosyvoice3.yaml`. Pass `--no-async-chunk` on `vllm serve` to switch to the legacy synchronous path.
### Notes
+
- Stage 0 (`talker`) emits speech tokens; stage 1 (`code2wav`) runs flow matching + HiFiGAN to synthesize waveform.
- Deploy config auto-loads from `vllm_omni/deploy/cosyvoice3.yaml` based on HF `model_type`. Pass `--deploy-config ` to override.
@@ -157,6 +172,7 @@ Streaming is enabled by default via `async_chunk: true` in `vllm_omni/deploy/cos
2-stage TTS pipeline (AR + DiT flow-matching) at 24 kHz. Every request requires reference audio and its transcript for zero-shot voice cloning.
### Quick start
+
```bash
python examples/offline_inference/text_to_speech/glm_tts/end2end.py \
--model zai-org/GLM-TTS \
@@ -167,12 +183,14 @@ python examples/offline_inference/text_to_speech/glm_tts/end2end.py \
```
### Architecture
+
```text
Text → [Stage 0: AR] → Speech Tokens → [Stage 1: DiT + HiFT] → Audio (24 kHz)
(Llama-based) (32k vocab) (Flow Matching)
```
### Notes
+
- `--ref-audio` and `--ref-text` are **required** together; GLM-TTS does not support text-only synthesis.
- Reference audio should be 3-10 seconds.
- First run may be slow due to lazy loading of WhisperVQ tokenizer and CampPlus ONNX speaker embedder.
@@ -187,12 +205,14 @@ Text → [Stage 0: AR] → Speech Tokens → [Stage 1: DiT + HiFT] → Audio (24
No extra packages are required; the DAC codec is vendored in vLLM-Omni.
### Quick start
+
```bash
python examples/offline_inference/text_to_speech/fish_speech/end2end.py \
--text "Hello, this is a test of the Fish Speech text to speech system."
```
### Voice cloning
+
```bash
python examples/offline_inference/text_to_speech/fish_speech/end2end.py \
--text "Hello, this is a cloned voice." \
@@ -201,14 +221,17 @@ python examples/offline_inference/text_to_speech/fish_speech/end2end.py \
```
### Streaming
+
```bash
python examples/offline_inference/text_to_speech/fish_speech/end2end.py \
--text "Hello, this is a streaming test." \
--streaming
```
+
Streaming requires `async_chunk: true` in the deploy config.
### Notes
+
- Output: 44.1 kHz mono WAV.
- DAC codec weights (`codec.pth`) are loaded lazily from the model directory.
@@ -219,6 +242,7 @@ Streaming requires `async_chunk: true` in the deploy config.
Dense 0.5B two-stage TTS pipeline (`AR + flow` + audio VAE) at 44.1 kHz. The example covers style, IP voice, music-only generation, text-to-audio events, emotion, dialect, zero-shot cloning, podcast, speech+BGM, and speech+environment-sound cases.
### Quick start
+
```bash
python examples/offline_inference/text_to_speech/ming_tts/end2end.py \
--case style \
@@ -227,6 +251,7 @@ python examples/offline_inference/text_to_speech/ming_tts/end2end.py \
```
### Voice cloning
+
```bash
python examples/offline_inference/text_to_speech/ming_tts/end2end.py \
--case zero_shot \
@@ -237,6 +262,7 @@ python examples/offline_inference/text_to_speech/ming_tts/end2end.py \
```
### Streaming
+
```bash
python examples/offline_inference/text_to_speech/ming_tts/end2end.py \
--case basic \
@@ -247,6 +273,7 @@ python examples/offline_inference/text_to_speech/ming_tts/end2end.py \
```
### Notes
+
- `style`, `ip`, `bgm`, and `tta` do not require reference audio.
- Reference-audio cases use `--ref-audio`; `zero_shot` also requires `--ref-text`.
- `podcast` uses multiple references via `--ref-audio-paths`.
@@ -259,14 +286,17 @@ python examples/offline_inference/text_to_speech/ming_tts/end2end.py \
Standalone talker-only deployment of Ming-flash-omni-2.0 at 44.1 kHz. Voice is controlled through caption fields (`风格` / `IP` / `语速`/`基频`/`音量`) rather than reference audio.
### Prerequisites
+
The example calls into `vllm_omni.model_executor.models.ming_flash_omni.prompt_utils` for the default prompt and instruction builder; no extra pip install on top of the base vLLM-Omni install.
### Quick start
+
```bash
python examples/offline_inference/text_to_speech/ming_flash_omni_tts/end2end.py --case style
```
### Cases
+
```bash
# ASMR-style whisper (caption-driven)
python examples/offline_inference/text_to_speech/ming_flash_omni_tts/end2end.py --case style
@@ -281,6 +311,7 @@ python examples/offline_inference/text_to_speech/ming_flash_omni_tts/end2end.py
Override the default text per case with `--text`, write to a custom path with `--output`.
### Notes
+
- Talker-only deployment — for the multimodal Ming-flash-omni example, see [`examples/offline_inference/ming_flash_omni/`](../../ming_flash_omni/).
- Deploy config: `vllm_omni/deploy/ming_flash_omni_tts.yaml` (single GPU, `enforce_eager`, `max_num_seqs: 1`).
- Decode defaults from the Ming cookbook: `max_decode_steps=200`, `cfg=2.0`, `sigma=0.25`, `temperature=0.0`, `use_zero_spk_emb=True`.
@@ -294,6 +325,7 @@ Single-stage 0.1B AR LM + MOSS-Audio-Tokenizer-Nano codec at 48 kHz mono (mixed
> **No built-in speaker presets.** `--ref-audio` is required on every call. Default `--mode voice_clone` matches upstream's recommended workflow; `--mode continuation` is exposed for completeness but upstream's continuation-with-prompt path emits very short / near-silent output, so it is rarely useful in practice. Sample reference clips ship in the upstream repo under [`assets/audio/`](https://github.com/OpenMOSS/MOSS-TTS-Nano/tree/main/assets/audio) (e.g. `zh_1.wav`, `en_2.wav`, `jp_2.wav`).
### Quick start
+
```bash
# Fetch a sample reference clip (one-off, user-scoped cache).
REF_DIR="${XDG_CACHE_HOME:-$HOME/.cache}/moss-tts-nano"
@@ -305,9 +337,11 @@ python examples/offline_inference/text_to_speech/moss_tts_nano/end2end.py \
--text "你好,这是MOSS-TTS-Nano的语音合成演示。" \
--ref-audio "$REF_DIR/zh_1.wav"
```
+
The first run downloads `OpenMOSS-Team/MOSS-TTS-Nano` and `OpenMOSS-Team/MOSS-Audio-Tokenizer-Nano` from Hugging Face.
### Reproducible runs
+
```bash
python examples/offline_inference/text_to_speech/moss_tts_nano/end2end.py \
--text "Deterministic test." \
@@ -316,6 +350,7 @@ python examples/offline_inference/text_to_speech/moss_tts_nano/end2end.py \
```
### Notes
+
- Output: 48 kHz mono WAV (the tokenizer is internally stereo at 48 kHz; the wrapper averages to mono before reaching the engine).
- Deploy config: `vllm_omni/deploy/moss_tts_nano.yaml` (auto-loaded; override with `--deploy-config`).
- Default `--max-new-frames 375` ≈ 14 s of audio; raise for longer outputs.
@@ -329,12 +364,15 @@ python examples/offline_inference/text_to_speech/moss_tts_nano/end2end.py \
Zero-shot multilingual TTS supporting 600+ languages, with three modes (auto / clone / design).
### Prerequisites
+
```bash
huggingface-cli download k2-fsa/OmniVoice
```
+
Voice cloning requires `transformers>=5.3.0`. Auto and design modes work with `transformers>=4.57.0`.
### Quick start (auto voice)
+
```bash
python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
--model k2-fsa/OmniVoice \
@@ -342,6 +380,7 @@ python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
```
### Voice cloning
+
```bash
python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
--model k2-fsa/OmniVoice \
@@ -351,6 +390,7 @@ python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
```
### Voice design
+
```bash
python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
--model k2-fsa/OmniVoice \
@@ -359,6 +399,7 @@ python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
```
### Language hint
+
```bash
python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
--model k2-fsa/OmniVoice \
@@ -367,6 +408,7 @@ python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
```
### Seed for Reproducibility
+
```bash
python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
--model k2-fsa/OmniVoice \
@@ -375,6 +417,7 @@ python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
```
### Notes
+
- Stage 0 (Generator): Qwen3-0.6B with 32-step iterative unmasking.
- Stage 1 (Decoder): HiggsAudioV2 RVQ + DAC at 24 kHz.
@@ -385,13 +428,16 @@ python examples/offline_inference/text_to_speech/omnivoice/end2end.py \
3-task-variant TTS with 24 kHz output. Has its own argparse surface (this script does not follow the common `--text` / `--ref-audio` shape).
### Prerequisites
+
For ROCm builds, replace `onnxruntime` with `onnxruntime-rocm`:
+
```bash
pip uninstall onnxruntime
pip install onnxruntime-rocm
```
### Task variants
+
- `CustomVoice`: predefined speaker (speaker ID) with optional style instruction.
- `VoiceDesign`: text + descriptive instruction designs a new voice.
- `Base`: voice cloning from reference audio + transcript.
@@ -415,22 +461,27 @@ python examples/offline_inference/text_to_speech/qwen3_tts/end2end.py --query-ty
```
### Streaming
+
```bash
python examples/offline_inference/text_to_speech/qwen3_tts/end2end.py \
--query-type CustomVoice \
--streaming \
--output-dir /tmp/out_stream
```
+
Streaming requires `async_chunk: true` in the deploy config.
### Word Timestamps
+
Word-level timestamps are currently a serving-path feature: launch
`vllm-omni serve` with `--forced-aligner` and request `word_timestamps`
(see `examples/online_serving/text_to_speech/README.md`). An offline
example is not provided in this release.
### Batched decoding
+
The Code2Wav stage supports batched decoding through the SpeechTokenizer. Pass multiple prompts via `--txt-prompts` and set `--batch-size` accordingly. To raise `max_num_seqs` on either stage, create an overlay based on `vllm_omni/deploy/qwen3_tts.yaml` and pass it with `--deploy-config`:
+
```bash
python examples/offline_inference/text_to_speech/qwen3_tts/end2end.py \
--query-type CustomVoice \
@@ -438,9 +489,11 @@ python examples/offline_inference/text_to_speech/qwen3_tts/end2end.py \
--batch-size 4 \
--deploy-config /path/to/qwen3_tts_batched.yaml
```
+
`--batch-size` must match a CUDA-graph capture size (1, 2, 4, 8, 16…).
### Notes
+
- Run `--help` for the full argument surface.
- See `qwen3_tts/end2end.py` for the prompt-length-estimation logic the Talker uses.
@@ -451,6 +504,7 @@ python examples/offline_inference/text_to_speech/qwen3_tts/end2end.py \
Single-stage native AR TTS at 22.05 kHz. Pipeline: `Qwen3.5 backbone → 32 FSQ codebook heads (one frame/step) → NeMo NanoCodec`. Backbone runs under vLLM paged attention; the 32-head sampling + learned embedding feedback ride the native-AR runner hooks. `enforce_eager` (CUDA graph is a perf follow-up).
### Prerequisites
+
The NanoCodec decoder needs NeMo (NVIDIA Open Model License), installed separately:
```bash
@@ -480,15 +534,18 @@ failure rather than an environment one. The PyTorch sampler it falls back to cos
here.
### Quick start (zero-shot, default voice)
+
```bash
python examples/offline_inference/text_to_speech/gepard/end2end.py \
--text "Hello, this is a Gepard demo."
```
### Voice cloning
+
Not yet — PR1 is zero-shot only (the learned `null_prefix` default voice). Reference-audio cloning (`ref_compressor` speaker prefix) is a follow-up PR.
### Notes
+
- Output: 22.05 kHz mono WAV.
- First run downloads two checkpoints, not one: the model itself, and the NanoCodec decoder it names in `codec_id` (`nvidia/nemo-nano-codec-22khz-1.89kbps-21.5fps` by default). Both are fetched automatically; expect the first startup to be correspondingly slower.
- Offline and online: `examples/offline_inference/text_to_speech/gepard/end2end.py` and `/v1/audio/speech` (see the [online Gepard section](../../online_serving/text_to_speech/README.md#gepard-10)).
@@ -502,6 +559,7 @@ Not yet — PR1 is zero-shot only (the learned `null_prefix` default voice). Ref
Single-stage native AR TTS at 48 kHz. Pipeline: `feat_encoder → MiniCPM4 → FSQ → residual_lm → LocDiT → AudioVAE`.
### Prerequisites
+
```bash
pip install voxcpm
# or, for a local source checkout:
@@ -509,6 +567,7 @@ export VLLM_OMNI_VOXCPM_CODE_PATH=/path/to/voxcpm
```
### Quick start
+
```bash
python examples/offline_inference/text_to_speech/voxcpm2/end2end.py \
--model openbmb/VoxCPM2 \
@@ -516,7 +575,9 @@ python examples/offline_inference/text_to_speech/voxcpm2/end2end.py \
```
### Voice cloning
+
Pass a reference audio for isolated cloning, or both `--ref-audio` + `--ref-text` for prompt continuation:
+
```bash
python examples/offline_inference/text_to_speech/voxcpm2/end2end.py \
--text "Hello, this is a voice clone demo." \
@@ -525,39 +586,16 @@ python examples/offline_inference/text_to_speech/voxcpm2/end2end.py \
```
### Streaming
+
Streaming is exposed through the online OpenAI Speech API (`stream=true`). See [`examples/online_serving/text_to_speech/voxcpm2/gradio_demo.py`](../../online_serving/text_to_speech/voxcpm2/gradio_demo.py) for an AudioWorklet-based gapless streaming player; the offline `end2end.py` script does not expose a streaming path.
### Notes
+
- Output: 48 kHz mono WAV.
- Deploy config: `vllm_omni/deploy/voxcpm2.yaml` (auto-loaded by HF `model_type`).
---
-## dots.tts
-
-Single-stage native AR TTS at 48 kHz (rednote-hilab). Pipeline: `Qwen2.5-1.5B base LM → DiT (10-step Euler flow matching) → patch_encoder AR loopback → AudioVAE (streaming decode)`. Same "vLLM-native base LM + side-path computation" pattern as VoxCPM2, with a plain Qwen2 backbone instead of MiniCPM4 and no FSQ / residual LM stage.
-
-### Quick start
-```bash
-python examples/offline_inference/text_to_speech/dots_tts/end2end.py \
- --model dots-studio/dots.tts-soar \
- --text "Hello, this is a test of dots TTS running on vLLM Omni."
-```
-
-### Voice cloning
-Not wired in this release. Generation is text-only and does not consume reference audio, a named voice, or a precomputed speaker embedding. The CAM++ x-vector speaker encoder weights load, but `end2end.py` has no `--ref-audio`/`--ref-text` flags yet.
-
-### Streaming
-The AudioVAE decoder emits incremental audio through its internal streaming path (`init_stream_state` / `stream_step` / `stream_flush`). Online streaming is exposed through the OpenAI-compatible `/v1/audio/speech` endpoint with `stream=true`; see the [online serving guide](../../online_serving/text_to_speech/README.md#dotstts). The offline `end2end.py` script returns the consolidated waveform.
-
-### Notes
-- Output: 48 kHz mono WAV.
-- Deploy config: `vllm_omni/deploy/dots_tts.yaml` (auto-loaded by HF `model_type`).
-- Checkpoints: `dots-studio/dots.tts-soar` is the validated default. `dots.tts-base` shares the same architecture but is unvalidated in this repo. `dots.tts-mf` (MeanFlow, 2-4 step) is not supported yet.
-- Known limitation: no CUDA graph capture and no batched side-path computation yet, so concurrent requests do not currently scale (each request's DiT Euler steps run serially). See `recipes/rednote-hilab/dots.tts.md` for details and the roadmap.
-
----
-
## IndexTTS-2 and IndexTTS-2.5
Both versions use a 2-stage TTS pipeline and produce 22.05 kHz mono audio. Stage 0 is a GPT AR talker. IndexTTS-2 Stage 1 uses RepCodec semantic embeddings, GPT latent, S2Mel CFM/DiT, and BigVGAN. IndexTTS-2.5 replaces RepCodec with EnhancedCodec and uses the official code-only path (`use_gpt_latent=false`). Every request requires reference audio for zero-shot voice cloning.
@@ -592,6 +630,7 @@ python examples/offline_inference/text_to_speech/indextts2/end2end.py \
```
### Emotion control
+
```bash
# Emotion from reference audio
python examples/offline_inference/text_to_speech/indextts2/end2end.py \
@@ -616,6 +655,7 @@ python examples/offline_inference/text_to_speech/indextts2/end2end.py \
```
### Notes
+
- `--ref-audio` is **required** — neither version provides text-only synthesis.
- IndexTTS-2.5 Stage 0 (AR Talker) generates mel codes from text + reference audio using plain vLLM sampling. It does not reproduce the official default `num_beams=3` beam search. For parity comparisons, run upstream with `num_beams=1`; output quality can differ from the official beam-search result.
- IndexTTS-2.5 accepts language codes such as `zh`, `en`, `zhen` (mixed Chinese/English), `ja`, and `yue`. `Mandarin` is a vLLM-Omni convenience alias for `zh`. Japanese (`ja`) uses `fugashi` tokenization and produces audio, but it does not automatically expand numbers, dates, or percentages; write those inputs as readable Japanese text before calling the model. Use `--no-text-normalization` only when the input is already normalized.
@@ -631,12 +671,15 @@ python examples/offline_inference/text_to_speech/indextts2/end2end.py \
Voxtral-4B-TTS (Mistral). Has its own argparse surface; uses voice presets and the `mistral_common` `SpeechRequest` protocol.
### Prerequisites
+
Latest `mistral_common` with `SpeechRequest` support:
+
```bash
pip install -e /path/to/mistral-common # or upgrade from PyPI when available
```
### Quick start (voice preset)
+
```bash
python examples/offline_inference/text_to_speech/voxtral_tts/end2end.py \
--write-audio --voice cheerful_female \
@@ -645,6 +688,7 @@ python examples/offline_inference/text_to_speech/voxtral_tts/end2end.py \
```
### Voice cloning (capability gated upstream)
+
```bash
python examples/offline_inference/text_to_speech/voxtral_tts/end2end.py \
--write-audio \
@@ -654,12 +698,14 @@ python examples/offline_inference/text_to_speech/voxtral_tts/end2end.py \
```
### Streaming + concurrency
+
```bash
python examples/offline_inference/text_to_speech/voxtral_tts/end2end.py \
--num-prompts 32 --concurrency 8 --streaming --write-audio --voice neutral_female \
--model mistralai/Voxtral-4B-TTS-2603 \
--text "..."
```
+
Available voice presets are listed on the HF model card (`mistralai/Voxtral-4B-TTS-2603`).
### Notes
diff --git a/examples/offline_inference/text_to_speech/dots_tts/end2end.py b/examples/offline_inference/text_to_speech/dots_tts/end2end.py
deleted file mode 100644
index aa710db4a..000000000
--- a/examples/offline_inference/text_to_speech/dots_tts/end2end.py
+++ /dev/null
@@ -1,125 +0,0 @@
-"""Offline dots.tts inference example (single-stage native AR pipeline).
-
-Uses the single-stage native AR config (vllm_omni/deploy/dots_tts.yaml).
-Reference checkpoint: dots-studio/dots.tts-soar.
-"""
-
-from __future__ import annotations
-
-import os
-import time
-from pathlib import Path
-
-import soundfile as sf
-import torch
-
-from vllm_omni import Omni
-from vllm_omni.utils.tracking_parser import TrackingArgumentParser
-
-REPO_ROOT = Path(__file__).resolve().parents[4]
-SAMPLE_RATE = 48_000
-
-
-def parse_args():
- parser = TrackingArgumentParser(description="Offline dots.tts native AR inference")
- parser.add_argument(
- "--model",
- type=str,
- default="dots-studio/dots.tts-soar",
- help="dots.tts model path or HuggingFace repo ID.",
- )
- parser.add_argument(
- "--text",
- type=str,
- default="Hello, this is a test of dots TTS running on vLLM Omni.",
- help="Text to synthesize.",
- )
- parser.add_argument(
- "--output-dir",
- type=str,
- default="output_audio",
- help="Directory for output WAV files.",
- )
- parser.add_argument(
- "--deploy-config",
- type=str,
- default=None,
- help="Override the deploy config path. If unset, auto-loads "
- "vllm_omni/deploy/dots_tts.yaml based on the HF model_type.",
- )
- return parser.parse_args()
-
-
-def extract_audio(multimodal_output: dict) -> torch.Tensor:
- """Extract the final complete audio tensor from multimodal output.
-
- The output processor concatenates per-step delta tensors under
- ``model_outputs``. Falls back to ``audio`` for backwards compat.
- """
- audio = multimodal_output.get("model_outputs")
- if audio is None:
- audio = multimodal_output.get("audio")
- if audio is None:
- raise ValueError(f"No audio key in multimodal_output: {list(multimodal_output.keys())}")
-
- if isinstance(audio, list):
- valid = [torch.as_tensor(a).float().cpu().reshape(-1) for a in audio if a is not None]
- if not valid:
- raise ValueError("Audio list is empty or all elements are None.")
- return torch.cat(valid, dim=0) if len(valid) > 1 else valid[0]
-
- return torch.as_tensor(audio).float().cpu().reshape(-1)
-
-
-def main():
- args = parse_args()
-
- output_dir = Path(args.output_dir)
- output_dir.mkdir(parents=True, exist_ok=True)
-
- engine = Omni(
- model=args.model,
- deploy_config=args.deploy_config,
- )
-
- from transformers import AutoTokenizer
-
- from vllm_omni.model_executor.models.dots_tts.dots_tts_prompt import (
- build_dots_tts_prompt,
- )
-
- tokenizer = AutoTokenizer.from_pretrained(args.model, trust_remote_code=True)
-
- prompt = build_dots_tts_prompt(
- tokenizer=tokenizer,
- text=args.text,
- )
-
- print(f"Model : {args.model}")
- print(f"Text : {args.text}")
- print(f"Output dir : {output_dir}")
- print(f"Prompt len : {len(prompt['prompt_token_ids'])} tokens")
-
- t_start = time.perf_counter()
- outputs = engine.generate([prompt])
- elapsed = time.perf_counter() - t_start
-
- request_output = outputs[0]
- mm = request_output.outputs[0].multimodal_output
- audio = extract_audio(mm)
-
- duration = audio.numel() / SAMPLE_RATE
- rtf = elapsed / duration if duration > 0 else float("inf")
-
- output_path = output_dir / "output.wav"
- sf.write(str(output_path), audio.numpy(), SAMPLE_RATE, format="WAV")
-
- print(f"Saved : {output_path}")
- print(f"Duration : {duration:.2f}s")
- print(f"Inference : {elapsed:.2f}s")
- print(f"RTF : {rtf:.3f}")
-
-
-if __name__ == "__main__":
- os.environ["VLLM_WORKER_MULTIPROC_METHOD"] = "spawn"
- main()
diff --git a/examples/offline_inference/text_to_video/text_to_video.py b/examples/offline_inference/text_to_video/text_to_video.py
index 06179ef9e..7b7bcb890 100644
--- a/examples/offline_inference/text_to_video/text_to_video.py
+++ b/examples/offline_inference/text_to_video/text_to_video.py
@@ -384,13 +384,20 @@ def parse_args() -> argparse.Namespace:
default=None,
help='JSON profiler config for torch/cuda profiling, e.g. \'{"profiler":"torch","torch_profiler_dir":"./perf"}\'.',
)
- parser.add_argument(
+ quantization_group = parser.add_mutually_exclusive_group()
+ quantization_group.add_argument(
"--quantization",
type=str,
default=None,
choices=["fp8", "mxfp8", "mxfp4", "mxfp4_dualscale", "int8"],
help="Quantization method for the transformer. mxfp8: W8A8 MXFP8 (NPU). mxfp4: W4A4 MXFP4 (NPU). mxfp4_dualscale: W4A4 MXFP4 dual-scale + BF16 fallback mixed (NPU). fp8: online FP8 (GPU).",
)
+ quantization_group.add_argument(
+ "--quantization-config",
+ type=json.loads,
+ default=None,
+ help='Quantization JSON, e.g. \'{"method":"mxfp4","w4a8_fallback_steps":[0,2]}\'.',
+ )
# Distributed and parallel execution
parser.add_argument(
@@ -572,6 +579,8 @@ def main():
omni_kwargs["flow_shift"] = args.flow_shift
if args.quantization is not None:
omni_kwargs["quantization"] = args.quantization
+ if args.quantization_config is not None:
+ omni_kwargs["quantization_config"] = args.quantization_config
if args.cache_backend is not None:
omni_kwargs["cache_backend"] = args.cache_backend
omni_kwargs["cache_config"] = cache_config
diff --git a/examples/online_serving/dynin_omni/README.md b/examples/online_serving/dynin_omni/README.md
deleted file mode 100644
index 6e78a5c1f..000000000
--- a/examples/online_serving/dynin_omni/README.md
+++ /dev/null
@@ -1,97 +0,0 @@
-# Dynin-Omni: Online serving
-
-## Installation
-
-Please refer to [README.md](../../../README.md).
-
-## Launch the Server
-
-First, find the `transformers_modules` path:
-
-```bash
-python - <<'PY'
-from transformers.utils.hub import HF_MODULES_CACHE
-print(HF_MODULES_CACHE)
-PY
-```
-
-Then export it for both `PYTHONPATH` and `HF_MODULES_CACHE`:
-
-```bash
-export PYTHONPATH=:$PYTHONPATH
-export HF_MODULES_CACHE=
-```
-
-Run from repository root. The 3-stage pipeline is resolved automatically from
-the model type (`vllm_omni/deploy/dynin_omni.yaml`), so no config path is
-required. Pass `--deploy-config` only to override the defaults:
-
-```bash
-vllm-omni serve snu-aidas/Dynin-Omni \
- --omni \
- --port 8091
-```
-
-If `vllm-omni` is not in PATH, run:
-
-```bash
-PYTHONPATH="$(pwd)" python -m vllm_omni.entrypoints.cli.main serve snu-aidas/Dynin-Omni \
- --omni \
- --port 8091
-```
-
-Wait until the server logs show both `All stages initialized successfully` and
-`Application startup complete.` before sending requests.
-
-## Send Requests via Python Client
-
-Move to the example directory:
-
-```bash
-cd examples/online_serving/dynin_omni
-```
-
-### Text -> Image
-
-```bash
-python openai_chat_completion_client_for_multimodal_generation.py \
- --query-type t2i \
- --prompt "A realistic indoor living room with natural daylight."
-```
-
-### Image -> Image
-
-```bash
-python openai_chat_completion_client_for_multimodal_generation.py \
- --query-type i2i \
- --image-path ../../offline_inference/dynin_omni/data/image/sofa_under_water.jpg \
- --prompt "Transform this surreal underwater setting into a realistic indoor living room while preserving the sofa layout."
-```
-
-### Text -> Speech
-
-```bash
-python openai_chat_completion_client_for_multimodal_generation.py \
- --query-type t2s \
- --prompt "Hello. This is Dynin-omni."
-```
-
-## CLI Arguments
-
-- `--query-type` (`t2i|t2s|i2i`)
-- `--model` (default: `snu-aidas/Dynin-Omni`)
-- `--host` / `--port` (OpenAI-compatible vLLM endpoint)
-- `--prompt` (custom text)
-- `--image-path` (required for `i2i`)
-- `--modalities` (optional output modalities override)
-- `--output-dir` (default: `/tmp/dynin_online_outputs`)
-
-## Notes
-
-- This client currently supports only `t2i`, `t2s`, and `i2i`.
-- `t2t` is intentionally not exposed in this online example.
-- This example intentionally uses the OpenAI-compatible chat completion endpoint.
-- Task routing for non-text outputs relies on Dynin task trigger tokens (`<|t2i|>`, `<|i2i|>`, `<|t2s|>`) injected by the client.
-- Outputs are saved under `/tmp/dynin_online_outputs` by default.
-- Dynin stage-0 warmup can take a while on first startup; do not send requests before startup completes.
-- Dynin itself can execute text-returning tasks such as `t2t`, `s2t`, `i2t`, and `v2t`, but this online serving example currently runs stage-0 in `generation` mode. In that path, the generation worker does not surface the final text as `output.text`, so OpenAI chat responses for those text-output tasks may complete internally but still return empty text.
diff --git a/examples/online_serving/dynin_omni/openai_chat_completion_client_for_multimodal_generation.py b/examples/online_serving/dynin_omni/openai_chat_completion_client_for_multimodal_generation.py
deleted file mode 100644
index 972855543..000000000
--- a/examples/online_serving/dynin_omni/openai_chat_completion_client_for_multimodal_generation.py
+++ /dev/null
@@ -1,342 +0,0 @@
-#!/usr/bin/env python3
-# SPDX-License-Identifier: Apache-2.0
-
-from __future__ import annotations
-
-import argparse
-import base64
-import json
-import mimetypes
-import os
-import time
-from pathlib import Path
-from typing import Any
-
-DEFAULT_MODEL = "snu-aidas/Dynin-Omni"
-DEFAULT_OUTPUT_DIR = "/tmp/dynin_online_outputs"
-
-QUERY_CHOICES = ("t2i", "t2s", "i2i")
-DEFAULT_PROMPT_BY_QUERY = {
- "t2i": "A high quality detailed living room interior photo.",
- "t2s": "Please read this sentence naturally: Hello from Dynin-Omni online serving.",
- "i2i": "Transform this image into a realistic indoor living room while preserving layout.",
-}
-DEFAULT_MODALITIES_BY_QUERY = {
- "t2i": ["image"],
- "t2s": ["audio"],
- "i2i": ["image"],
-}
-OFFLINE_PARITY_STAGE_COUNT = 3
-OFFLINE_PARITY_STAGE_SAMPLING = {
- "max_tokens": 1,
- "temperature": 0.0,
- "top_p": 1.0,
- "detokenize": False,
-}
-
-
-def _infer_mime_type(path: Path) -> str:
- mime_type, _ = mimetypes.guess_type(str(path))
- return mime_type or "application/octet-stream"
-
-
-def _encode_file_as_data_url(path: Path) -> str:
- mime_type = _infer_mime_type(path)
- raw = path.read_bytes()
- encoded = base64.b64encode(raw).decode("utf-8")
- return f"data:{mime_type};base64,{encoded}"
-
-
-def _to_image_url(path_or_url: str) -> str:
- value = str(path_or_url)
- if value.startswith(("http://", "https://", "data:image/")):
- return value
- path = Path(value).expanduser().resolve()
- if not path.exists():
- raise FileNotFoundError(f"Image file not found: {path}")
- return _encode_file_as_data_url(path)
-
-
-def _build_user_content(query_type: str, prompt: str, image_path: str | None) -> list[dict[str, Any]]:
- if query_type == "t2i":
- return [{"type": "text", "text": f"<|t2i|> {prompt}"}]
-
- if query_type == "t2s":
- return [{"type": "text", "text": f"<|t2s|> {prompt}"}]
-
- if query_type == "i2i":
- if not image_path:
- raise ValueError("--image-path is required for query type i2i")
- return [
- {"type": "text", "text": f"<|i2i|> {prompt}"},
- {"type": "image_url", "image_url": {"url": _to_image_url(image_path)}},
- ]
-
- raise ValueError(f"Unsupported query_type: {query_type}")
-
-
-def _collect_text_from_content(content: Any) -> list[str]:
- texts: list[str] = []
- if isinstance(content, str):
- stripped = content.strip()
- if stripped:
- texts.append(stripped)
- return texts
-
- if isinstance(content, dict):
- for key in ("text", "content", "value", "output_text"):
- text_value = content.get(key)
- if isinstance(text_value, str) and text_value.strip():
- texts.append(text_value.strip())
- return texts
-
- if isinstance(content, list):
- for item in content:
- texts.extend(_collect_text_from_content(item))
- return texts
-
- content_text = getattr(content, "text", None)
- if isinstance(content_text, str) and content_text.strip():
- texts.append(content_text.strip())
- content_value = getattr(content, "content", None)
- if isinstance(content_value, str) and content_value.strip():
- texts.append(content_value.strip())
- output_text = getattr(content, "output_text", None)
- if isinstance(output_text, str) and output_text.strip():
- texts.append(output_text.strip())
- return texts
-
-
-def _extract_text_outputs(chat_completion: Any) -> list[str]:
- texts: list[str] = []
- for choice in getattr(chat_completion, "choices", []) or []:
- message = getattr(choice, "message", None)
- if message is None:
- continue
- content = getattr(message, "content", None)
- texts.extend(_collect_text_from_content(content))
- reasoning_content = getattr(message, "reasoning_content", None)
- if isinstance(reasoning_content, str) and reasoning_content.strip():
- texts.append(reasoning_content.strip())
- choice_text = getattr(choice, "text", None)
- if isinstance(choice_text, str) and choice_text.strip():
- texts.append(choice_text.strip())
- top_level_output_text = getattr(chat_completion, "output_text", None)
- if isinstance(top_level_output_text, str) and top_level_output_text.strip():
- texts.append(top_level_output_text.strip())
- return texts
-
-
-def _extract_image_data_urls(chat_completion: Any) -> list[str]:
- urls: list[str] = []
- for choice in getattr(chat_completion, "choices", []) or []:
- message = getattr(choice, "message", None)
- if message is None:
- continue
- content = getattr(message, "content", None)
- if not isinstance(content, list):
- continue
- for item in content:
- if not isinstance(item, dict):
- continue
- if item.get("type") != "image_url":
- continue
- image_url = (item.get("image_url") or {}).get("url")
- if isinstance(image_url, str) and image_url.startswith("data:image"):
- urls.append(image_url)
- return urls
-
-
-def _extract_audio_payloads(chat_completion: Any) -> list[bytes]:
- payloads: list[bytes] = []
- for choice in getattr(chat_completion, "choices", []) or []:
- message = getattr(choice, "message", None)
- if message is None:
- continue
- message_audio = getattr(message, "audio", None)
- if message_audio is None:
- continue
- data_b64 = getattr(message_audio, "data", None)
- if isinstance(data_b64, str) and data_b64:
- try:
- payloads.append(base64.b64decode(data_b64))
- except Exception:
- continue
- return payloads
-
-
-def _decode_data_url(data_url: str) -> tuple[bytes, str]:
- header, data = data_url.split(",", 1)
- mime_type = "image/png"
- if ";" in header and ":" in header:
- mime_type = header.split(":", 1)[1].split(";", 1)[0]
- return base64.b64decode(data), mime_type
-
-
-def _image_extension_from_mime(mime_type: str) -> str:
- if mime_type == "image/jpeg":
- return ".jpg"
- if mime_type == "image/webp":
- return ".webp"
- if mime_type == "image/gif":
- return ".gif"
- return ".png"
-
-
-def _save_outputs(
- *,
- query_type: str,
- chat_completion: Any,
- output_dir: Path,
-) -> None:
- output_dir.mkdir(parents=True, exist_ok=True)
- stamp = time.strftime("%Y%m%d_%H%M%S")
-
- text_outputs = _extract_text_outputs(chat_completion)
- image_data_urls = _extract_image_data_urls(chat_completion)
- audio_payloads = _extract_audio_payloads(chat_completion)
-
- if text_outputs:
- text_path = output_dir / f"{query_type}_{stamp}.txt"
- text_path.write_text("\n\n".join(text_outputs) + "\n", encoding="utf-8")
- print(f"[dynin-online] text saved: {text_path}")
- print(text_outputs[0])
-
- for idx, image_url in enumerate(image_data_urls):
- image_bytes, mime_type = _decode_data_url(image_url)
- ext = _image_extension_from_mime(mime_type)
- image_path = output_dir / f"{query_type}_{stamp}_{idx}{ext}"
- image_path.write_bytes(image_bytes)
- print(f"[dynin-online] image saved: {image_path}")
-
- for idx, audio_bytes in enumerate(audio_payloads):
- audio_path = output_dir / f"{query_type}_{stamp}_{idx}.wav"
- audio_path.write_bytes(audio_bytes)
- print(f"[dynin-online] audio saved: {audio_path}")
-
- if not text_outputs and not image_data_urls and not audio_payloads:
- print("[dynin-online] no output extracted from response")
- raw_path = output_dir / f"{query_type}_{stamp}_raw_response.json"
- try:
- if hasattr(chat_completion, "model_dump_json"):
- serialized = chat_completion.model_dump_json(indent=2)
- else:
- if hasattr(chat_completion, "model_dump"):
- raw_payload: Any = chat_completion.model_dump(mode="json")
- else:
- raw_payload = chat_completion
- try:
- serialized = json.dumps(raw_payload, ensure_ascii=False, indent=2)
- except Exception:
- serialized = json.dumps({"repr": repr(raw_payload)}, ensure_ascii=False, indent=2)
- raw_path.write_text(serialized + "\n", encoding="utf-8")
- print(f"[dynin-online] raw response saved: {raw_path}")
- except Exception:
- pass
-
-
-def _build_offline_parity_sampling_params_list() -> list[dict[str, Any]]:
- return [dict(OFFLINE_PARITY_STAGE_SAMPLING) for _ in range(OFFLINE_PARITY_STAGE_COUNT)]
-
-
-def run_request(args: argparse.Namespace) -> None:
- from openai import OpenAI
-
- client = OpenAI(
- api_key="EMPTY",
- base_url=f"http://{args.host}:{args.port}/v1",
- )
- prompt = args.prompt.strip() if args.prompt else DEFAULT_PROMPT_BY_QUERY[args.query_type]
- user_content = _build_user_content(
- query_type=args.query_type,
- prompt=prompt,
- image_path=args.image_path,
- )
- if args.modalities:
- modalities = [item.strip() for item in args.modalities.split(",") if item.strip()]
- else:
- modalities = DEFAULT_MODALITIES_BY_QUERY[args.query_type]
-
- extra_body = {
- "sampling_params_list": _build_offline_parity_sampling_params_list(),
- }
- chat_completion = client.chat.completions.create(
- model=args.model,
- messages=[{"role": "user", "content": user_content}],
- modalities=modalities,
- extra_body=extra_body,
- )
- _save_outputs(
- query_type=args.query_type,
- chat_completion=chat_completion,
- output_dir=Path(args.output_dir).expanduser(),
- )
-
-
-def parse_args() -> argparse.Namespace:
- parser = argparse.ArgumentParser(description="Dynin-Omni online chat completion client")
- parser.add_argument(
- "--query-type",
- "-q",
- type=str,
- default="t2i",
- choices=QUERY_CHOICES,
- help="Dynin query type",
- )
- parser.add_argument(
- "--model",
- "-m",
- type=str,
- default=DEFAULT_MODEL,
- help="Model name/path",
- )
- parser.add_argument(
- "--host",
- type=str,
- default="localhost",
- help="Host/IP of the vLLM Omni API server",
- )
- parser.add_argument(
- "--port",
- type=int,
- default=8091,
- help="Port of the vLLM Omni API server",
- )
- parser.add_argument(
- "--prompt",
- "-p",
- type=str,
- default="",
- help="Custom prompt text",
- )
- parser.add_argument(
- "--image-path",
- "-i",
- type=str,
- default=None,
- help="Image path/URL for i2i",
- )
- parser.add_argument(
- "--modalities",
- type=str,
- default="",
- help="Comma-separated output modalities override (e.g., text,image,audio)",
- )
- parser.add_argument(
- "--output-dir",
- "-o",
- type=str,
- default=DEFAULT_OUTPUT_DIR,
- help="Directory to save outputs",
- )
- return parser.parse_args()
-
-
-def main() -> None:
- args = parse_args()
- os.environ.setdefault("HF_HUB_DISABLE_XET", "1")
- run_request(args)
-
-
-if __name__ == "__main__":
- main()
diff --git a/examples/online_serving/minicpmo/README.md b/examples/online_serving/minicpmo/README.md
index 67b268a77..ffd50167f 100644
--- a/examples/online_serving/minicpmo/README.md
+++ b/examples/online_serving/minicpmo/README.md
@@ -316,3 +316,12 @@ them unless `--allow-invalid-clock` is explicit.
[`examples/offline_inference/minicpmo/`](../../offline_inference/minicpmo/)
- Recipe:
[`recipes/OpenBMB/MiniCPM-o-4_5.md`](../../../recipes/OpenBMB/MiniCPM-o-4_5.md)
+
+### Shared realtime UI implementation
+
+The `python -m examples.online_serving.minicpmo.realtime_web` command remains
+available with the same MiniCPM defaults and required `--ref-audio`. Its assets
+now live in [the shared realtime UI](../realtime_web/README.md), with a dedicated
+`minicpm-native` profile preserving native duplex input, playback ACKs and camera
+frames. Qwen3 uses a separate profile in the same shell, supporting manual STT
+turns or Server VAD turns with speech interruption.
diff --git a/examples/online_serving/minicpmo/realtime_web/server.py b/examples/online_serving/minicpmo/realtime_web/server.py
index ee78fff74..1ef12d186 100644
--- a/examples/online_serving/minicpmo/realtime_web/server.py
+++ b/examples/online_serving/minicpmo/realtime_web/server.py
@@ -1,185 +1,23 @@
-"""Static host and same-origin Realtime proxy for the full-duplex demo."""
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
-from __future__ import annotations
+"""Backward-compatible MiniCPM entry point for the shared realtime UI."""
-import argparse
-import asyncio
-import base64
-import contextlib
-import hashlib
-import json
-import logging
-from pathlib import Path
-from urllib.parse import urlencode
+from examples.online_serving.realtime_web.server import (
+ APP_DIR,
+ STATIC_DIR,
+ _join_ws_url,
+ build_app,
+)
+from examples.online_serving.realtime_web.server import (
+ main as _main,
+)
-import uvicorn
-import websockets
-from fastapi import FastAPI, WebSocket, WebSocketDisconnect
-from fastapi.responses import HTMLResponse, Response
-from fastapi.staticfiles import StaticFiles
-
-logger = logging.getLogger(__name__)
-APP_DIR = Path(__file__).parent / "app"
-STATIC_DIR = APP_DIR / "static"
-
-
-def _join_ws_url(base: str, path: str, query: str) -> str:
- return base.rstrip("/") + path + (("?" + query) if query else "")
-
-
-async def _pump_client_to_backend(client: WebSocket, backend) -> None:
- try:
- while True:
- message = await client.receive()
- if message["type"] == "websocket.disconnect":
- await backend.close()
- return
- if message.get("text") is not None:
- await backend.send(message["text"])
- elif message.get("bytes") is not None:
- await backend.send(message["bytes"])
- except (WebSocketDisconnect, websockets.ConnectionClosed):
- with contextlib.suppress(Exception):
- await backend.close()
-
-
-async def _pump_backend_to_client(client: WebSocket, backend) -> None:
- try:
- async for message in backend:
- if isinstance(message, bytes):
- await client.send_bytes(message)
- else:
- await client.send_text(message)
- except (WebSocketDisconnect, websockets.ConnectionClosed):
- return
- except RuntimeError as exc:
- if "websocket.send" in str(exc) and "websocket.close" in str(exc):
- return
- raise
-
-
-def _expected_proxy_close(exc: BaseException) -> bool:
- if isinstance(exc, (WebSocketDisconnect, websockets.ConnectionClosed, asyncio.CancelledError)):
- return True
- return isinstance(exc, RuntimeError) and "websocket.send" in str(exc) and "websocket.close" in str(exc)
-
-
-def build_app(
- *,
- ws_backend: str = "ws://127.0.0.1:8099",
- model: str = "openbmb/MiniCPM-o-4_5",
- public_realtime_url: str | None = None,
- ref_audio: str | None = None,
-) -> FastAPI:
- app = FastAPI(title="Experimental Full-Duplex Web Demo")
- index_path = APP_DIR / "index.html"
- app_version_hash = hashlib.sha256()
- for asset_path in (
- STATIC_DIR / "app.js",
- STATIC_DIR / "pcm_worklet.js",
- STATIC_DIR / "playback_worklet.js",
- ):
- app_version_hash.update(asset_path.read_bytes())
- app_version = app_version_hash.hexdigest()[:12]
-
- ref_audio_uri: str | None = None
- if ref_audio:
- ref_path = Path(ref_audio)
- if not ref_path.is_file():
- raise SystemExit(f"--ref-audio not found: {ref_audio}")
- encoded = base64.b64encode(ref_path.read_bytes()).decode("ascii")
- ref_audio_uri = f"data:audio/wav;base64,{encoded}"
-
- @app.get("/", response_class=HTMLResponse)
- def index() -> HTMLResponse:
- config = json.dumps(
- {
- "model": model,
- "realtimePath": public_realtime_url or "v1/realtime",
- "refAudio": ref_audio_uri,
- "appVersion": app_version,
- },
- ensure_ascii=True,
- )
- html = (
- index_path.read_text(encoding="utf-8")
- .replace("__FULL_DUPLEX_CONFIG__", config)
- .replace("__FULL_DUPLEX_APP_VERSION__", app_version)
- )
- return HTMLResponse(html, headers={"Cache-Control": "no-store"})
-
- @app.get("/healthz")
- def healthz() -> Response:
- return Response(content="ok", media_type="text/plain")
-
- @app.websocket("/v1/realtime")
- async def realtime_proxy(websocket: WebSocket) -> None:
- await websocket.accept()
- query = urlencode(websocket.query_params.multi_items())
- backend_url = _join_ws_url(ws_backend, "/v1/realtime", query)
- logger.info("Proxying Realtime WebSocket to %s", backend_url)
- try:
- async with websockets.connect(
- backend_url,
- max_size=64 * 1024 * 1024,
- ) as backend:
- tasks = {
- asyncio.create_task(_pump_client_to_backend(websocket, backend)),
- asyncio.create_task(_pump_backend_to_client(websocket, backend)),
- }
- done, pending = await asyncio.wait(
- tasks,
- return_when=asyncio.FIRST_COMPLETED,
- )
- for task in pending:
- task.cancel()
- await asyncio.gather(*pending, return_exceptions=True)
- for result in await asyncio.gather(*done, return_exceptions=True):
- if isinstance(result, BaseException) and not _expected_proxy_close(result):
- raise result
- except (WebSocketDisconnect, websockets.ConnectionClosed):
- return
- except Exception:
- logger.exception("Realtime WebSocket proxy failed")
- with contextlib.suppress(Exception):
- await websocket.close(code=1011)
-
- app.mount("/static", StaticFiles(directory=str(STATIC_DIR)), name="static")
- return app
+__all__ = ["APP_DIR", "STATIC_DIR", "_join_ws_url", "build_app", "main"]
def main() -> None:
- parser = argparse.ArgumentParser(description=__doc__)
- parser.add_argument("--host", default="0.0.0.0")
- parser.add_argument("--port", type=int, default=7862)
- parser.add_argument("--ws-backend", default="ws://127.0.0.1:8099")
- parser.add_argument(
- "--public-realtime-url",
- help="Browser-visible ws:// or wss:// Realtime URL; defaults to the same-origin proxy.",
- )
- parser.add_argument("--model", default="openbmb/MiniCPM-o-4_5")
- parser.add_argument(
- "--ref-audio",
- required=True,
- help=(
- "Reference voice wav for TTS voice cloning, e.g. the "
- "official MiniCPM-o-Demo assets/ref_audio/ref_minicpm_signature.wav"
- ),
- )
- args = parser.parse_args()
-
- logging.basicConfig(level=logging.INFO)
- uvicorn.run(
- build_app(
- ws_backend=args.ws_backend,
- model=args.model,
- public_realtime_url=args.public_realtime_url,
- ref_audio=args.ref_audio,
- ),
- host=args.host,
- port=args.port,
- log_level="info",
- )
+ _main(default_profile="minicpm-native")
if __name__ == "__main__":
diff --git a/examples/online_serving/qwen3_omni/README.md b/examples/online_serving/qwen3_omni/README.md
index 107e1f098..5eb9a2042 100644
--- a/examples/online_serving/qwen3_omni/README.md
+++ b/examples/online_serving/qwen3_omni/README.md
@@ -14,6 +14,17 @@ Please refer to [README.md](../../../README.md)
vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni --port 8091
```
+For a local deployment with multiple API frontend processes sharing one set
+of stage engines, add `--api-server-count`:
+
+```bash
+vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni --api-server-count 2 --port 8091
+```
+
+This mode currently supports local EngineCore stages. It is not available
+with headless or remote stage deployments, and pure diffusion stages remain
+single-frontend.
+
The default deployment configuration, situated at `vllm_omni/deploy/qwen3_omni_moe.yaml`, is resolved and loaded
automatically via the model registry, obviating the `--deploy-config` flag in standard deployment topologies.
Asynchronous chunk streaming operates as **enabled by default** within this bundled configuration.
@@ -156,7 +167,7 @@ parser defaults). If you don't pass a flag, the YAML value wins.
> chunked vs end-to-end modes (e.g. qwen3_tts code2wav) dispatch
> automatically based on that bool — no extra flag or variant yaml is
> needed.
-
+>
> ⚠️ **For multi-stage models that share GPUs (qwen3_omni_moe by default
> shares cuda:1 between stages 1 and 2), avoid using global memory flags.**
> A global `--gpu-memory-utilization 0.85` would apply to every stage and
@@ -309,24 +320,17 @@ python openai_realtime_client.py \
Server VAD uses the pinned Silero v6.2 ONNX artifact from `istupakov/silero-vad-onnx` and never downloads model files while processing a session. Make the artifact available in the Hugging Face cache before startup, or configure a local artifact in the deployment YAML:
```yaml
+base_config: /path/to/vllm-omni/vllm_omni/deploy/qwen3_omni_duplex.yaml
duplex_session:
server_vad_model_path: /models/silero_vad.onnx
```
-Start from the bundled Qwen3-Omni deployment YAML, add the fields above at the top level, and serve that complete configuration:
-
-```bash
-cp vllm_omni/deploy/qwen3_omni_moe.yaml /path/to/qwen3_omni_server_vad.yaml
-# Edit /path/to/qwen3_omni_server_vad.yaml and add duplex_session.
-vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct \
- --omni \
- --port 8091 \
- --deploy-config /path/to/qwen3_omni_server_vad.yaml
-```
-
-Keep Qwen's default `session_mode: turn`; `duplex_session` enables the Realtime handler without changing scheduler
-semantics. Bare `/v1/realtime` selects that handler. The client uses `?duplex=0` only for the existing non-Server-VAD
-wire flow; `?duplex=1` remains a supported compatibility alias.
+For the engine-owned plugin, use an overlay based on
+`vllm_omni/deploy/qwen3_omni_duplex.yaml`, with `duplex_session.server_vad_model_path`
+pointing to your local artifact. See the [complete duplex setup](../realtime_web/README.md#qwen3-with-server-vad-automatic-turns).
+The default `qwen3_omni_moe.yaml` remains a turn deployment. Duplex mode serves
+`/v1/realtime?duplex=1` and `/v1/chat/completions`; the legacy STT handler requires
+a turn deployment.
The Python client supports the following command-line arguments:
@@ -573,3 +577,53 @@ The gradio script supports the following arguments:
- `--ip`: Host/IP for Gradio server (default: 127.0.0.1)
- `--port`: Port for Gradio server (default: 7861)
- `--share`: Share the Gradio demo publicly (creates a public link)
+
+## Browser voice call (shared realtime UI)
+
+Run these commands from the repository root with the vLLM-Omni environment activated.
+
+### Without VAD: manually submit each turn
+
+Start the backend:
+
+```bash
+vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni --port 8091
+```
+
+In another terminal, check backend readiness and start the UI:
+
+```bash
+curl --fail http://127.0.0.1:8091/health
+python -m examples.online_serving.qwen3_omni.realtime_web \
+ --backend ws://127.0.0.1:8091 --stt --port 7863
+```
+
+Open `http://localhost:7863`, start a session, speak, and press **Send turn**.
+`--stt` is the default. Each turn uses a separate connection without shared model
+history; the conversation shown in the browser is a local log.
+
+### With VAD: automatically submit after silence
+
+Start the backend with a Server VAD deployment overlay and a compatible Silero
+ONNX artifact, following the
+[complete VAD setup](../realtime_web/README.md#qwen3-with-server-vad-automatic-turns).
+After its health check succeeds, start the UI:
+
+```bash
+python -m examples.online_serving.qwen3_omni.realtime_web \
+ --backend ws://127.0.0.1:8091 --vad --port 7863
+```
+
+Speak and pause for 500 ms to submit automatically. `--vad` configures the client;
+it does not load a VAD model or change the backend deployment by itself.
+
+VAD mode keeps uploading audio during replies and supports speech interruption.
+The engine-owned Qwen duplex plugin maintains conversation history and tracks
+played replies through playback acknowledgements. Each committed utterance starts
+a new generation request; the model does not use native streaming-input KV decoding.
+STT mode pauses microphone upload while the reply is generated and played.
+In VAD mode, click **Camera** to upload sampled frames with your spoken question;
+see [camera setup and limits](../realtime_web/README.md#qwen-vad-camera-input).
+STT remains audio-only. To switch back to manual turns, use the default turn
+deployment, restart the UI with `--stt`, refresh the page, and reconnect. Stop the existing UI before reusing port 7863.
+See the [shared UI guide](../realtime_web/README.md) for HTTPS access and testing.
diff --git a/examples/online_serving/qwen3_omni/openai_realtime_client.py b/examples/online_serving/qwen3_omni/openai_realtime_client.py
index 0a98d69a0..2a6bca0fe 100644
--- a/examples/online_serving/qwen3_omni/openai_realtime_client.py
+++ b/examples/online_serving/qwen3_omni/openai_realtime_client.py
@@ -130,7 +130,7 @@ async def run_client(
"prefix_padding_ms": 300,
"silence_duration_ms": 500,
"create_response": True,
- "interrupt_response": False,
+ "interrupt_response": True,
},
}
},
@@ -233,6 +233,7 @@ async def run_client(
continue
if event_type == "response.done" and server_vad:
+ await ws.send(json.dumps({"type": "session.close"}))
break
if event_type == "error":
diff --git a/examples/online_serving/qwen3_omni/realtime_web/__init__.py b/examples/online_serving/qwen3_omni/realtime_web/__init__.py
new file mode 100644
index 000000000..14c5daad2
--- /dev/null
+++ b/examples/online_serving/qwen3_omni/realtime_web/__init__.py
@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
+
+"""Qwen3-Omni turn-based browser call UI."""
diff --git a/examples/online_serving/qwen3_omni/realtime_web/__main__.py b/examples/online_serving/qwen3_omni/realtime_web/__main__.py
new file mode 100644
index 000000000..698179528
--- /dev/null
+++ b/examples/online_serving/qwen3_omni/realtime_web/__main__.py
@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
+
+from examples.online_serving.realtime_web.server import main
+
+if __name__ == "__main__":
+ main(default_profile="qwen3-turn")
diff --git a/examples/online_serving/realtime_web/README.md b/examples/online_serving/realtime_web/README.md
new file mode 100644
index 000000000..854aa4718
--- /dev/null
+++ b/examples/online_serving/realtime_web/README.md
@@ -0,0 +1,221 @@
+# Shared Realtime Web UI
+
+One browser shell provides microphone capture, speaker playback, a level meter,
+conversation text, and an event log. Model profiles own the wire protocol.
+This implements [RFC #7222](https://github.com/vllm-project/vllm-omni/issues/7222).
+
+| Profile | Turn control | Camera | Playback acknowledgement |
+| --- | --- | --- | --- |
+| `minicpm-native` | Model-controlled listen/speak, continuous audio input | Frames accompany audio | Yes |
+| `qwen3-turn --stt` (default) | User presses **Send turn** | No | No |
+| `qwen3-turn --vad` | Server detects trailing silence; speech interrupts replies | Sampled frames with each spoken turn | Yes |
+
+Qwen3 VAD uses an engine-owned duplex plugin: microphone upload continues
+while replies stream, and speech can interrupt generation and playback. The
+checkpoint still generates committed turns; this is not native streaming-input
+KV decoding. STT remains explicit-turn and audio-only.
+
+## MiniCPM: existing command stays valid
+
+Start your MiniCPM backend using the [existing deployment instructions](../minicpmo/README.md), then:
+
+```bash
+python -m examples.online_serving.minicpmo.realtime_web \
+ --ws-backend ws://127.0.0.1:8099 \
+ --ref-audio /path/to/ref_minicpm_signature.wav
+```
+
+The compatibility wrapper serves the shared assets with `minicpm-native`.
+The current native query, `extra_body`, reference voice, continuous microphone
+upload, camera frames and playback acknowledgements are retained.
+
+## Qwen3: explicit-turn STT adapter
+
+Start the backend, then the UI in a second terminal:
+
+```bash
+vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni --port 8091
+
+python -m examples.online_serving.qwen3_omni.realtime_web \
+ --backend ws://127.0.0.1:8091 --stt --port 7863
+```
+
+Open `http://localhost:7863`, start a session, speak, and press **Send turn**.
+Wait for the answer to finish playing before speaking again. The UI opens a
+fresh STT connection for each turn; the displayed conversation is a local log,
+and **previous turns are not provided as model history**. The STT endpoint
+accepts only model selection, so system-prompt controls are hidden in this mode.
+
+The adapter follows the shipped `qwen3_omni/openai_realtime_client.py` and
+`vllm_omni/entrypoints/openai/realtime_connection.py`:
+
+1. Explicit `duplex=0` selects the legacy STT handler on a turn deployment.
+ It does not enable STT on a duplex deployment.
+2. Send `{type: "session.update", model: ...}` and `commit(final=false)`.
+3. Stream mono PCM16 at 16 kHz; **Send turn** flushes buffered audio, then sends `commit(final=true)`.
+4. `response.output_audio.delta.audio` contains PCM; `response.output_audio.done`
+ terminates this adapter, including a response with no audio.
+5. The local implementation emits **model output** on `transcription.*`, so the
+ UI displays it as assistant text. This differs from the early RFC's suggested
+ user-transcript mapping. The VAD adapter also supports `response.output_text.*`
+ and audio-transcript events without duplicating the answer.
+
+## Qwen3 with Server VAD (automatic turns)
+
+Run commands from the repository root with the vLLM-Omni environment activated.
+Prepare the pinned Silero v6.2 ONNX artifact as described in the
+[Qwen3 Server VAD instructions](../qwen3_omni/README.md#realtime-websocket-client-openai_realtime_clientpy).
+The backend requires ONNX Runtime and a compatible local artifact; setting
+`--vad` on the UI alone does not enable VAD on the backend.
+
+Create an overlay named `qwen3_vad.yaml`, replacing both paths with absolute paths
+on the backend host:
+
+```yaml
+base_config: /path/to/vllm-omni/vllm_omni/deploy/qwen3_omni_duplex.yaml
+duplex_session:
+ server_vad_model_path: /path/to/silero_vad.onnx
+```
+
+The base configuration enables duplex mode and sets the per-prompt audio and image limits.
+
+Start the backend:
+
+```bash
+vllm serve Qwen/Qwen3-Omni-30B-A3B-Instruct --omni --port 8091 \
+ --deploy-config qwen3_vad.yaml
+```
+
+In a second terminal, wait until the health check succeeds, then start the UI:
+
+```bash
+curl --fail http://127.0.0.1:8091/health
+python -m examples.online_serving.qwen3_omni.realtime_web \
+ --backend ws://127.0.0.1:8091 --vad --port 7863
+```
+
+Open `http://localhost:7863` and start a session. Speak and pause: the server
+commits the turn automatically after 500 ms of silence. No **Send turn** action
+is needed. Defaults are a speech threshold of 0.5 and 300 ms of prefix padding.
+Speak again to interrupt an answer. The engine owns input buffering, VAD,
+request cancellation, playback acknowledgements, and conversation history.
+Each committed utterance starts a normal Thinker → Talker → Code2Wav request;
+it does not append input to a live Qwen KV cache. The capability response reports
+`implementation_level: turn_based_duplex` and `supports_core_resumable_request: false`.
+
+The plugin retains up to four audio inputs (including the current turn), pruning
+older audio at an 8 MiB base64 budget; one current utterance is bounded by the
+engine's pending-input limit. The UI reports playback progress both on normal
+drain and on interruption. Qwen does not provide text/audio alignment, so assistant
+text enters history only after the complete audio response has been generated and
+acknowledged as played. A partially played answer contributes no guessed text
+prefix. Image conversation items remain available until deleted. Model context limits still apply.
+The bundled duplex deploy allows four audio inputs and eight images per prompt.
+Use headphones to avoid speaker audio triggering VAD interruption. Reference
+voices and tool calls are not supported by this plugin.
+
+### Switching between VAD and manual turns
+
+| Mode | Backend | UI flag | Submit a turn |
+| --- | --- | --- | --- |
+| Without VAD | Default Qwen turn deployment | `--stt` (default) | Press **Send turn** |
+| With VAD | Server VAD configuration and Silero artifact | `--vad` | Pause after speaking |
+
+Stop the existing UI process before starting another on the same port, then
+refresh the browser and reconnect. To use STT, start a backend with the default
+turn deployment and restart the UI with `--stt`. The duplex backend exposes
+Realtime duplex and ChatCompletion; it does not expose the legacy STT handler.
+To enable VAD on a default backend, first restart that backend with the overlay.
+Make `--backend` match the actual backend port; the UI and backend use separate
+ports. `Connection refused` means the target backend is unavailable: check its
+startup log and `/health` before connecting.
+
+VAD connects with `duplex=1` and sends nested `session.audio.input` configuration
+with `create_response: true` and `interrupt_response: true`. It sends playback
+ACKs when speaker audio drains. `response.audio.done` / `response.output_audio.done`
+only drain playback; `response.done` terminates a turn. Backpressure displays a
+notice without pausing the microphone. Failed handshakes time out after 15 seconds;
+Silero initialization failures display a specific error.
+
+After updating the backend Python code, restart the backend, refresh the UI, and
+start a new session so the plugin and browser assets use the updated code. A
+successful `/health` check confirms readiness, not which deployment mode is active.
+
+## Qwen VAD camera input
+
+After starting a session with `--vad`, click **Camera** and allow access. The UI
+sends one JPEG per second, resized to a longest side of 448 pixels, independently
+of microphone uploads (including while muted). Each frame is a user conversation
+item using the [OpenAI Realtime image input](https://developers.openai.com/api/docs/guides/realtime-conversations#image-inputs) shape:
+
+```json
+{"type":"conversation.item.create","item":{"id":"camera_1","type":"message","role":"user","content":[{"type":"input_image","image_url":"data:image/jpeg;base64,..."}]}}
+```
+
+Images become conversation context immediately; they do not start a response.
+Speak and let VAD commit your audio, or send `response.create` after adding an
+image/text item. A manual `input_audio_buffer.commit` only commits audio; follow
+it with `response.create` to generate. Images persist across audio commits,
+interruptions, and audio-buffer clears. Remove them with `conversation.item.delete`.
+The browser retains eight camera items and deletes the oldest before adding a
+ninth. Camera-off stops capture but leaves those items in the conversation.
+
+This deployment accepts JPEG/PNG Base64 data URLs with a total image-context
+budget of eight images and 4 MiB; external image URLs are not supported. Clients
+must delete old image items when reaching the limit. There is no precise
+video/audio timestamp alignment or native streaming-video KV update.
+
+### Protocol compatibility boundary
+
+Qwen VAD uses `session.update`, 24 kHz PCM16 `input_audio_buffer.append`,
+`conversation.item.create` with `input_image`/`input_text`, and `response.create`.
+The engine resamples input to Qwen's 16 kHz processing rate. Qwen rejects the
+custom `video_frames` field on an append: it answers whole turns, so it has no
+audio unit for a frame track to align to. MiniCPM keeps that field for its
+native camera protocol, where Stage 0 interleaves frames at unit boundaries.
+
+This is a supported subset, not full OpenAI Realtime API compatibility.
+`duplex=1`, `overlap_policy`, `playback.ack`, and `session.close` remain vLLM-Omni
+extensions. The legacy `--stt` mode is unchanged and is not the standard Realtime
+conversation API. This demo does not add WebRTC, semantic VAD, or tool calling.
+
+## Shared host options
+
+The shared entry point can select either profile explicitly:
+
+```bash
+python -m examples.online_serving.realtime_web --profile qwen3-turn \
+ --backend ws://127.0.0.1:8091 --stt --port 7863
+```
+
+- `--backend` / `--ws-backend`: backend WebSocket origin (not the full `/v1/realtime` URL).
+- `--model`: override the wrapper's model name.
+- `--public-realtime-url`: optional browser-visible WebSocket URL; otherwise the
+ static host proxies `/v1/realtime` on the same origin.
+- `--host`, `--port`: UI bind address and port (default port 7862).
+- `--ref-audio`: required for MiniCPM; rejected for Qwen3.
+
+Microphone and camera access require `localhost` or HTTPS. For a remote backend,
+use an SSH tunnel to the UI host or an HTTPS reverse proxy with WebSocket support.
+An explicit `wss://` public URL retains its scheme.
+
+## Validation
+
+```bash
+node --test tests/examples/test_realtime_web_profiles.cjs
+pytest tests/examples/test_minicpmo_realtime_web_server.py \
+ tests/examples/test_minicpmo_realtime_web_static.py \
+ tests/examples/test_realtime_web_profiles.py
+pytest -m cpu tests/model_executor/models/qwen3_omni/test_duplex_plugin.py \
+ tests/engine/duplex/test_session_runner.py \
+ tests/engine/test_duplex_orchestrator.py
+```
+
+These CPU tests cover profile messages, two STT turns, VAD terminal/drain ordering,
+backpressure, native capture during playback, server config injection, and shared
+worklets. Backend regressions cover current audio inclusion in history-based
+prompts, delayed playback ACK ordering, and no extra generation during silence
+after a completed VAD turn. Hardware acceptance still requires a MiniCPM call
+with camera/barge-in and two Qwen turns against each enabled backend, including
+speech interruption in VAD mode; simulated tests do not
+establish model quality or hardware latency.
diff --git a/examples/online_serving/realtime_web/__init__.py b/examples/online_serving/realtime_web/__init__.py
new file mode 100644
index 000000000..9e82f8967
--- /dev/null
+++ b/examples/online_serving/realtime_web/__init__.py
@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
+
+"""Shared browser audio UI and model-specific realtime profiles."""
diff --git a/examples/online_serving/realtime_web/__main__.py b/examples/online_serving/realtime_web/__main__.py
new file mode 100644
index 000000000..618f3c542
--- /dev/null
+++ b/examples/online_serving/realtime_web/__main__.py
@@ -0,0 +1,7 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright contributors to the vLLM-Omni project
+
+from .server import main
+
+if __name__ == "__main__":
+ main()
diff --git a/examples/online_serving/minicpmo/realtime_web/app/index.html b/examples/online_serving/realtime_web/app/index.html
similarity index 76%
rename from examples/online_serving/minicpmo/realtime_web/app/index.html
rename to examples/online_serving/realtime_web/app/index.html
index 46ab15907..a38a731e4 100644
--- a/examples/online_serving/minicpmo/realtime_web/app/index.html
+++ b/examples/online_serving/realtime_web/app/index.html
@@ -4,37 +4,35 @@
- MiniCPM-o 4.5 Voice
+ Omni Realtime Voice