Closed
[Documentation|文档反馈]: HardtanhGrad 文档中的两个输入含义写反 #9226
拾光客Add on 3 days agoClosed at 2 days ago
3 days ago Added label: documentation
3 days ago Associated pull request
3 days ago Assign shiguangke as responsible person
yuning_chen
3 days ago Comments:
3 days ago Comments:
文档问题成立,两个输入含义写反属于「照着文档写会直接算错」的严重文档缺陷。建议:①按 op_graph/hardtanh_grad_proto.h 的定义修正中英文两份(result 是前向输出、grad 是上游梯度,两者顺序与语义都要对齐原型);②在公式区补一句「resul* 参与 mask、grad* 是待乘的梯度」,让读者能自查方向。建议顺手检查同类「反向算子文档输入顺序」的算子(activation 下 grad 系算子),这类错误往往是批量复制文档时一起带过来的。


3 days ago Assign ASCEND222 as responsible person, remove original responsible person: shiguangke
3 days ago Assign ASCEND222 as responsible person, remove original responsible person: shiguangke
yuning_chen
3 days ago Comments:
3 days ago Comments:
您好,问题已收到,当前 @ascend222 正在处理中。


3 days ago Associated pull request
2 days ago Associated pull request
2 days ago changed custom state from 待办的 to 已完成
2 days ago Close issue
文档链接
问题描述
两份 README 将输入
result描述为反向梯度,将grad描述为前向输入;但图模式调用的实际顺序是前向输入在前、反向梯度在后。图模式原型注释也没有正确说明这两个参数,README 输出参数名out与算子注册的y不一致。activation/hardtanh_grad/op_api/hardtanh_grad.cpp以OP_INPUT(self, gradOutput)调用算子;tests/assets/golden.py也是用第一个输入比较上下限,再选择第二个输入。按目前 README 交换传入顺序会得到错误计算结果。复现及建议
例如前向输入
[-2, 0, 2]、梯度[10, 20, 30],上下限分别为 -1 和 1。参考函数按实际顺序得到[0, 20, 0],按文档中描述的顺序传入则得到[0, 0, 0]。建议将
result的描述改为前向输入、grad改为反向梯度,并将算子输出名统一为y;同步修正图模式原型注释。