快速入门

本指南将帮助您快速开始使用 vLLM 来执行

离线批量推理
使用 OpenAI 兼容服务器进行在线服务

先决条件¶

操作系统: Linux
Python: 3.9 -- 3.12

安装¶

如果您使用 NVIDIA GPU，可以直接使用 pip 安装 vLLM。

建议使用 uv，一个非常快速的 Python 环境管理器，来创建和管理 Python 环境。请遵循文档来安装 uv。安装 uv 后，您可以使用以下命令创建新的 Python 环境并安装 vLLM

uv venv --python 3.12 --seed
source .venv/bin/activate
uv pip install vllm --torch-backend=auto

uv 可以通过 --torch-backend=auto (或 UV_TORCH_BACKEND=auto) 检查已安装的 CUDA 驱动程序版本，从而在运行时自动选择合适的 PyTorch 索引。要选择特定的后端（例如 cu126），请设置 --torch-backend=cu126 (或 UV_TORCH_BACKEND=cu126)。

另一种愉快的方式是使用 uv run 结合 --with [dependency] 选项，这允许您运行诸如 vllm serve 之类的命令而无需创建任何永久环境

uv run --with vllm vllm --help

您也可以使用 conda 来创建和管理 Python 环境。如果您想在环境内管理 uv，可以通过 pip 将其安装到 conda 环境中。

conda create -n myenv python=3.12 -y
conda activate myenv
pip install --upgrade uv
uv pip install vllm --torch-backend=auto

注意

有关更多详细信息和非 CUDA 平台，请参阅此处，获取关于如何安装 vLLM 的具体说明。

离线批量推理¶

安装 vLLM 后，您可以开始为一系列输入提示词生成文本（即离线批量推理）。请参阅示例脚本： examples/offline_inference/basic/basic.py

此示例的第一行导入了 LLM 和 SamplingParams 类

LLM 是使用 vLLM 引擎运行离线推理的主要类。
SamplingParams 指定采样过程的参数。

from vllm import LLM, SamplingParams

下一节定义了一系列输入提示词和文本生成采样参数。采样温度设置为 0.8，核采样概率设置为 0.95。您可以在此处找到有关采样参数的更多信息。

警告

默认情况下，如果 Hugging Face 模型仓库中存在 generation_config.json，vLLM 将应用模型创建者推荐的采样参数。在大多数情况下，如果不指定 SamplingParams，这将默认提供最佳结果。

但是，如果更喜欢 vLLM 的默认采样参数，请在创建 LLM 实例时设置 generation_config="vllm"。

prompts = [
    "Hello, my name is",
    "The president of the United States is",
    "The capital of France is",
    "The future of AI is",
]
sampling_params = SamplingParams(temperature=0.8, top_p=0.95)

LLM 类初始化 vLLM 的引擎以及用于离线推理的 OPT-125M 模型。支持的模型列表可在此处找到。

llm = LLM(model="facebook/opt-125m")

注意

默认情况下，vLLM 从 Hugging Face 下载模型。如果您想使用 ModelScope 的模型，请在初始化引擎之前设置环境变量 VLLM_USE_MODELSCOPE。

export VLLM_USE_MODELSCOPE=True

现在，有趣的部分来了！输出使用 llm.generate 生成。它将输入提示词添加到 vLLM 引擎的等待队列中，并执行 vLLM 引擎以高吞吐量生成输出。输出以 RequestOutput 对象的列表形式返回，其中包括所有输出 token。

outputs = llm.generate(prompts, sampling_params)

for output in outputs:
    prompt = output.prompt
    generated_text = output.outputs[0].text
    print(f"Prompt: {prompt!r}, Generated text: {generated_text!r}")

OpenAI 兼容服务器¶

vLLM 可以部署为实现 OpenAI API 协议的服务器。这使得 vLLM 可以作为使用 OpenAI API 的应用的直接替代品。默认情况下，它在 http://localhost:8000 启动服务器。您可以使用 --host 和 --port 参数指定地址。该服务器目前一次只托管一个模型，并实现了诸如列出模型、创建聊天补全和创建补全等端点。

