From 5b90ddf099cdfbbace99a4c0ff11ad1876b9b7b4 Mon Sep 17 00:00:00 2001 From: Hongsheng Liu Date: Wed, 31 Dec 2025 12:07:23 +0800 Subject: [PATCH] update qwen-omni docs (#559) Signed-off-by: hsliu --- docs/contributing/tests/tests_style.md | 6 ++--- .../online_serving/qwen2_5_omni/README.md | 24 ++++--------------- examples/online_serving/qwen3_omni/README.md | 24 ++++--------------- 3 files changed, 12 insertions(+), 42 deletions(-) diff --git a/docs/contributing/tests/tests_style.md b/docs/contributing/tests/tests_style.md index 976d6b869..308d05bfe 100644 --- a/docs/contributing/tests/tests_style.md +++ b/docs/contributing/tests/tests_style.md @@ -113,11 +113,9 @@ vllm_omni/ tests/ ### Naming Conventions -- **Unit/System Tests**: Use `test_.py` format - - Example: `omni_llm.py` → `test_omni_llm.py` +- **Unit/System Tests**: Use `test_.py` format. Example: `omni_llm.py` → `test_omni_llm.py` -- **E2E Tests**: Place in `tests/e2e/offline_inference/` or `tests/e2e/online_serving/` with descriptive names - - Example: `tests/e2e/offline_inference/test_qwen3_omni.py`, `tests/e2e/offline_inference/test_diffusion_model.py` +- **E2E Tests**: Place in `tests/e2e/offline_inference/` or `tests/e2e/online_serving/` with descriptive names. Example: `tests/e2e/offline_inference/test_qwen3_omni.py`, `tests/e2e/offline_inference/test_diffusion_model.py` ### Best Practices diff --git a/examples/online_serving/qwen2_5_omni/README.md b/examples/online_serving/qwen2_5_omni/README.md index ebaf6a2ca..56e7b5b36 100644 --- a/examples/online_serving/qwen2_5_omni/README.md +++ b/examples/online_serving/qwen2_5_omni/README.md @@ -32,25 +32,11 @@ python openai_chat_completion_client_for_multimodal_generation.py --query-type m The Python client supports the following command-line arguments: -- `--query-type` (or `-q`): Query type (default: `mixed_modalities`) - - Options: `mixed_modalities`, `use_audio_in_video`, `multi_audios`, `text` -- `--video-path` (or `-v`): Path to local video file or URL - - If not provided and query-type uses video, uses default video URL - - Supports local file paths (automatically encoded to base64) or HTTP/HTTPS URLs - - Example: `--video-path /path/to/video.mp4` or `--video-path https://example.com/video.mp4` -- `--image-path` (or `-i`): Path to local image file or URL - - If not provided and query-type uses image, uses default image URL - - Supports local file paths (automatically encoded to base64) or HTTP/HTTPS URLs - - Supports common image formats: JPEG, PNG, GIF, WebP - - Example: `--image-path /path/to/image.jpg` or `--image-path https://example.com/image.png` -- `--audio-path` (or `-a`): Path to local audio file or URL - - If not provided and query-type uses audio, uses default audio URL - - Supports local file paths (automatically encoded to base64) or HTTP/HTTPS URLs - - Supports 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?"` +- `--query-type` (or `-q`): Query type (default: `mixed_modalities`). Options: `mixed_modalities`, `use_audio_in_video`, `multi_audios`, `text` +- `--video-path` (or `-v`): Path to local video file or URL. If not provided and query-type uses video, uses default video URL. Supports local file paths (automatically encoded to base64) or HTTP/HTTPS URLs. Example: `--video-path /path/to/video.mp4` or `--video-path https://example.com/video.mp4` +- `--image-path` (or `-i`): Path to local image file or URL. If not provided and query-type uses image, uses default image URL. Supports local file paths (automatically encoded to base64) or HTTP/HTTPS URLs and common image formats: JPEG, PNG, GIF, WebP. Example: `--image-path /path/to/image.jpg` or `--image-path https://example.com/image.png` +- `--audio-path` (or `-a`): Path to local audio file or URL. If not provided and query-type uses 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 mixed modalities with all local files: diff --git a/examples/online_serving/qwen3_omni/README.md b/examples/online_serving/qwen3_omni/README.md index 41e954264..aa141a505 100644 --- a/examples/online_serving/qwen3_omni/README.md +++ b/examples/online_serving/qwen3_omni/README.md @@ -32,26 +32,12 @@ python openai_chat_completion_client_for_multimodal_generation.py --query-type u The Python client supports the following command-line arguments: -- `--query-type` (or `-q`): Query type (default: `use_video`) - - Options: `text`, `use_audio`, `use_image`, `use_video` +- `--query-type` (or `-q`): Query type (default: `use_video`). Options: `text`, `use_audio`, `use_image`, `use_video` - `--model` (or `-m`): Model name/path (default: `Qwen/Qwen3-Omni-30B-A3B-Instruct`) -- `--video-path` (or `-v`): Path to local video file or URL - - If not provided and query-type is `use_video`, uses default video URL - - Supports local file paths (automatically encoded to base64) or HTTP/HTTPS URLs - - Example: `--video-path /path/to/video.mp4` or `--video-path https://example.com/video.mp4` -- `--image-path` (or `-i`): Path to local image file or URL - - If not provided and query-type is `use_image`, uses default image URL - - Supports local file paths (automatically encoded to base64) or HTTP/HTTPS URLs - - Supports common image formats: JPEG, PNG, GIF, WebP - - Example: `--image-path /path/to/image.jpg` or `--image-path https://example.com/image.png` -- `--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 - - Supports 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?"` +- `--video-path` (or `-v`): Path to local video file or URL. If not provided and query-type is `use_video`, uses default video URL. Supports local file paths (automatically encoded to base64) or HTTP/HTTPS URLs. Example: `--video-path /path/to/video.mp4` or `--video-path https://example.com/video.mp4` +- `--image-path` (or `-i`): Path to local image file or URL. If not provided and query-type is `use_image`, uses default image URL. Supports local file paths (automatically encoded to base64) or HTTP/HTTPS URLs and common image formats: JPEG, PNG, GIF, WebP. Example: `--image-path /path/to/image.jpg` or `--image-path https://example.com/image.png` +- `--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: