Closed
[Requirement|需求建议]: 统一代码风格并修正 Add 算子文档及测试脚本 #4787
cai-chengchaoAdd on  17 hours agoClosed at  12 hours ago
cai-chengchaoCollaborators
17 hours ago Create

一、背景信息

ops-math 仓库存在以下待统一/修正的内容:

  1. 公共头文件与单元测试头文件代码格式不统一:common/inc 下 aicpu、op_host、aclnn_kernels 公共头文件以及 tests/ut 下单元测试头文件,部分文件末尾缺少换行符,不满足 clang-format 规范。
  2. Add 算子文档描述不准确:math/add/README.md、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. Add 算子测试 golden 脚本实现不一致:math/add/tests/assets/golden.py 中 complex32 类型基准值使用 numpy 实现,与文件内其他数据类型(torch 实现)不一致。

二、价值/作用

  1. 统一代码格式,提升可读性与可维护性,满足 clang-format 规范。
  2. 修正文档表述,使公式下标、调用方式与 Doxygen 参数方向标注准确。
  3. 统一 golden 测试实现方式,降低维护成本。

三、设计方案

3.1 使能方式(涉及哪些框架:如Aclnn直调、Pytorch训练等)

Add 算子支持 aclnn API 调用与 GE 图模式调用(见 math/add/README.md 调用方式表格)。

3.2 总体设计
3.2.1 算子支持的数据类型

BOOL、INT8、INT16、INT32、INT64、UINT8、FLOAT64、FLOAT16、BFLOAT16、FLOAT32、COMPLEX128、COMPLEX64(见 math/add/README.md)。

3.2.2 host侧设计

对 common/inc/op_host 下头文件仅做 clang-format 格式调整与换行符补齐,不改变 host 侧逻辑。

3.2.3 kernel侧设计

本次改动不涉及 kernel 侧逻辑变更。

3.3 支持硬件

本次改动不涉及硬件适配变更。

3.4 算子约束限制

本次改动不涉及算子约束的放宽或收紧。

关联 PR:https://gitcode.com/cann/ops-math/pull/7417

likedislike
Ccai-chengchaoCollaborators
17 hours ago Added label: requirement
cai-chengchaoCollaborators
17 hours ago Comments:
likedislike
CANN-robotCANN-robotCollaborators
17 hours ago Assign cai-chengchao as responsible person
CANN-robotCANN-robotCollaborators
12 hours ago Close issue
CANN-robotCANN-robotCollaborators
12 hours ago changed custom state from 待办的 to 已完成
CANN-robotCANN-robotCollaborators
11 hours ago Added label: resolved