mindspore.nn.AdamWeightDecay

class mindspore.nn.AdamWeightDecay(params, learning_rate=0.001, beta1=0.9, beta2=0.999, eps=1e-06, weight_decay=0.0)

权重衰减Adam算法的实现。

\[\begin{split}\begin{array}{l} &\newline &\hline \\ &\textbf{Parameters}: \: 1^{\text {st }}\text {moment vector} \: m , \: 2^{\text {nd}} \: \text{moment vector} \: v , \\ &\: gradients \: g, \: \text{learning rate} \: \gamma, \text {exponential decay rates for the moment estimates} \: \beta_{1} \: \beta_{2} , \\ &\:\text {parameter vector} \: w_{0}, \:\text{timestep} \: t, \: \text{weight decay} \: \lambda \\ &\textbf{Init}: m_{0} \leftarrow 0, \: v_{0} \leftarrow 0, \: t \leftarrow 0, \: \text{init parameter vector} \: w_{0} \\[-1.ex] &\newline &\hline \\ &\textbf{repeat} \\ &\hspace{5mm} t \leftarrow t+1 \\ &\hspace{5mm}\boldsymbol{g}_{t} \leftarrow \nabla f_{t}\left(\boldsymbol{w}_{t-1}\right) \\ &\hspace{5mm}\boldsymbol{m}_{t} \leftarrow \beta_{1} \boldsymbol{m}_{t-1}+\left(1-\beta_{1}\right) \boldsymbol{g}_{t} \\ &\hspace{5mm}\boldsymbol{v}_{t} \leftarrow \beta_{2} \boldsymbol{v}_{t-1}+\left(1-\beta_{2}\right) \boldsymbol{g}_{t}^{2} \\ &\hspace{5mm}\boldsymbol{w}_{t} \leftarrow \boldsymbol{w}_{t-1}-\gamma\left({\boldsymbol{m}}_{t} /\left(\sqrt{{\boldsymbol{v}}_{t}}+\epsilon\right)+\lambda \boldsymbol{w}_{t-1}\right) \\ &\textbf{until}\text { stopping criterion is met } \\[-1.ex] &\newline &\hline \\[-1.ex] &\textbf{return} \: \boldsymbol{w}_{t} \\[-1.ex] &\newline &\hline \\[-1.ex] \end{array}\end{split}\]

\(m\) 代表第一个动量矩阵 moment1 ，\(v\) 代表第二个动量矩阵 moment2 ，\(g\) 代表 gradients ，\(\gamma\) 代表 learning_rate ，\(\beta_1, \beta_2\) 代表 beta1 和 beta2 ， \(t\) 代表当前step，\(w\) 代表 params ，\(\lambda\) 代表 weight_decay 。

说明

优化器和混合精度之间通常没有联系。但是，当使用 FixedLossScaleManager 且 FixedLossScaleManager 中的 drop_overflow_update 设置为False时，优化器需要设置'loss_scale'。

由于此优化器没有 loss_scale 的参数，因此需要通过其他方式处理 loss_scale 。

如何正确处理 loss_scale 详见 LossScale。

• 在参数未分组时，优化器配置的 weight_decay 应用于名称不含"beta"或"gamma"的网络参数。

• 用户可以分组调整权重衰减策略。分组时，每组网络参数均可配置 weight_decay 。若未配置，则该组网络参数使用优化器中配置的 weight_decay 。

参数：

• params (Union[list[Parameter], list[dict]]) - 必须是 Parameter 组成的列表或字典组成的列表。当列表元素是字典时，字典的键可以是"params"、"lr"、"weight_decay"、和"order_params"：

  • params - 必填。当前组别的权重，该值必须是 Parameter 列表。

  • lr - 可选。如果键中存在"lr"，则使用对应的值作为学习率。如果没有，则使用优化器中的参数 learning_rate 作为学习率。支持固定和动态学习率。

  • weight_decay - 可选。如果键中存在"weight_decay”，则使用对应的值作为权重衰减值。如果没有，则使用优化器中配置的 weight_decay 作为权重衰减值。 值得注意的是， weight_decay 可以是常量，也可以是Cell类型。Cell类型的weight decay用于实现动态weight decay算法。动态权重衰减和动态学习率相似， 用户需要自定义一个输入为global step的weight_decay_schedule。在训练的过程中，优化器会调用WeightDecaySchedule的实例来获取当前step的weight decay值。

  • order_params - 可选。值的顺序是参数更新的顺序。当使用参数分组功能时，通常使用该配置项保持 parameters 的顺序以提升性能。如果键中存在"order_params"，则会忽略该组配置中的其他键。"order_params"中的参数必须在某一组 params 参数中。

