mindspore 2.2.11__cp39-cp39-win_amd64.whl → 2.3.0__cp39-cp39-win_amd64.whl

mindspore/dataset/vision/utils.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2022 Huawei Technologies Co., Ltd
+# Copyright 2019-2024 Huawei Technologies Co., Ltd
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
 Interpolation Mode, Resampling Filters
 """
 from enum import Enum, IntEnum
+from fractions import Fraction
 import numbers
 
 import numpy as np
@@ -127,7 +128,10 @@ class AutoAugmentPolicy(str, Enum):
                     AutoAugmentPolicy.CIFAR10: cde.AutoAugmentPolicy.DE_AUTO_AUGMENT_POLICY_CIFAR10,
                     AutoAugmentPolicy.SVHN: cde.AutoAugmentPolicy.DE_AUTO_AUGMENT_POLICY_SVHN}
 
-        return c_values.get(policy)
+        value = c_values.get(policy)
+        if value is None:
+            raise RuntimeError("Unsupported AutoAugmentPolicy, only support IMAGENET, CIFAR10, and SVHN.")
+        return value
 
 
 class Border(str, Enum):
@@ -160,7 +164,11 @@ class Border(str, Enum):
                          Border.EDGE: 'edge',
                          Border.REFLECT: 'reflect',
                          Border.SYMMETRIC: 'symmetric'}
-        return python_values.get(border_type)
+
+        value = python_values.get(border_type)
+        if value is None:
+            raise RuntimeError("Unsupported Border type, only support CONSTANT, EDGE, REFLECT and SYMMETRIC.")
+        return value
 
     @staticmethod
     def to_c_type(border_type):
@@ -172,7 +180,10 @@ class Border(str, Enum):
                     Border.REFLECT: cde.BorderType.DE_BORDER_REFLECT,
                     Border.SYMMETRIC: cde.BorderType.DE_BORDER_SYMMETRIC}
 
-        return c_values.get(border_type)
+        value = c_values.get(border_type)
+        if value is None:
+            raise RuntimeError("Unsupported Border type, only support CONSTANT, EDGE, REFLECT and SYMMETRIC.")
+        return value
 
 
 class ConvertMode(IntEnum):
@@ -250,7 +261,11 @@ class ConvertMode(IntEnum):
                     ConvertMode.COLOR_RGBA2GRAY: cde.ConvertMode.DE_COLOR_RGBA2GRAY,
                     }
 
-        return c_values.get(mode)
+        mode = c_values.get(mode)
+        if mode is None:
+            raise RuntimeError("Unsupported ConvertMode, see https://www.mindspore.cn/docs/zh-CN/master/api_python/"
+                               "dataset_vision/mindspore.dataset.vision.ConvertColor.html for more details.")
+        return mode
 
 
 class ImageBatchFormat(IntEnum):
@@ -273,7 +288,10 @@ class ImageBatchFormat(IntEnum):
         c_values = {ImageBatchFormat.NHWC: cde.ImageBatchFormat.DE_IMAGE_BATCH_FORMAT_NHWC,
                     ImageBatchFormat.NCHW: cde.ImageBatchFormat.DE_IMAGE_BATCH_FORMAT_NCHW}
 
-        return c_values.get(image_batch_format)
+        value = c_values.get(image_batch_format)
+        if value is None:
+            raise RuntimeError("Unsupported ImageBatchFormat, only support NHWC and NCHW.")
+        return value
 
 
 class ImageReadMode(IntEnum):
@@ -298,7 +316,11 @@ class ImageReadMode(IntEnum):
         c_values = {ImageReadMode.UNCHANGED: cde.ImageReadMode.DE_IMAGE_READ_MODE_UNCHANGED,
                     ImageReadMode.GRAYSCALE: cde.ImageReadMode.DE_IMAGE_READ_MODE_GRAYSCALE,
                     ImageReadMode.COLOR: cde.ImageReadMode.DE_IMAGE_READ_MODE_COLOR}
-        return c_values.get(image_read_mode)
+
+        value = c_values.get(image_read_mode)
+        if value is None:
+            raise RuntimeError("Unsupported ImageReadMode, only support UNCHANGED, GRAYSCALE and COLOR.")
+        return value
 
 
 class Inter(IntEnum):
@@ -334,7 +356,10 @@ class Inter(IntEnum):
                          Inter.LINEAR: LINEAR,
                          Inter.CUBIC: CUBIC}
 
-        return python_values.get(inter_type)
+        value = python_values.get(inter_type)
+        if value is None:
+            raise RuntimeError("Unsupported interpolation, only support NEAREST, ANTIALIAS, LINEAR and CUBIC.")
+        return value
 
     @staticmethod
     def to_c_type(inter_type):
@@ -347,7 +372,11 @@ class Inter(IntEnum):
                     Inter.AREA: cde.InterpolationMode.DE_INTER_AREA,
                     Inter.PILCUBIC: cde.InterpolationMode.DE_INTER_PILCUBIC}
 
-        return c_values.get(inter_type)
+        value = c_values.get(inter_type)
+        if value is None:
+            raise RuntimeError("Unsupported interpolation, only support NEAREST, LINEAR, CUBIC, AREA and PILCUBIC.")
+
+        return value
 
 
 class SliceMode(IntEnum):
@@ -370,7 +399,10 @@ class SliceMode(IntEnum):
         c_values = {SliceMode.PAD: cde.SliceMode.DE_SLICE_PAD,
                     SliceMode.DROP: cde.SliceMode.DE_SLICE_DROP}
 
-        return c_values.get(mode)
+        value = c_values.get(mode)
+        if value is None:
+            raise RuntimeError("Unsupported SliceMode, only support PAD and DROP.")
+        return value
 
 
 def encode_jpeg(image, quality=75):
@@ -595,6 +627,125 @@ def read_image(filename, mode=ImageReadMode.UNCHANGED):
     return cde.read_image(filename, ImageReadMode.to_c_type(mode)).as_array()
 
 
+def read_video(filename, start_pts=0, end_pts=None, pts_unit="pts"):
+    """
+    Read the video, audio, metadata from a video file.
+
+    It supports AVI, H264, H265, MOV, MP4, WMV file formats.
+
+    Args:
+        filename(str): The path to the video file to be read.
+        start_pts(Union[float, Fraction, int], optional): The start presentation timestamp of the video. Default: 0.
+        end_pts(Union[float, Fraction, int], optional): The end presentation timestamp of the video. Default: None.
+            The None is represented by 2147483647.
+        pts_unit(str, optional): The unit of the timestamps. It can be any of ["pts", "sec"]. Default: "pts".
+
+    Returns:
+        - numpy.ndarray, four dimensions uint8 data for video. The format is [T, H, W, C]. `T` is the number of frames,
+          `H` is the height, `W` is the width, `C` is the channel for RGB.
+        - numpy.ndarray, two dimensions float for audio. The format is [C, L]. `C` is the number of channels.
+          `L` is the length of the points in one channel.
+        - dict, metadata for the video and audio.
+          It contains video_fps data of type float and audio_fps data of type int.
+
+    Raises:
+        TypeError: If `filename` is not of type str.
+        TypeError: If `start_pts` is not of type [float, Fraction, int].
+        TypeError: If `end_pts` is not of type [float, Fraction, int].
+        TypeError: If `pts_unit` is not of type str.
+        RuntimeError: If `filename` does not exist, or not a regular file, or not a supported video file.
+        ValueError: If `start_pts` is less than 0.
+        ValueError: If `end_pts` is less than `start_pts`.
+        ValueError: If `pts_unit` is not in ["pts", "sec"].
+
+    Supported Platforms:
+        ``CPU``
+
+    Examples:
+        >>> import mindspore.dataset.vision as vision
+        >>> video_output, audio_output, metadata_output = vision.read_video("/path/to/file")
+    """
+    if not isinstance(filename, str):
+        raise TypeError("Input filename is not of type {0}, but got: {1}.".format(str, type(filename)))
+    if not isinstance(start_pts, (float, Fraction, int)):
+        raise TypeError("Input start_pts is not of type [{0}, {1}, {2}], but got: {3}".format(float, Fraction, int,
+                                                                                              type(start_pts)))
+    if start_pts < 0.0:
+        err_msg = "Not supported start_pts for " + str(start_pts) + ". The start_pts should be >= 0."
+        raise ValueError(err_msg)
+    if end_pts is None:
+        end_pts = 2147483647.0
+    if not isinstance(end_pts, (float, Fraction, int)):
+        raise TypeError("Input end_pts is not of type [{0}, {1}, {2}], but got: {3}".format(float, Fraction, int,
+                                                                                            type(end_pts)))
+    if end_pts < start_pts:
+        err_msg = "Not supported end_pts for " + str(end_pts) + ". start_pts = " + str(start_pts) + "."
+        err_msg += " The end_pts should be >= start_pts."
+        raise ValueError(err_msg)
+    if not isinstance(pts_unit, str):
+        raise TypeError("Input pts_unit is not of type {0}, but got: {1}.".format(str, type(pts_unit)))
+    if pts_unit not in ["pts", "sec"]:
+        raise ValueError("Not supported pts_unit for " + pts_unit)
+
+    video_output, audio_output, raw_metadata = cde.read_video(filename, float(start_pts), float(end_pts), pts_unit)
+
+    if video_output is not None:
+        video_output = video_output.as_array()
+    if audio_output is not None:
+        audio_output = audio_output.as_array()
+    metadata_output = {}
+    for key in raw_metadata:
+        if key == "video_fps":
+            metadata_output[key] = float(raw_metadata[key])
+            continue
+        if key == "audio_fps":
+            metadata_output[key] = int(raw_metadata[key])
+            continue
+        metadata_output[key] = raw_metadata[key]
+    return video_output, audio_output, metadata_output
+
+
+def read_video_timestamps(filename, pts_unit="pts"):
+    """
+    Read the timestamps and frames per second of a video file.
+    It supports AVI, H264, H265, MOV, MP4, WMV files.
+
+    Args:
+        filename(str): The path to the video file to be read.
+        pts_unit(str, optional): The unit of the timestamps. It can be any of ["pts", "sec"]. Default: "pts".
+
+    Returns:
+        - list, when `pts_unit` is set to "pts", list[int] is returned, when `pts_unit` is set to "sec",
+          list[float] is returned.
+        - float, the frames per second of the video file.
+
+    Raises:
+        TypeError: If `filename` is not of type str.
+        TypeError: If `pts_unit` is not of type str.
+        RuntimeError: If `filename` does not exist, or not a regular file, or not a supported video file.
+        RuntimeError: If `pts_unit` is not in ["pts", "sec"].
+
+    Supported Platforms:
+        ``CPU``
+
+    Examples:
+        >>> import mindspore.dataset.vision as vision
+        >>> video_timestamps, video_fps = vision.read_video_timestamps("/path/to/file")
+    """
+    if not isinstance(filename, str):
+        raise TypeError("Input filename is not of type {0}, but got: {1}.".format(str, type(filename)))
+    if not isinstance(pts_unit, str):
+        raise TypeError("Input pts_unit is not of type {0}, but got: {1}.".format(str, type(pts_unit)))
+
+    video_pts, video_fps, time_base = cde.read_video_timestamps(filename, pts_unit)
+
+    if video_pts == []:
+        return video_pts, None
+    if pts_unit == "pts":
+        return video_pts, video_fps
+    return [x * time_base for x in video_pts], video_fps
+
+
 def write_file(filename, data):
     """
     Write the one dimension uint8 data into a file using binary mode.

