Closed
[Documentation|文档反馈]: aclnnForeach 系列算子错误码表、约束说明与中英文文档不一致 #8533
zhang-wenbo-beatAdd on  12 days agoClosed at  11 days ago
zhang-wenbo-beat
zhang-wenbo-beatCollaborators
12 days ago Create

问题描述

aclnnForeachAbs/Neg/Sign/Tanh/Asin/Exp 的中英文文档存在以下问题:

  1. 错误码表与实现不一致:文档将维度/shape 等参数校验错误归入不可达的 561002;未补充 exp out dtype 推导、空指针 Tensor 等 161002 场景。
  2. 约束说明不完整:neg/sign/tanh 缺少 Tensor 数量、dtype、out 类型/shape、0-8 维、空 Tensor、非连续 Tensor、确定性计算等约束。
  3. out shape 表述与实现不一致:文档写“shape size 等于”,实现要求逐元素 shape 全等。
  4. README 未声明单个 Tensor 列表数量不超过 256 的约束。
  5. 中英文文档在错误码表、约束说明、out shape 表述、术语大小写等方面不一致。

环境信息

  • 昇腾硬件型号:Ascend 910B / Ascend 950
  • CANN 版本:CANN 9.2.0
  • Python 版本:3.11

重现步骤

  1. 查看 docs/aclnnForeach{Abs,Neg,Sign,Tanh,Asin,Exp}.md 及对应 _en.md。
  2. 对照 op_host/op_api 的参数校验逻辑与 README。
  3. 对比中英文错误码表、约束说明、out shape 表述。

预期结果

  1. 错误码表删除不可达的 561002,参数校验统一归入 161002,补充 exp out 类型推导与空指针 Tensor 场景。
  2. 补齐 neg/sign/tanh 约束说明,中英文一致。
  3. out shape 统一表述为“与入参 x 对应位置的 Tensor 一致”。
  4. README 补充单个 Tensor 列表不超过 256 的约束。
  5. 修复质检发现的问题(多余空行、空Tensor 术语、sign 第一段说明、README 输出参数命名等)。

说明:本 Issue 仅跟踪文档问题;接口参数校验日志中出现 561000 的问题不在本 MR 范围内,另行跟踪。

关联

likedislike
yuning_chenyuning_chenCollaborators
12 days ago Assign zhang-wenbo-beat as responsible person
yuning_chen
yuning_chenCollaborators
12 days ago Comments:

您好,该问题已收到,当前问题 @zhang-wenbo-beat 正在处理中

likedislike
zhang-wenbo-beatzhang-wenbo-beatCollaborators
11 days ago Change title to "[Documentation|文档反馈]: aclnnForeach 系列算子错误码表、约束说明与中英文文档不一致", originally titled "[Bug-Report|缺陷反馈]: aclnnForeach 系列算子参数校验错误码日志与中英文文档不一致".
zhang-wenbo-beatzhang-wenbo-beatCollaborators
11 days ago Modify description of issue
CANN-robotCANN-robotCollaborators
11 days ago Close issue
CANN-robotCANN-robotCollaborators
11 days ago changed custom state from 待办的 to 已完成
CANN-robotCANN-robotCollaborators
10 days ago Added label: resolved