CANN/ops-linear-algebra贡献指南
贡献指南【免费下载链接】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测试文件开发完成后请检查以下内容代码交付件完整性含 UT 测试用例代码PR 是否已关联对应 Issue是否签署 CLA通过评论compile指令触发开源仓门禁并依据 CI 检测结果进行修改。如涉及codecheck误报请提交给sig成员屏蔽。门禁通过后请在关联的 Issue 中回复该 Issue 关联的 PRXXX请尽快评审Sig成员检视后将反馈检视意见请完成所有修改后回复该 Issue 关联的 PRXXX已完成 PR 问题整改请尽快评审4. PR 上库Committer 检视通过后Maintainer 将进行最终审核。确认无误后将标注/lgtm和/approve标签合入PR。文档纠错如果您在本项目中发现某些算子文档描述错误欢迎您新建Issue进行反馈和修复。您可以按照提交Issue/处理Issue任务指引新建Documentation|文档反馈类Issue指出对应文档的问题然后在评论框中输入“/assign”或“/assign yourself”将该Issue分配给您纠正对应文档描述。帮助解决他人Issue如果社区中他人遇到的问题您有合适的解决方法欢迎您在Issue中发表评论交流帮助他人解决问题和痛点共同优化易用性。如果对应Issue需要进行代码修改您可以在Issue评论框中输入“/assign”或“/assign yourself”将该Issue分配给您跟踪协助解决问题。【免费下载链接】community本项目是CANN开源社区的核心管理仓库包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息项目地址: https://gitcode.com/cann/community创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考