CuPy项目开发与贡献指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00405/article/details/148415975

CuPy项目开发与贡献指南

cupy cupy/cupy: Cupy 是一个用于 NumPy 的 Python 库，提供了基于 GPU 的 Python 阵列计算和深度学习库，可以用于机器学习，深度学习，图像和视频处理等任务。项目地址: https://gitcode.com/gh_mirrors/cu/cupy

项目概述

CuPy是一个基于CUDA的NumPy兼容数组库，它利用GPU的强大计算能力加速数值计算任务。作为NumPy的GPU替代方案，CuPy提供了与NumPy几乎相同的API接口，使得开发者可以轻松地将现有的NumPy代码迁移到GPU上运行。

开发流程详解

版本管理策略

CuPy采用基于PEP 440和语义化版本控制的混合版本管理方案：

版本号结构：X.Y.Zw
- X：主版本号（重大更新）
- Y：次版本号（功能新增）
- Z：修订号（错误修复）
- w：预发布标识（a=alpha, b=beta, rc=候选版本）
兼容性原则：
- 主版本更新通常不会包含破坏性变更
- 修订版本仅包含向后兼容的错误修复
- 次版本可能包含向后兼容的新功能

发布周期

CuPy采用双轨制发布策略：

稳定版本轨道：针对当前主版本的修订更新
开发版本轨道：针对下一主版本的预发布

典型发布周期示例（以X.0.0为基准）：

| 相对时间 | 稳定版本 | 开发版本 | 未来版本 | |---------|----------|----------|----------| | 0周 | X.0.0rc1 | - | - | | 4周 | X.0.0 | Y.0.0a1 | - | | 8周 | X.1.0* | Y.0.0b1 | - | | 12周 | X.2.0* | Y.0.0rc1 | - | | 16周 | - | Y.0.0 | Z.0.0a1 |

*注：带星号的可能是修订版本或次版本

代码分支管理

CuPy采用以下分支策略：

main分支：开发预发布版本（alpha/beta/RC）
- 包含最新功能
- 面向下一主版本
版本分支（vN）：稳定版本开发
- 例如v1分支用于v1.x.x系列
- 仅包含错误修复和必要的安全更新

贡献者须知：

新功能开发应基于main分支
错误修复可同时提交到main和相应版本分支
仅适用于稳定版本的修复应直接提交到版本分支

代码贡献规范

编码风格指南

CuPy遵循以下编码规范：

基础规范：
- PEP 8风格指南
- OpenStack风格指南的部分内容

预提交检查：

pip install pre-commit
pre-commit run -a  # 手动检查
pre-commit install  # 安装Git钩子

特殊规范：
- 禁止使用相对导入
- 导入应分为三部分：标准库、第三方库、内部模块
- 禁止使用模块内部的快捷符号
Cython规范：
- 仅内部使用的指针应为void*
- 暴露给Python的指针应为intptr_t
- 内存大小使用size_t
- 内存偏移使用ptrdiff_t

文档编写指南

由于CuPy基于NumPy设计，文档编写需注意：

复制或修改NumPy文档时应明确标注
简要说明功能特性后，可引用NumPy的详细文档
若功能实现有限，应明确说明支持的范围

测试规范

测试环境准备

安装依赖：
```
pip install pytest mock
```

构建Cython模块：

pip install --no-build-isolation -e .

修改.pxd文件后需清理：

git clean -fdx

测试执行方法

基本测试：
```
python -m pytest
```
跳过cuDNN测试：
```
python -m pytest -m='not cudnn'
```

单GPU环境测试：

export CUPY_TEST_GPU_LIMIT=1
python -m pytest

测试编写规范

目录结构：
- 测试目录名以_tests结尾
- 测试文件名以test_开头
- 模块cupy.x.y.z的测试应位于tests/cupy_tests/x_tests/y_tests/test_z.py
编写原则：
- 继承unittest.TestCase
- 优先使用assert语句而非self.assert*方法
- 使用pytest.raises()而非self.assertRaises()