• learning_rate (Union[float, int, Tensor, Iterable, LearningRateSchedule]) - 默认值： 1e-3 。

  • float - 固定的学习率。必须大于等于零。

  • int - 固定的学习率。必须大于等于零。整数类型会被转换为浮点数。

  • Tensor - 可以是标量或一维向量。标量是固定的学习率。一维向量是动态的学习率，第i步将取向量中第i个值作为学习率。

  • Iterable - 动态的学习率。第i步将取迭代器第i个值作为学习率。

  • LearningRateSchedule - 动态的学习率。在训练过程中，优化器将使用步数（step）作为输入，调用 LearningRateSchedule 实例来计算当前学习率。

• beta1 (float) - moment1 的指数衰减率。参数范围（0.0,1.0）。默认值： 0.9 。

• beta2 (float) - moment2 的指数衰减率。参数范围（0.0,1.0）。默认值： 0.999 。

• eps (float) - 将添加到分母中，以提高数值稳定性。必须大于0。默认值： 1e-6 。

• weight_decay (Union[float, int, Cell]) - 权重衰减（L2 penalty）。默认值： 0.0 。

  • float: 固定值，必须大于或者等于0。

  • int: 固定值，必须大于或者等于0，会被转换成float。

  • Cell: 动态weight decay。在训练过程中，优化器会使用步数（step）作为输入，调用该Cell实例来计算当前weight decay值。

输入：

• gradients (tuple[Tensor]) - params 的梯度，shape与 params 相同。

输出：

tuple[bool]，所有元素都为True。

异常：

• TypeError - learning_rate 不是int、float、Tensor、Iterable或LearningRateSchedule。

• TypeError - parameters 的元素不是Parameter或字典。

• TypeError - beta1 、 beta2 或 eps 不是float。

• TypeError - weight_decay 不是float或int。

• ValueError - eps 小于等于0。

• ValueError - beta1 、 beta2 不在（0.0,1.0）范围内。

• ValueError - weight_decay 小于0。

支持平台：

Ascend GPU CPU

样例：

>>> import mindspore as ms
>>> from mindspore import nn
>>>
>>> # Define the network structure of LeNet5. Refer to
>>> # https://gitee.com/mindspore/docs/blob/r2.3.0/docs/mindspore/code/lenet.py
>>> net = LeNet5()
>>> #1) All parameters use the same learning rate and weight decay
>>> optim = nn.AdamWeightDecay(params=net.trainable_params())
>>>
>>> #2) Use parameter groups and set different values
>>> conv_params = list(filter(lambda x: 'conv' in x.name, net.trainable_params()))
>>> no_conv_params = list(filter(lambda x: 'conv' not in x.name, net.trainable_params()))
>>> group_params = [{'params': conv_params, 'weight_decay': 0.01},
...                 {'params': no_conv_params, 'lr': 0.01},
...                 {'order_params': net.trainable_params()}]
>>> optim = nn.AdamWeightDecay(group_params, learning_rate=0.1, weight_decay=0.0)
>>> # The conv_params's parameters will use default learning rate of 0.1 and weight decay of 0.01.
>>> # The no_conv_params's parameters will use learning rate of 0.01 and default weight decay of 0.0.
>>> # The final parameters order in which the optimizer will be followed is the value of 'order_params'.
>>>
>>> loss = nn.SoftmaxCrossEntropyWithLogits()
>>> model = ms.Model(net, loss_fn=loss, optimizer=optim)