mindspore.nn.Adam

class mindspore.nn.Adam(params, learning_rate=0.001, beta1=0.9, beta2=0.999, eps=1e-08, use_locking=False, use_nesterov=False, weight_decay=0.0, loss_scale=1.0, use_amsgrad=False, **kwargs)

Adaptive Moment Estimation (Adam)算法的实现。

Adam optimizer可以使用梯度的first-order moment estimation和second-order moment estimation，动态地调整每一个参数的学习率。

请参阅论文 Adam: A Method for Stochastic Optimization。

公式如下：

\[\begin{split}\begin{array}{l} &\newline &\hline \\ &\textbf{Parameters}: \: 1^{\text {st }}\text {moment vector} \: m , \: 2^{\text {nd}} \: \text{moment vector} \: v , \\ &\:\text{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{while} \: w_{t} \: \text{not converged} \: \textbf{do} \\ &\hspace{5mm}\boldsymbol{g}_{t} \leftarrow \nabla_{w} \boldsymbol{f}_{t}\left(\boldsymbol{w}_{t-1}\right) \\ &\hspace{5mm}\textbf {if } \lambda \neq 0 \\ &\hspace{10mm}\boldsymbol{g}_{t} \leftarrow \boldsymbol{g}_{t}+\lambda \boldsymbol{w}_{t-1} \\ &\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}\hat{\boldsymbol{m}}_{t} \leftarrow \boldsymbol{m}_{t} /\left(1-\beta_{1}^{t}\right) \\ &\hspace{5mm}\hat{\boldsymbol{v}}_{t} \leftarrow \boldsymbol{v}_{t} /\left(1-\beta_{2}^{t}\right) \\ &\hspace{5mm}\boldsymbol{w}_{t} \leftarrow \boldsymbol{w}_{t-1}-\gamma \hat{\boldsymbol{m}}_{t} /(\sqrt{\hat{\boldsymbol{v}}_{t}}+\epsilon) \\ &\textbf{end while} \\[-1.ex] &\newline &\hline \\[-1.ex] &\textbf{return} \: \boldsymbol{w}_{t} \\[-1.ex] &\newline &\hline \\[-1.ex] \end{array}\end{split}\]

\(m\) 代表第一个动量矩阵，\(v\) 代表第二个动量矩阵，\(g\) 代表梯度 gradients ，\(\gamma\) 代表学习率 learning_rate ，\(\beta_1, \beta_2\) 代表衰减速率 beta1 和 beta2 ，\(t\) 代表当前step，\(beta_1^t\) 和 \(beta_2^t\) 代表 beta1 和 beta2 的t次方 ， \(w\) 代表 params ， \(\epsilon\) 代表 eps 。

说明

• 如果前向网络使用了SparseGatherV2等算子，优化器会执行稀疏运算。通过设置 target 为CPU，可在主机（host）上进行稀疏运算。稀疏特性在持续开发中。

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

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

当使用Adam时，如果设置 use_lazy =True，需要注意的是，梯度稀疏时该优化器只更新网络参数的当前的索引位置，稀疏行为不等同于Adam算法。如果想执行稀疏策略，那么需要把target设置为CPU。

当使用Adam时，如果设置 use_offload =True，需要注意的是，此优化器目前仅支持图模式。

参数：

• params (Union[list[Parameter], list[dict]]) - 必须是 Parameter 组成的列表或字典组成的列表。当列表元素是字典时，字典的键可以是"params"、"lr"、"weight_decay"、"grad_centralization"和"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值。

  • grad_centralization - 可选。如果键中存在"grad_centralization"，则使用对应的值，该值必须为布尔类型。如果没有，则认为 grad_centralization 为False。该参数仅适用于卷积层。

  • 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) - 第一个动量矩阵的指数衰减率。参数范围（0.0,1.0）。默认值： 0.9 。

• beta2 (float) - 第二个动量矩阵的指数衰减率。参数范围（0.0,1.0）。默认值： 0.999 。

• eps (float) - 加在分母上的值，以确保数值稳定。必须大于0。默认值： 1e-8 。

• use_locking (bool) - 是否对参数更新加锁保护。如果为 True ，则 w 、m 和 v 的tensor更新将受到锁的保护。如果为 False ，则结果不可预测。默认值： False 。

• use_nesterov (bool) - 是否使用Nesterov Accelerated Gradient (NAG)算法更新梯度。如果为 True ，使用NAG更新梯度。如果为 False ，则在不使用NAG的情况下更新梯度。默认值：False 。

• use_amsgrad (bool) - 是否使用Amsgrad算法更新梯度。如果为 True ，使用Amsgrad更新梯度。如果为 False ，则在不使用Amsgrad的情况下更新梯度。默认值： False 。

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

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

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

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

• loss_scale (float) - 梯度缩放系数，必须大于0.0。如果 loss_scale 是整数，它将被转换为浮点数。通常使用默认值，仅当训练时使用了 FixedLossScaleManager，且 FixedLossScaleManager 的 drop_overflow_update 属性配置为 False 时，此值需要与 FixedLossScaleManager 中的 loss_scale 相同。有关更多详细信息，请参阅 mindspore.amp.FixedLossScaleManager。默认值： 1.0 。

• kwargs -

  • use_lazy (bool)：是否使用Lazy Adam算法。默认值： False 。如果为 True ，使用lazy Adam，反之使用普通Adam算法。

  • use_offload (bool)：是否在主机CPU上运行Adam优化算法。默认值： False 。如果为 True ，使用offload方法，反之使用普通Adam算法。

输入：

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

输出：

Tensor[bool]，值为True。

异常：

• KeyError - 如果 kwargs 接收到非 'use_lazy' or 'use_offload' 的关键字。

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

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

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

• TypeError - weight_decay 不是float或int。

• TypeError - use_locking 、 use_nesterov 、 use_amsgrad 、 use_lazy 或 use_offload 不是bool。

• ValueError - loss_scale 或 eps 小于或等于0。

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

• ValueError - weight_decay 小于0。

• ValueError - use_lazy 和 use_offload 均为 True 。

• ValueError - use_amsgrad 为True时， use_lazy 或 use_offload 亦为 True 。

• ValueError - 在分布式训练时， use_amsgrad 为 True 。

支持平台：

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.1/docs/mindspore/code/lenet.py
>>> net = LeNet5()
>>> #1) All parameters use the same learning rate and weight decay
>>> optim = nn.Adam(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, 'grad_centralization':True},
...                 {'params': no_conv_params, 'lr': 0.01},
...                 {'order_params': net.trainable_params()}]
>>> optim = nn.Adam(group_params, learning_rate=0.1, weight_decay=0.0, use_lazy=False, use_offload=False)
>>> # The conv_params's parameters will use default learning rate of 0.1 and weight decay of 0.01 and grad
>>> # centralization of True.
>>> # The no_conv_params's parameters will use learning rate of 0.01 and default weight decay of 0.0 and grad
>>> # centralization of False.
>>> # 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)