evalscope/docs/zh/user_guides/stress_test/quick_start.md

11 KiB
Raw Permalink Blame History

快速开始

下面是使用EvalScope进行模型推理性能压测的快速指南。支持OpenAI API格式模型服务以及多种数据集格式方便用户进行性能评测。

环境准备

EvalScope支持在Python环境中使用用户可以通过pip安装或源码安装EvalScope。以下是两种安装方式的示例

::::{tab-set} :::{tab-item} pip安装

# 安装额外依赖
pip install evalscope[perf] -U

:::

:::{tab-item} 源码安装

git clone https://github.com/modelscope/evalscope.git
cd evalscope
pip install -e '.[perf]'

::: ::::

基本使用

可以使用以下两种方式(命令行/Python脚本)启动模型推理性能压测工具:

下面展示了用vLLM框架在A100上进行Qwen2.5-0.5B-Instruct模型的压测示例固定输入1024 token输出1024 token。用户可以根据自己的需求修改参数。

::::{tab-set} :::{tab-item} 命令行启动

evalscope perf \
  --parallel 1 10 50 100 200 \
  --number 10 20 100 200 400 \
  --model Qwen2.5-0.5B-Instruct \
  --url http://127.0.0.1:8801/v1/chat/completions \
  --api openai \
  --dataset random \
  --max-tokens 1024 \
  --min-tokens 1024 \
  --prefix-length 0 \
  --min-prompt-length 1024 \
  --max-prompt-length 1024 \
  --tokenizer-path Qwen/Qwen2.5-0.5B-Instruct \
  --extra-args '{"ignore_eos": true}'

:::

:::{tab-item} Python脚本启动

from evalscope.perf.main import run_perf_benchmark
from evalscope.perf.arguments import Arguments

task_cfg = Arguments(
    parallel=[1, 10, 50, 100, 200],
    number=[10, 20, 100, 200, 400],
    model='Qwen2.5-0.5B-Instruct',
    url='http://127.0.0.1:8801/v1/chat/completions',
    api='openai',
    dataset='random',
    min_tokens=1024,
    max_tokens=1024,
    prefix_length=0,
    min_prompt_length=1024,
    max_prompt_length=1024,
    tokenizer_path='Qwen/Qwen2.5-0.5B-Instruct',
    extra_args={'ignore_eos': True}
)
results = run_perf_benchmark(task_cfg)

::: ::::

参数说明

  • parallel: 请求的并发数,可以传入多个值,用空格隔开
  • number: 每个并发请求的数量,可以传入多个值,用空格隔开(与parallel一一对应)
  • url: 请求的URL地址
  • model: 使用的模型名称
  • api: 使用的API服务默认为openai
  • dataset: 数据集名称,此处为random,表示随机生成数据集,具体使用说明参考
  • tokenizer-path: 模型的tokenizer路径用于计算token数量在random数据集中是必须的
  • extra-args: 请求中的额外的参数传入json格式的字符串例如{"ignore_eos": true}表示忽略结束token
[完整参数说明](./parameters.md)

输出结果

输出的测试报告总结如下图所示,包括基础信息、每个并发下的指标、压测建议等:

multi_perf

此外每个并发数的测试结果会单独输出包含了每个并发数下的请求数量、成功请求数量、失败请求数量、平均延迟时间、平均每token延迟时间等指标。

Benchmarking summary:
+-----------------------------------+------------+
| Key                               |      Value |
+===================================+============+
| Time taken for tests (s)          |    62.9998 |
+-----------------------------------+------------+
| Number of concurrency             |   200      |
+-----------------------------------+------------+
| Total requests                    |   400      |
+-----------------------------------+------------+
| Succeed requests                  |   400      |
+-----------------------------------+------------+
| Failed requests                   |     0      |
+-----------------------------------+------------+
| Output token throughput (tok/s)   |  6501.61   |
+-----------------------------------+------------+
| Total token throughput (tok/s)    | 13379.1    |
+-----------------------------------+------------+
| Request throughput (req/s)        |     6.3492 |
+-----------------------------------+------------+
| Average latency (s)               |    30.9964 |
+-----------------------------------+------------+
| Average time to first token (s)   |     1.3071 |
+-----------------------------------+------------+
| Average time per output token (s) |     0.029  |
+-----------------------------------+------------+
| Average input tokens per request  |  1083.2    |
+-----------------------------------+------------+
| Average output tokens per request |  1024      |
+-----------------------------------+------------+
| Average package latency (s)       |     0.029  |
+-----------------------------------+------------+
| Average package per request       |  1023.43   |
+-----------------------------------+------------+
2025-05-16 11:36:33,122 - evalscope - INFO - 
Percentile results:
+-------------+----------+---------+----------+-------------+--------------+---------------+----------------+---------------+
| Percentiles | TTFT (s) | ITL (s) | TPOT (s) | Latency (s) | Input tokens | Output tokens | Output (tok/s) | Total (tok/s) |
+-------------+----------+---------+----------+-------------+--------------+---------------+----------------+---------------+
|     10%     |  0.3371  |   0.0   |  0.0275  |   28.8971   |     1029     |     1024      |    30.5721     |    62.9394    |
|     25%     |  0.4225  | 0.0218  |  0.0281  |   29.7338   |     1061     |     1024      |    32.1195     |    65.5693    |
|     50%     |  0.9366  | 0.0263  |  0.0291  |   30.8739   |     1073     |     1024      |    33.1733     |    67.9478    |
|     66%     |  1.5892  | 0.0293  |  0.0296  |   31.5315   |     1080     |     1024      |    33.9593     |    69.8569    |
|     75%     |  2.0769  | 0.0308  |  0.0298  |   31.8956   |     1084     |     1024      |    34.4398     |    70.9794    |
|     80%     |  2.3656  | 0.0319  |  0.0299  |   32.3317   |     1088     |     1024      |    34.7858     |    71.7338    |
|     90%     |  3.1024  |  0.039  |  0.0304  |   33.4968   |     1197     |     1024      |    35.4505     |    73.0745    |
|     95%     |  3.5413  | 0.0572  |  0.0308  |   34.1158   |     1251     |     1024      |    35.8045     |    74.3043    |
|     98%     |  3.8131  | 0.1462  |  0.0309  |   34.5008   |     1292     |     1024      |    36.0191     |    77.1365    |
|     99%     |  3.8955  | 0.1761  |  0.031   |   34.5951   |     1343     |     1024      |    36.1281     |    79.4895    |
+-------------+----------+---------+----------+-------------+--------------+---------------+----------------+---------------+

