diff --git a/docs/.nav.yml b/docs/.nav.yml index 74c2425c9..516c9d712 100644 --- a/docs/.nav.yml +++ b/docs/.nav.yml @@ -13,8 +13,10 @@ nav: - Text-To-Image: user_guide/examples/offline_inference/text_to_image.md - Text-To-Video: user_guide/examples/offline_inference/text_to_video.md - Online Serving: + - Image-To-Image: user_guide/examples/online_serving/image_to_image.md - Qwen2.5-Omni: user_guide/examples/online_serving/qwen2_5_omni.md - Qwen3-Omni: user_guide/examples/online_serving/qwen3_omni.md + - Text-To-Image: user_guide/examples/online_serving/text_to_image.md - General: - usage/* - Configuration: diff --git a/docs/api/README.md b/docs/api/README.md index 914d0b67d..7c637be4b 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -4,6 +4,7 @@ Main entry points for vLLM-Omni inference and serving. +- [vllm_omni.entrypoints.async_diffusion.AsyncOmniDiffusion][] - [vllm_omni.entrypoints.async_omni.AsyncOmni][] - [vllm_omni.entrypoints.async_omni.AsyncOmniStageLLM][] - [vllm_omni.entrypoints.chat_utils.OmniAsyncMultiModalContentParser][] diff --git a/docs/contributing/tests/tests_style.md b/docs/contributing/tests/tests_style.md index 7f065c1af..976d6b869 100644 --- a/docs/contributing/tests/tests_style.md +++ b/docs/contributing/tests/tests_style.md @@ -1,4 +1,4 @@ -# vLLM-Omni Test File Structure and Style Guide +# Test File Structure and Style Guide To ensure project maintainability and sustainable development, we encourage contributors to submit test code (unit tests, system tests, or end-to-end tests) alongside their code changes. This document outlines the guidelines for organizing and naming test files. @@ -261,8 +261,8 @@ def test_video_to_audio(omni_runner: type[OmniRunner], model: str) -> None: assert has_audio ``` -## Checklist before submit your test files: +## Checklist before submitting your test files -1. The file is saved in a suitable places and the file name is clear. -2. The coding style matches the requirements. -3. For e2e omni model tests, specify the +1. The file is saved in an appropriate place and the file name is clear. +2. The coding style follows the requirements outlined above. +3. For e2e model test, please ensure the test is configured under the `./buildkite/` folder. diff --git a/docs/user_guide/examples/online_serving/image_to_image.md b/docs/user_guide/examples/online_serving/image_to_image.md index 096488b92..3ab1497ff 100644 --- a/docs/user_guide/examples/online_serving/image_to_image.md +++ b/docs/user_guide/examples/online_serving/image_to_image.md @@ -1,6 +1,6 @@ -# Qwen-Image-Edit Online Serving +# Image-To-Image -Source . +Source . This example demonstrates how to deploy Qwen-Image-Edit model for online image editing service using vLLM-Omni. @@ -15,6 +15,7 @@ vllm serve Qwen/Qwen-Image-Edit --omni --port 8092 ### Start with Parameters + Or use the startup script: ```bash @@ -125,13 +126,16 @@ Use `extra_body` to pass generation parameters: ## Generation Parameters (extra_body) -| Parameter | Type | Default | Description | -|-----------|------|---------|-------------| -| `num_inference_steps` | int | 50 | Number of denoising steps | -| `guidance_scale` | float | 7.5 | CFG guidance scale | -| `seed` | int | None | Random seed (reproducible) | -| `negative_prompt` | str | None | Negative prompt | -| `num_outputs_per_prompt` | int | 1 | Number of images to generate | +| Parameter | Type | Default | Description | +| ------------------------ | ----- | ------- | ------------------------------------- | +| `height` | int | None | Output image height in pixels | +| `width` | int | None | Output image width in pixels | +| `size` | str | None | Output image size (e.g., "1024x1024") | +| `num_inference_steps` | int | 50 | Number of denoising steps | +| `guidance_scale` | float | 7.5 | CFG guidance scale | +| `seed` | int | None | Random seed (reproducible) | +| `negative_prompt` | str | None | Negative prompt | +| `num_outputs_per_prompt` | int | 1 | Number of images to generate | ## Response Format @@ -159,39 +163,35 @@ Use `extra_body` to pass generation parameters: ## Common Editing Instructions Examples -| Instruction | Description | -|-------------|-------------| -| `Convert this image to watercolor style` | Style transfer | -| `Convert the image to black and white` | Desaturation | -| `Enhance the color saturation` | Color adjustment | -| `Convert to cartoon style` | Cartoonization | -| `Add vintage filter effect` | Filter effect | -| `Convert daytime scene to nighttime` | Scene conversion | +| Instruction | Description | +| ---------------------------------------- | ---------------- | +| `Convert this image to watercolor style` | Style transfer | +| `Convert the image to black and white` | Desaturation | +| `Enhance the color saturation` | Color adjustment | +| `Convert to cartoon style` | Cartoonization | +| `Add vintage filter effect` | Filter effect | +| `Convert daytime scene to nighttime` | Scene conversion | ## File Description -| File | Description | -|------|-------------| -| `run_server.sh` | Server startup script | -| `run_curl_image_edit.sh` | curl image editing example | -| `openai_chat_client.py` | Python client | -| `gradio_demo.py` | Gradio interactive interface | +| File | Description | +| ------------------------ | ---------------------------- | +| `run_server.sh` | Server startup script | +| `run_curl_image_edit.sh` | curl image editing example | +| `openai_chat_client.py` | Python client | +| `gradio_demo.py` | Gradio interactive interface | ## Example materials ??? abstract "gradio_demo.py" ``````py - --8<-- "examples/online_serving/qwen_image_edit/gradio_demo.py" + --8<-- "examples/online_serving/image_to_image/gradio_demo.py" `````` ??? abstract "openai_chat_client.py" ``````py - --8<-- "examples/online_serving/qwen_image_edit/openai_chat_client.py" - `````` -??? abstract "run_curl_image_edit.sh" - ``````sh - --8<-- "examples/online_serving/qwen_image_edit/run_curl_image_edit.sh" + --8<-- "examples/online_serving/image_to_image/openai_chat_client.py" `````` ??? abstract "run_server.sh" ``````sh - --8<-- "examples/online_serving/qwen_image_edit/run_server.sh" + --8<-- "examples/online_serving/image_to_image/run_server.sh" `````` diff --git a/docs/user_guide/examples/online_serving/text_to_image.md b/docs/user_guide/examples/online_serving/text_to_image.md index 12d4de636..adc9c5c30 100644 --- a/docs/user_guide/examples/online_serving/text_to_image.md +++ b/docs/user_guide/examples/online_serving/text_to_image.md @@ -1,6 +1,6 @@ -# Qwen-Image/Z-Image Online Serving +# Text-To-Image -Source . +Source . This example demonstrates how to deploy Qwen-Image model for online image generation service using vLLM-Omni. @@ -15,7 +15,6 @@ vllm serve Qwen/Qwen-Image --omni --port 8091 ### Start with Parameters - Or use the startup script: ```bash @@ -62,7 +61,7 @@ python gradio_demo.py ## Request Format -### Simple Text-to-Image Generation +### Simple Text Generation ```json { @@ -108,15 +107,16 @@ Use `extra_body` to pass generation parameters: ## Generation Parameters (extra_body) -| Parameter | Type | Default | Description | -|-----------|------|---------|-------------| -| `height` | int | None | Image height in pixels | -| `width` | int | None | Image width in pixels | -| `num_inference_steps` | int | 50 | Number of denoising steps | -| `true_cfg_scale` | float | 4.0 | Qwen-Image CFG scale | -| `seed` | int | None | Random seed (reproducible) | -| `negative_prompt` | str | None | Negative prompt | -| `num_outputs_per_prompt` | int | 1 | Number of images to generate | +| Parameter | Type | Default | Description | +| ------------------------ | ----- | ------- | ------------------------------ | +| `height` | int | None | Image height in pixels | +| `width` | int | None | Image width in pixels | +| `size` | str | None | Image size (e.g., "1024x1024") | +| `num_inference_steps` | int | 50 | Number of denoising steps | +| `true_cfg_scale` | float | 4.0 | Qwen-Image CFG scale | +| `seed` | int | None | Random seed (reproducible) | +| `negative_prompt` | str | None | Negative prompt | +| `num_outputs_per_prompt` | int | 1 | Number of images to generate | ## Response Format @@ -151,28 +151,28 @@ cat response.json | jq -r '.choices[0].message.content[0].image_url.url' | cut - ## File Description -| File | Description | -|------|-------------| -| `run_server.sh` | Server startup script | -| `run_curl_text_to_image.sh` | curl example | -| `openai_chat_client.py` | Python client | -| `gradio_demo.py` | Gradio interactive interface | +| File | Description | +| --------------------------- | ---------------------------- | +| `run_server.sh` | Server startup script | +| `run_curl_text_to_image.sh` | curl example | +| `openai_chat_client.py` | Python client | +| `gradio_demo.py` | Gradio interactive interface | ## Example materials ??? abstract "gradio_demo.py" ``````py - --8<-- "examples/online_serving/qwen_image/gradio_demo.py" + --8<-- "examples/online_serving/text_to_image/gradio_demo.py" `````` ??? abstract "openai_chat_client.py" ``````py - --8<-- "examples/online_serving/qwen_image/openai_chat_client.py" + --8<-- "examples/online_serving/text_to_image/openai_chat_client.py" `````` ??? abstract "run_curl_text_to_image.sh" ``````sh - --8<-- "examples/online_serving/qwen_image/run_curl_text_to_image.sh" + --8<-- "examples/online_serving/text_to_image/run_curl_text_to_image.sh" `````` ??? abstract "run_server.sh" ``````sh - --8<-- "examples/online_serving/qwen_image/run_server.sh" + --8<-- "examples/online_serving/text_to_image/run_server.sh" `````` diff --git a/examples/online_serving/image_to_image/README.md b/examples/online_serving/image_to_image/README.md index d9c3f11ff..53f0faa30 100644 --- a/examples/online_serving/image_to_image/README.md +++ b/examples/online_serving/image_to_image/README.md @@ -1,4 +1,4 @@ -# Qwen-Image-Edit Online Serving +# Image-To-Image This example demonstrates how to deploy Qwen-Image-Edit model for online image editing service using vLLM-Omni. @@ -123,16 +123,16 @@ Use `extra_body` to pass generation parameters: ## Generation Parameters (extra_body) -| Parameter | Type | Default | Description | -|-----------|------|---------|-------------| -| `height` | int | None | Output image height in pixels | -| `width` | int | None | Output image width in pixels | -| `size` | str | None | Output image size (e.g., "1024x1024") | -| `num_inference_steps` | int | 50 | Number of denoising steps | -| `guidance_scale` | float | 7.5 | CFG guidance scale | -| `seed` | int | None | Random seed (reproducible) | -| `negative_prompt` | str | None | Negative prompt | -| `num_outputs_per_prompt` | int | 1 | Number of images to generate | +| Parameter | Type | Default | Description | +| ------------------------ | ----- | ------- | ------------------------------------- | +| `height` | int | None | Output image height in pixels | +| `width` | int | None | Output image width in pixels | +| `size` | str | None | Output image size (e.g., "1024x1024") | +| `num_inference_steps` | int | 50 | Number of denoising steps | +| `guidance_scale` | float | 7.5 | CFG guidance scale | +| `seed` | int | None | Random seed (reproducible) | +| `negative_prompt` | str | None | Negative prompt | +| `num_outputs_per_prompt` | int | 1 | Number of images to generate | ## Response Format @@ -160,20 +160,20 @@ Use `extra_body` to pass generation parameters: ## Common Editing Instructions Examples -| Instruction | Description | -|-------------|-------------| -| `Convert this image to watercolor style` | Style transfer | -| `Convert the image to black and white` | Desaturation | -| `Enhance the color saturation` | Color adjustment | -| `Convert to cartoon style` | Cartoonization | -| `Add vintage filter effect` | Filter effect | -| `Convert daytime scene to nighttime` | Scene conversion | +| Instruction | Description | +| ---------------------------------------- | ---------------- | +| `Convert this image to watercolor style` | Style transfer | +| `Convert the image to black and white` | Desaturation | +| `Enhance the color saturation` | Color adjustment | +| `Convert to cartoon style` | Cartoonization | +| `Add vintage filter effect` | Filter effect | +| `Convert daytime scene to nighttime` | Scene conversion | ## File Description -| File | Description | -|------|-------------| -| `run_server.sh` | Server startup script | -| `run_curl_image_edit.sh` | curl image editing example | -| `openai_chat_client.py` | Python client | -| `gradio_demo.py` | Gradio interactive interface | +| File | Description | +| ------------------------ | ---------------------------- | +| `run_server.sh` | Server startup script | +| `run_curl_image_edit.sh` | curl image editing example | +| `openai_chat_client.py` | Python client | +| `gradio_demo.py` | Gradio interactive interface | diff --git a/examples/online_serving/text_to_image/README.md b/examples/online_serving/text_to_image/README.md index 60494b443..6f835e66e 100644 --- a/examples/online_serving/text_to_image/README.md +++ b/examples/online_serving/text_to_image/README.md @@ -1,4 +1,4 @@ -# Qwen-Image Online Serving +# Text-To-Image This example demonstrates how to deploy Qwen-Image model for online image generation service using vLLM-Omni. @@ -104,16 +104,16 @@ Use `extra_body` to pass generation parameters: ## Generation Parameters (extra_body) -| Parameter | Type | Default | Description | -|-----------|------|---------|-------------| -| `height` | int | None | Image height in pixels | -| `width` | int | None | Image width in pixels | -| `size` | str | None | Image size (e.g., "1024x1024") | -| `num_inference_steps` | int | 50 | Number of denoising steps | -| `true_cfg_scale` | float | 4.0 | Qwen-Image CFG scale | -| `seed` | int | None | Random seed (reproducible) | -| `negative_prompt` | str | None | Negative prompt | -| `num_outputs_per_prompt` | int | 1 | Number of images to generate | +| Parameter | Type | Default | Description | +| ------------------------ | ----- | ------- | ------------------------------ | +| `height` | int | None | Image height in pixels | +| `width` | int | None | Image width in pixels | +| `size` | str | None | Image size (e.g., "1024x1024") | +| `num_inference_steps` | int | 50 | Number of denoising steps | +| `true_cfg_scale` | float | 4.0 | Qwen-Image CFG scale | +| `seed` | int | None | Random seed (reproducible) | +| `negative_prompt` | str | None | Negative prompt | +| `num_outputs_per_prompt` | int | 1 | Number of images to generate | ## Response Format @@ -148,9 +148,9 @@ cat response.json | jq -r '.choices[0].message.content[0].image_url.url' | cut - ## File Description -| File | Description | -|------|-------------| -| `run_server.sh` | Server startup script | -| `run_curl_text_to_image.sh` | curl example | -| `openai_chat_client.py` | Python client | -| `gradio_demo.py` | Gradio interactive interface | +| File | Description | +| --------------------------- | ---------------------------- | +| `run_server.sh` | Server startup script | +| `run_curl_text_to_image.sh` | curl example | +| `openai_chat_client.py` | Python client | +| `gradio_demo.py` | Gradio interactive interface |