pytorch / 2 / generated / torch.nn.hardshrink.html

Hardshrink

class torch.nn.Hardshrink(lambd=0.5) [source]

Applies the Hard Shrinkage (Hardshrink) function element-wise.

Hardshrink is defined as:

HardShrink ( x ) = { x , if x > λ x , if x < λ 0 , otherwise \text{HardShrink}(x) = \begin{cases} x, & \text{ if } x > \lambda \\ x, & \text{ if } x < -\lambda \\ 0, & \text{ otherwise } \end{cases}
Parameters

lambd (float) – the λ \lambda value for the Hardshrink formulation. Default: 0.5

Shape:
  • Input: ( ) (*) , where * means any number of dimensions.
  • Output: ( ) (*) , same shape as the input.
../_images/Hardshrink.png

Examples:

>>> m = nn.Hardshrink()
>>> input = torch.randn(2)
>>> output = m(input)

© 2024, PyTorch Contributors
PyTorch has a BSD-style license, as found in the LICENSE file.
https://pytorch.org/docs/2.1/generated/torch.nn.Hardshrink.html