Closed
[Documentation|文档反馈]: math/complex README 称“仅包含 aclnn 接口”,但同目录 op_kernel 已有 4 个实现文件 #3714
liuhanwen8Add on  17 days agoClosed at  11 days ago
liuhanwen8
liuhanwen8
17 days ago Create

问题描述

math/complex/README.md 在当前 HEAD 3e45432d 仍为占位空壳:去掉 H1 后正文只有 149 字节一句话——

本目录仅包含Complex算子对应的aclnn接口;如您想要贡献该算子的AscendC实现,请参考[贡献流程](../../CONTRIBUTING.md)。

实际交付件(HEAD 3e45432d)

交付件 现状
aclnn 接口 4 个(op_api/aclnn_complex.cpp、op_api/aclnn_complex.h、op_api/complex.cpp、op_api/complex.h)
op_host/ 4 个(op_host/arch35/complex_tiling_arch35.cpp、op_host/arch35/complex_tiling_arch35.h、op_host/complex_def.cpp …共 4 个)
op_kernel/ 4 个(op_kernel/arch35/complex.h、op_kernel/arch35/complex_dag.h、op_kernel/arch35/complex_struct.h、op_kernel/complex_apt.cpp)
op_graph/ 无
docs/ docs/aclnnComplex.md
examples/ 1 份
docs/zh/op_list.md 已收录(索引直达该占位页)

与占位语不符之处

  • op_kernel/ 已有 4 个 AscendC 实现文件(入口 op_kernel/complex_apt.cpp),实现真实存在。
  • 同目录已有接口文档 docs/aclnnComplex.md,README 未给出任何 docs/ 入口。

修复建议

  1. 删掉“仅包含 aclnn 接口 / 欢迎贡献 AscendC 实现”的占位句,按事实写三层交付:aclnn 接口(op_api/aclnn_complex.cpp;文档 docs/aclnnComplex.md)、AscendC 实现(op_kernel/,入口 complex_apt.cpp)、样例(examples/)。
  2. 参数、dtype、产品支持等约束链接到 docs/aclnnComplex.md,不复制正文,避免两份资料不同步。
  3. CI 门禁按 #3691 讨论口径:只拦“声称仅接口但存在有效 kernel 入口”的明确矛盾(排除 .gitkeep/空壳文件),“本目录无独立 kernel”不判为缺陷。
  4. 修复后回填 #3691 清单状态,本条目随之关闭。

关联

  • 拆分自 #3691(36 份占位 README 汇总项,按算子逐条跟踪,不重复计缺陷)。
  • #3691 中维护者 2026-10-21 反馈:需区分“同目录无 kernel”与“算子未实现”,不得统一写成“kernel 待补充”,并要求写明实际实现位置(含共享实现);本条目按该口径描述。
likedislike
liuhanwen8liuhanwen8
17 days ago Added label: documentation
陈思
陈思Collaborators
17 days ago Comments:

您好,感谢反馈!

核对 cann/ops-math 提交 b19eaee4f58e5e1e3cb3b2ecbfed2d02c11c820a,README仍写“仅包含 aclnn 接口”,但已存在计算实现:complex_apt.cpp 包含 arch35/complex.h,该头内定义 complex 全局入口,并通过广播调度器的 Process(real, imag, out) 处理实部和虚部输入。因此,这处占位说明与该版本的实际交付内容不一致,不能据此判断 Complex 尚无实现。

一个可行的调整是,在 README 分别说明 aclnn 接口、当前实现的实际位置和样例入口,并将参数、dtype、产品支持约束直接链接到已有接口文档,避免复制两份说明后发生差异。当前核查到的 arch35 实现不能扩大为所有产品都走同一路径,产品限制仍需保留详细文档的适用范围。

关于 CI 建议,可以考虑检测“明确宣称仅接口”与“存在有效实现入口”的矛盾,同时区分共享实现、空壳文件及无独立 kernel 的目录,控制误报和维护成本;具体规则仍需评估。#3691 的清单可在本项有修订合入依据后同步,当前尚无据此关闭本项的依据。我们会继续确认这项文档调整。

likedislike
陈思陈思Collaborators
17 days ago Assign yue-ma as responsible person
陈思陈思Collaborators
17 days ago Added label: pending-confirmation
陈思陈思Collaborators
17 days ago Removed label: pending-confirmation
Yyue-maCollaborators
16 days ago Removed responsible person yue-ma
Yyue-maCollaborators
16 days ago Assign yue-ma as responsible person
Jjisihuai
16 days ago Associated pull request
CANN-robotCANN-robotCollaborators
11 days ago Close issue
CANN-robotCANN-robotCollaborators
11 days ago Added label: resolved