贡献指南【免费下载链接】cann-recipes-train本项目针对LLM与多模态模型训练业务中的典型模型、加速算法提供基于CANN平台的优化样例项目地址: https://gitcode.com/cann/cann-recipes-train本项目欢迎广大开发者体验并参与贡献。在参与社区贡献之前请参见cann-community了解行为准则、签署CLA协议并熟悉源码仓的贡献流程。开发者在准备本地代码与提交PR时请重点关注以下几点PR描述提交PR时请按照模板仔细填写业务背景、目的、方案等信息。重大修改讨论若涉及到新增特性、新增接口、新增配置参数或者修改代码流程等请务必先通过Issue进行方案讨论以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为“简单的bug修复”亦可通过提交Issue进行方案讨论。开发者贡献场景主要包括反馈BUG、建议特性、改进文档、修复问题、新增样例。新增样例流程感谢您参与样例建设为了确保贡献顺畅建议您遵循“RFC讨论 - 代码开发 - 提交PR”的流程1. 提交 RFC达成方案共识在正式开发前建议先提交 Issue 进行 RFC请求评议包含背景与动机解决什么场景需求提供什么参考价值。核心设计技术思路、关键模块模型选型、流程架构等。预期目标核心功能、精度指标或性能表现。排期预计完成时间。2. 开发规范重点在开始编码前请务必遵循以下目录结构与代码风格要求。2.1 样例目录结构规范样例代码以模型为单位组织如qwen3。修改原则大修改完整替换/Monkey Patch针对文件修改量大或逻辑复杂的情况请在patches/框架名下复刻原仓目录结构放置修改后的完整 Python 文件。小修改Git Patch针对少量代码修改Bugfix/参数调整请基于特性Feature粒度将多个文件修改合并为一个.patch文件置于patches/框架名根目录下。Patch 命名规范编号-框架名-类型-特性名.patch类型feature或bugfix特性名全小写下划线连接示例0001-verl-feature-enable_alltoall_overlap.patch目录结构示例qwen3 # 样例名 ├── patches # 修改补丁总目录 │ ├── verl # 框架A (如 verl) │ │ ├── trainer # [大修改] 目录对应原仓路径 │ │ │ └── verl_trainer_adaptor.py # 完整替换或Monkey Patch文件 │ │ ├── utils # [大修改] 目录对应原仓路径 │ │ │ └── ... │ │ └── 0001-verl-feature-enable_alltoall_overlap.patch # [小修改] 特性粒度 patch │ └── vllm_ascend # 框架B(如vllm_ascend) │ └── ... ├── internal # 框架无关的内部文件 ├── Dockerfile # 环境部署文件 ├── prelude_patch.py # Monkey Patch 加载的入口文件如有 ├── requirements.txt # 依赖库需锁定版本 └── README.md # 说明文档2.2 代码风格请使用pre-commit工具确保代码满足基本规范安装后会在 git commit 时自动检查pip install pre-commit pre-commit install2.3 patch校验请在项目根目录下cann-recipes-train/执行./ci/validate_all_projects.sh以验证patch文件命名规范并确保项目能够基本构建。 基本构建包含以下步骤下载样例所需的框架代码如verl, vllm, vllm_ascend等。将框架代码复制到样例文件夹下复刻原仓目录结构。依次用git apply应用所有patch确保改动能够正确应用没有冲突。3. 提交 PR完善交付内容方案达成共识且代码开发完成后请提交 PR 并关联 RFC Issue。PR 内容需包含样例代码符合上述目录规范并通过流水线 code check。优化文档说明功能适配、性能优化的重点原因、方法、收益。README文档简述核心内容模型、设备、精度/性能数据。操作步骤详细的复现流程从环境准备到执行。贡献注意事项为了避免合入时的波折请检查以下细节无二进制文件除必要的文档配图外代码库中不应包含二进制文件。数据集涉及第三方数据集时仅在文档说明下载和使用方式勿直接提交数据集。公共代码验证若修改涉及公共代码需确保通过 CI 验证。算子依赖涉及算子新增或修改请先合入算子仓再推进样例合入。License 合规检查使用的 License 是否合规推荐 Apache 2.0 或 MIT并正确标注版权。如有任何疑问欢迎在社区交流。再次感谢您的支持【免费下载链接】cann-recipes-train本项目针对LLM与多模态模型训练业务中的典型模型、加速算法提供基于CANN平台的优化样例项目地址: https://gitcode.com/cann/cann-recipes-train创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
CANN训练样例贡献指南
发布时间：2026/7/18 21:53:27
贡献指南【免费下载链接】cann-recipes-train本项目针对LLM与多模态模型训练业务中的典型模型、加速算法提供基于CANN平台的优化样例项目地址: https://gitcode.com/cann/cann-recipes-train本项目欢迎广大开发者体验并参与贡献。在参与社区贡献之前请参见cann-community了解行为准则、签署CLA协议并熟悉源码仓的贡献流程。开发者在准备本地代码与提交PR时请重点关注以下几点PR描述提交PR时请按照模板仔细填写业务背景、目的、方案等信息。重大修改讨论若涉及到新增特性、新增接口、新增配置参数或者修改代码流程等请务必先通过Issue进行方案讨论以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为“简单的bug修复”亦可通过提交Issue进行方案讨论。开发者贡献场景主要包括反馈BUG、建议特性、改进文档、修复问题、新增样例。新增样例流程感谢您参与样例建设为了确保贡献顺畅建议您遵循“RFC讨论 - 代码开发 - 提交PR”的流程1. 提交 RFC达成方案共识在正式开发前建议先提交 Issue 进行 RFC请求评议包含背景与动机解决什么场景需求提供什么参考价值。核心设计技术思路、关键模块模型选型、流程架构等。预期目标核心功能、精度指标或性能表现。排期预计完成时间。2. 开发规范重点在开始编码前请务必遵循以下目录结构与代码风格要求。2.1 样例目录结构规范样例代码以模型为单位组织如qwen3。修改原则大修改完整替换/Monkey Patch针对文件修改量大或逻辑复杂的情况请在patches/框架名下复刻原仓目录结构放置修改后的完整 Python 文件。小修改Git Patch针对少量代码修改Bugfix/参数调整请基于特性Feature粒度将多个文件修改合并为一个.patch文件置于patches/框架名根目录下。Patch 命名规范编号-框架名-类型-特性名.patch类型feature或bugfix特性名全小写下划线连接示例0001-verl-feature-enable_alltoall_overlap.patch目录结构示例qwen3 # 样例名 ├── patches # 修改补丁总目录 │ ├── verl # 框架A (如 verl) │ │ ├── trainer # [大修改] 目录对应原仓路径 │ │ │ └── verl_trainer_adaptor.py # 完整替换或Monkey Patch文件 │ │ ├── utils # [大修改] 目录对应原仓路径 │ │ │ └── ... │ │ └── 0001-verl-feature-enable_alltoall_overlap.patch # [小修改] 特性粒度 patch │ └── vllm_ascend # 框架B(如vllm_ascend) │ └── ... ├── internal # 框架无关的内部文件 ├── Dockerfile # 环境部署文件 ├── prelude_patch.py # Monkey Patch 加载的入口文件如有 ├── requirements.txt # 依赖库需锁定版本 └── README.md # 说明文档2.2 代码风格请使用pre-commit工具确保代码满足基本规范安装后会在 git commit 时自动检查pip install pre-commit pre-commit install2.3 patch校验请在项目根目录下cann-recipes-train/执行./ci/validate_all_projects.sh以验证patch文件命名规范并确保项目能够基本构建。 基本构建包含以下步骤下载样例所需的框架代码如verl, vllm, vllm_ascend等。将框架代码复制到样例文件夹下复刻原仓目录结构。依次用git apply应用所有patch确保改动能够正确应用没有冲突。3. 提交 PR完善交付内容方案达成共识且代码开发完成后请提交 PR 并关联 RFC Issue。PR 内容需包含样例代码符合上述目录规范并通过流水线 code check。优化文档说明功能适配、性能优化的重点原因、方法、收益。README文档简述核心内容模型、设备、精度/性能数据。操作步骤详细的复现流程从环境准备到执行。贡献注意事项为了避免合入时的波折请检查以下细节无二进制文件除必要的文档配图外代码库中不应包含二进制文件。数据集涉及第三方数据集时仅在文档说明下载和使用方式勿直接提交数据集。公共代码验证若修改涉及公共代码需确保通过 CI 验证。算子依赖涉及算子新增或修改请先合入算子仓再推进样例合入。License 合规检查使用的 License 是否合规推荐 Apache 2.0 或 MIT并正确标注版权。如有任何疑问欢迎在社区交流。再次感谢您的支持【免费下载链接】cann-recipes-train本项目针对LLM与多模态模型训练业务中的典型模型、加速算法提供基于CANN平台的优化样例项目地址: https://gitcode.com/cann/cann-recipes-train创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
