|
- mindspore.nn.Adagrad
- =====================
-
- .. py:class:: mindspore.nn.Adagrad(*args, **kwargs)
-
- 使用ApplyAdagrad算子实现Adagrad算法。
-
- Adagrad用于在线学习和随机优化。
- 请参阅论文`Efficient Learning using Forward-Backward Splitting <https://proceedings.neurips.cc/paper/2009/file/621bf66ddb7c962aa0d22ac97d69b793-Paper.pdf>`_。
- 公式如下：
-
- .. math::
- \begin{array}{ll} \\
- h_{t+1} = h_{t} + g\\
- w_{t+1} = w_{t} - lr*\frac{1}{\sqrt{h_{t+1}}}*g
- \end{array}
-
- :math:`h` 表示梯度平方的累积和，:math:`g` 表示 `grads` 。
- :math:`lr` 代表 `learning_rate`，:math:`w` 代表 `params` 。
-
- .. note::
- 在参数未分组时，优化器配置的 `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) - 累加器 :math:`h` 的初始值，必须大于等于零。默认值：0.1。
- - **learning_rate** (Union[float, Tensor, Iterable, LearningRateSchedule]) - 默认值：0.001。
-
- - **float** - 固定的学习率。必须大于等于零。
- - **int** - 固定的学习率。必须大于等于零。整数类型会被转换为浮点数。
- - **Tensor** - 可以是标量或一维向量。标量是固定的学习率。一维向量是动态的学习率，第i步将取向量中第i个值作为学习率。
- - **Iterable** - 动态的学习率。第i步将取迭代器第i个值作为学习率。
- - **LearningRateSchedule** - 动态的学习率。在训练过程中，优化器将使用步数（step）作为输入，调用 `LearningRateSchedule` 实例来计算当前学习率。
-
- - **update_slots** (bool) - 如果为True，则更新累加器 :math:`h` 。默认值：True。
- - **loss_scale** (float) - 梯度缩放系数，必须大于0。如果`loss_scale`是整数，它将被转换为浮点数。通常使用默认值，仅当训练时使用了 `FixedLossScaleManager` ，且 `FixedLossScaleManager` 的 `drop_overflow_update` 属性配置为False时，此值需要与 `FixedLossScaleManager` 中的 `loss_scale` 相同。有关更多详细信息，请参阅class：`mindspore.FixedLossScaleManager` 。默认值：1.0。
- - **weight_decay** (Union[float, int]) - 要乘以权重的权重衰减值，必须大于等于0.0。默认值：0.0。
-
- **输入：**
-
- **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``
-
- **样例：**
-
- >>> net = Net()
- >>> #1) 所有参数使用相同的学习率和权重衰减
- >>> optim = nn.Adagrad(params=net.trainable_params())
- >>>
- >>> #2) 使用参数组并设置不同的值
- >>> 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)
- >>> # conv_params参数组将使用优化器中的学习率0.1、该组的权重衰减0.01、该组的梯度中心化配置True。
- >>> # no_conv_params参数组将使用该组的学习率0.01、优化器中的权重衰减0.0、梯度中心化使用默认值False。
- >>> # 优化器按照"order_params"配置的参数顺序更新参数。
- >>>
- >>> loss = nn.SoftmaxCrossEntropyWithLogits()
- >>> model = Model(net, loss_fn=loss, optimizer=optim)
|
