mindspore.nn.FTRL

class mindspore.nn.FTRL(params, initial_accum=0.1, learning_rate=0.001, lr_power=- 0.5, l1=0.0, l2=0.0, use_locking=False, loss_scale=1.0, weight_decay=0.0)

FTRL算法实现。

FTRL是一种在线凸优化算法，根据损失函数自适应地选择正则化函数。详见论文 Adaptive Bound Optimization for Online Convex Optimization。

更新公式如下：

\[\begin{split}\begin{array}{ll} \\ m_{t+1} = m_{t} + g^2 \\ u_{t+1} = u_{t} + g - \frac{m_{t+1}^\text{-p} - m_{t}^\text{-p}}{\alpha } * \omega_{t} \\ \omega_{t+1} = \begin{cases} \frac{(sign(u_{t+1}) * l1 - u_{t+1})}{\frac{m_{t+1}^\text{-p}}{\alpha } + 2 * l2 } & \text{ if } |u_{t+1}| > l1 \\ 0.0 & \text{ otherwise } \end{cases}\\ \end{array}\end{split}\]

\(m\) 表示累加器，\(g\) 表示 grads， \(t\) 表示当前step，\(u\) 表示需要更新的线性系数，\(p\) 表示 lr_power，\(\alpha\) 表示 learning_rate ，\(\omega\) 表示 params 。

说明

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

• 在参数未分组时，优化器配置的 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 - 学习率当前不支持参数分组。

  • 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 参数中。

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

• learning_rate (float) - 学习速率值必须为零或正数，当前不支持动态学习率。默认值： 0.001 。

• lr_power (float) - 学习率的幂值，控制训练期间学习率的下降方式，必须小于或等于零。如果lr_power为零，则使用固定的学习率。默认值： -0.5 。

• l1 (float) - l1正则化强度，必须大于等于零。默认值： 0.0 。

• l2 (float) - l2正则化强度，必须大于等于零。默认值： 0.0 。

• use_locking (bool) - 如果为True，则更新操作使用锁保护。默认值： False 。

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

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

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

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

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

输入：

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

输出：

tuple[Parameter]，更新的参数，shape与 params 相同。

异常：

• TypeError - initial_accum、learning_rate、lr_power、l1、l2 或 loss_scale 不是float。

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

• TypeError - weight_decay 不是float或int。

• TypeError - use_nesterov 不是bool。

• ValueError - lr_power 大于0。

• ValueError - loss_scale 小于等于0。

• ValueError - initial_accum、l1 或 l2 小于0。

支持平台：

Ascend GPU

样例：

>>> import mindspore as ms
>>> from mindspore import nn
>>>
>>> # Define the network structure of LeNet5. Refer to
>>> # https://gitee.com/mindspore/docs/blob/r2.3.q1/docs/mindspore/code/lenet.py
>>> net = LeNet5()
>>> #1) All parameters use the same learning rate and weight decay
>>> optim = nn.FTRL(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},
...                 {'order_params': net.trainable_params()}]
>>> optim = nn.FTRL(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 default learning rate of 0.1 will use 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)