ClipGradByNorm

class paddle.nn. ClipGradByNorm ( clip_norm ) [源代码]

将输入的多维Tensor \(X\) 的L2范数限制在 clip_norm 范围之内。

  • 如果L2范数大于 clip_norm ，则该 Tensor 会乘以一个系数进行压缩

  • 如果L2范数小于或等于 clip_norm ，则不会进行任何操作。

输入的 Tensor 不是从该类里传入， 而是默认选择优化器中输入的所有参数的梯度。如果某个参数 ParamAttr 中的 need_clip 值被设置为 False ，则该参数的梯度不会被裁剪。

该类需要在初始化 optimizer 时进行设置后才能生效，可参看 optimizer 文档(例如： SGD )。

裁剪公式如下：

\[\begin{split}Out= \left\{ \begin{aligned} & X & & if (norm(X) \leq clip\_norm)\\ & \frac{clip\_norm∗X}{norm(X)} & & if (norm(X) > clip\_norm) \\ \end{aligned} \right.\end{split}\]

其中 \(norm（X）\) 代表 \(X\) 的L2范数

\[\begin{split}\\norm(X) = (\sum_{i=1}^{n}|x_i|^2)^{\frac{1}{2}}\\\end{split}\]
参数:

  • clip_norm (float) - 所允许的二范数最大值。

代码示例

import paddle

x = paddle.uniform([10, 10], min=-1.0, max=1.0, dtype='float32')
linear = paddle.nn.Linear(in_features=10, out_features=10,
                          weight_attr=paddle.ParamAttr(need_clip=True),
                          bias_attr=paddle.ParamAttr(need_clip=False))
out = linear(x)
loss = paddle.mean(out)
loss.backward()

clip = paddle.nn.ClipGradByNorm(clip_norm=1.0)
sdg = paddle.optimizer.SGD(learning_rate=0.1, parameters=linear.parameters(), grad_clip=clip)
sdg.step()

使用本API的教程文档