CANN基础算子贡献指南-编程实验室

贡献指南

【免费下载链接】community本项目是CANN开源社区的核心管理仓库，包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息项目地址: https://gitcode.com/cann/community

本项目欢迎广大开发者体验并参与贡献，在参与社区贡献之前。请参见cann-community了解行为准则，进行CLA协议签署，了解源码仓的贡献流程。

开发者准备本地代码与提交PR时需要重点关注如下几点：

提交PR时，请按照PR模板仔细填写本次PR的业务背景、目的、方案等信息。
若您的修改不是简单的bug修复，而是涉及到新增特性、新增接口、新增配置参数或者修改代码流程等，请务必先通过Issue进行方案讨论，以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为“简单的bug修复”，亦可通过提交Issue进行方案讨论。

开发者贡献场景主要包括：

算子Bug修复

如果您在本项目中发现了某些算子Bug，希望对其进行修复，欢迎您新建Issue进行反馈和跟踪处理。

您可以按照提交Issue/处理Issue任务指引新建Bug-Report|缺陷反馈类Issue对Bug进行描述，然后在评论框中输入“/assign”或“/assign @yourself”，将该Issue分配给您进行处理。

算子优化

如果您对本项目中某些算子实现有泛化性增强/性能优化思路，希望着手实现这些优化点，欢迎您对算子进行优化贡献。

您可以按照提交Issue/处理Issue任务指引新建Requirement|需求建议类Issue对优化点进行说明，并提供您的设计方案，然后在评论框中输入“/assign”或“/assign @yourself”，将该Issue分配给您进行跟踪优化。

贡献新算子

如果您有全新的算子希望基于 NPU 进行设计与实现，欢迎在 Issue 中提出您的想法与设计方案。完整的贡献流程如下：

1. 新增 Issue

请按照提交 Issue / 处理 Issue 任务指引，新建Requirement|需求建议类 Issue，并在其中说明新增算子的设计方案。 Issue 需包含以下内容：

背景信息
价值/作用
设计方案

同时，请在提交的 Issue 中评论/assign或/assign @yourself认领该任务，以便后续完成算子上库。

2. 需求评审

Sig成员将对您提交的 Issue 进行评审并给出修改意见。请在完成修改后，于 Issue 中回复：

“完成意见修改，申请复审”

若需求被接纳，sig成员将为您分配合适的算子分类路径（如：experimental/math），以便您将新增算子提交至对应目录。如在 Issue 交流中未能达成共识，建议申报 SIG 组双周例会，在会议中进行进一步讨论。

3. 提交 PR

在方案确定后，即可开始开发工作。新增算子的交付内容可基于最小交付件结构调整，请参考以下最小交付件进行检查。其中${op_name}为新增算子名称。

${op_class} # 算子分类 ├── ${op_name} # 算子名 │ ├── op_host # 算子定义、Tiling相关实现 │ │ ├── ${op_name}_def.cpp # 算子定义文件 │ │ ├── ${op_name}_tiling.cpp # 算子Tiling实现文件 │ │ └── CMakeLists.txt │ ├── op_kernel # 算子Kernel目录 │ │ ├── ${op_name}.cpp # Kernel入口文件，包含主函数和调度逻辑 │ │ ├── ${op_name}.h # Kernel实现文件，定义Kernel头文件，包含函数说明、结构定义、逻辑实现 │ │ ├── ${op_name}_tiling_data.h # TilingData文件，存储Tiling策略相关配置信息 │ │ └── ${op_name}_tiling_key.h # TilingKey文件，定义Tiling策略的key，标识不同划分方式 │ ├── CMakeLists.txt # 算子编译配置文件，保留原文件即可 │ └── README.md # 算子说明文档 │ └── tests # 算子测试文件 │ │ ├── ut # 算子ut测试文件

开发完成后，请检查以下内容：