Closed
[Documentation|文档反馈]: [aclnnClampMin] 错误码 161002 未说明 self 与 out 的 shape 不一致也会触发 #3905
liuhanwen8Add on  27 days agoClosed at  24 days ago
liuhanwen8
liuhanwen8
27 days ago Create

一、文档链接 (必填)

  • 仓库:cann/ops-math
  • 文件:conversion/clip_by_value_v2/docs/aclnnClampMin.md(第 164-168 行,错误码表 161002 项)
  • 实现锚点:conversion/clip_by_value_v2/op_api/aclnn_clamp.cpp(第 164、189 行)
  • 版本:commit 584b2ea6

二、问题文档片段 (必填)

第 164-168 行:

<tr>
  <td>ACLNN_ERR_PARAM_INVALID</td>
  <td>161002</td>
  <td>self、out的数据类型和数据格式不在支持的范围之内。</td>
</tr>

💡 存在的问题

资料对 161002 只列了「数据类型和数据格式」两类触发条件;但实现里 self 与 out 的 shape 不一致 同样返回 161002,资料未列这一条。

实现证据(op_api/aclnn_clamp.cpp):

  • 第 164 行:OP_CHECK_SHAPE_NOT_EQUAL(self, out, return false);
  • 第 189 行:CHECK_RET(CheckShape(self, out), ACLNN_ERR_PARAM_INVALID);

CheckShape 在 CheckParams 内被调用,失败即以 ACLNN_ERR_PARAM_INVALID(161002)返回,属于「第一段接口完成入参校验」那张表应覆盖的范围。

同仓体例支持这种写法 —— math/muls/docs/aclnnMuls&aclnnInplaceMuls.md 的 161002 下明确列了「self与out的shape不一致。」(第 193 行)与「self和out的维度大于8。」(第 196 行)。因此这不是全仓统一省略,而是本文件漏写。

影响:使用者按错误码表排查时,会先把 self/out 的 dtype 与 format 排一遍;shape 不一致这一最常见原因不在表中,容易误判为「资料支持但实现报错」。

复核方式

把下面的脚本存为 check_161002.py,在仓根执行 python3 check_161002.py --repo-root .。
退出码:0 = 资料符合预期;1 = 缺陷成立;2 = 缺文件无法判定。

import argparse, os, sys

DOC = "conversion/clip_by_value_v2/docs/aclnnClampMin.md"
SRC = "conversion/clip_by_value_v2/op_api/aclnn_clamp.cpp"
PEER = "math/muls/docs/aclnnMuls&aclnnInplaceMuls.md"


def read(root, rel):
    p = os.path.join(root, rel.replace("/", os.sep))
    if not os.path.isfile(p):
        return None
    with open(p, encoding="utf-8", errors="replace") as fh:
        return fh.read()


def line_of(text, needle):
    for i, line in enumerate(text.splitlines(), start=1):
        if needle in line:
            return i
    return 0


def main():
    ap = argparse.ArgumentParser()
    ap.add_argument("--repo-root", required=True)
    a = ap.parse_args()
    root = os.path.abspath(a.repo_root)

    doc, src, peer = read(root, DOC), read(root, SRC), read(root, PEER)
    if not (doc and src and peer):
        print("[UNDECIDED] 缺文件,无法判定")
        return 2

    a_ok = bool(line_of(src, "OP_CHECK_SHAPE_NOT_EQUAL")) and \
        bool(line_of(src, "CHECK_RET(CheckShape"))
    d_line = line_of(doc, "161002")
    block = " ".join(doc.splitlines()[d_line - 1: d_line + 3])
    b_has_shape = ("shape" in block.lower()) or ("维度" in block)
    c_ok = bool(line_of(peer, "self与out的shape不一致"))

    print("[A] 实现把 shape 不一致映射为 161002:%s" % a_ok)
    print("[B] 资料 161002 描述提到 shape/维度:%s" % b_has_shape)
    print("[C] 同族 aclnnMuls 在 161002 下列了 shape 子项:%s" % c_ok)
    if a_ok and not b_has_shape and c_ok:
        print("[DEFECT] aclnnClampMin 的 161002 未说明 shape 不一致")
        return 1
    print("[OK] 本条不成立")
    return 0


if __name__ == "__main__":
    sys.exit(main())

实测输出(commit 584b2ea6,退出码 1):

[A] 实现把 shape 不一致映射为 161002:True
[B] 资料 161002 描述提到 shape/维度:False
[C] 同族 aclnnMuls 在 161002 下列了 shape 子项:True
[DEFECT] aclnnClampMin 的 161002 未说明 shape 不一致

修复建议

在 161002 下补一条子项:self与out的shape不一致。(与 aclnnMuls 的 161002 表体例一致)。同目录 aclnnClamp.md 的 161002 只有一条描述,建议一并核对。

likedislike
陈思
陈思Collaborators
26 days ago Comments:

您好,感谢反馈!已按 cann/ops-math@584b2ea6cbaeba684a51a74296d82d4d50ab3b0f 核对,aclnnClampMin 的 161002 描述确实遗漏了 self 与 out 的 shape 不一致这一条件。

该接口转入 aclnnClampCommon,其标量参数检查先通过 OP_CHECK_SHAPE_NOT_EQUAL(self, out, ...) 检查形状相同,失败再映射为 ACLNN_ERR_PARAM_INVALID。因此,类型和格式均合法时,shape 不一致仍会在第一段返回 161002。入口、检查与返回码映射

可在错误码表的 161002 下保留原有类型、格式说明,并补充独立子项:self与out的shape不一致。 您提到的标量 aclnnClamp 也共用这条检查路径,其错误码表存在相同遗漏,可按相同口径对齐。这里属于已有参数校验行为的资料补充,无需为此放宽 shape 约束。我们会继续跟踪这两处资料说明。

likedislike
陈思陈思Collaborators
26 days ago Assign chensi79 as responsible person
陈思陈思Collaborators
26 days ago Added label: pending-confirmation
陈思陈思Collaborators
26 days ago Assign sun-yibo1 as responsible person
陈思陈思Collaborators
26 days ago Removed responsible person chensi79
陈思陈思Collaborators
26 days ago Removed label: pending-confirmation
zhang-song-ruizhang-song-ruiCollaborators
26 days ago Assign zhang-song-rui as responsible person
zhang-song-ruizhang-song-ruiCollaborators
24 days ago Associated pull request
CANN-robotCANN-robotCollaborators
24 days ago Close issue
CANN-robotCANN-robotCollaborators
24 days ago Added label: resolved