mindspore.ops.ApplyAdagradDA

class mindspore.ops.ApplyAdagradDA(use_locking=False)

根据Adagrad算法更新 var 。

Adagrad算法在论文 Adaptive Subgradient Methods for Online Learning and Stochastic Optimization 中提出。

$$\begin{array}{r}\begin{array}{l}\\ grad\mathrm{\_}accum+=grad\\ grad\mathrm{\_}squared\mathrm{\_}accum+=grad\ast grad\\ tmp\mathrm{\_}val=\{\begin{array}{ll}sign(grad\mathrm{\_}accum)\ast max\{|grad\mathrm{\_}accum|-l1\ast global\mathrm{\_}step,0\}& \text{ if }l1>0\\ grad\mathrm{\_}accum& \text{ otherwise }\end{array}\\ x\mathrm{\_}value=-1\ast lr\ast tmp\mathrm{\_}val\\ y\mathrm{\_}value=l2\ast global\mathrm{\_}step\ast lr+\sqrt{grad\mathrm{\_}squared\mathrm{\_}accum}\\ var=\frac{x\mathrm{\_}value}{y\mathrm{\_}value}\end{array}\end{array}$$

var 、 gradient_accumulator 、 gradient_squared_accumulator 和 grad 的输入遵循隐式类型转换规则，使数据类型一致。 如果它们具有不同的数据类型，则较低精度的数据类型将转换为相对最高精度的数据类型。

参数：

• use_locking (bool) - 如果为 True ， var 和 gradient_accumulator 的更新将受到锁的保护。否则，行为为未定义，很可能出现较少的冲突。默认值为 False 。

输入：

• var (Union[Parameter, Tensor]) - 要更新的变量。数据类型必须为float16或float32。shape： $(N,\ast )$ ，其中 $\ast$ 表示任意数量的附加维度。

• gradient_accumulator (Union[Parameter, Tensor]) - 要更新累积的梯度，为公式中的 $grad\mathrm{\_}accum$ 。shape必须与 var 相同。

• gradient_squared_accumulator (Union[Parameter, Tensor]) - 要更新的平方累积的梯度，为公式中的 $grad\mathrm{\_}squared\mathrm{\_}accum$ 。shape必须与 var 相同。

• grad (Tensor) - 梯度，为一个Tensor。shape必须与 var 相同。

• lr ([Number, Tensor]) - 学习率。必须是Scalar。数据类型为float32或float16。

• l1 ([Number, Tensor]) - L1正则化。必须是Scalar。数据类型为float32或float16。

• l2 ([Number, Tensor]) - L2正则化。必须是Scalar。数据类型为float32或float16。

• global_step ([Number, Tensor]) - 训练步骤的编号。必须是Scalar。数据类型为int32或int64。

输出：

1个Tensor组成的tuple，更新后的参数或者Tensor。

• var (Tensor) - shape和数据类型与 var 相同。

异常：

• TypeError - 如果 var 、 gradient_accumulator 或 gradient_squared_accumulator 不是Parameter或者Tensor。

• TypeError - 如果 grad 不是 Tensor。

• TypeError - 如果 lr 、 l1 、 l2 或者 global_step 既不是数值型也不是Tensor。

• TypeError - 如果 use_locking 不是bool。

• TypeError - 如果 var 、 gradient_accumulator 、 gradient_squared_accumulator 、 grad 、 lr 、 l1 或 l2 的数据类型既不是float16也不是float32。

• TypeError - 如果 gradient_accumulator 、 gradient_squared_accumulator 、 grad 与 var 的数据类型不相同。

• TypeError - 如果 global_step 的数据类型不是int32也不是int64。

• ValueError - 如果 lr 、 l1 、 l2 和 global_step 的shape大小不为0。

• TypeError - 如果 var 、 gradient_accumulator 、 gradient_squared_accumulator 和 grad 不支持数据类型转换。

支持平台：

Ascend GPU CPU

样例：

>>> import numpy as np
>>> from mindspore import dtype as mstype
>>> from mindspore import Tensor, nn, ops, Parameter
>>> class ApplyAdagradDANet(nn.Cell):
...     def __init__(self, use_locking=False):
...         super(ApplyAdagradDANet, self).__init__()
...         self.apply_adagrad_d_a = ops.ApplyAdagradDA(use_locking)
...         self.var = Parameter(Tensor(np.array([[0.6, 0.4], [0.1, 0.5]]).astype(np.float32)), name="var")
...         self.gradient_accumulator = Parameter(Tensor(np.array([[0.1, 0.3],
...                                                                [0.1, 0.5]]).astype(np.float32)),
...                                               name="gradient_accumulator")
...         self.gradient_squared_accumulator = Parameter(Tensor(np.array([[0.2, 0.1],
...                                                                        [0.1, 0.2]]).astype(np.float32)),
...                                                       name="gradient_squared_accumulator")
...         self.gradient_accumulator = Parameter(Tensor(np.array([[0.1, 0.3],
...                                                                [0.1, 0.5]]).astype(np.float32)),
...                                               name="gradient_accumulator")
...     def construct(self, grad, lr, l1, l2, global_step):
...         out = self.apply_adagrad_d_a(self.var, self.gradient_accumulator,
...                                      self.gradient_squared_accumulator, grad, lr, l1, l2, global_step)
...         return out
...
>>> net = ApplyAdagradDANet()
>>> grad = Tensor(np.array([[0.3, 0.4], [0.1, 0.2]]).astype(np.float32))
>>> lr = Tensor(0.001, mstype.float32)
>>> l1 = Tensor(0.001, mstype.float32)
>>> l2 = Tensor(0.001, mstype.float32)
>>> global_step = Tensor(2, mstype.int32)
>>> output = net(grad, lr, l1, l2, global_step)
>>> print(output)
[[-0.00073906, -0.00136889],
 [-0.00059699, -0.00142478]]