Closed
[Documentation|文档问题]: norm/group_norm: aclnn 文档将总体方差写成样本方差 #7337
zhu_qiAdd on  27 days agoClosed at  17 days ago
zhu_qi
zhu_qi
27 days ago Create

一、问题描述(必填)

docs/aclnnGroupNorm.md 第 29 行将方差表述为「样本方差」,但公式分母为 1/n,对应总体方差。同目录 README.md 写明 variance 为「每组总体方差」,op_graph/group_norm_proto.h 写明 population variance。同一算子文档术语冲突,容易误解 rstdOut 与 GE variance 的数值含义。

二、环境信息

代码与文档静态对照,仓库 cann/ops-nn,路径 norm/group_norm/docs/aclnnGroupNorm.md。

三、重现步骤

对照以下三处:

  1. docs/aclnnGroupNorm.md:29:Var[x] = 1/n * sum(...),正文写「样本方差」。
  2. README.md:variance 为「每组总体方差」。
  3. op_graph/group_norm_proto.h:population variance。

四、预期结果

aclnn 文档应与公式及 GE 文档一致,将「样本方差」改为「总体方差」。

五、日志 / 代码位置

norm/group_norm/docs/aclnnGroupNorm.md:29

likedislike
yuning_chen
yuning_chenCollaborators
26 days ago Comments:

初步分析

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

现象理解:文档反馈;norm/group_norm: aclnn 文档将总体方差写成样本方差。
当前判断:从描述看,这是资料/注释与实现口径不一致类文档反馈「norm/group_norm: aclnn 文档将总体方差写成样本方差」。需要对照接口文档、头文件注释与实现/实测结果核对哪一侧需修正。以上为初步判断,待复现确认,不能当成已确认根因。
涉及范围:aclnnGroupNorm
下一步:我们会先核对文档声明与实现/测试结果是否一致,再决定改资料还是改代码。

likedislike
yuning_chenyuning_chenCollaborators
25 days ago Assign east_yang as responsible person
yuning_chen
yuning_chenCollaborators
25 days ago Comments:

您好,问题已收到,当前 @east_yang 正在处理中。

likedislike
east_yangeast_yangCollaborators
25 days ago Assign liujie12345678 as responsible person
east_yangeast_yangCollaborators
25 days ago Removed responsible person east_yang
liujie12345678liujie12345678Collaborators
24 days ago Assign gitee-duhuiping as responsible person
liujie12345678liujie12345678Collaborators
24 days ago Removed responsible person liujie12345678
gitee-duhuipinggitee-duhuipingCollaborators
18 days ago Associated pull request
CANN-robotCANN-robotCollaborators
17 days ago Close issue
CANN-robotCANN-robotCollaborators
16 days ago Added label: resolved
chenjiayi_
chenjiayi_Collaborators
11 days ago Comments:

补充说明本问题的修复结果:

结论:文档已按公式口径改正,aclnnGroupNorm 计算公式中的「样本方差」改为「总体方差」。

修复内容(文件/函数):

  • norm/group_norm/docs/aclnnGroupNorm.md:29:Var[x] = 1/n * Σ(x_i - E[x])² 的说明由「代表 x 的样本方差」改为「代表 x 的总体方差」。
  • norm/group_norm/docs/aclnnGroupNorm_en.md:同步修改英文表述。

验证:

  • 静态核对:修改后的表述与公式分母 1/n、同目录 README.md 的「每组总体方差」、op_graph/group_norm_proto.h 的 population variance 一致。
  • 本次仅改文档,不涉及代码与数值结果。

该 issue 已随修复合入关闭。

MR 链接:https://gitcode.com/cann/ops-nn/merge_requests/13602

likedislike