From 3c2661da16761a159c715192d2e3e5f304f6205f Mon Sep 17 00:00:00 2001 From: SYLAR <125541396+lishunyang12@users.noreply.github.com> Date: Sun, 4 Jan 2026 16:01:05 +0800 Subject: [PATCH] [Doc] Updated user guide for omni examples to avoid any inconvenience (#581) Signed-off-by: lishunyang --- .../examples/offline_inference/qwen2_5_omni.md | 13 +++---------- .../examples/offline_inference/qwen3_omni.md | 5 +++-- examples/offline_inference/qwen2_5_omni/README.md | 14 ++++---------- examples/offline_inference/qwen3_omni/README.md | 6 ++++-- 4 files changed, 14 insertions(+), 24 deletions(-) diff --git a/docs/user_guide/examples/offline_inference/qwen2_5_omni.md b/docs/user_guide/examples/offline_inference/qwen2_5_omni.md index 7a12e0e14..f2387761d 100644 --- a/docs/user_guide/examples/offline_inference/qwen2_5_omni.md +++ b/docs/user_guide/examples/offline_inference/qwen2_5_omni.md @@ -2,19 +2,12 @@ Source . +## Setup +Please refer to the [stage configuration documentation](https://docs.vllm.ai/projects/vllm-omni/en/latest/configuration/stage_configs/) to configure memory allocation appropriately for your hardware setup. -## Run examples (Qwen2.5-Omni) +## Run examples ### Multiple Prompts -Download dataset from [seed_tts](https://drive.google.com/file/d/1GlSjVfSHkW3-leKKBlfrjuuTGqQ_xaLP/edit). To get the prompt, you can: -```bash -tar -xf /seedtts_testset.tar -cp seedtts_testset/en/meta.lst examples/offline_inference/qwen2_5_omni/meta.lst -python3 examples/offline_inference/qwen2_5_omni/extract_prompts.py \ - --input examples/offline_inference/qwen2_5_omni/meta.lst \ - --output examples/offline_inference/qwen2_5_omni/top100.txt \ - --topk 100 -``` Get into the example folder ```bash cd examples/offline_inference/qwen2_5_omni diff --git a/docs/user_guide/examples/offline_inference/qwen3_omni.md b/docs/user_guide/examples/offline_inference/qwen3_omni.md index a3abf89a5..8a5d8687a 100644 --- a/docs/user_guide/examples/offline_inference/qwen3_omni.md +++ b/docs/user_guide/examples/offline_inference/qwen3_omni.md @@ -2,11 +2,12 @@ Source . +## Setup +Please refer to the [stage configuration documentation](https://docs.vllm.ai/projects/vllm-omni/en/latest/configuration/stage_configs/) to configure memory allocation appropriately for your hardware setup. -## Run examples (Qwen3-Omni) +## Run examples ### Multiple Prompts -Download dataset from [seed_tts](https://drive.google.com/file/d/1GlSjVfSHkW3-leKKBlfrjuuTGqQ_xaLP/edit). For processing dataset please refer to [Qwen2.5-Omni README.md](https://github.com/vllm-project/vllm-omni/tree/main/examples/offline_inference/qwen2_5_omni/README.md) Get into the example folder ```bash cd examples/offline_inference/qwen3_omni diff --git a/examples/offline_inference/qwen2_5_omni/README.md b/examples/offline_inference/qwen2_5_omni/README.md index aede5db51..f0a8169a1 100644 --- a/examples/offline_inference/qwen2_5_omni/README.md +++ b/examples/offline_inference/qwen2_5_omni/README.md @@ -1,17 +1,11 @@ # Qwen2.5-Omni -## Run examples (Qwen2.5-Omni) +## Setup +Please refer to the [stage configuration documentation](https://docs.vllm.ai/projects/vllm-omni/en/latest/configuration/stage_configs/) to configure memory allocation appropriately for your hardware setup. + +## Run examples ### Multiple Prompts -Download dataset from [seed_tts](https://drive.google.com/file/d/1GlSjVfSHkW3-leKKBlfrjuuTGqQ_xaLP/edit). To get the prompt, you can: -```bash -tar -xf /seedtts_testset.tar -cp seedtts_testset/en/meta.lst examples/offline_inference/qwen2_5_omni/meta.lst -python3 examples/offline_inference/qwen2_5_omni/extract_prompts.py \ - --input examples/offline_inference/qwen2_5_omni/meta.lst \ - --output examples/offline_inference/qwen2_5_omni/top100.txt \ - --topk 100 -``` Get into the example folder ```bash cd examples/offline_inference/qwen2_5_omni diff --git a/examples/offline_inference/qwen3_omni/README.md b/examples/offline_inference/qwen3_omni/README.md index f9859039a..6014fd707 100644 --- a/examples/offline_inference/qwen3_omni/README.md +++ b/examples/offline_inference/qwen3_omni/README.md @@ -1,9 +1,11 @@ # Qwen3-Omni -## Run examples (Qwen3-Omni) +## Setup +Please refer to the [stage configuration documentation](https://docs.vllm.ai/projects/vllm-omni/en/latest/configuration/stage_configs/) to configure memory allocation appropriately for your hardware setup. + +## Run examples ### Multiple Prompts -Download dataset from [seed_tts](https://drive.google.com/file/d/1GlSjVfSHkW3-leKKBlfrjuuTGqQ_xaLP/edit). For processing dataset please refer to [Qwen2.5-Omni README.md](../qwen2_5_omni/README.md) Get into the example folder ```bash cd examples/offline_inference/qwen3_omni