Closed
[Documentation|文档反馈]: 规范六个量化算子的中文文档并修正接口行为说明 #8344
panzhijaAdd on  15 days agoClosed at  12 days ago
panzhija
panzhijaCollaborators
15 days ago Create

Document Link(文档链接)

以下为修复前版本的文档入口,问题涉及各目录中的 README 及中文接口、IR、融合说明:

Issues Section(问题文档片段)

  • TransQuantParam 的 README 只有目录说明,缺少产品支持、功能、参数、约束和调用说明。
  • aclnnTransQuantParam 功能说明将 scale 编码描述为“保留高19位(即bit位13~31,低13位清零)”,与当前 Host 实现保留完整 32 位的行为不一致;错误码表还将 scaleArray 为空归入 ACLNN_ERR_PARAM_NULLPTR,而公开接口实际返回 ACLNN_ERR_PARAM_INVALID。
  • TransQuantParamV2/V3 文档对 scale 位模式、roundMode、offset 最近偶数舍入及输出形状组合的说明不够明确。
  • 相关 README、ACLNN、IR、融合及 PyTorch 文档存在章节组织、参数表、列表缩进、代码块标记和章节引用不统一的问题,部分 C++ 示例还需补充头文件、指针初始化及创建 Tensor 后的检查。

Existing Issues(存在的问题)

现有文档的格式和部分接口行为描述与 wiki 模板、当前源码不一致,容易影响调用者对量化编码、输入组合和结果内存管理的理解。

本次按算子 README、ACLNN 等模板核查上述 6 个算子的中文资料,修订 23 份 Markdown 文档:统一结构与排版,补齐链接、约束及返回码,明确 TransQuantParam 的同步 Host 计算、不广播、输出对齐补零和内存释放规则,并完善文档内调用示例。

关联 PR:https://gitcode.com/cann/ops-nn/pull/13862

likedislike
panzhijapanzhijaCollaborators
15 days ago Added label: documentation
panzhijapanzhijaCollaborators
15 days ago Assign smdbha as responsible person
CANN-robotCANN-robotCollaborators
12 days ago Close issue
CANN-robotCANN-robotCollaborators
12 days ago changed custom state from 待办的 to 已完成
CANN-robotCANN-robotCollaborators
12 days ago Added label: resolved
cuijiecuijieCollaborators
9 days ago Associated pull request
cuijiecuijieCollaborators
9 days ago Deleted associated pull request: fix(quant): 同步 trans_quant_param_v2 示例代码与文档调用示例一致
yangyang016yangyang016Collaborators
9 days ago Deleted associated pull request: docs(quant): 规范量化矩阵乘与参数转换算子的中文文档