运行以下命令，使用 Qwen2.5-1.5B-Instruct 模型启动 vLLM 服务器

vllm serve Qwen/Qwen2.5-1.5B-Instruct

注意

默认情况下，服务器使用存储在 tokenizer 中的预定义聊天模板。您可以在此处了解如何覆盖它。

警告

默认情况下，如果 huggingface 模型仓库中存在 generation_config.json，服务器会应用它。这意味着某些采样参数的默认值可以被模型创建者推荐的值覆盖。

要禁用此行为，请在启动服务器时传递参数 --generation-config vllm。

该服务器可以以与 OpenAI API 相同的格式进行查询。例如，列出模型

curl http://localhost:8000/v1/models

您可以传入参数 --api-key 或环境变量 VLLM_API_KEY 来启用服务器检查请求头中的 API 密钥。

使用 vLLM 的 OpenAI Completions API¶

服务器启动后，您可以使用输入提示词查询模型

curl http://localhost:8000/v1/completions \
    -H "Content-Type: application/json" \
    -d '{
        "model": "Qwen/Qwen2.5-1.5B-Instruct",
        "prompt": "San Francisco is a",
        "max_tokens": 7,
        "temperature": 0
    }'

由于此服务器与 OpenAI API 兼容，因此它可以作为使用 OpenAI API 的任何应用的直接替代品。例如，另一种查询服务器的方式是通过 openai Python 包

from openai import OpenAI

# Modify OpenAI's API key and API base to use vLLM's API server.
openai_api_key = "EMPTY"
openai_api_base = "http://localhost:8000/v1"
client = OpenAI(
    api_key=openai_api_key,
    base_url=openai_api_base,
)
completion = client.completions.create(model="Qwen/Qwen2.5-1.5B-Instruct",
                                      prompt="San Francisco is a")
print("Completion result:", completion)

更详细的客户端示例可在此处找到： examples/online_serving/openai_completion_client.py

使用 vLLM 的 OpenAI Chat Completions API¶

vLLM 也被设计用于支持 OpenAI Chat Completions API。聊天接口是一种更动态、互动性更强的方式与模型进行交流，允许往返交换并存储在聊天历史中。这对于需要上下文或更详细解释的任务非常有用。

您可以使用创建聊天补全端点与模型交互

curl http://localhost:8000/v1/chat/completions \
    -H "Content-Type: application/json" \
    -d '{
        "model": "Qwen/Qwen2.5-1.5B-Instruct",
        "messages": [
            {"role": "system", "content": "You are a helpful assistant."},
            {"role": "user", "content": "Who won the world series in 2020?"}
        ]
    }'

或者，您可以使用 openai Python 包

from openai import OpenAI
# Set OpenAI's API key and API base to use vLLM's API server.
openai_api_key = "EMPTY"
openai_api_base = "http://localhost:8000/v1"

client = OpenAI(
    api_key=openai_api_key,
    base_url=openai_api_base,
)

chat_response = client.chat.completions.create(
    model="Qwen/Qwen2.5-1.5B-Instruct",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Tell me a joke."},
    ]
)
print("Chat response:", chat_response)

关于注意力后端¶

目前，vLLM 支持多种后端，用于跨不同平台和加速器架构进行高效的注意力计算。它会自动选择与您的系统和模型规范兼容的性能最佳的后端。

如果需要，您还可以通过将环境变量 VLLM_ATTENTION_BACKEND 配置为以下选项之一来手动设置您选择的后端：FLASH_ATTN、FLASHINFER 或 XFORMERS。

警告

没有包含 Flash Infer 的预构建 vllm wheel，因此您必须首先在环境中安装它。请参阅 Flash Infer 官方文档或查看 docker/Dockerfile，获取安装说明。