快速入门

快速入门#

本指南展示了如何使用 vLLM 来：

  • 在数据集上运行离线批处理推理；

  • 为大型语言模型构建 API 服务器；

  • 启动一个与 OpenAI 兼容的 API 服务器。

在继续本指南之前，请确保已完成 安装说明。

备注

默认情况下，vLLM 从 HuggingFace 下载模型。如果你想在以下示例中使用来自 ModelScope 的模型，请设置环境变量：

export VLLM_USE_MODELSCOPE=True

离线批处理推理#

我们首先展示一个使用 vLLM 在数据集上进行离线批处理推理的示例。换句话说，我们使用 vLLM 为一组输入提示生成文本。

从 vLLM 导入 LLM 和 SamplingParams 类。LLM 类是使用 vLLM 引擎进行离线推理的主要类。SamplingParams 类指定了采样过程的参数。

from vllm import LLM, SamplingParams

定义输入提示列表和生成采样参数。采样温度设置为 0.8，核采样概率设置为 0.95。有关采样参数的更多信息，请参阅 类定义。

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 类和 OPT-125M 模型 初始化 vLLM 的离线推理引擎。支持的模型列表可以在 支持的模型 中找到。

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

调用 llm.generate 生成输出。它将输入提示添加到 vLLM 引擎的等待队列中，并执行 vLLM 引擎以高吞吐量生成输出。输出以 RequestOutput 对象列表的形式返回，其中包含所有输出标记。

outputs = llm.generate(prompts, sampling_params)

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

代码示例也可以在 examples/offline_inference.py 中找到。

OpenAI 兼容服务器#

vLLM 可以部署为实现 OpenAI API 协议的服务器。这允许 vLLM 用作使用 OpenAI API 的应用程序的直接替代品。默认情况下，它在 http://localhost:8000 上启动服务器。你可以使用 --host 和 --port 参数指定地址。该服务器目前一次只托管一个模型（下面命令中的 OPT-125M），并实现了 列出模型、创建聊天完成 和 创建完成 端点。我们正在积极添加对更多端点的支持。

启动服务器：

$ vllm serve facebook/opt-125m

默认情况下，服务器使用存储在分词器中的预定义聊天模板。你可以使用 --chat-template 参数覆盖此模板：

$ vllm serve facebook/opt-125m --chat-template ./examples/template_chatml.jinja

此服务器可以使用与 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": "facebook/opt-125m",
$         "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="facebook/opt-125m",
                                      prompt="San Francisco is a")
print("Completion result:", completion)

有关更详细的客户端示例，请参考 examples/openai_completion_client.py。

使用 vLLM 与 OpenAI Chat API#

vLLM 服务器旨在支持 OpenAI Chat API，允许你与模型进行动态对话。聊天界面是与模型进行交互的更直观的方式，允许在聊天历史记录中存储来回的交流。这对于需要上下文或更详细解释的任务很有用。

使用 OpenAI Chat API 查询模型：

你可以使用 创建聊天完成 端点以在类似聊天的界面中与模型进行交流：

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

Python 客户端示例：

使用 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="facebook/opt-125m",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Tell me a joke."},
    ]
)
print("Chat response:", chat_response)

有关聊天 API 的更深入示例和高级功能，你可以参考官方 OpenAI 文档。

目录