Document feedback

Question document fragment

When a question document fragment contains a formula, it is displayed as a space.

Submission type

issue

It's a little complicated...

I'd like to ask someone.

Please select the submission type

Problem type

Specifications and Common Mistakes

- Specifications and Common Mistakes:

- Misspellings or punctuation mistakes,incorrect formulas, abnormal display.

- Incorrect links, empty cells, or wrong formats.

- Chinese characters in English context.

- Minor inconsistencies between the UI and descriptions.

- Low writing fluency that does not affect understanding.

- Incorrect version numbers, including software package names and version numbers on the UI.

Usability

- Usability:

- Incorrect or missing key steps.

- Missing main function descriptions, keyword explanation, necessary prerequisites, or precautions.

- Ambiguous descriptions, unclear reference, or contradictory context.

- Unclear logic, such as missing classifications, items, and steps.

Correctness

- Correctness:

- Technical principles, function descriptions, supported platforms, parameter types, or exceptions inconsistent with that of software implementation.

- Incorrect schematic or architecture diagrams.

- Incorrect commands or command parameters.

- Incorrect code.

- Commands inconsistent with the functions.

- Wrong screenshots.

- Sample code running error, or running results inconsistent with the expectation.

Risk Warnings

- Risk Warnings:

- Lack of risk warnings for operations that may damage the system or important data.

Content Compliance

- Content Compliance:

- Contents that may violate applicable laws and regulations or geo-cultural context-sensitive words and expressions.

- Copyright infringement.

Please select the type of question

Problem description

Describe the bug so that we can quickly locate the problem.

Submit

Document feedback

mindspore.ops.FusedSparseAdam

class mindspore.ops.FusedSparseAdam(*args, **kwargs)

Merges the duplicate value of the gradient and then updates parameters by the Adaptive Moment Estimation (Adam) algorithm. This operator is used when the gradient is sparse.

The Adam algorithm is proposed in Adam: A Method for Stochastic Optimization.

The updating formulas are as follows,

$$\begin{array}{r}\begin{array}{l}\\ m={\beta }_1\ast m+(1-{\beta }_1)\ast g\\ v={\beta }_2\ast v+(1-{\beta }_2)\ast g\ast g\\ l=\alpha \ast \frac{\sqrt{1-{\beta }_2^t}}{1-{\beta }_1^t}\\ w=w-l\ast \frac{m}{\sqrt{v}+ϵ}\end{array}\end{array}$$

$m$ represents the 1st moment vector, $v$ represents the 2nd moment vector, $g$ represents gradient, $l$ represents scaling factor lr, ${\beta }_1,{\beta }_2$ represent beta1 and beta2, $t$ represents updating step while $bet{a}_1^t$ and $bet{a}_2^t$ represent beta1_power and beta2_power, $\alpha$ represents learning_rate, $w$ represents var, $ϵ$ represents epsilon.

All of inputs except indices comply with the implicit type conversion rules to make the data types consistent. If they have different data types, lower priority data type will be converted to relatively highest priority data type. RuntimeError exception will be thrown when the data type conversion of Parameter is required.

Parameters

• use_locking (bool) – Whether to enable a lock to protect variable tensors from being updated. If true, updates of the var, m, and v tensors will be protected by a lock. If false, the result is unpredictable. Default: False.

• use_nesterov (bool) – Whether to use Nesterov Accelerated Gradient (NAG) algorithm to update the gradients. If true, update the gradients using NAG. If false, update the gradients without using NAG. Default: False.

Inputs:

• var (Parameter) - Parameters to be updated with float32 data type.

• m (Parameter) - The 1st moment vector in the updating formula, has the same type as var with float32 data type.

• v (Parameter) - The 2nd moment vector in the updating formula. Mean square gradients, has the same type as var with float32 data type.

• beta1_power (Tensor) - $bet{a}_1^t$ in the updating formula with float32 data type.

• beta2_power (Tensor) - $bet{a}_2^t$ in the updating formula with float32 data type.

• lr (Tensor) - $l$ in the updating formula. With float32 data type.

• beta1 (Tensor) - The exponential decay rate for the 1st moment estimations with float32 data type.

• beta2 (Tensor) - The exponential decay rate for the 2nd moment estimations with float32 data type.

• epsilon (Tensor) - Term added to the denominator to improve numerical stability with float32 data type.

• gradient (Tensor) - Gradient value with float32 data type.

• indices (Tensor) - Gradient indices with int32 data type.

Outputs:

Tuple of 3 Tensors, this operator will update the input parameters directly, the outputs are useless.

• var (Tensor) - A Tensor with shape (1,).

• m (Tensor) - A Tensor with shape (1,).

• v (Tensor) - A Tensor with shape (1,).

Raises

• TypeError – If neither use_locking nor use_neserov is a bool.

• TypeError – If dtype of var, m, v, beta1_power, beta2_power, lr, beta1, beta2, epsilon, gradient or indices is not float32.

Supported Platforms:

Ascend CPU

Examples

>>> import numpy as np
>>> import mindspore.nn as nn
>>> from mindspore import Tensor, Parameter
>>> from mindspore.ops import operations as ops
>>> import mindspore.common.dtype as mstype
>>> class Net(nn.Cell):
...     def __init__(self):
...         super(Net, self).__init__()
...         self.sparse_apply_adam = ops.FusedSparseAdam()
...         self.var = Parameter(Tensor(np.ones([3, 1, 2]).astype(np.float32)), name="var")
...         self.m = Parameter(Tensor(np.ones([3, 1, 2]).astype(np.float32)), name="m")
...         self.v = Parameter(Tensor(np.ones([3, 1, 2]).astype(np.float32)), name="v")
...     def construct(self, beta1_power, beta2_power, lr, beta1, beta2, epsilon, grad, indices):
...         out = self.sparse_apply_adam(self.var, self.m, self.v, beta1_power, beta2_power, lr, beta1, beta2,
...                                      epsilon, grad, indices)
...         return out
...
>>> net = Net()
>>> beta1_power = Tensor(0.9, mstype.float32)
>>> beta2_power = Tensor(0.999, mstype.float32)
>>> lr = Tensor(0.001, mstype.float32)
>>> beta1 = Tensor(0.9, mstype.float32)
>>> beta2 = Tensor(0.999, mstype.float32)
>>> epsilon = Tensor(1e-8, mstype.float32)
>>> gradient = Tensor(np.random.rand(2, 1, 2), mstype.float32)
>>> indices = Tensor([0, 1], mstype.int32)
>>> output = net(beta1_power, beta2_power, lr, beta1, beta2, epsilon, gradient, indices)
>>> print(net.var.asnumpy())
[[[0.9996963  0.9996977 ]]
 [[0.99970144 0.9996992 ]]
 [[0.99971527 0.99971527]]]