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

class mindspore.ops.ApplyAddSign

Updates relevant entries according to the AddSign algorithm.

$$\begin{array}{r}\begin{array}{l}\\ m_{t+1}=\beta \ast m_t+(1-\beta )\ast g\\ \text{update}=(\alpha +\text{sign\_decay}\ast sign(g)\ast sign(m))\ast g\\ var=var-l{r}_{t+1}\ast \text{update}\end{array}\end{array}$$

$t$ represents updating step while $m$ represents the 1st moment vector, $m_t$ is the last momentent of $m_{t+1}$, $lr$ represents scaling factor lr, $g$ represents grad, $\alpha$ represents alpha, $\beta$ represents beta.

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

Inputs:

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

• m (Parameter) - Variable tensor to be updated, has the same shape and data type as var.

• lr (Union[Number, Tensor]) - The learning rate value, must be a scalar. With float32 or float16 data type.

• alpha (Union[Number, Tensor]) - Must be a scalar. With float32 or float16 data type.

• sign_decay (Union[Number, Tensor]) - Must be a scalar. With float32 or float16 data type.

• beta (Union[Number, Tensor]) - The exponential decay rate, must be a scalar. With float32 or float16 data type.

• grad (Tensor) - A tensor of the same shape and data type as var, for the gradient.

Outputs:

Tuple of 2 Tensors, the updated parameters.

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

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

Raises

• TypeError – If dtype of var, lr, alpha, sign_decay or beta is neither float16 nor float32.

• TypeError – If lr, alpha or sign_decay is neither a Number nor a Tensor.

• TypeError – If grad is not a Tensor.

Supported Platforms:

Ascend

Examples

>>> class Net(nn.Cell):
...     def __init__(self):
...         super(Net, self).__init__()
...         self.apply_add_sign = ops.ApplyAddSign()
...         self.var = Parameter(Tensor(np.array([[0.6, 0.4],
...                                               [0.1, 0.5]]).astype(np.float32)), name="var")
...         self.m = Parameter(Tensor(np.array([[0.6, 0.5],
...                                             [0.2, 0.6]]).astype(np.float32)), name="m")
...         self.lr = 0.001
...         self.alpha = 1.0
...         self.sign_decay = 0.99
...         self.beta = 0.9
...     def construct(self, grad):
...         out = self.apply_add_sign(self.var, self.m, self.lr, self.alpha, self.sign_decay, self.beta, grad)
...         return out
...
>>> net = Net()
>>> grad = Tensor(np.array([[0.3, 0.7], [0.1, 0.8]]).astype(np.float32))
>>> output = net(grad)
>>> print(output)
(Tensor(shape=[2, 2], dtype=Float32, value=
[[ 5.99403024e-01,  3.98607016e-01],
 [ 9.98010039e-02,  4.98407990e-01]]), Tensor(shape=[2, 2], dtype=Float32, value=
[[ 5.70000052e-01,  5.19999981e-01],
 [ 1.89999998e-01,  6.20000064e-01]]))