mindspore.nn.Adagrad
=====================

.. py:class:: mindspore.nn.Adagrad(params, accum=0.1, learning_rate=0.001, update_slots=True, loss_scale=1.0, weight_decay=0.0)

    Adagrad算法的实现。

    Adagrad用于在线学习和随机优化。
    请参阅论文 `Efficient Learning using Forward-Backward Splitting <https://proceedings.neurips.cc/paper/2009/file/621bf66ddb7c962aa0d22ac97d69b793-Paper.pdf>`_。

    Adagrad可以根据不同参数的样本数量不均，自适应地给每个参数分配不同的学习率。

    公式如下：

    .. math::
        \begin{array}{ll} \\
            &\newline
            &\hline \\
            &\textbf{Parameters}: \text{learning rate } \gamma, \:  \text{ params } w_0, \:
                \: \text{ weight decay } \lambda, \\
            &\hspace{12mm} \text{ initial accumulator value } state\_sum\\
            &\textbf{Init}: state\_sum_0 \leftarrow 0 \\[-1.ex]
            &\newline
            &\hline \\
            &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do} \\
            &\hspace{5mm}g_t  \leftarrow  \nabla_{w} f_t (w_{t-1}) \\
            &\hspace{5mm} \textbf{if} \: \lambda \neq 0 \\
            &\hspace{10mm} g_t \leftarrow g_t + \lambda w_{t-1} \\
            &\hspace{5mm}state\_sum_t  \leftarrow  state\_sum_{t-1} + g^2_t \\
            &\hspace{5mm}w_t \leftarrow w_{t-1}- \gamma*\frac{g_t}{\sqrt{state\_sum_t} + \epsilon} \\
            &\newline
            &\hline \\
            &\bf{return} \:  w_t \\[-1.ex]
            &\newline
            &\hline \\
        \end{array}

    :math:`state\_sum` 表示梯度平方的累加和 :math:`accum` 。:math:`g` 表示 `grads` ，:math:`\lambda` 代表 `weight_decay`  。
    :math:`\gamma` 代表 `learning_rate`，:math:`w` 代表 `params` 。
    :math:`t` 代表当前的 `step`。

    .. note::
        .. include:: mindspore.nn.optim_note_weight_decay.txt

    参数：
        - **params** (Union[list[Parameter], list[dict]]) - 必须是 `Parameter` 组成的列表或字典组成的列表。当列表元素是字典时，字典的键可以是"params"、"lr"、"weight_decay"、"grad_centralization"和"order_params"：

          .. include:: mindspore.nn.optim_group_param.txt
          .. include:: mindspore.nn.optim_group_lr.txt
          .. include:: mindspore.nn.optim_group_weight_decay.txt
          .. include:: mindspore.nn.optim_group_gc.txt
          .. include:: mindspore.nn.optim_group_order.txt

        - **accum** (float) - 累加器 :math:`h` 的初始值，必须大于等于零。默认值： ``0.1`` 。
        - **learning_rate** (Union[float, int, Tensor, Iterable, LearningRateSchedule]) - 默认值： ``0.001`` 。

          .. include:: mindspore.nn.optim_arg_dynamic_lr.txt

        - **update_slots** (bool) - 如果为 ``True`` ，则更新累加器 :math:`h` 。默认值： ``True`` 。

        .. include:: mindspore.nn.optim_arg_loss_scale.txt

        - **weight_decay** (Union[float, int, Cell]) - 要乘以权重的权重衰减值，必须大于等于 ``0.0`` 。默认值： ``0.0`` 。

          - float：固定的权量衰减值。必须等于或大于0。
          - int：固定的权量衰减值。必须等于或大于0。它将会被转换为float类型。
          - Cell：权重衰减此时是动态的。在训练期间，优化器调用该Cell的实例，以获取当前阶段所要使用的权重衰减值。

    输入：
        - **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。