mindspore/dataset/vision/validators.py

@@ -36,7 +36,7 @@ def check_affine(method):
         [degrees, translate, scale, shear, resample, fill_value], _ = parse_user_args(method, *args, **kwargs)
 
         type_check(degrees, (int, float), "degrees")
-        check_degrees(degrees)
+        check_value(degrees, [-180, 180], "degrees")
 
         type_check(translate, (list, tuple), "translate")
         if len(translate) != 2:
@@ -54,6 +54,9 @@ def check_affine(method):
                 raise TypeError("The length of shear should be 2.")
             for i, _ in enumerate(shear):
                 type_check(shear[i], (int, float), "shear[{}]".format(i))
+                check_value(shear[i], [-180, 180], "shear[{}]".format(i))
+        else:
+            check_value(shear, [-180, 180], "shear")
 
         type_check(resample, (Inter,), "resample")
 
@@ -182,6 +185,7 @@ def check_padding(padding):
     """Parsing the padding arguments and check if it is legal."""
     type_check(padding, (tuple, list, numbers.Number), "padding")
     if isinstance(padding, numbers.Number):
+        type_check(padding, (int,), "padding")
         check_value(padding, (0, INT32_MAX), "padding")
     if isinstance(padding, (tuple, list)):
         if len(padding) not in (2, 4):
