• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1mindspore.ops.SparseApplyAdagradV2
2==================================
3
4.. py:class:: mindspore.ops.SparseApplyAdagradV2(lr, epsilon, update_slots=True, use_locking=False)
5
6    根据Adagrad算法更新相关参数。
7
8    .. math::
9        \begin{array}{ll} \\
10            accum += grad * grad \\
11            var -= lr * grad * \frac{1}{\sqrt{accum} + \epsilon}
12        \end{array}
13
14    :math:`\epsilon` 代表 `epsilon`。
15
16    `var` 、 `accum` 和 `grad` 的输入遵循隐式类型转换规则，使数据类型一致。如果它们具有不同的数据类型，则低精度数据类型将转换为相对最高精度的数据类型。
17
18    参数：
19        - **lr** (float) - 学习率。
20        - **epsilon** (float) - 添加到分母上的较小值，以确保数值的稳定性。
21        - **update_slots** (bool) - 如果为 ``True`` ，则将更新 `accum` 。默认值： ``True`` 。
22        - **use_locking** (bool) - 是否对参数更新加锁保护。默认值： ``False`` 。
23
24    输入：
25        - **var** (Parameter) - 要更新的变量。为任意维度，其数据类型为float16或float32。其shape为 :math:`(N, *)` ，其中 :math:`*` 为任意数量的额外维度。
26        - **accum** (Parameter) - 要更新的累积。shape必须与 `var` 相同。
27        - **grad** (Tensor) - 梯度，为一个Tensor。shape必须与 `var` 相同，且需要满足当 `var.shape > 1` 时 :math:`grad.shape[1:] = var.shape[1:]`。
28        - **indices** (Tensor) - `var` 和 `accum` 第一维度的索引向量，数据类型为int32，且需要保证 :math:`indices.shape[0] = grad.shape[0]`。
29
30    输出：
31        2个Tensor组成的tuple，更新后的参数。
32
33        - **var** (Tensor) - shape和数据类型与 `var` 相同。
34        - **accum** (Tensor) - shape和数据类型与 `accum` 相同。
35
36    异常：
37        - **TypeError** - 如果 `lr` 或者 `epsilon` 不是float类型。
38        - **TypeError** - 如果 `update_slots` 或者 `use_locking` 不是布尔值。
39        - **TypeError** - 如果 `var` 、 `accum` 、 `lr` 或 `grad` 的数据类型既不是float16也不是float32。
40        - **TypeError** - 如果 `indices` 的数据类型不是int32。
41        - **RuntimeError** - 如果 `var` 、 `accum` 和 `grad` 不支持数据类型转换。
42