mindspore.nn.Adagrad

class mindspore.nn.Adagrad(params, accum=0.1, learning_rate=0.001, update_slots=True, loss_scale=1.0, weight_decay=0.0)[源代码]

Adagrad算法的实现。

Adagrad用于在线学习和随机优化。 请参阅论文 Efficient Learning using Forward-Backward Splitting。

Adagrad可以根据不同参数的样本数量不均，自适应地给每个参数分配不同的学习率。

公式如下：

\[\begin{split}\begin{array}{ll} \\ &\newline &\hline \\ &\textbf{Parameters}: \text{learning rate } \gamma, \: \text{ params } w_0, \: \: \text{ weight decay } \lambda, \\ &\hspace{12mm} \text{ initial accumulator value } state\_sum\\ &\textbf{Init}: state\_sum_0 \leftarrow 0 \\[-1.ex] &\newline &\hline \\ &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do} \\ &\hspace{5mm}g_t \leftarrow \nabla_{w} f_t (w_{t-1}) \\ &\hspace{5mm} \textbf{if} \: \lambda \neq 0 \\ &\hspace{10mm} g_t \leftarrow g_t + \lambda w_{t-1} \\ &\hspace{5mm}state\_sum_t \leftarrow state\_sum_{t-1} + g^2_t \\ &\hspace{5mm}w_t \leftarrow w_{t-1}- \gamma*\frac{g_t}{\sqrt{state\_sum_t} + \epsilon} \\ &\newline &\hline \\ &\bf{return} \: w_t \\[-1.ex] &\newline &\hline \\ \end{array}\end{split}\]

\(state\_sum\) 表示梯度平方的累积和 \(accum\) 。\(g\) 表示 grads ，\(\lambda\) 代表 weight_decay 。 \(\gamma\) 代表 learning_rate，\(w\) 代表 params 。

说明

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

用户可以分组调整权重衰减策略。

分组时，每组网络参数均可配置 weight_decay 。若未配置，则该组网络参数使用优化器中配置的 weight_decay 。

参数：

  • 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 作为权重衰减值。

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

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

  • accum (float) - 累加器 \(h\) 的初始值，必须大于等于零。默认值：0.1。

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

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

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

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

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

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

  • update_slots (bool) - 如果为True，则更新累加器 \(h\) 。默认值：True。

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

  • weight_decay (Union[float, int, Cell]) - 要乘以权重的权重衰减值，必须大于等于0.0。默认值：0.0。

    • float：固定的权量衰减值。必须等于或大于0。

    • int：固定的权量衰减值。必须等于或大于0。它将会被转换为float类型。

    • Cell：权重衰减此时是动态的。在训练期间，优化器调用该Cell的实例，以获取当前阶段所要使用的权重衰减值。

输入：

  • grads (tuple[Tensor]) - 优化器中 params 的梯度，形状（shape）与 params 相同。

输出：

Tensor[bool]，值为True。

异常：

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

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

  • TypeError - accum 或 loss_scale 不是float。

  • TypeError - update_slots 不是bool。

  • TypeError - weight_decay 不是float或int。

  • ValueError - loss_scale 小于或等于0。

  • ValueError - accum 或 weight_decay 小于0。

支持平台：

Ascend CPU GPU

样例：

>>> import mindspore as ms
>>> from mindspore import nn
>>>
>>> net = Net()
>>> #1) All parameters use the same learning rate and weight decay
>>> optim = nn.Adagrad(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.Adagrad(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 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)