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.SparseApplyAdagradV2

class mindspore.ops.SparseApplyAdagradV2(lr, epsilon, use_locking=False, update_slots=True)

Updates relevant entries according to the adagrad scheme, one more epsilon attribute than SparseApplyAdagrad.

$$\begin{array}{r}\begin{array}{l}\\ accum+=grad\ast grad\\ var-=lr\ast grad\ast \frac{1}{\sqrt{accum}+ϵ}\end{array}\end{array}$$

where $ϵ$ represents epsilon.

Inputs of var, accum and grad comply with the implicit type conversion rules to make the data types consistent. If they have different data types, the lower priority data type will be converted to the relatively highest priority data type.

Parameters

• lr (float) – Learning rate.

• epsilon (float) – A small value added for numerical stability.

• use_locking (bool) – If True, the var and accum tensors will be protected from being updated. Default: False.

• update_slots (bool) – If True, the computation logic will be different to False. Default: True.

Inputs:

• var (Parameter) - Variable to be updated. The data type must be float16 or float32. The shape is $(N,\ast )$ where $\ast$ means, any number of additional dimensions.

• accum (Parameter) - Accumulation to be updated. The shape and data type must be the same as var.

• grad (Tensor) - Gradients has the same data type as var and $grad.shape[1:]=var.shape[1:]$ if var.shape > 1.

• indices (Tensor) - A vector of indices into the first dimension of var and accum. The type must be int32 and indices.shape[0] = grad.shape[0].

Outputs:

Tuple of 2 tensors, the updated parameters.

• var (Tensor) - The same shape and data type as var.

• accum (Tensor) - The same shape and data type as accum.

Raises

• TypeError – If neither lr nor epsilon is a float.

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

• TypeError – If dtype of var, accum or grad is neither float16 nor float32.

• TypeError – If dtype of indices is not int32.

• RuntimeError – If the data type of var, accum and grad conversion of Parameter is not supported.

Supported Platforms:

Ascend CPU GPU

Examples

>>> class Net(nn.Cell):
...     def __init__(self):
...         super(Net, self).__init__()
...         self.sparse_apply_adagrad_v2 = ops.SparseApplyAdagradV2(lr=1e-8, epsilon=1e-6)
...         self.var = Parameter(Tensor(np.array([[0.2]]).astype(np.float32)), name="var")
...         self.accum = Parameter(Tensor(np.array([[0.1]]).astype(np.float32)), name="accum")
...
...     def construct(self, grad, indices):
...         out = self.sparse_apply_adagrad_v2(self.var, self.accum, grad, indices)
...         return out
...
>>> net = Net()
>>> grad = Tensor(np.array([[0.7]]).astype(np.float32))
>>> indices = Tensor(np.array([0]), mindspore.int32)
>>> output = net(grad, indices)
>>> print(output)
(Tensor(shape=[1, 1], dtype=Float32, value=
[[ 1.99999988e-01]]), Tensor(shape=[1, 1], dtype=Float32, value=
[[ 5.89999974e-01]]))