已关闭
[Documentation|文档反馈]: [aclnnMuls] 参数表 self 行 dtype 列表后的「注:」悬空无内容 #3906
liuhanwen8创建于  9 天前关闭于  6 天前
liuhanwen8
liuhanwen8
9 天前 创建

一、文档链接 (必填)

  • 仓库:cann/ops-math
  • 文件:math/muls/docs/aclnnMuls&aclnnInplaceMuls.md(第 106 行)
  • 版本:commit 584b2ea6

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

第 106 行(aclnnMuls 参数表中 self 的「数据类型」列):

<td>FLOAT、FLOAT16、DOUBLE、INT32、INT64、INT16、INT8、UINT8、BOOL、COMPLEX128、COMPLEX64、BFLOAT16<br>注:</td>

💡 存在的问题

该单元格以 BFLOAT16<br>注: 结尾,「注:」之后没有任何文字,直接闭合 </td>。读者能看出这里本该有一条关于 dtype 的补充说明(此类资料里「注:」用于补充 dtype 限制或类型推导规则),但内容缺失,无法判断约束内容。

同表可作为对照的三行都没有「注:」:

  • other 行(第 116 行)
  • out 行(第 126 行)
  • aclnnInplaceMuls 的 selfRef 行(第 275 行)

全文件检索「注:」只命中第 106 行一处,说明这不是多处统一体例,而是该行在编辑/复制时被截断。

影响:aclnnMuls 的 self 是 12 种 dtype 的大支持面,读者本来需要这条注释来判断组合限制(例如哪些 dtype 组合会走类型提升、哪些会被拒绝);注释缺失会让使用者按「12 种都任意组合」理解,与实现不一致时无法自查。

复核方式

在仓根执行:

grep -n "注:" math/muls/docs/aclnnMuls*.md

实测输出(commit 584b2ea6):

106:      <td>FLOAT、FLOAT16、DOUBLE、INT32、INT64、INT16、INT8、UINT8、BOOL、COMPLEX128、COMPLEX64、BFLOAT16<br>注:</td>

只有第 106 行命中,且该行「注:」后紧接 </td>。

修复建议

按实现补齐该注的内容(例如 dtype 组合与类型推导的补充约束),或删除悬空的「注:」以免读者以为还有未展示的约束。若补齐,请同时核对 aclnnInplaceMuls 的 selfRef 行是否也要加对应注释。

likedislike
陈思
陈思成员
8 天前 评论:

您好,感谢反馈!核对 cann/ops-math 固定版本 584b2ea6cbaeba684a51a74296d82d4d50ab3b0f 的资料,aclnnMuls 参数表 self 的 dtype 单元格确实以 <br>注: 结束且没有正文;other、out 和原地 selfRef 的对照行没有这个悬空标记。

该行“使用说明”已链接类型推导规则,页面也单独保留了产品类型限制。一个可行的修订是删除没有正文的 <br>注:,保留现有 dtype 列表、推导链接和平台说明。当前片段不能证明原先计划补充哪条约束,补写注释时需要以实际接口规则为依据;原地表是否需要补充也应按该规则分别核对。我们会继续确认这处表述的整理方式。

likedislike
陈思陈思成员
8 天前 将 chensi79 设为负责人
陈思陈思成员
8 天前 添加了label:pending-confirmation
陈思陈思成员
8 天前 将 sun-yibo1 设为负责人
陈思陈思成员
8 天前 移除了负责人 chensi79
陈思陈思成员
8 天前 删除了label:pending-confirmation
zhang-song-ruizhang-song-rui成员
8 天前 将 zhang-song-rui 设为负责人
zhang-song-ruizhang-song-rui成员
6 天前 关联了pull request:[Docs] 删除 Muls 数据类型表中的空注释
CANN-robotCANN-robot成员
6 天前 关闭了 issue
CANN-robotCANN-robot成员
6 天前 添加了label:resolved