.. _cn_api_paddle_nn_functional_softshrink:

softshrink
-------------------------------

.. py:function:: paddle.nn.functional.softshrink(x, threshold=0.5, name=None)

softshrink 激活层

.. math::

    softshrink(x)= \begin{cases}
                    x - threshold, \text{if } x > threshold \\
                    x + threshold, \text{if } x < -threshold \\
                    0,  \text{otherwise}
                    \end{cases}

其中，:math:`x` 为输入的 Tensor。

参数
::::::::::
    - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。
    - **threshold** (float，可选) - softshrink 激活计算公式中的 threshold 值，必须大于等于零。默认值为 0.5。
    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

返回
::::::::::
    ``Tensor``，数据类型和形状同 ``x`` 一致。

代码示例
::::::::::

COPY-FROM: paddle.nn.functional.softshrink
