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.

PR

Just a small problem.

I can fix it online!

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.nn.SoftShrink

class mindspore.nn.SoftShrink(lambd=0.5)

Applies the SoftShrink function element-wise.

$$\begin{array}{r}\text{SoftShrink}(x)=\{\begin{array}{ll}x-\lambda ,& \text{ if }x>\lambda \\ x+\lambda ,& \text{ if }x<-\lambda \\ 0,& \text{ otherwise }\end{array}\end{array}$$

SoftShrink Activation Function Graph:

Parameters

lambd (number, optional) – The threshold $\lambda$ defined by the Soft Shrink formula. It should be greater than or equal to 0, default: 0.5 .

Inputs:

• input (Tensor) - The input of Soft Shrink. Supported dtypes:

  • Ascend: float16, float32, bfloat16.

  • CPU/GPU: float16, float32.

Outputs:

Tensor, the same shape and data type as the input.

Raises

• TypeError – If lambd is not a float, int or bool.

• TypeError – If input is not a tensor.

• TypeError – If dtype of input is not float16, float32 or bfloat16.

Supported Platforms:

Ascend GPU CPU

Examples

>>> import mindspore
>>> from mindspore import Tensor, nn
>>> import numpy as np
>>> input = Tensor(np.array([[ 0.5297,  0.7871,  1.1754], [ 0.7836,  0.6218, -1.1542]]), mindspore.float16)
>>> softshrink = nn.SoftShrink()
>>> output = softshrink(input)
>>> print(output)
[[ 0.02979  0.287    0.676  ]
 [ 0.2837   0.1216  -0.6543 ]]