测试

测试#

本文档介绍如何编写端到端测试和单元测试，以验证您实现的功能。

设置测试环境#

设置测试环境最快的方法是使用 main 分支的容器镜像：

本地（CPU）

您可以按照以下步骤在 CPU 上运行单元测试：

cd ~/vllm-project/
# ls
# vllm  vllm-ascend

# Use mirror to speed up download
# docker pull m.daocloud.io/quay.io/ascend/cann:9.0.0-910b-ubuntu22.04-py3.11
export IMAGE=quay.io/ascend/cann:9.0.0-910b-ubuntu22.04-py3.11
docker run --rm --name vllm-ascend-ut \
    -v $(pwd):/vllm-project \
    -v ~/.cache:/root/.cache \
    -ti $IMAGE bash

# (Optional) Configure mirror to speed up download
sed -i 's|ports.ubuntu.com|mirrors.huaweicloud.com|g' /etc/apt/sources.list
pip config set global.index-url https://mirrors.huaweicloud.com/repository/pypi/simple/

# For torch-npu dev version or x86 machine
export PIP_EXTRA_INDEX_URL="https://download.pytorch.org/whl/cpu/ https://mirrors.huaweicloud.com/ascend/repos/pypi"

# src path
export SRC_WORKSPACE=/vllm-workspace
mkdir -p $SRC_WORKSPACE
cd $SRC_WORKSPACE

apt-get update -y
apt-get install -y python3-pip git vim wget net-tools gcc g++ cmake libnuma-dev curl gnupg2

git clone -b v0.18.0 --depth 1 https://github.com/vllm-project/vllm-ascend.git
git clone --depth 1 https://github.com/vllm-project/vllm.git

# vllm
cd $SRC_WORKSPACE/vllm
VLLM_TARGET_DEVICE=empty python3 -m pip install .
python3 -m pip uninstall -y triton

# vllm-ascend
cd $SRC_WORKSPACE/vllm-ascend
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/Ascend/ascend-toolkit/latest/$(uname -m)-linux/devlib
# For cpu environment, set SOC_VERSION for different chips.
# See https://github.com/vllm-project/vllm-ascend/blob/3cb0af0bcf3299089ca7e72159fa36e825a470f8/setup.py#L132 for detail.
export SOC_VERSION="ascend910b1"
python3 -m pip install -v .
python3 -m pip install -r requirements-dev.txt

单卡

# Update DEVICE according to your device (/dev/davinci[0-7])
export DEVICE=/dev/davinci0
# Update the vllm-ascend image
export IMAGE=quay.io/ascend/vllm-ascend:main
docker run --rm \
    --name vllm-ascend \
    --shm-size=1g \
    --device $DEVICE \
    --device /dev/davinci_manager \
    --device /dev/devmm_svm \
    --device /dev/hisi_hdc \
    -v /usr/local/dcmi:/usr/local/dcmi \
    -v /usr/local/bin/npu-smi:/usr/local/bin/npu-smi \
    -v /usr/local/Ascend/driver/lib64/:/usr/local/Ascend/driver/lib64/ \
    -v /usr/local/Ascend/driver/version.info:/usr/local/Ascend/driver/version.info \
    -v /etc/ascend_install.info:/etc/ascend_install.info \
    -v /root/.cache:/root/.cache \
    -p 8000:8000 \
    -it $IMAGE bash

启动容器后，您应该安装所需的软件包：

# Prepare
pip config set global.index-url https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple

# Install required packages
pip install -r requirements-dev.txt

多卡

# Update the vllm-ascend image
export IMAGE=quay.io/ascend/vllm-ascend:main
docker run --rm \
    --name vllm-ascend \
    --shm-size=1g \
    --device /dev/davinci0 \
    --device /dev/davinci1 \
    --device /dev/davinci2 \
    --device /dev/davinci3 \
    --device /dev/davinci_manager \
    --device /dev/devmm_svm \
    --device /dev/hisi_hdc \
    -v /usr/local/dcmi:/usr/local/dcmi \
    -v /usr/local/bin/npu-smi:/usr/local/bin/npu-smi \
    -v /usr/local/Ascend/driver/lib64/:/usr/local/Ascend/driver/lib64/ \
    -v /usr/local/Ascend/driver/version.info:/usr/local/Ascend/driver/version.info \
    -v /etc/ascend_install.info:/etc/ascend_install.info \
    -v /root/.cache:/root/.cache \
    -p 8000:8000 \
    -it $IMAGE bash

启动容器后，您应该安装所需的软件包：

cd /vllm-workspace/vllm-ascend/

# Prepare
pip config set global.index-url https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple

# Install required packages
pip install -r requirements-dev.txt

运行测试#

单元测试#

编写单元测试时需要遵循以下几个原则：