@@ -282,7 +286,15 @@ def check_erase(method):
         check_pos_int32(height, "height")
         check_pos_int32(width, "width")
         type_check(inplace, (bool,), "inplace")
-        check_fill_value(value)
+        type_check(value, (float, int, tuple), "value")
+        if isinstance(value, (float, int)):
+            value = tuple([value] * 3)
+        type_check_list(value, (float, int), "value")
+        if isinstance(value, tuple) and len(value) == 3:
+            for i, val in enumerate(value):
+                check_value(val, (UINT8_MIN, UINT8_MAX), "value[{}]".format(i))
+        else:
+            raise TypeError("value should be a single integer/float or a 3-tuple.")
 
         return method(self, *args, **kwargs)
 

mindspore/experimental/optim/__init__.py

@@ -15,7 +15,7 @@
 """
 Optimizer.
 
-Provide common optimizers for training, such as SGD, ADAM, Momentum.
+Provide common optimizers for training, such as SGD, Adam.
 The optimizer is used to calculate and update the gradients.
 """
 from __future__ import absolute_import
@@ -24,7 +24,17 @@ from mindspore.experimental.optim.optimizer import Optimizer
 from mindspore.experimental.optim.adamw import AdamW
 from mindspore.experimental.optim.sgd import SGD
 from mindspore.experimental.optim.adam import Adam
