已关闭
[Bug-Report|缺陷反馈]: 多个两段式 aclnn 接口头文件注释参数名拼写错误 exector(应为 executor,18+ 处) #5350
OpenGood_WeChat创建于  7 天前关闭于  1 天前
OpenGood_WeChat
OpenGood_WeChat
7 天前 创建

一、问题描述 (必填)

ops-nn 仓大量两段式 aclnn 接口头文件的第二段接口注释中,参数名 executor 被拼写为 exector(少一个 u),与函数签名中的真实参数名不一致。

逐字证据(节选,均为 * @param [in] exector: op执行器,包含了算子计算流程。 或英文版本 @param [in] exector: op executor, ...):

  1. activation/fast_gelu/op_api/aclnn_fast_gelu.h:45
  2. activation/fast_gelu_grad/op_api/aclnn_fast_gelu_backward.h:41
  3. matmul/quant_matmul_activation_quant/op_api/aclnn_quant_matmul_activation_quant_weight_nz.h:42
  4. matmul/fused_quant_mat_mul/op_host/op_api/aclnn_fused_quant_matmul.h:55
  5. matmul/fused_quant_mat_mul/op_host/op_api/aclnn_fused_quant_matmul_weight_nz.h:55
  6. matmul/quant_matmul_reduce_sum/op_host/op_api/aclnn_quant_matmul_reduce_sum.h:64
  7. matmul/quant_matmul_dequant/op_host/op_api/aclnn_quant_matmul_dequant.h:51
  8. matmul/weight_quant_batch_matmul_v2/op_host/op_api/aclnn_weight_quant_batch_matmul_v2.h:49
  9. matmul/weight_quant_batch_matmul_v2/op_host/op_api/aclnn_weight_quant_batch_matmul_nz.h:49
  10. matmul/sparse4to2quant_matmul/op_api/aclnn_sparse4to2quant_matmul_weight_nz.h:63
  11. quant/trans_quant_param_v2/op_host/op_api/aclnn_trans_quant_param_v2.h:39
  12. quant/trans_quant_param_v2/op_host/op_api/aclnn_trans_quant_param_v3.h:40
  13. pooling/adaptive_max_pool3d_grad/op_api/aclnn_adaptive_max_pool2d_backward.h:52
  14. pooling/adaptive_max_pool3d_grad/op_api/aclnn_adaptive_max_pool3d_backward.h:52
  15. pooling/max_pool3d_grad_with_argmax/op_api/aclnn_max_pool3d_with_argmax_backward.h:59
  16. vfusion/scaled_masked_softmax_v2/op_host/op_api/aclnn_scaled_masked_softmax.h:48
  17. vfusion/scaled_masked_softmax_grad_v2/op_host/op_api/aclnn_scaled_masked_softmax_backward.h:51
  18. rnn/dynamic_rnn/op_api/aclnn_lstm.h:33(英文注释版本)

对照组(拼写正确):同文件内 @param [out] executor(第一段接口出参注释)均为正确拼写,如 activation/fast_gelu/op_api/aclnn_fast_gelu.h 第一段接口注释即无此错误。

二、环境信息 (可选)

  • 仓库:cann/ops-nn(master)

三、重现步骤 (可选)

在仓内全局检索 @param [in] exector 即可复现,涉及文件远不止上述 18 处,建议以 grep 结果为准统一整改。

四、预期结果 (可选)

注释参数名统一为 executor,与函数签名一致。

💡 备注(选填)

纯注释拼写错误,无编译/运行影响;属于两段式接口注释模板的系统性拼写问题,建议一次性统一修改。ops-transformer 仓存在同样问题(已另行提单),两仓可参考同一整改方式。

likedislike
yuning_chenyuning_chen成员
5 天前 将 yolic 设为负责人
yuning_chen
yuning_chen成员
5 天前 评论:

您好,感谢反馈,问题已收到,正在处理。

likedislike
yuning_chenyuning_chen成员
5 天前 将 void_ptr 设为负责人
Vvoid_ptr成员
4 天前 关联了pull request:Fix misspelled executor parameter in aclnn API doxygen comment.
CANN-robotCANN-robot成员
1 天前 关闭了 issue
CANN-robotCANN-robot成员
1 天前 添加了label:resolved