Merged
refactor: 统一代码风格并修正Add算子文档及测试脚本 #7417
cai-chengchaoAdd on 3 days ago
refactor: 统一代码风格并修正Add算子文档及测试脚本 #7417
Merged
cai-chengchaoAdd on 3 days ago
cai-chengchaoCollaborators
3 days ago

描述

本次改动统一了 ops-math 仓库部分公共头文件与单元测试头文件的代码格式,并修正了 Add 算子的文档注释与测试脚本实现。

改动原因

  1. common/inc 下 aicpu、op_host、aclnn_kernels 公共头文件以及 tests/ut 下单元测试头文件的代码格式不统一,部分文件末尾缺少换行符,不满足 clang-format 规范。
  2. Add 算子的 README(中英文)中公式张量下标、算子调用方式描述不准确,Doxygen 注释中参数方向标注有误。
  3. Add 算子测试 golden 脚本中 complex32 类型的基准值计算使用 numpy 实现,与文件内其他数据类型(torch 实现)不一致。

改动方法

  1. 代码格式统一:对 common/inc/aicpu/math_aicpu_register.h、common/inc/external/aclnn_kernels/common/op_error_check.h、common/inc/op_host/math_tiling_templates_registry.h 及 tests/ut 下相关头文件按 clang-format 重新排版,并补齐文件末尾换行符。
  2. 文档修正:
    • math/add/README.md、math/add/README_en.md:修正公式输入/输出张量下标格式(x_1 → x1),修正“调用方式”表格(aclnn调用 → aclnn API,图模式调用 → GE图模式),补充编译验证文档链接。
    • math/add/op_api/aclnn_add.h:修正 Doxygen 参数方向标注(@param [in] out → @param [out] out,@param [in] self → @param [in/out] selfRef)。
  3. 测试脚本重构:math/add/tests/assets/golden.py 中 complex32 类型的 golden 基准计算由 numpy 改为 torch.complex 实现,与其他类型保持一致,并为 golden 方法补充 @staticmethod 装饰器。

关联的Issue

测试

  • 涉及公共头文件格式调整与测试 golden 脚本逻辑等价重构,需回归 Add 算子的二级冒烟与算子泛化测试。

文档更新

  • 更新 math/add/README.md、math/add/README_en.md。
  • 修正 math/add/op_api/aclnn_add.h 接口注释。

类型标签