+from mindspore.experimental.optim.adadelta import Adadelta
+from mindspore.experimental.optim.adagrad import Adagrad
+from mindspore.experimental.optim.asgd import ASGD
+from mindspore.experimental.optim.adamax import Adamax
+from mindspore.experimental.optim.rmsprop import RMSprop
+from mindspore.experimental.optim.rprop import Rprop
+from mindspore.experimental.optim.radam import RAdam
+from mindspore.experimental.optim.nadam import NAdam
+
 from mindspore.experimental.optim import lr_scheduler
 
 
-__all__ = ['Optimizer', 'AdamW', 'SGD', 'Adam']
+__all__ = ['Optimizer', 'AdamW', 'SGD', 'Adam', 'Adadelta', 'Adagrad',
+           'ASGD', 'Adamax', 'RMSprop', 'Rprop', 'RAdam', 'NAdam']

mindspore/experimental/optim/adadelta.py

@@ -0,0 +1,161 @@
+# Copyright 2023 Huawei Technologies Co., Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ============================================================================
+"""adadelta"""
+from __future__ import absolute_import
+
+from mindspore.ops import functional as F, composite as C, operations as P
+import mindspore.common.dtype as mstype
+from mindspore.experimental.optim.optimizer import Optimizer, check_not_less_than, check_not_less_than_without_equal
+from mindspore import _checkparam as validator
+from mindspore import jit
+
+_adadelta_opt = C.MultitypeFuncGraph("adadelta_opt")
+
+
+@_adadelta_opt.register("Function", "Number", "Number", "Tensor", "Tensor", "Tensor", "Tensor", "Tensor")
+def _tensor_run_opt(opt, rho, epsilon, learning_rate, weight, accum, accum_update, gradient):
+    """Apply adadelta optimizer to the weight parameter."""
+    success = True
+    success = F.depend(success, opt(weight, accum, accum_update, learning_rate, rho, epsilon, gradient))
+    return success
+
+
+class Adadelta(Optimizer):
+    r"""
+    Implements Adadelta algorithm.
+
+    .. math::
+       \begin{aligned}
+            &\rule{150mm}{0.4pt}                                                                 \\
+            &\textbf{input}      : \gamma \text{ (lr)}, \: \theta_0 \text{ (params)},
+                \: f(\theta) \text{ (objective)}, \: \rho \text{ (decay)},
+                \: \lambda \text{ (weight decay)}                                                \\
+            &\textbf{initialize} :  v_0  \leftarrow 0 \: \text{ (square avg)},
+                \: u_0 \leftarrow 0 \: \text{ (accumulate variables)}                     \\[-1.ex]
+            &\rule{110mm}{0.4pt}                                                                 \\
+            &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do}                         \\
+            &\hspace{5mm}g_t           \leftarrow   \nabla_{\theta} f_t (\theta_{t-1})           \\
+            &\hspace{5mm}if \: \lambda \neq 0                                                    \\
+            &\hspace{10mm} g_t \leftarrow g_t + \lambda  \theta_{t-1}                            \\
+            &\hspace{5mm} v_t      \leftarrow v_{t-1} \rho + g^2_t (1 - \rho)                    \\
+            &\hspace{5mm}\Delta x_t    \leftarrow   \frac{\sqrt{u_{t-1} +
+                \epsilon }}{ \sqrt{v_t + \epsilon}  }g_t \hspace{21mm}                           \\
+            &\hspace{5mm} u_t  \leftarrow   u_{t-1}  \rho +
+                 \Delta x^2_t  (1 - \rho)                                                        \\
+            &\hspace{5mm}\theta_t      \leftarrow   \theta_{t-1} - \gamma  \Delta x_t            \\
+            &\rule{110mm}{0.4pt}                                                          \\[-1.ex]
+            &\bf{return} \:  \theta_t                                                     \\[-1.ex]
+            &\rule{110mm}{0.4pt}                                                          \\[-1.ex]
+       \end{aligned}
+
+    .. warning::
+        This is an experimental optimizer API that is subject to change.
+        This module must be used with lr scheduler module in `LRScheduler Class
+        <https://www.mindspore.cn/docs/en/master/api_python/mindspore.experimental.html#lrscheduler-class>`_ .
+
+    Args:
+        params (Union[list(Parameter), list(dict)]): list of parameters to optimize or dicts defining
+            parameter groups.
+        lr (Union[int, float, Tensor], optional): learning rate. Default: ``1.0``.
+        rho (float, optional): coefficient used for computing a running average
+            of squared gradients. :math:`\rho` in the formula above. Default: ``0.9``.
+        eps (float, optional): term added to the denominator to improve
+            numerical stability. :math:`\epsilon` in the formula above. Default: ``1e-6``.
+        weight_decay (float, optional): weight decay (L2 penalty). Default: ``0.``.
+
+    Keyword Args:
+        maximize (bool, optional): maximize the params based on the objective, instead of minimizing.
+            Default: ``False``.
+
+    Inputs:
+        - **gradients** (tuple[Tensor]) - The gradients of `params`.
+
+    Raises:
+        ValueError: If the learning rate is not int, float or Tensor.
+        ValueError: If the learning rate is less than 0.
+        ValueError: If the `eps` is less than or equal to 0.0.
+        ValueError: If the `rho` is not in the range of [0, 1].
+        ValueError: If the `weight_decay` is less than 0.
+
+    Supported Platforms:
+        ``Ascend`` ``GPU`` ``CPU``
+
+    Examples:
+        >>> import mindspore
+        >>> from mindspore import nn
+        >>> from mindspore.experimental import optim
+        >>> # Define the network structure of LeNet5. Refer to
+        >>> # https://gitee.com/mindspore/docs/blob/master/docs/mindspore/code/lenet.py
+        >>> net = LeNet5()
+        >>> loss_fn = nn.SoftmaxCrossEntropyWithLogits(sparse=True)
+        >>> optimizer = optim.Adadelta(net.trainable_params(), lr=0.1)
+        >>> def forward_fn(data, label):
+        ...     logits = net(data)
+        ...     loss = loss_fn(logits, label)
+        ...     return loss, logits
+        >>> grad_fn = mindspore.value_and_grad(forward_fn, None, optimizer.parameters, has_aux=True)
+        >>> def train_step(data, label):
+        ...     (loss, _), grads = grad_fn(data, label)
+        ...     optimizer(grads)
+        ...     return loss
+    """
+
+    def __init__(self, params, lr=1.0, rho=0.9, eps=1e-6, weight_decay=0.0, *, maximize=False):
+        check_not_less_than_without_equal(lr, "lr", self.cls_name)
+        check_not_less_than_without_equal(eps, "eps", self.cls_name)
+        check_not_less_than(weight_decay, "weight_decay", self.cls_name)
+        validator.check_float_range(rho, 0., 1., validator.INC_BOTH, "rho", self.cls_name)
+
+        defaults = dict(
+            lr=lr,
+            rho=rho,
+            eps=eps,
+            weight_decay=weight_decay,
+            maximize=maximize,
+        )
+        super(Adadelta, self).__init__(params, defaults)
+
+        self.accum = self.parameters.clone(prefix="accum", init=0)
+        self.accum_update = self.parameters.clone(prefix="accum_update", init=0)
+        self.opt = P.ApplyAdadelta()
+        self.op_cast = P.Cast()
+
+    @jit
+    def implementation(self, lr, rho, eps, maximize, weight_decay, start_id, end_id, gradients):
+        """Extract the common computing part for acceleration"""
+        params = self.parameters[start_id: end_id]
+        grads = tuple([grad if not maximize else F.neg(grad) for grad in gradients[start_id: end_id]])
+        grads = self._decay_weight(weight_decay, params, grads)
+        accum = self.accum[start_id: end_id]
+        accum_update = self.accum_update[start_id: end_id]
+        self.hyper_map(F.partial(_adadelta_opt, self.opt, rho, eps, lr),
+                       params, accum, accum_update, grads)
+        return True
+
+    def construct(self, gradients):
+        for group_id, group in enumerate(self.param_groups):
+            lr = self.lrs[group_id]
+            if isinstance(group.get("lr"), float):
+                lr = self.op_cast(group.get("lr"), mstype.float32)
+            maximize = group.get("maximize")
+            rho = group["rho"]
+            eps = group["eps"]
+
+            start_id = self.group_start_id[group_id]
+            end_id = self.group_start_id[group_id + 1]
+            weight_decay = group["weight_decay"]
+            self.implementation(lr, rho, eps, maximize, weight_decay, start_id, end_id, gradients)
+
+        return True

