已关闭
[Documentation|文档反馈]: 修正量化矩阵乘与 TransQuantParam 文档表述 #6323
ddssz创建于  28 天前关闭于  28 天前
ddssz
ddssz成员
28 天前 创建

Thanks for sending an issue! Please fill in the following template to help quickly solve your problem.

Document Link(文档链接)

  • 修订提交:https://gitcode.com/smdbha/ops-nn/commit/35fd0c931564473fde53c52ba8c4133ab9e3d49f
  • matmul/quant_batch_matmul_v3/docs/aclnnQuantMatmulWeightNz.md
  • matmul/quant_batch_matmul_v4/docs/aclnnQuantMatmulV5.md
  • matmul/quant_batch_matmul_inplace_add/docs/aclnnQuantBatchMatmulInplaceAdd.md
  • matmul/quant_batch_matmul_v3/docs/aclnnQuantMatmulV3.md
  • quant/trans_quant_param/docs/aclnnTransQuantParam.md
  • quant/trans_quant_param_v2/README.md
  • quant/trans_quant_param_v2/docs/aclnnTransQuantParamV2.md
  • quant/trans_quant_param_v2/docs/aclnnTransQuantParamV3.md

Issues Section(问题文档片段)

  1. 量化矩阵乘文档中的 FP16/BF16 输出注释、aclnnPermute 失败日志、空 Tensor/维度/shape 约束、类型名称及标点与实际接口语义或示例实现不一致。
  2. TransQuantParam 系列文档将 scale 高 19 位描述为“存储于 out 的 bit 位 32 位处”,位段含义不清;V3 文档还将接口参数 roundMode 写成了 round_mode,示例代码块语言标记使用了大写 Cpp。
  3. ACLNN_ERR_INNER_NULLPTR 的错误描述写成“quantParam为空指针”,与前文 ACLNN_ERR_PARAM_NULLPTR 的检查项重复,无法区分输出缓冲区申请失败和入参空指针。

Existing Issues(存在的问题)

上述表述会导致调用者误解量化参数的 bit 布局、API 参数名和错误码含义,并增加量化矩阵乘接口使用及问题排查的成本。本反馈对应提交 35fd0c931564473fde53c52ba8c4133ab9e3d49f,该提交已统一修正文档内容、日志示例、约束说明、标点及 Markdown 代码块标记。

likedislike
ddsszddssz成员
28 天前 添加了label:documentation
ddsszddssz成员
28 天前 关联了pull request:docs: 修正量化矩阵乘与 TransQuantParam 文档表述
ddsszddssz成员
28 天前 将 smdbha 设为负责人
CANN-robotCANN-robot成员
28 天前 关闭了 issue
CANN-robotCANN-robot成员
28 天前 添加了label:resolved