mirror of https://github.com/vllm-project/vllm-ascend.git synced 2025-10-20 13:43:53 +08:00

Files

Yikun Jiang 46977f9f06 [Doc] Add sphinx build for vllm-ascend (#55 )

### What this PR does / why we need it?

This patch enables the doc build for vllm-ascend

- Add sphinx build for vllm-ascend
- Enable readthedocs for vllm-ascend
- Fix CI:
- exclude vllm-empty/tests/mistral_tool_use to skip `You need to agree
to share your contact information to access this model` which introduce
in
314cfade02
- Install test req to fix
https://github.com/vllm-project/vllm-ascend/actions/runs/13304112758/job/37151690770:
      ```
      vllm-empty/tests/mistral_tool_use/conftest.py:4: in <module>
          import pytest_asyncio
      E   ModuleNotFoundError: No module named 'pytest_asyncio'
      ```
  - exclude docs PR

### Does this PR introduce _any_ user-facing change?
No

### How was this patch tested?
1. test locally:
    ```bash
    # Install dependencies.
    pip install -r requirements-docs.txt
    
    # Build the docs and preview
    make clean; make html; python -m http.server -d build/html/
    ```
    
    Launch browser and open http://localhost:8000/.

2. CI passed with preview:
    https://vllm-ascend--55.org.readthedocs.build/en/55/

Signed-off-by: Yikun Jiang <yikunkero@gmail.com>

2025-02-13 18:44:17 +08:00

3.7 KiB

Raw Blame History

贡献指南

构建与测试

我们推荐您在提交PR之前在本地开发环境进行构建和测试。

环境准备与构建

理论上，vllm-ascend 构建仅支持 Linux，因为vllm-ascend 依赖项 torch_npu 仅支持 Linux。

但是您仍然可以在 Linux/Windows/macOS 上配置开发环境进行代码检查和基本测试，如下命令所示：

# 选择基础文件夹 (~/vllm-project/) ，创建python虚拟环境
cd ~/vllm-project/
python3 -m venv .venv
source ./.venv/bin/activate

# 克隆并安装vllm
git clone https://github.com/vllm-project/vllm.git
cd vllm
pip install -r requirements-build.txt
VLLM_TARGET_DEVICE="empty" pip install .
cd ..

# 克隆并安装vllm-ascend
git clone https://github.com/vllm-project/vllm-ascend.git
cd vllm-ascend
pip install -r requirements-dev.txt

# 通过执行以下脚本以运行 lint 及 mypy 测试
bash format.sh

# 构建:
# - 目前仅支持在Linux上进行完整构建（torch_npu 限制）
# pip install -e .
# - 在其他操作系统上构建安装，需要跳过依赖
# - build without deps for debugging in other OS
# pip install -e . --no-deps

# 使用 `-s` 提交更改
git commit -sm "your commit info"

测试

虽然 vllm-ascend CI 提供了对 Ascend 的集成测试，但您也可以在本地运行它。在本地运行这些集成测试的最简单方法是通过容器：

# 基于昇腾NPU环境
git clone https://github.com/vllm-project/vllm-ascend.git
cd vllm-ascend

IMAGE=vllm-ascend-dev-image
CONTAINER_NAME=vllm-ascend-dev
DEVICE=/dev/davinci1

# 首次构建会花费10分钟（10MB/s）下载基础镜像和包
docker build -t $IMAGE -f ./Dockerfile .
# 您还可以通过设置 VLLM_REPO 来指定镜像仓库以加速
# docker build -t $IMAGE -f ./Dockerfile . --build-arg VLLM_REPO=https://gitee.com/mirrors/vllm

docker run --name $CONTAINER_NAME --network host --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/ \
           -ti --rm $IMAGE bash

cd vllm-ascend
pip install -r requirements-dev.txt

pytest tests/

开发者来源证书(DCO)

在向本项目提交贡献时，您必须同意 DCO。提交必须包含“Signed-off-by:”标头，以证明同意 DCO 的条款。

在git commit时使用-s将会自动添加该标头。

PR 标题和分类

仅特定类型的 PR 会被审核。PR 标题会以适当的前缀来表明变更类型。请使用以下之一：

[Attention] 关于attention的新特性或优化
[Communicator] 关于communicators的新特性或优化
[ModelRunner] 关于model runner的新特性或优化
[Platform] 关于platform的新特性或优化
[Worker] 关于worker的新特性或优化
[Core] 关于vllm-ascend核心逻辑 (如 platform, attention, communicators, model runner)的新特性或优化
[Kernel] 影响计算内核和操作的更改.
[Bugfix] bug修复
[Doc] 文档的修复与更新
[Test] 测试 (如：单元测试)
[CI] 构建或持续集成改进
[Misc] 适用于更改内容对于上述类别均不适用的PR，请谨慎使用该前缀

[!注意] 如果 PR 涉及多个类别，请添加所有相关前缀

其他

您可以在 docs.vllm.ai 上找到更多有关为 vLLM 昇腾插件贡献的信息。如果您在贡献过程中发现任何问题，您可以随时提交 PR 来改进文档以帮助其他开发人员。

3.7 KiB Raw Blame History Unescape Escape