mindspore/experimental/optim/adagrad.py

@@ -0,0 +1,168 @@
+# Copyright 2023 Huawei Technologies Co., Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ============================================================================
+"""adagrad"""
+from __future__ import absolute_import
+
+from mindspore.ops import functional as F, composite as C, operations as P
+from mindspore.common import Tensor, Parameter
+import mindspore.common.dtype as mstype
+from mindspore.experimental.optim.optimizer import Optimizer, check_not_less_than, check_not_less_than_without_equal
+from mindspore import jit
+
+_adagrad_opt = C.MultitypeFuncGraph("adagrad_opt")
+
+
+@_adagrad_opt.register("Function", "Tensor", "Tensor", "Tensor", "Tensor")
+def _tensor_run_opt(opt, learning_rate, weight, accum, gradient):
+    """Apply adagrad optimizer to the weight parameter."""
+    success = True
+    success = F.depend(success, opt(weight, accum, learning_rate, gradient))
+    return success
+
+
+class Adagrad(Optimizer):
+    r"""
+    Implements Adagrad algorithm.
+
+    .. math::
+       \begin{aligned}
+            &\rule{110mm}{0.4pt}                                                                 \\
+            &\textbf{input}      : \gamma \text{ (lr)}, \: \theta_0 \text{ (params)}, \: f(\theta)
+                \text{ (objective)}, \: \lambda \text{ (weight decay)},                          \\
+            &\hspace{12mm}    \tau \text{ (initial accumulator value)}, \: \eta\text{ (lr decay)}\\
+            &\textbf{initialize} :  state\_sum_0 \leftarrow 0                             \\[-1.ex]
+            &\rule{110mm}{0.4pt}                                                                 \\
+            &\textbf{for} \: t=1 \: \textbf{to} \: \ldots \: \textbf{do}                         \\
+            &\hspace{5mm}g_t           \leftarrow   \nabla_{\theta} f_t (\theta_{t-1})           \\
+            &\hspace{5mm} \tilde{\gamma}    \leftarrow \gamma / (1 +(t-1) \eta)                  \\
+            &\hspace{5mm} \textbf{if} \: \lambda \neq 0                                          \\
+            &\hspace{10mm} g_t \leftarrow g_t + \lambda \theta_{t-1}                             \\
+            &\hspace{5mm}state\_sum_t  \leftarrow  state\_sum_{t-1} + g^2_t                      \\
+            &\hspace{5mm}\theta_t \leftarrow
+                \theta_{t-1}- \tilde{\gamma} \frac{g_t}{\sqrt{state\_sum_t}+\epsilon}            \\
+            &\rule{110mm}{0.4pt}                                                          \\[-1.ex]
+            &\bf{return} \:  \theta_t                                                     \\[-1.ex]
+            &\rule{110mm}{0.4pt}                                                          \\[-1.ex]
+       \end{aligned}
+
+    .. warning::
+        This is an experimental optimizer API that is subject to change.
+        This module must be used with lr scheduler module in `LRScheduler Class
+        <https://www.mindspore.cn/docs/en/master/api_python/mindspore.experimental.html#lrscheduler-class>`_ .
+
+    Args:
+        params (Union[list(Parameter), list(dict)]): list of parameters to optimize or dicts defining
+            parameter groups.
+        lr (Union[int, float, Tensor], optional): learning rate. Default: ``1e-2``.
+        lr_decay (float, optional): learning rate decay. Default: ``0.``.
+        weight_decay (float, optional): weight decay (L2 penalty). Default: ``0.``.
+        initial_accumulator_value (float, optional): the initial accumulator value. Default: ``0.``.
+        eps (float, optional): term added to the denominator to improve
+            numerical stability. Default: ``1e-10``.
+
+    Keyword Args:
+        maximize (bool, optional): maximize the params based on the objective, instead of minimizing.
+            Default: ``False``.
+
+    Inputs:
+        - **gradients** (tuple[Tensor]) - The gradients of `params`.
+
+    Raises:
+        ValueError: If the learning rate is not int, float or Tensor.
+        ValueError: If the learning rate is less than 0.
+        ValueError: If the learning rate decay is less than 0.
+        ValueError: If the `weight_decay` is less than 0.
+        ValueError: If the `initial_accumulator_value` is less than 0.0.
+        ValueError: If the `eps` is less than 0.0.
+
+    Supported Platforms:
+        ``Ascend`` ``GPU`` ``CPU``
+
+    Examples:
+        >>> import mindspore
+        >>> from mindspore import nn
+        >>> from mindspore.experimental import optim
+        >>> # Define the network structure of LeNet5. Refer to
+        >>> # https://gitee.com/mindspore/docs/blob/master/docs/mindspore/code/lenet.py
+        >>> net = LeNet5()
+        >>> loss_fn = nn.SoftmaxCrossEntropyWithLogits(sparse=True)
+        >>> optimizer = optim.Adagrad(net.trainable_params(), lr=0.1)
+        >>> def forward_fn(data, label):
+        ...     logits = net(data)
+        ...     loss = loss_fn(logits, label)
+        ...     return loss, logits
+        >>> grad_fn = mindspore.value_and_grad(forward_fn, None, optimizer.parameters, has_aux=True)
+        >>> def train_step(data, label):
+        ...     (loss, _), grads = grad_fn(data, label)
+        ...     optimizer(grads)
+        ...     return loss
+    """
+
+    def __init__(self, params, lr=1e-2, lr_decay=0.0, weight_decay=0.0, initial_accumulator_value=0.0,
+                 eps=1e-10, *, maximize=False):
+        check_not_less_than_without_equal(lr, "lr", self.cls_name)
+        check_not_less_than(lr_decay, "lr_decay", self.cls_name)
+        check_not_less_than(weight_decay, "weight_decay", self.cls_name)
+        check_not_less_than(initial_accumulator_value, "initial_accumulator_value", self.cls_name)
+        check_not_less_than_without_equal(eps, "eps", self.cls_name)
+
+        defaults = dict(
+            lr=lr,
+            lr_decay=lr_decay,
+            eps=eps,
+            weight_decay=weight_decay,
+            initial_accumulator_value=initial_accumulator_value,
+            maximize=maximize,
+        )
+        super(Adagrad, self).__init__(params, defaults)
+
+        self.accum = self.parameters.clone(prefix="accum", init=initial_accumulator_value)
+        self.op_cast = P.Cast()
+        self.step_t = Parameter(Tensor(0, mstype.int32), "step_t")
+        self.increase_tensor = Tensor(1, mstype.int32)
+        self.assignadd = P.AssignAdd()
+        self.assign = P.Assign()
+
+    @jit
+    def implementation(self, eps, lr, lr_decay, maximize, weight_decay, start_id, end_id, gradients):
+        """Extract the common computing part for acceleration"""
+        opt = P.ApplyAdagradV2(epsilon=eps, update_slots=True)
+        decay_lr = lr / (1 + self.step_t * lr_decay)
+        params = self.parameters[start_id: end_id]
+        grads = tuple([grad if not maximize else F.neg(grad) for grad in gradients[start_id: end_id]])
+        grads = self._decay_weight(weight_decay, params, grads)
+        accum = self.accum[start_id: end_id]
+        self.hyper_map(F.partial(_adagrad_opt, opt, decay_lr), params, accum, grads)
+        return True
+
+    def construct(self, gradients):
+        for group_id, group in enumerate(self.param_groups):
+
+            lr = self.lrs[group_id]
+            if isinstance(group.get("lr"), float):
+                lr = self.op_cast(group.get("lr"), mstype.float32)
+
+            lr_decay = group["lr_decay"]
+            maximize = group.get("maximize")
+            weight_decay = group["weight_decay"]
+            eps = group["eps"]
+
+            start_id = self.group_start_id[group_id]
+            end_id = self.group_start_id[group_id + 1]
+            self.implementation(eps, lr, lr_decay, maximize, weight_decay, start_id, end_id, gradients)
+
+        self.assignadd(self.step_t, self.increase_tensor)
+
+        return True