欢迎来到昇腾VERL的官方文档中心!
本项目是 VERL 训练框架在 昇腾(Ascend) AI 平台的官方文档资源库。我们致力于为全球开发者提供最全面、最精准、最易于上手的学习资源,帮助您在昇腾硬件上高效地使用 VERL 进行 AI 模型训练。
本文档遵循 "Docs-as-Code" 的理念,将所有文档源文件在GitCode上进行版本管理,并通过CI/CD流水线自动构建和发布。这不仅确保了文档与代码的同步更新,也使社区贡献变得前所未有的简单。
注意: 请将上方链接替换为您通过 GitCode Pages 部署后生成的实际URL。
我们的文档库经过精心规划,覆盖了开发者从入门到精通的全链路学习路径:
-
🚀 快速入门 (Tutorials): 手把手教学,助您在30分钟内完成从环境配置到第一个模型的训练,快速获得成功体验。
-
🔧 核心指南 (How-to Guides): 面向目标的实战手册,针对特定任务提供清晰的步骤指导,如如何开启混合精度、如何实现分布式训练等。
-
🔬 原理剖析 (Explanation): 深入浅出地讲解VERL在昇腾后端的工作机制与设计哲学,帮助您知其然,更知其所以然。
-
📚 API参考 (Reference): 提供详尽、准确的API查询手册,是您开发过程中的权威参考。
我们热烈欢迎并鼓励社区开发者共同参与本文档的建设,任何形式的贡献都是对社区的宝贵价值!无论是修正一个错别字,优化一句表达,还是撰写一篇全新的教程,我们都无任欢迎。
贡献流程非常简单:
- 发现问题或有新想法? 在本仓库的 Issues 页面提出您的建议。
- Fork 本仓库 到您自己的账户下。
- 创建新的分支 (e.g.,
feature/add-resnet-guideorfix/typo-in-quickstart)。 - 在您的分支上进行修改和内容撰写。
- 提交一个 Pull Request (PR) 到本仓库的
main分支,并清晰描述您的修改内容。
我们会尽快Review您的PR,一经合并,您的贡献将自动发布到官方文档网站,并出现在贡献者列表中!
如果您在阅读文档时发现任何问题(如事实错误、描述不清、链接失效等),或对文档有任何改进建议,请毫不犹豫地通过本仓库的 Issues 页面 提交反馈。
本项目遵循 MIT 开源许可协议。