From cfc356f01d1d7cda5f69b52cda0fafe40bbb8cb2 Mon Sep 17 00:00:00 2001 From: Alicia <115451386+congw729@users.noreply.github.com> Date: Wed, 24 Dec 2025 12:51:19 +0800 Subject: [PATCH] [Docs] Update installation method. (#448) Signed-off-by: Alicia <115451386+congw729@users.noreply.github.com> --- docs/api/README.md | 2 -- docs/getting_started/installation/gpu/cuda.inc.md | 2 ++ docs/getting_started/quickstart.md | 9 ++++++--- .../examples/offline_inference/image_to_image.md | 14 +++++++++++++- 4 files changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/api/README.md b/docs/api/README.md index 4100cc2cd..0332dceff 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -4,7 +4,6 @@ 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][] @@ -18,7 +17,6 @@ Main entry points for vLLM-Omni inference and serving. - [vllm_omni.entrypoints.omni_llm.OmniLLM][] - [vllm_omni.entrypoints.omni_llm.OmniStageLLM][] - [vllm_omni.entrypoints.omni_stage.OmniStage][] -- [vllm_omni.entrypoints.openai.serving_chat.OmniOpenAIServingChat][] ## Inputs diff --git a/docs/getting_started/installation/gpu/cuda.inc.md b/docs/getting_started/installation/gpu/cuda.inc.md index c88302939..a15ed2d1d 100644 --- a/docs/getting_started/installation/gpu/cuda.inc.md +++ b/docs/getting_started/installation/gpu/cuda.inc.md @@ -17,6 +17,8 @@ Therefore, it is recommended to install vLLM and vLLM-Omni with a **fresh new** # --8<-- [start:pre-built-wheels] #### Installation of vLLM +Note: Pre-built wheels are currently only available for vLLM-Omni 0.11.0rc1. For the latest version, please [build from source](https://docs.vllm.ai/projects/vllm-omni/en/latest/getting_started/installation/gpu/#build-wheel-from-source). + vLLM-Omni is built based on vLLM. Please install it with command below. ```bash diff --git a/docs/getting_started/quickstart.md b/docs/getting_started/quickstart.md index 7fe8954c9..996124f3b 100644 --- a/docs/getting_started/quickstart.md +++ b/docs/getting_started/quickstart.md @@ -12,14 +12,17 @@ This guide will help you quickly get started with vLLM-Omni to perform: ## Installation -For installation on GPU using pre-built-wheel: +For installation on GPU from source: ```bash uv venv --python 3.12 --seed source .venv/bin/activate -uv pip install vllm==0.11.0 --torch-backend=auto -uv pip install vllm-omni +uv pip install vllm==0.12.0 --torch-backend=auto +git clone https://github.com/vllm-project/vllm-omni.git +cd vllm-omni +uv pip install -e . ``` + For additional details—including alternative installation methods, installation on NPU and other platforms — please see the installation guide in [installation](installation/README.md) ## Offline Inference diff --git a/docs/user_guide/examples/offline_inference/image_to_image.md b/docs/user_guide/examples/offline_inference/image_to_image.md index 8c03c6323..ab44de854 100644 --- a/docs/user_guide/examples/offline_inference/image_to_image.md +++ b/docs/user_guide/examples/offline_inference/image_to_image.md @@ -9,6 +9,14 @@ This example edits an input image with `Qwen/Qwen-Image-Edit` using the `image_e ### Single Image Editing +Download the example image: + +```bash +wget https://vllm-public-assets.s3.us-west-2.amazonaws.com/omni-assets/qwen-bear.png +``` + +Then run: + ```bash python image_edit.py \ --image qwen_bear.png \ @@ -20,7 +28,7 @@ python image_edit.py \ ### Multiple Image Editing (Qwen-Image-Edit-2509) -For multiple image inputs, use `Qwen/Qwen-Image-Edit-2509` or later version: +For multiple image inputs, use `Qwen/Qwen-Image-Edit-2509` or `Qwen/Qwen-Image-Edit-2511`: ```bash python image_edit.py \ @@ -49,3 +57,7 @@ Key arguments: ``````py --8<-- "examples/offline_inference/image_to_image/image_edit.py" `````` +??? abstract "run_qwen_image_edit_2511.sh" + ``````sh + --8<-- "examples/offline_inference/image_to_image/run_qwen_image_edit_2511.sh" + ``````