mindspore.mint.nn.Hardshrink

class mindspore.mint.nn.Hardshrink(lambd=0.5)

Applies Hard Shrink activation function element-wise.

The formula is defined as follows:

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

Hardshrink Activation Function Graph:

Parameters

lambd (number, optional) – The threshold $\lambda$ defined by the Hard Shrink formula. Default: 0.5 .

Inputs:

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

  • Ascend: float16, float32, bfloat16.

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

Examples

>>> import mindspore
>>> from mindspore import Tensor, mint
>>> import numpy as np
>>> input = Tensor(np.array([[0.5, 1, 2.0], [0.0533, 0.0776, -2.1233]]), mindspore.float32)
>>> hshrink = mint.nn.Hardshrink()
>>> output = hshrink(input)
>>> print(output)
[[ 0.      1.      2.    ]
 [ 0.      0.     -2.1233]]