已开启
[Documentation|文档反馈]: fix aclnn doc problem #6091
zhangquanxin创建于  7 天前
zhangquanxin
zhangquanxin成员
7 天前 创建

Document Link(文档链接)

  1. https://gitcode.com/cann/ops-nn/blob/master/matmul/dual_level_quant_batch_matmul/docs/aclnnDualLevelQuantMatmulWeightNz.md
  2. https://gitcode.com/cann/ops-nn/blob/master/matmul/quant_batch_matmul_v3/op_api/aclnn_quant_matmul_weight_nz.h
  3. https://gitcode.com/cann/ops-nn/blob/master/matmul/quant_batch_matmul_v4/docs/aclnnQuantMatmulV5.md
  4. https://gitcode.com/cann/ops-nn/blob/master/matmul/quant_batch_matmul_v4/op_host/op_api/aclnn_quant_matmul_v5.h
  5. https://gitcode.com/cann/ops-nn/blob/master/matmul/weight_quant_batch_matmul_v2/op_host/op_api/aclnn_weight_quant_batch_matmul_nz.h

Issues Section(问题文档片段)

  • aclnnDualLevelQuantMatmulWeightNz.md:x1Level1Scale / x2Level0Scale 参数描述顺序颠倒,FLOAT8_E8M0 / FLOAT32 数据类型与 ND / ND、NCL 格式标注错误;FLOAT4_E2M1 缺少"需使用 INT8 传入"说明。
  • aclnn_quant_matmul_weight_nz.h:x2、x2Scale 数据类型支持列表不完整,yScale 参数说明有误。
  • aclnnQuantMatmulV5.md:groupSize 存在一条与实现不符的约束描述。
  • aclnn_quant_matmul_v5.h:yScale 数据类型描述使用了错误的中文顿号。
  • aclnn_weight_quant_batch_matmul_nz.h:weight 数据类型支持列表缺少 int8。

Existing Issues(存在的问题)

上述 aclnn 算子文档/接口注释存在参数描述顺序颠倒、数据类型与格式标注错误、支持列表不完整、约束描述与实现不符、标点符号错误等问题,导致文档与实际接口行为不一致。

likedislike
zhangquanxinzhangquanxin成员
7 天前 修改标题为 “[Documentation|文档反馈]: fix aclnn doc problem”,原标题为“fix aclnn doc problem”
zhangquanxinzhangquanxin成员
7 天前 修改了issue 的描述
zhangquanxinzhangquanxin成员
7 天前 添加了label:documentation
zhangquanxin
zhangquanxin成员
7 天前 评论:

/assign @zhangquanxin

likedislike
CANN-robotCANN-robot成员
7 天前 将 zhangquanxin 设为负责人
zhangquanxinzhangquanxin成员
7 天前 关联了pull request:fix aclnn doc problem
zhangquanxinzhangquanxin成员
7 天前 关联了pull request:fix aclnn doc problem