From 4ac3e6e7d0cad56baa8a764727f20e0cbd699db9 Mon Sep 17 00:00:00 2001 From: Samit <285365963@qq.com> Date: Mon, 8 Dec 2025 16:00:25 +0800 Subject: [PATCH] [Docs] Add basic usage examples for diffusion (#222) Signed-off-by: samithuang <285365963@qq.com> Signed-off-by: Samit <285365963@qq.com> Co-authored-by: Hongsheng Liu --- docs/getting_started/quickstart.md | 14 +++++++++++++- examples/offline_inference/qwen_image/README.md | 15 +++++++++++++-- .../offline_inference/qwen_image/gradio_demo.py | 1 - .../offline_inference/qwen_image/text_to_image.py | 1 - 4 files changed, 26 insertions(+), 5 deletions(-) diff --git a/docs/getting_started/quickstart.md b/docs/getting_started/quickstart.md index d2fd88961..e18da6726 100644 --- a/docs/getting_started/quickstart.md +++ b/docs/getting_started/quickstart.md @@ -16,7 +16,19 @@ Please refer to [installation](installation/README.md) ## Offline Inference -Please refer to [offline inference](../user_guide/examples/offline_inference/qwen2_5_omni.md) +Text-to-image generation quickstart with vLLM-Omni: + +```python +from vllm_omni.entrypoints.omni import Omni + +if __name__ == "__main__": + omni = Omni(model="Tongyi-MAI/Z-Image-Turbo") + prompt = "a cup of coffee on the table" + images = omni.generate(prompt) + images[0].save("coffee.png") +``` + +For more usages, please refer to [offline inference](../user_guide/examples/offline_inference/qwen2_5_omni.md) ## Online Serving with OpenAI-Completions API diff --git a/examples/offline_inference/qwen_image/README.md b/examples/offline_inference/qwen_image/README.md index 85d364568..078d9fda3 100644 --- a/examples/offline_inference/qwen_image/README.md +++ b/examples/offline_inference/qwen_image/README.md @@ -1,10 +1,21 @@ # Qwen-Image Offline Inference -This folder provides two simple entrypoints for experimenting with `Qwen/Qwen-Image` using vLLM-Omni: +This folder provides several entrypoints for experimenting with `Qwen/Qwen-Image` using vLLM-Omni: -- `text_to_image.py`: command-line script for single image generation. +- `text_to_image.py`: command-line script for single image generation with advanced options. - `web_demo.py`: lightweight Gradio UI for interactive prompt/seed/CFG exploration. +## Basic Usage + +```python +from vllm_omni.entrypoints.omni import Omni + +if __name__ == "__main__": + omni = Omni(model="Qwen/Qwen-Image") + prompt = "a cup of coffee on the table" + images = omni.generate(prompt) + images[0].save("coffee.png") +``` ## Local CLI Usage diff --git a/examples/offline_inference/qwen_image/gradio_demo.py b/examples/offline_inference/qwen_image/gradio_demo.py index f7196a4fd..42659e058 100644 --- a/examples/offline_inference/qwen_image/gradio_demo.py +++ b/examples/offline_inference/qwen_image/gradio_demo.py @@ -105,7 +105,6 @@ def build_demo(args: argparse.Namespace) -> gr.Blocks: generator=generator, true_cfg_scale=float(cfg_scale_value), num_inference_steps=num_steps, - num_images_per_prompt=num_images, num_outputs_per_prompt=num_images, ) return [img for img in images[:num_images]] diff --git a/examples/offline_inference/qwen_image/text_to_image.py b/examples/offline_inference/qwen_image/text_to_image.py index 6261d8067..966679215 100644 --- a/examples/offline_inference/qwen_image/text_to_image.py +++ b/examples/offline_inference/qwen_image/text_to_image.py @@ -65,7 +65,6 @@ def main(): generator=generator, true_cfg_scale=args.cfg_scale, num_inference_steps=args.num_inference_steps, - num_images_per_prompt=args.num_images_per_prompt, num_outputs_per_prompt=args.num_images_per_prompt, )