指标说明

指标 英文名称 解释 公式
测试总时长 Time taken for tests 整个测试过程从开始到结束所花费的总时间 最后一个请求结束时间 - 第一个请求开始时间
并发数 Number of concurrency 同时发送请求的客户端数量 预设值
总请求数 Total requests 在整个测试过程中发送的所有请求的数量 成功请求数 + 失败请求数
成功请求数 Succeed requests 成功完成并返回预期结果的请求数量 直接统计
失败请求数 Failed requests 由于各种原因未能成功完成的请求数量 直接统计
输出吞吐量 Output token throughput 每秒钟处理的平均标记token 总输出token数 / 测试总时长
总吞吐量 Total token throughput 每秒钟处理的平均标记token 总输入token数 + 总输出token数 / 测试总时长
请求吞吐量 Request throughput 每秒钟成功处理的平均请求数 成功请求数 / 测试总时长
总延迟时间 Total latency 所有成功请求的延迟时间总和 所有成功请求的延迟时间之和
平均延迟 Average latency 从发送请求到接收完整响应的平均时间 总延迟时间 / 成功请求数
平均首token时间 Average time to first token 从发送请求到接收到第一个响应标记的平均时间 总首chunk延迟 / 成功请求数
平均每输出token时间 Average time per output token 生成每个输出标记所需的平均时间不包含首token 总每输出token时间 / 成功请求数
平均输入token数 Average input tokens per request 每个请求的平均输入标记数 总输入token数 / 成功请求数
平均输出token数 Average output tokens per request 每个请求的平均输出标记数 总输出token数 / 成功请求数
平均数据包延迟 Average package latency 接收每个数据包的平均延迟时间 总数据包时间 / 总数据包数
平均每请求数据包数 Average package per request 每个请求平均接收的数据包数量 总数据包数 / 成功请求数

百分位指标 (Percentile)

以单个请求为单位进行统计数据被分为100个相等部分第n百分位表示n%的数据点在此值之下。

指标 英文名称 解释
首次生成token时间 TTFT (Time to First Token) 从发送请求到生成第一个token的时间以秒为单位评估首包延时
输出token间时延 ITL (Inter-token Latency) 生成每个输出token间隔时间以秒为单位评估输出是否平稳
每token延迟 TPOT (Time per Output Token) 生成每个输出token所需的时间不包含首token以秒为单位评估解码速度
端到端延迟时间 Latency 从发送请求到接收完整响应的时间以秒为单位TTFT + TPOT * Output tokens
输入token数 Input tokens 请求中输入的token数量
输出token数 Output tokens 响应中生成的token数量
输出吞吐量 Output Throughput 每秒输出的token数量输出tokens / 端到端延时
总吞吐量 Total throughput 每秒处理的token数量(输入tokens + 输出tokens) / 端到端延时

可视化测试结果

使用Wandb进行可视化测试结果

请先安装wandb并获取对应的API Key

pip install wandb

在评测启动时额外添加以下参数即可将测试结果上传wandb server并进行可视化

# ...
--wandb-api-key 'wandb_api_key'
--name 'name_of_wandb_log'

例如:

wandb sample

使用SwanLab进行可视化测试结果

请先安装SwanLab并获取对应的API Key

pip install swanlab

在评测启动时额外添加以下参数即可将测试结果上传swanlab server并进行可视化

# ...
--swanlab-api-key 'swanlab_api_key'
--name 'name_of_swanlab_log'

例如:

swanlab sample

如果希望仅使用SwanLab本地看板模式先安装swanlab离线看板

pip install 'swanlab[dashboard]'

再通过设置如下参数:

--swanlab-api-key local

并通过swanlab watch <日志路径>打开本地可视化看板。