mindspore.nn.ASGD

class mindspore.nn.ASGD(params, learning_rate=0.1, lambd=0.0001, alpha=0.75, t0=1000000.0, weight_decay=0.0)[源代码]

随机平均梯度下降（ASGD）算法的实现。

请参阅论文 Acceleration of stochastic approximation by average 。

更新公式如下：

\[\begin{split}\begin{gather*} w_{t} = w_{t-1} * (1 - \lambda * \eta_{t-1}) - \eta_{t-1} * g_{t} \\ ax_{t} = (w_t - ax_{t-1}) * \mu_{t-1} \\ \eta_{t} = \frac{1.}{(1 + \lambda * lr * t)^\alpha} \\ \mu_{t} = \frac{1}{\max(1, t - t0)} \end{gather*}\end{split}\]

\(\lambda\) 代表衰减项， \(\mu\) 和 \(\eta\) 被跟踪以更新 \(ax\) 和 \(w\) ， \(t0\) 代表开始平均的点， \(\alpha\) 代表 \(\eta\) 更新的系数， \(ax\) 表示平均参数值， \(t\) 表示当前步数（step）， \(g\) 表示 gradients ， \(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 作为权重衰减值。值得注意的是， 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]) - 学习率。默认值： 0.1 。
- float - 固定的学习率。必须大于等于零。
- int - 固定的学习率。必须大于等于零。整数类型会被转换为浮点数。
- Tensor - 可以是标量或一维向量。标量是固定的学习率。一维向量是动态的学习率，第i步将取向量中第i个值作为学习率。
- Iterable - 动态的学习率。第i步将取迭代器第i个值作为学习率。
- LearningRateSchedule - 动态的学习率。在训练过程中，优化器将使用步数（step）作为输入，调用 LearningRateSchedule 实例来计算当前学习率。
lambd (float) - 衰减项。默认值： 1e-4 。
alpha (float) - \(\eta\) 更新的系数。默认值： 0.75 。
t0 (float) - 开始平均的点。默认值： 1e6 。
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 相同。

输出：

Tensor[bool]，值为True。

异常：

TypeError - 如果 learning_rate 不是int、float、Tensor、Iterable或LearningRateSchedule。
TypeError - 如果 parameters 的元素不是Parameter或字典。
TypeError - 如果 lambd 、 alpha 或 t0 不是float。
TypeError - 如果 weight_decay 既不是float也不是int。
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.1/docs/mindspore/code/lenet.py
>>> net = LeNet5()
>>> #1) All parameters use the same learning rate and weight decay
>>> optim = nn.ASGD(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,'grad_centralization':True},
...                 {'params': no_conv_params, 'lr': 0.01},
...                 {'order_params': net.trainable_params()}]
>>> optim = nn.ASGD(group_params, learning_rate=0.1, weight_decay=0.0)
>>> # The conv_params's parameters will use default learning rate of 0.1 default weight decay of 0.0 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.train.Model(net, loss_fn=loss, optimizer=optim)