Star0
0
代码
代码
Issues
Pull Requests
Actions
项目讨论
Wiki
分析
Star0
0
cann-robotcann-robotdocs: 完善 QuickStart 与 Docker 环境部署文档
7001cfe1创建于 8月4日历史提交
文件最后提交记录最后更新时间
zh
docs: 完善 QuickStart 与 Docker 环境部署文档 Co-authored-by: yolic<chenyuning1@huawei.com> # message auto-generated for no-merge-commit merge: !8218 merge 0803readme into master docs: 完善 QuickStart 与 Docker 环境部署文档 Created-by: yolic Commit-by: yolic Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 完善 ops-nn 快速入门与环境部署文档，对齐近期 math 仓同类文档修正，并结合本仓样例代码做适配（非全量照抄）。 ### QUICKSTART.md - 补充编译前需 source set_env.sh 配置 CANN 环境变量的说明 - DumpTensor 示例改为贴合 Compute 函数上下文 - 性能采集由 msprof 改为 msprof op，并更新结果目录（OPPROF_*）与参考链接 - 算子验证章节将 selfZ 更正为 out，并补充修改 shape 时需同步 host vector 长度的提示 ### quick_install.md - Docker 适用范围由“仅 A2、仅 Ubuntu”更正为 A2/A3、ubuntu22.04/openeuler24.03 - 默认示例镜像由 openEuler24.03 调整为 ubuntu22.04 - 补充 -devel 开发镜像说明、镜像标签取值查询指引及 --name 自定义容器名提醒 - 完善驱动安装说明（安装步骤与表述），并同步调整相关用语 ### 说明 - 本仓 add_example 样例输入仍为全 1，因此未照搬 math 仓“递增序列/随机数”相关预期输出与 selfX 数据说明，避免文档与源码不一致 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> ## 测试 <!--描述进行了哪些测试来验证你的改动。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> 更新了quick start和quick install ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： ## AI/Agent生成声明 <!-- [x] 表示选中 --> - [ ] AI辅助编写 See merge request: cann/ops-nn!8218
1 个月前
CONTRIBUTING_DOCS.md
fix: Modify the AIDD docs issue Co-authored-by: zwj223<zhangwenjing55@h-partners.com> # message auto-generated for no-merge-commit merge: !8149 merge master into master fix: Modify the AIDD docs issue Created-by: zwj223 Commit-by: zwj223 Merged-by: cann-robot Description: ## 描述 修改AIDD扫描的核心资料问题 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> [#3939](https://gitcode.com/cann/ops-nn/issues/3939) ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： ## AI/Agent生成声明 <!-- [x] 表示选中 --> - [ ] AI辅助编写 See merge request: cann/ops-nn!8149
1 个月前
QUICKSTART.md
docs: 完善 QuickStart 与 Docker 环境部署文档 Co-authored-by: yolic<chenyuning1@huawei.com> # message auto-generated for no-merge-commit merge: !8218 merge 0803readme into master docs: 完善 QuickStart 与 Docker 环境部署文档 Created-by: yolic Commit-by: yolic Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 完善 ops-nn 快速入门与环境部署文档，对齐近期 math 仓同类文档修正，并结合本仓样例代码做适配（非全量照抄）。 ### QUICKSTART.md - 补充编译前需 source set_env.sh 配置 CANN 环境变量的说明 - DumpTensor 示例改为贴合 Compute 函数上下文 - 性能采集由 msprof 改为 msprof op，并更新结果目录（OPPROF_*）与参考链接 - 算子验证章节将 selfZ 更正为 out，并补充修改 shape 时需同步 host vector 长度的提示 ### quick_install.md - Docker 适用范围由“仅 A2、仅 Ubuntu”更正为 A2/A3、ubuntu22.04/openeuler24.03 - 默认示例镜像由 openEuler24.03 调整为 ubuntu22.04 - 补充 -devel 开发镜像说明、镜像标签取值查询指引及 --name 自定义容器名提醒 - 完善驱动安装说明（安装步骤与表述），并同步调整相关用语 ### 说明 - 本仓 add_example 样例输入仍为全 1，因此未照搬 math 仓“递增序列/随机数”相关预期输出与 selfX 数据说明，避免文档与源码不一致 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> ## 测试 <!--描述进行了哪些测试来验证你的改动。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> 更新了quick start和quick install ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x] 文档更新 - [ ] 其他，请描述： ## AI/Agent生成声明 <!-- [x] 表示选中 --> - [ ] AI辅助编写 See merge request: cann/ops-nn!8218
1 个月前
README.md
docs目录基本概念md中文名改为英文名 Co-authored-by: chenjiao<chenjiao31@huawei.com> # message auto-generated for no-merge-commit merge: !7857 merge master into master docs目录基本概念md中文名改为英文名 Created-by: gitcode-chenjiao Commit-by: gitcode-chenjiao;chenjiao Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> docs目录基本概念md文件名改为英文： 避免link中的中文字符引发的跳转异常，例如两段式接口.md变成%E4%B8%A4%E6%AE%B5%E5%BC%8F%E6%8E%A5%E5%8F%A3.md，不易于维护，可能导致其他平台跳转有问题。 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #000--> [#4260](https://gitcode.com/cann/ops-nn/issues/4260) ## 测试 <!--描述进行了哪些测试来验证你的改动。--> ok ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> docs/zh/context所有md和对应的link ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [x ] 文档更新 - [ ] 其他，请描述： ## AI/Agent生成声明 <!-- [x] 表示选中 --> - [ ] AI辅助编写 See merge request: cann/ops-nn!7857
2 个月前
README