测试文件路径应与源文件保持一致，并以 test_ 前缀开头，例如：vllm_ascend/worker/worker.py --> tests/ut/worker/test_worker.py
vLLM Ascend 测试使用 unittest 框架。请参阅 Python unittest 文档以了解如何编写单元测试。
所有单元测试都可以在 CPU 上运行，因此您必须在主机上模拟与设备相关的函数。
示例：tests/ut/test_ascend_config.py。
您可以使用 pytest 运行单元测试：

本地（CPU）

# Run unit tests
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/Ascend/ascend-toolkit/latest/$(uname -m)-linux/devlib
TORCH_DEVICE_BACKEND_AUTOLOAD=0 pytest -sv tests/ut

单卡

cd /vllm-workspace/vllm-ascend/
# Run all single-card tests
pytest -sv tests/ut

# Run single test
pytest -sv tests/ut/test_ascend_config.py

多卡

cd /vllm-workspace/vllm-ascend/
# Run all multi-card tests
pytest -sv tests/ut

# Run single test
pytest -sv tests/ut/test_ascend_config.py

端到端测试#

虽然 vllm-ascend CI 在 Ascend CI 上提供了端到端测试（例如，schedule_nightly_test_a2.yaml、schedule_nightly_test_a3.yaml、pr_test_full.yaml），但您也可以在本地运行它们。

本地（CPU）

您无法在 CPU 上运行端到端测试。

单卡

cd /vllm-workspace/vllm-ascend/
# Run all single-card tests
VLLM_USE_MODELSCOPE=true pytest -sv tests/e2e/singlecard/

# Run a certain test script
VLLM_USE_MODELSCOPE=true pytest -sv tests/e2e/singlecard/test_offline_inference.py

# Run a certain case in test script
VLLM_USE_MODELSCOPE=true pytest -sv tests/e2e/singlecard/test_offline_inference.py::test_models

多卡

cd /vllm-workspace/vllm-ascend/
# Run all multi-card tests
VLLM_USE_MODELSCOPE=true pytest -sv tests/e2e/singlecard/

# Run a certain test script
VLLM_USE_MODELSCOPE=true pytest -sv tests/e2e/singlecard/test_aclgraph_accuracy.py

# Run a certain case in test script
VLLM_USE_MODELSCOPE=true pytest -sv tests/e2e/singlecard/test_aclgraph_accuracy.py::test_models_output

这将复现端到端测试。请参阅 vllm_ascend_test.yaml。

要在本地运行夜间多节点测试用例，请参阅多节点测试中的 本地运行 部分。

端到端测试示例#

离线测试示例：tests/e2e/singlecard/test_offline_inference.py
在线测试示例：tests/e2e/singlecard/test_prompt_embedding.py

正确性测试示例：tests/e2e/singlecard/test_aclgraph_accuracy.py

CI 资源有限，您可能需要减少模型的层数。以下是如何生成缩减层数模型的示例：

在 ModelScope 中 Fork 原始模型仓库。需要仓库中除权重文件外的所有文件。
将 num_hidden_layers 设置为期望的层数，例如 {"num_hidden_layers": 2,}

将以下 Python 脚本复制为 generate_random_weight.py。根据需要设置相关参数 MODEL_LOCAL_PATH、DIST_DTYPE 和 DIST_MODEL_PATH：

import torch
from transformers import AutoTokenizer, AutoConfig
from modeling_deepseek import DeepseekV3ForCausalLM
from modelscope import snapshot_download

MODEL_LOCAL_PATH = "~/.cache/modelscope/models/vllm-ascend/DeepSeek-V3-Pruning"
DIST_DTYPE = torch.bfloat16
DIST_MODEL_PATH = "./random_deepseek_v3_with_2_hidden_layer"

config = AutoConfig.from_pretrained(MODEL_LOCAL_PATH, trust_remote_code=True)
model = DeepseekV3ForCausalLM(config)
model = model.to(DIST_DTYPE)
model.save_pretrained(DIST_MODEL_PATH)

在 GitHub Actions 中查看 CI 日志摘要#

CI 作业完成后，您可以打开相应的 GitHub Actions 作业页面，并查看 Summary 选项卡以查看生成的 CI 日志摘要。

GitHub Actions CI 日志摘要

该摘要旨在帮助开发者更快地排查故障。它可能包括：

失败的测试文件
失败的测试用例
不同的根本原因错误
从作业日志中提取的简短错误上下文

该摘要是由 /.github/workflows/scripts/ci_log_summary_v2.py 从作业日志中为单元测试和端到端测试工作流生成的。

运行 doctest#

vllm-ascend 提供了一个 vllm-ascend/tests/e2e/run_doctests.sh 命令来运行文档文件中的所有 doctest。doctest 是确保文档保持最新且示例保持可执行性的好方法，可以按如下方式在本地运行：

# Run doctest
/vllm-workspace/vllm-ascend/tests/e2e/run_doctests.sh

这将复现与 CI 相同的环境。请参阅 vllm_ascend_doctest.yaml。

测试

目录

测试#

设置测试环境#

运行测试#

单元测试#

端到端测试#

端到端测试示例#

在 GitHub Actions 中查看 CI 日志摘要#

运行 doctest#