已关闭
[Documentation|文档反馈]: kl_div_v2 README标题宣称aclnnKlDivV2,实际对外API为aclnnKlDiv #3501
liuhanwen8创建于  17 天前关闭于  9 天前
liuhanwen8
liuhanwen8
17 天前 创建

Document Link(文档链接)

https://gitcode.com/cann/ops-math/blob/master/math/kl_div_v2/README.md#L1

Issues Section(问题文档片段)

README.md:1 标题为:

aclnnKlDivV2

而同文件 README.md:102 的调用方式表写"通过 aclnnKlDiv 接口方式调用 KlDivV2 算子"。

Existing Issues(存在的问题)

README 标题宣称的接口名与实际对外 API 不符(master @ f53b52a3 实测):

  1. op_api/aclnn_kl_div.h 声明的接口为 aclnnKlDivGetWorkspaceSize(:24)与 aclnnKlDiv(:31),不存在 aclnnKlDivV2 API;
  2. 目录内 aclnnKlDivV2 字样仅出现在 README 标题(:1);接口文档为 docs/aclnnKlDiv.md,README:102 亦自述通过 aclnnKlDiv 调用;
  3. 已排除文件名/符号变体:目录内无 aclnn_kl_div_v2.h/.cpp、无 aclnnKlDivV2GetWorkspaceSize 定义。

用户按标题检索或调用 aclnnKlDivV2 将找不到该 API。建议标题改为 # KlDivV2(aclnnKlDiv),与 docs/aclnnKlDiv.md 及头文件口径统一。

likedislike
liuhanwen8liuhanwen8
17 天前 添加了label:documentation
陈思
陈思成员
16 天前 评论:

您好,感谢反馈!

核对 cann/ops-math@f53b52a3 后,头文件声明的公共接口确实是 aclnnKlDivGetWorkspaceSize 和 aclnnKlDiv,接口文档及 README 的调用方式也使用 aclnnKlDiv。README 标题 aclnnKlDivV2 容易让读者将算子名 KlDivV2 误认为一个同名的 ACLNN 接口。

可将标题改为 KlDivV2(aclnnKlDiv),同时保留算子名称和实际 API 名称,消除歧义。调用时应继续使用现有的 aclnnKlDivGetWorkspaceSize、aclnnKlDiv 两段式接口。

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

/assign @songkai111

likedislike
CANN-robotCANN-robot成员
16 天前 将 songkai111 设为负责人
xiu_ling_wang成员
10 天前 评论:
likedislike
CANN-robotCANN-robot成员
10 天前 将 xiu_ling_wang 设为负责人
Xxiu_ling_wang成员
10 天前 关联了pull request:修改aclnnAcosh接口文档以及KlDivV2算子文档
Xxiu_ling_wang成员
9 天前 issue状态由 进行中 改变为 已完成
Xxiu_ling_wang成员
9 天前 关闭了 issue