Closed
[Documentation|文档反馈]: [aclnnComplex] 头文件 real/imag 的 dtype 注释漏列 DOUBLE,与资料 dtype 表及实现白名单不一致 #4361
liuhanwen8Add on  18 days agoClosed at  18 hours ago
liuhanwen8
liuhanwen8
18 days ago Create

现象

math/complex/op_api/aclnn_complex.h 里 real / imag 两个形参的注释把支持的数据类型写成「FLOAT16,FLOAT」,漏列 DOUBLE;而同一接口的资料与实现都支持 DOUBLE:

来源 位置 内容
头文件 op_api/aclnn_complex.h:25、:28 数据类型支持FLOAT16,FLOAT数据类型,
资料 math/complex/docs/aclnnComplex.md:85、:95 FLOAT、FLOAT16、DOUBLE
资料 math/complex/docs/aclnnComplex.md(id7 段) out 支持 COMPLEX128,且「COMPLEX128(输入只能是 DOUBLE)」
实现 op_api/aclnn_complex.cpp:38-40 INPUT_DTYPE_SUPPORT_LIST = {DT_FLOAT16, DT_FLOAT, DT_DOUBLE}
实现 op_api/aclnn_complex.cpp:46-50 DTYPE_PAIR 含 {DT_DOUBLE, DT_COMPLEX128}

头文件是「契约优先级最高」的一侧(头文件 > 资料 > 样例),按它写的注释,接入方会认为 fp64→complex128 不受支持而绕开该通路;实测该通路在 A3 上可用(fp64 输入 16 元素逐字节正确)。

原文

math/complex/op_api/aclnn_complex.h:23-29(逐字复制):

 * @param [in] real: npu device侧的aclTensor,
 * 数据类型支持FLOAT16,FLOAT数据类型,
 * shape需要与imag满足broadcast关系,支持非连续的Tensor,数据格式支持ND。
 * @param [in] imag: npu device侧的aclTensor,
 * 数据类型支持FLOAT16,FLOAT数据类型,
 * shape需要与real满足broadcast关系,支持非连续的Tensor,数据格式支持ND,数据类型需要与real相同。

复现

脚本对「资料 / 实现 / 头文件」三方做文本断言,退出码 1 且打印 [DEFECT] 即缺陷成立:

# python3 check_header_dtype.py --repo-root /path/to/ops-math   → rc=1 且打印 [DEFECT]
import argparse, os, re, sys
ap = argparse.ArgumentParser(); ap.add_argument("--repo-root", required=True)
base = os.path.join(ap.parse_args().repo_root, "math", "complex")
doc = open(os.path.join(base, "docs", "aclnnComplex.md"), encoding="utf-8").read()
hdr = open(os.path.join(base, "op_api", "aclnn_complex.h"), encoding="utf-8").read()
impl = open(os.path.join(base, "op_api", "aclnn_complex.cpp"), encoding="utf-8").read()
doc_has = "FLOAT、FLOAT16、DOUBLE" in doc
impl_has = "DataType::DT_DOUBLE" in impl and "DT_COMPLEX128" in impl
comments = re.findall(r"\*\s*数据类型支持([^\n]*)", hdr)
hdr_has = any("DOUBLE" in c.upper() for c in comments)
print("资料含 DOUBLE:", doc_has, "| 实现含 DT_DOUBLE:", impl_has, "| 头文件注释:", comments)
if doc_has and impl_has and not hdr_has:
    print("[DEFECT] 头文件注释漏列 DOUBLE,与资料/实现不一致")
    sys.exit(1)
print("[OK] 三方一致")

实测输出(ops-math master@a6d37f00,CANN 9.2.0):

资料 dtype 列含 DOUBLE          : True
实现白名单/pair 含 DT_DOUBLE    : True
头文件注释里的 dtype 支持面      : FLOAT16,FLOAT数据类型, | FLOAT16,FLOAT数据类型,
头文件注释含 DOUBLE             : False
[DEFECT] 头文件注释只写 FLOAT16,FLOAT数据类型,漏列 DOUBLE …
rc=1

建议

把 aclnn_complex.h:25 与 :28 两处的「数据类型支持FLOAT16,FLOAT数据类型」改为「数据类型支持FLOAT16、FLOAT、DOUBLE数据类型」,与资料 aclnnComplex.md:85/95 及实现白名单保持一致。

同类问题已有先例(aclnnGlobalAveragePool 头文件注释漏列 BFLOAT16,已单独立单),本条只针对 aclnnComplex,未与其他接口合并。

likedislike
陈思
陈思Collaborators
17 days ago Comments:

您好,感谢反馈!已核对 cann/ops-math 提交 212ce9d5460b1be26cfbee481aff1acbf5cc5c62:头文件中 real、imag 的两处类型注释确实漏列 DOUBLE,与您报告的 a6d37f00 情况一致。

实现白名单与类型配对已包含 DOUBLE→COMPLEX128,并要求 real 与 imag 类型相同;文档的 A3 产品备注也列明该配对。

一个可行的修订是将两处注释补为“数据类型支持 FLOAT16、FLOAT、DOUBLE”,同时保留输入同类型及输出类型配对要求。这属于现有支持范围的注释补全;我们会继续跟踪头文件与接口资料的一致性。

likedislike
陈思陈思Collaborators
17 days ago Assign chen_0715 as responsible person
陈思陈思Collaborators
17 days ago Added label: pending-confirmation
陈思陈思Collaborators
15 days ago Removed label: pending-confirmation
Wwangbo
14 days ago Associated pull request
wangbo
14 days ago Comments:

已提交修复:real / imag 两处注释补列 DOUBLE,与资料及实现白名单一致:
https://gitcode.com/cann/ops-math/merge_requests/7050

likedislike
CchenyifengCollaborators
14 days ago Assign wang_bo as responsible person
CchenyifengCollaborators
14 days ago Removed responsible person chen_0715
CchenyifengCollaborators
14 days ago Assign chen_0715 as responsible person
CchenyifengCollaborators
14 days ago Removed responsible person chen_0715
CchenyifengCollaborators
14 days ago Assign chen_0715 as responsible person
chenyifengCollaborators
18 hours ago Comments:

整改已合入,issue将关闭,后续有问题欢迎继续提issue。

likedislike
CchenyifengCollaborators
18 hours ago changed custom state from 进行中 to 已解决
CchenyifengCollaborators
18 hours ago Close issue