CANN空间智能样例贡献指南
贡献指南【免费下载链接】cann-recipes-spatial-intelligence本项目针对空间智能业务中的典型模型、加速算法提供基于CANN平台的优化样例项目地址: https://gitcode.com/cann/cann-recipes-spatial-intelligence本项目欢迎广大开发者体验并参与贡献在参与社区贡献之前。请参见cann-community了解行为准则进行CLA协议签署了解源码仓的贡献流程。开发者准备本地代码与提交PR时需要重点关注如下几点提交PR时请按照PR模板仔细填写本次PR的业务背景、目的、方案等信息。若您的修改不是简单的bug修复而是涉及到新增特性、新增接口、新增配置参数或者修改代码流程等请务必先通过Issue进行方案讨论以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为“简单的bug修复”亦可通过提交Issue进行方案讨论。开发者贡献场景主要包括反馈BUG建议特性改进文档修复问题新增样例代码风格请使用pre-commit工具确保代码满足基本要求安装后会在git commit时自动检查当前提交的代码规范问题。pip install pre-commit pre-commit install新增样例要求感谢您参与样例建设为cann-recipes注入更多价值为了让您的贡献过程更顺畅、方案能更好地契合社区需求以下是详细的操作指引供您参考提交 RFC达成方案共识在正式开发前建议您先提交一份RFC请求评议文档通过创建ISSUE的方式提交方便与其他开发者充分交流方案细节、达成共识。RFC中辛苦您至少包含以下内容样例的背景和动机比如该样例解决了什么场景下的需求、能为其他开发者提供哪些参考价值核心设计方案简要说明样例的技术思路、关键模块设计如模型选型、流程架构等预期达成的功能性能目标例如样例需实现的核心功能、预期的精度指标或性能表现预计完成时间方便社区了解开发进度也便于后续协同支持。提交PR完善交付内容当方案共识达成后您可以提交对应的PR并记得关联到之前的RFC。为确保样例质量和可复用性PR中辛苦您至少包含以下内容样例代码请确保代码风格符合社区基本要求且能通过流水线的code check让后续开发者更容易理解和使用优化文档麻烦您详细说明样例在功能适配、性能优化过程中的重点内容比如“为什么要做这个优化点”、“用了什么方法实现”、“优化后带来了哪些具体收益如性能提升X%”README文档这是帮助其他开发者快速上手的关键需要包含两部分简述当前样例的核心内容比如用到的模型、支持的执行设备、已验证的精度/性能信息等操作步骤请尽量详细地描述从环境准备到执行样例的全流程确保其他开发者能顺利复现结果。一些小提醒让贡献更顺利为了避免后续合入时的小波折还有几个小细节想跟您同步除了README或文档中需要的配图合入的代码里请不要包含二进制文件如果样例涉及第三方数据集的使用只需在文档中说明数据集的下载方式、使用方法即可无需直接提供数据集如果您的修改涉及公共代码非仅样例内部代码需要确保能通过CI样例的验证如果样例开发过程中涉及算子的新增或修改麻烦先将对应的算子变更合入到算子仓再推进样例合入。请检查您样例所使用的LICENSE是否合规建议使用Apache 2.0或MIT等协议并按照实际情况标注版权信息样例目录结构参考样例需要合入到contrib目录下您可以参考以下结构组织您的代码和文档样例名建议全部小写多个单词之间用短中划线连接比如qwen3-moe├── contrib # 开发者贡献样例目录 | ├── sample1 # 您的样例名如qwen3-moe | | ├── doc # doc目录存放优化文档、配图等 | | ├── src # src目录存放样例代码 | | ├── README.md # 上述提到的README文档 | | └── ... # 其他必要文件如环境配置文件等 | ├── sample2 │ └── ...如果在贡献过程中有任何疑问随时欢迎在社区中交流再次感谢您的支持期待您的精彩样例【免费下载链接】cann-recipes-spatial-intelligence本项目针对空间智能业务中的典型模型、加速算法提供基于CANN平台的优化样例项目地址: https://gitcode.com/cann/cann-recipes-spatial-intelligence创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考