likedislike
Pull Request has been successfully merged by CANN-robot.
(Thank you for cai-chengchao's contribution.)
Ccai-chengchaoCollaborators
3 days ago Created pull request, commit 8faf8dc8
atomgit-bot
atomgit-bot
3 days ago Comments:

变更摘要

本次改动以格式整理为主、少量语义修正为辅,主要围绕 math/add 算子的 aclnn 接口与测试资产:调整了 golden.py 中 complex32 黄金数据的计算方式(改用 torch 复数运算),修正了 aclnn_add.h 的参数方向注释,并将两个测试类的 golden 方法改为静态方法;同时 common/inc 下的注册宏、校验宏以及 tests/ut 下多个公共头文件被重新按新对齐方式排版,并补上文件末尾缺失的换行符。

主要改动

  • complex32 黄金值生成改用 torch: math/add/tests/assets/golden.py 的 AddTestSpec 中该分支不再用 numpy 复数逐元素拼接,而是先经 numpy_to_torch_tensor 转换,再用 torch.complex、torch.add、torch.stack 计算并通过 torch_to_numpy_tensor 输出。
  • 测试 golden 方法声明为静态方法: AclnnAddTestSpec.golden 与 AclnnAddV3TestSpec.golden 增加 @staticmethod 装饰器,签名与参数语义保持不变。
  • aclnnAdd 接口注释方向修正: math/add/op_api/aclnn_add.h 中 out 参数由 [in] 改为 [out],原地接口的首个参数说明改为 [in/out] selfRef。
  • 注册宏与检查宏的格式化重排: common/inc/aicpu/math_aicpu_register.h 的 OPS_MATH_REGISTER_CPU_KERNELV2、common/inc/op_host/math_tiling_templates_registry.h 的 REGISTER_TILING_TEMPLATE_WITH_SOCVERSION、REGISTER_OPS_TILING_TEMPLATE 等宏及 OP_LOGE/OP_CHECK_IF 调用仅调整换行与缩进,逻辑不变。
  • 测试公共头文件签名换行与末尾换行补齐: tests/ut/common 与 tests/ut/op_api/op_api_ut_common 下的 TilingContextPara/TilingContextFaker、OpApiUt、SaveResultToBinaryFile 等声明合并换行参数列表,并为多个头文件补上文件末尾换行符。

🧩 本次 Review 已使用自定义 Skill:

likedislike
Incorrect?
atomgit-bot
atomgit-bot
3 days ago Comments:

代码审查

✅ 未发现问题


🧩 本次 Review 已使用自定义 Skill:

likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
3 days ago Added label: cann-cla/yes
CANN-robot
CANN-robotCollaborators
3 days ago Comments:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here.
You can get sig-info at here.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.


PR Approval Progress

✅ Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
*/*/README.md ✅ 陈娇, 顾宝成, 张磊 (3/2) ✅ 陈娇 (1/1)
*/*/op_api/*.h ✅ 王永光, 顾宝成, 张磊 (3/2) ✅ 王永光 (1/1)
math/add ✅ 张磊, 顾宝成 (2/2) ✅ 张磊, 顾宝成 (2/1)
repo-cann/ops-math ✅ 张磊, 顾宝成 (2/2) ✅ 张磊, 顾宝成 (2/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)
likedislike
CANN-robot
CANN-robotCollaborators
3 days ago Comments:

CLA Signature Pass

cai-chengchao, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robotCANN-robotCollaborators
3 days ago Set FelixTang7,yue-ma,zhou-qilong,gitee-duhuiping,wangrui_,rxtfeng,loov1,tang-lei01,zhangzijie,jia0liang,zl_hw,songkai111,gitcode-chenjiao,chenxingyu18,lwx1255555,pingchuantang,llimwang,gubaocheng,andong_hw,wangyongguang,fengying555682,xuejinghui,onanfield,zhanw_coding,jiangjiawei,clinglai0517,caiwenwen,yanglu-1 as approver
CANN-robotCANN-robotCollaborators
3 days ago Set FelixTang7,yue-ma,zhou-qilong,gitee-duhuiping,wangrui_,rxtfeng,loov1,tang-lei01,zhangzijie,jia0liang,zl_hw,songkai111,gitcode-chenjiao,chenxingyu18,lwx1255555,pingchuantang,llimwang,gubaocheng,andong_hw,wangyongguang,fengying555682,xuejinghui,onanfield,zhanw_coding,jiangjiawei,clinglai0517,caiwenwen,yanglu-1 as approver
Ccai-chengchaoCollaborators
3 days ago Change title to "refactor: 统一代码风格并修正Add算子文档及测试脚本", originally titled "fix".
Ccai-chengchaoCollaborators
3 days ago Modify description of pull request
cai-chengchaoCollaborators
3 days ago Comments:

compile

likedislike
Ccai-chengchaoCollaborators
3 days ago Pre merge succeeded (commit_id: a188568167d82b7aea25ba006f7fc7db0aeddd42)
CANN-robot
CANN-robotCollaborators
3 days ago Comments:
🚀 CI 流水线已启动
📋 执行详情: 点击查看流水线
likedislike
CANN-robotCANN-robotCollaborators
3 days ago Added label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
3 days ago Removed label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
3 days ago Added label: ci-pipeline-passed
gubaochengCollaborators
3 days ago Comments:

/lgtm
/approve
by agent

likedislike
chenyifengCollaborators
2 days ago Comments:

您好,PR已满足合入指标,请尽快联系Committer进行合入。如暂时不需要合入,请在PR标题前加[WIP]

likedislike
Ccai-chengchaoCollaborators
17 hours ago Modify description of pull request
chenjiaoCollaborators
14 hours ago Comments:

/approve

likedislike
wangyongguangCollaborators
14 hours ago Comments:

/approve

likedislike
CANN-robotCANN-robotCollaborators
14 hours ago Added label: approved
zl_hwCollaborators
12 hours ago Comments:

/lgtm
/approve

likedislike
CANN-robotCANN-robotCollaborators
12 hours ago Added label: lgtm
CANN-robotCANN-robotCollaborators
12 hours ago Closed associated issue
CANN-robotCANN-robotCollaborators
12 hours ago Merged pull request