vLLM项目贡献指南：开发者必读的技术规范

vLLM项目贡献指南：开发者必读的技术规范

vllm A high-throughput and memory-efficient inference and serving engine for LLMs 项目地址: https://gitcode.com/gh_mirrors/vl/vllm

作为一款高性能的LLM推理和服务引擎，vLLM项目以其卓越的PagedAttention技术和高效的推理能力在AI社区广受关注。本文将详细介绍如何为vLLM项目贡献代码，帮助开发者快速融入项目开发流程。

开发环境搭建

vLLM支持两种开发模式，开发者可根据需求选择：

1. 完整编译模式：适用于需要修改CUDA内核或底层C++代码的场景
2. 纯Python模式：适用于仅修改Python逻辑的场景

建议使用Python 3.12进行开发，以保持与CI环境的一致性。文档开发需安装特定依赖：

pip install -r requirements/docs.txt
mkdocs serve  # 启动实时重载文档服务器

代码质量保障体系

vLLM采用严格的代码质量控制流程：

1. 预提交检查：

pre-commit install --hook-type pre-commit --hook-type commit-msg
pre-commit run --all-files  # 手动运行检查

2. 类型检查： 项目目前尚未完全通过mypy检查，但建议开发者尽可能添加类型注解

3. 单元测试：

pytest tests/

注意：部分测试需要GPU支持，无GPU环境可依赖CI系统完成测试

提交规范与PR分类

vLLM采用严格的PR分类系统，提交时需在标题中使用以下前缀：

• [Bugfix]：错误修复
• [CI/Build]：构建系统改进
• [Doc]：文档更新
• [Model]：模型相关修改（需包含模型名称）
• [Frontend]：前端接口修改
• [Kernel]：CUDA内核修改
• [Core]：核心引擎逻辑修改
• [Hardware][Vendor]：硬件相关修改
• [Misc]：其他类别（谨慎使用）

CUDA内核开发规范

开发或修改CUDA内核时需要特别注意：

1. PyTorch自定义算子注册：

• 必须遵循PyTorch官方规范注册自定义算子
• 返回Tensor的操作需要实现meta函数
• 使用torch.library.opcheck()验证算子注册

2. 模式验证：

• 修改现有算子时需同步更新schema定义
• 新增自定义类型需遵循PT2规范

大型修改注意事项

对于超过500行代码的架构级修改（不包括测试代码），要求：

1. 提前提交RFC（Request for Comments）说明技术设计和合理性
2. 未经讨论的大型PR可能被标记为rfc-required并暂缓审核

代码审查流程

vLLM团队承诺提供透明的审查流程：

1. PR提交后2-3个工作日内分配审查者
2. 7日内未获审查可主动提醒
3. 审查意见将标记为action-required
4. 开发者应及时回应所有审查意见

开发者证书协议

所有贡献必须包含Signed-off-by声明，表明同意开发者证书协议（DCO）。使用git commit -s可自动添加此声明。

通过遵循这些规范，开发者可以更高效地为vLLM项目做出贡献，共同推动这一高性能LLM推理引擎的发展。

vllm A high-throughput and memory-efficient inference and serving engine for LLMs 项目地址: https://gitcode.com/gh_mirrors/vl/vllm