文档中心

目录结构

Docs目录结构说明如下：

├── zh
  ├── context                            # 公共文档，如术语、基础概念等
  ├── debug                              # 算子调试指导文档
  │   ├── op_debug_prof.md
  │   ├── ...
  ├── develop                            # 算子开发指导文档
  │   ├── aicore_develop_guide.md
  │   ├── aicpu_develop_guide.md
  │   ├── ...
  ├── figures                            # 图片目录
  ├── install                            # 环境安装和编译指导文档
  │   ├── build.md
  │   ├── compile.md
  │   ├── quick_install.md
  │   └── ...
  ├── invocation                         # 算子调用指导文档（包括aclnn调用、图模式调用等）
  │   ├── quick_op_invocation.md
  │   ├── ...
  ├── menu_aclnn_api.md                  # 全量aclnn接口索引文件
  ├── op_api_list.md                     # 全量aclnn接口列表
  ├── op_list.md                         # 全量算子列表
├── CONTRIBUTING_DOCS.md                 # 文档贡献说明
├── QUICKSTART.md                        # 快速入门
└── README.md

进阶教程

指南类文档

文档 说明
源码构建指南 介绍联网/未联网场景下不同的源码构建方式和验证方法。
算子调用指南 介绍调用算子样例方法和不同算子调用方式（如PyTorch/aclnn/图等）。
标准算子开发指南 介绍如何基于标准工程定义算子原型、实现Tiling和Kernel，此类算子称为“标准算子”。
标准算子支持aclnn和图模式调用。
简易算子开发指南 介绍如何基于简易工程实现fast_kernel_launch，即<<<>>>方式，此类算子称为“简易算子”。
简易算子仅支持PyTorch调用。
算子调试调优 介绍常见的算子功能调试和性能调优方法（如数据采集和仿真流水等）。

API类文档

文档 说明
算子列表 介绍项目包含的所有算子清单。
aclnn列表 介绍项目包含的所有算子aclnn API清单。为方便用户在Host侧调用算子，提供了C语言API，即aclnn前缀的API。

工具类文档

文档 说明
Simulator仿真工具 面向算子开发场景的SoC级仿真工具，用于分析运行在AI仿真器上AI任务在各阶段精度和性能数据。

更多文档

附录

文档 说明
算子基本概念 介绍算子领域相关的基础概念和术语，如量化/稀疏、数据类型、数据格式等。
build参数说明 介绍本项目build.sh参数功能和取值，包括源码编译、算子调用、调试等。