已关闭
[文档修正] aclnnKthvalue 参数 dtype 注释需补齐平台支持范围 #5998
黄晓彬创建于  28 天前关闭于  26 天前
黄晓彬成员
28 天前 创建

问题描述

index/kth_value/op_api/aclnn_kthvalue.h 中,aclnnKthvalueGetWorkspaceSize 的 self、valuesOut 参数注释只列出 INT32、FLOAT16、FLOAT32,与实际支持范围不一致,可能误导接口调用方。

来源:PR https://gitcode.com/cann/ops-nn/pull/10728 ,检视意见 ID:190437733。该意见已标记 resolved,但核查时 PR 分支头文件中的注释仍未更新。

代码依据

index/kth_value/op_api/aclnn_kthvalue.cpp 的 GetDtypeSupportList() 按平台选择:

  • 默认:FLOAT32、FLOAT16、INT8、UINT8、INT16、INT32、INT64,共 7 种。
  • DAV_2201:在默认列表基础上增加 BFLOAT16,共 8 种。
  • IsRegbase():在上述 8 种基础上增加 UINT16、UINT32、UINT64,共 11 种。

valuesOut 的 dtype 必须与 self 相同;indicesOut 为 INT64。

建议处理

  • 更新 self 和 valuesOut 的参数注释,明确平台对应的 dtype 支持范围,避免直接写成所有平台均支持 11 种。
  • 顺带修正 valuesOut 注释中的 dnpu 拼写。
  • 核对 master 和 9.2.0 分支,以及接口文档中的描述一致性。

本问题属于接口注释不准确,不涉及 kernel、tiling 或实际 dtype 校验逻辑修改。

likedislike
黄黄晓彬成员
28 天前 修改了issue 的描述
yuning_chen
yuning_chen成员
28 天前 评论:

初步分析

感谢反馈,我们已开始核对这个问题。

现象理解:aclnnKthvalueGetWorkspaceSize 的 self/valuesOut 注释目前只列出 INT32、FLOAT16、FLOAT32,可能与实现里按平台选择的 dtype 列表不一致,并提到 valuesOut 注释中的拼写问题。
当前判断:初步判断,待复现确认。这更像接口注释未按平台区分更新,而不是 kernel 或校验逻辑错误;master、9.2.0 与正式文档是否同时不一致,仍需对照当前头文件和 GetDtypeSupportList() 核实。
涉及范围:index/kth_value/op_api 的头文件与实现,以及对应接口文档。
下一步:我们会对照实现中的平台 dtype 列表核对注释和文档,并确认拼写是否仍需修正。

likedislike
黄黄晓彬成员
26 天前 关联了pull request:[修复] KthValue公共头文件命名及代码质量整改
黄黄晓彬成员
26 天前 关联了pull request:fix(index): address KthValue and NanMedian issues
CANN-robotCANN-robot成员
26 天前 关闭了 issue
CANN-robotCANN-robot成员
26 天前 添加了label:resolved