cann-robotdocs: 修复 issue #1618 反馈的三处文档不一致

文件	最后提交记录	最后更新时间
add_example	fix: 修复 add_example 头文件 include guard 宏名错误 (#1616) Co-authored-by: songkai111<songkai16@huawei.com> # message auto-generated for no-merge-commit merge: !3637 merge fix/add-example-include-guard-1616 into master fix: 修复 add_example 头文件 include guard 宏名错误 (#1616) Created-by: songkai111 Commit-by: songkai111 Merged-by: cann-robot Description: ## 修复内容修复 issue #1616 中反馈的头文件 include guard 宏名错误： 1. add_example_tiling_data.h：include guard 从 `_ROTARY_POSITION_EMBEDDING_GRAD_TILING_DATA_H_`（从其他算子拷贝未修改）改为 `_ADD_EXAMPLE_TILING_DATA_H_` 2. add_example_aicpu/op_graph/add_example_proto.h：include guard 从 `OPS_OP_PROTO_INC_AddEXAMPLE_H_` 改为 `OPS_OP_PROTO_INC_AddEXAMPLEAICPU_H_`，避免与 `add_example` 版本两个不同算子使用相同 include guard 导致冲突 ## 涉及文件 - examples/add_example/op_kernel/add_example_tiling_data.h - examples/add_example_aicpu/op_graph/add_example_proto.h Closes #1616 See merge request: cann/ops-math!3637	1 个月前
add_example_aicpu	fix: 修复 add_example 头文件 include guard 宏名错误 (#1616) Co-authored-by: songkai111<songkai16@huawei.com> # message auto-generated for no-merge-commit merge: !3637 merge fix/add-example-include-guard-1616 into master fix: 修复 add_example 头文件 include guard 宏名错误 (#1616) Created-by: songkai111 Commit-by: songkai111 Merged-by: cann-robot Description: ## 修复内容修复 issue #1616 中反馈的头文件 include guard 宏名错误： 1. add_example_tiling_data.h：include guard 从 `_ROTARY_POSITION_EMBEDDING_GRAD_TILING_DATA_H_`（从其他算子拷贝未修改）改为 `_ADD_EXAMPLE_TILING_DATA_H_` 2. add_example_aicpu/op_graph/add_example_proto.h：include guard 从 `OPS_OP_PROTO_INC_AddEXAMPLE_H_` 改为 `OPS_OP_PROTO_INC_AddEXAMPLEAICPU_H_`，避免与 `add_example` 版本两个不同算子使用相同 include guard 导致冲突 ## 涉及文件 - examples/add_example/op_kernel/add_example_tiling_data.h - examples/add_example_aicpu/op_graph/add_example_proto.h Closes #1616 See merge request: cann/ops-math!3637	1 个月前
add_example_c_api	style: 全仓统一 clang-format 代码格式化 Co-authored-by: songkai111<songkai16@huawei.com> # message auto-generated for no-merge-commit merge: !3345 merge master into master style: 全仓统一 clang-format 代码格式化 Created-by: songkai111 Commit-by: songkai111 Merged-by: cann-robot Description: ## 描述对全仓代码（common、examples、tests 等目录共 113 个文件）统一执行 clang-format 格式化，使代码风格与 `.clang-format` 配置保持一致。本次变更不涉及任何功能逻辑修改，仅涉及缩进、对齐、空格、换行等代码风格调整。涉及的主要目录： - `common/inc/`、`common/src/`：公共头文件及框架插件代码 - `examples/`：示例算子代码 - `tests/`：UT 测试框架及工具代码 ## 关联的Issue #1984 ## 测试代码仅涉及格式化，不影响编译与功能；全量 UT 已通过。 ## 文档更新无 ## 类型标签 - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [ ] 文档更新 - [x] 其他，请描述：代码格式化（clang-format） See merge request: cann/ops-math!3345	1 个月前
fast_kernel_launch_example	link修改commerical为community Co-authored-by: gitcode-chenjiao<chenjiao31@huawei.com> # message auto-generated for no-merge-commit merge: !3874 merge master into master link修改commerical为community Created-by: gitcode-chenjiao Commit-by: gitcode-chenjiao Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 变更点： ① torch_npu名称合一TorchNPU ②《acl API》手册更名修改 ③ link修改commerical为community ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> [#2168](https://gitcode.com/cann/ops-math/issues/2168) ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ok ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> 所有md ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [ x] 文档更新 - [ ] 其他，请描述： See merge request: cann/ops-math!3874	1 个月前
CMakeLists.txt	【描述】解决_add_example_aicpu eager模式下头文件找不到 Co-authored-by: j00427146<jialimin1@huawei.com> # message auto-generated for no-merge-commit merge: !2396 merge issue_1332 into master 【描述】解决_add_example_aicpu eager模式下头文件找不到 Created-by: jialimin1 Commit-by: j00427146 Merged-by: cann-robot Description: ## 描述 1、解add_example_aicpu eager模式下头文件找不到问题 2、修改aclnnLeftShift、aclnnLeftShifts、aclnnTriangularSolve确定性计算说明 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> ## 关联的Issue Issue##1332 <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。--> <!-- 如果这个PR是为了解决特定的问题单，请在这里描述问题单单号。--> ## 测试修复前： ![image.png](https://raw.gitcode.com/user-images/assets/7649531/5a6c7b8b-6850-46e5-9a5c-a8432396b480/image.png 'image.png') 修复后： ![image.png](https://raw.gitcode.com/user-images/assets/7649531/5e847575-51d8-4e10-908a-ef1c4c74a924/image.png 'image.png') <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] Bug修复 - [ ] 新特性 - [ ] 性能优化 - [ ] 文档更新 - [ ] 其他，请描述： See merge request: cann/ops-math!2396	3 个月前
README.md	docs: 修复 issue #1618 反馈的三处文档不一致 Co-authored-by: chensi79@huawei.com<chensi79@huawei.com> # message auto-generated for no-merge-commit merge: !4024 merge fix/issue-1618-docs-fixes into master docs: 修复 issue #1618 反馈的三处文档不一致 Created-by: chensi79 Commit-by: chensi79@huawei.com Merged-by: cann-robot Description: ## 描述本 PR 修复 Issue #1618 反馈的三处文档不一致问题，全部为纯文档修改，不涉及代码逻辑： - `examples/README.md`：在"目录说明"的目录树中补全 `fast_kernel_launch_example` 子目录，使其与下方样例表格保持一致。 - `docs/zh/develop/aicpu_develop_guide.md`：修正第 140 行链接，URL 由 `add_example.json` 改为 `add_example_aicpu.cpp`，与链接文本保持一致（链接目标文件已在仓库中确认存在）。 - `docs/zh/install/quick_install.md`：将 `spack install` 命令中的 Spack 包名 `cann-ops` 改为 `cann-ops-math`，与 `spack/prepare_cann_env.sh` 中 `DEFAULT_PACKAGE_NAME="cann-ops-math@master +pkg"` 及同文件 `spack location -i cann-ops-math` 命令保持一致。涉及文件中由 pre-commit `trailing-whitespace` hook 自动清理了行尾空格，无功能性变更。 ## 关联的Issue https://gitcode.com/cann/ops-math/issues/1618 ## 测试纯文档修改，未涉及代码逻辑，无相关单元测试可运行；已通过以下方式人工核对： - 目录树新增行与 L44 表格描述对齐。 - `scripts/opgen/template/add_example_aicpu/op_kernel_aicpu/add_example_aicpu.cpp` 文件在仓库中确实存在。 - Spack 包名修改与 `spack/prepare_cann_env.sh` 中的 `DEFAULT_PACKAGE_NAME` 一致。 ## 文档更新 - `examples/README.md`：补全 `fast_kernel_launch_example` 子目录说明。 - `docs/zh/develop/aicpu_develop_guide.md`：修正 L140 链接 URL。 - `docs/zh/install/quick_install.md`：统一 Spack 包名。 ## 类型标签 - [x] 文档更新 See merge request: cann/ops-math!4024	28 天前

简介

说明：

目前算子库中大部分算子运行在AI Core上，少部分算子运行在AI CPU上。默认情况下，项目中提到的算子指AI Core算子。

关于AI Core和AI CPU的介绍请参见《Ascend C算子开发》中“概念原理和术语 > 硬件架构与数据处理原理”。

本项目提供了AI Core算子和AI CPU算子的开发和调用样例，请开发者根据实际情况参考对应实现。

目录说明

├── examples
│   ├── add_example                # AI Core算子名
│   │   ├── CMakeLists.txt         # 算子编译配置文件，保留原文件即可
│   │   ├── examples               # 算子使用示例
│   │   ├── op_graph               # 算子构图相关目录
│   │   ├── op_host                # 算子信息库、Tiling、InferShape相关实现
│   │   └── op_kernel              # 算子kernel目录
│   ├── add_example_c_api          # AI Core C API算子名（使用C API/asc_simd开发kernel）
│   │   ├── CMakeLists.txt         # 算子编译配置文件，保留原文件即可
│   │   ├── examples               # 算子使用示例
│   │   ├── op_graph               # 算子构图相关目录
│   │   ├── op_host                # 算子信息库、Tiling、InferShape相关实现
│   │   └── op_kernel              # 算子kernel目录（C API风格）
│   ├── add_example_aicpu          # AI CPU算子名
│   │   ├── CMakeLists.txt         # 算子编译配置文件，保留原文件即可
│   │   ├── examples               # 算子使用示例
│   │   ├── op_graph               # 算子构图相关目录
│   │   ├── op_host                # 算子信息库、InferShape相关实现
│   │   └── op_kernel_aicpu        # 算子kernel目录
│   ├── fast_kernel_launch_example # PyTorch场景下快速端到端开发算子的样例
│   ├── CMakeLists.txt             # 算子编译配置文件，保留原文件即可
│   └── README.md                  # 算子说明文档

算子开发样例

样例目录	样例介绍	算子开发	算子调用
add_example	实现两个张量相加功能的算子。	算子端到端开发过程参见AI Core算子开发指南	调用参见README
add_example_c_api	实现两个张量相加功能的算子，kernel使用C API（asc_simd）开发方式。	算子端到端开发过程参见AI Core算子开发指南	调用参见README
add_example_aicpu	实现两个张量相加功能的算子。	算子端到端开发过程参见AI CPU算子开发指南	调用参见README
fast_kernel_launch_example	实现一种PyTorch场景下快速端到端开发算子的样例。	算子端到端开发过程参见PyTorch算子快速开发指南	调用参见README