贡献指南#
构建与测试#
建议在提交 PR 之前，先搭建本地开发环境来构建 vllm-ascend 并运行测试。
设置开发环境#
理论上，vllm-ascend 的构建仅支持 Linux，因为其依赖项 torch_npu 仅支持 Linux。
但你仍然可以在 Linux/Windows/macOS 上设置开发环境，用于代码规范检查和运行基本测试。
本地运行代码检查#
# Choose a base dir (~/vllm-project/) and set up venv
cd ~/vllm-project/
python3 -m venv .venv
source ./.venv/bin/activate
# Clone vllm-ascend and install
git clone https://github.com/vllm-project/vllm-ascend.git
cd vllm-ascend
# Install lint requirement and enable pre-commit hook
pip install -r requirements-lint.txt
# Run lint (You need to install pre-commits deps via proxy network at first time)
bash format.sh
本地运行 CI#
完成“运行代码检查”设置后，你可以在本地运行 CI（持续集成）：
cd ~/vllm-project/
# Run CI needs vLLM installed
git clone --branch v0.18.0 https://github.com/vllm-project/vllm.git
cd vllm
pip install -r requirements/build.txt
VLLM_TARGET_DEVICE="empty" pip install .
cd ..
# Install requirements
cd vllm-ascend
# For Linux:
pip install -r requirements-dev.txt
# For non-Linux:
cat requirements-dev.txt | grep -Ev '^#|^--|^$|^-r' | while read PACKAGE; do pip install "$PACKAGE"; done
cat requirements.txt | grep -Ev '^#|^--|^$|^-r' | while read PACKAGE; do pip install "$PACKAGE"; done
# Run ci:
bash format.sh ci
提交更改#
# Commit changed files using `-s`
git commit -sm "your commit info"
🎉 恭喜！您已完成开发环境的设置。
本地测试#
你可以参考 测试 文档来设置测试环境并在本地运行测试。
DCO 与签署确认#
向本项目贡献更改时，您必须同意 DCO。提交必须包含 Signed-off-by: 标头，以证明您同意 DCO（开发者原创证书）的条款。
在 git commit 命令中使用 -s 参数会自动添加此标头。
PR 标题与分类#
只有特定类型的 PR 会被审核。PR 标题应使用适当的前缀来指明更改类型。请使用以下前缀之一：
[Attention]用于注意力机制的新功能或优化。[Communicator]用于通信器的新功能或优化。[ModelRunner]用于模型运行器的新功能或优化。[Platform]用于平台的新功能或优化。[Worker]用于工作器的新功能或优化。[Core]用于核心 vllm-ascend 逻辑中的新功能或优化（例如平台、注意力机制、通信器、模型运行器）。[Kernel]用于影响计算内核和操作的更改。[Bugfix]用于错误修复。[Doc]用于文档修复和改进。[Test]用于测试（例如单元测试）。[CI]用于构建或持续集成的改进。[Misc]用于不属于上述类别的 PR。请谨慎使用此标签。
备注
如果 PR 涉及多个类别，请包含所有相关的前缀。
其他#
你可以在 docs.vllm.ai 上找到有关为 vLLM Ascend 后端插件做贡献的更多信息。如果在贡献过程中遇到任何问题，欢迎随时提交 PR 来改进文档，以帮助其他开发者。