Soft Shrink Activation Function — mlr_pipeops_nn

Applies the soft shrinkage function elementwise

nn_module

Calls torch::nn_softshrink() when trained.

Parameters

lambd :: numeric(1)
The lambda (must be no less than zero) value for the Softshrink formulation. Default: 0.5

Input and Output Channels

One input channel called "input" and one output channel called "output". For an explanation see PipeOpTorch.

State

The state is the value calculated by the public method $shapes_out().

Super classes

mlr3pipelines::PipeOp -> PipeOpTorch -> PipeOpTorchSoftShrink

Methods

Inherited methods

`PipeOpTorchSoftShrink$new()`

Creates a new instance of this R6 class.

Usage

PipeOpTorchSoftShrink$new(id = "nn_softshrink", param_vals = list())

Arguments

id: (character(1))
Identifier of the resulting object.
param_vals: (list())
List of hyperparameter settings, overwriting the hyperparameter settings that would otherwise be set during construction.

`PipeOpTorchSoftShrink$clone()`

The objects of this class are cloneable with this method.

Usage

PipeOpTorchSoftShrink$clone(deep = FALSE)

Arguments

deep: Whether to make a deep clone.

Examples

# Construct the PipeOp
pipeop = nn("softshrink")
pipeop
#> 
#> ── PipeOp <softshrink>: not trained ────────────────────────────────────────────
#> Values: list()
#> 
#> ── Input channels: 
#>    name           train predict
#>  <char>          <char>  <char>
#>   input ModelDescriptor    Task
#> 
#> ── Output channels: 
#>    name           train predict
#>  <char>          <char>  <char>
#>  output ModelDescriptor    Task
# The available parameters
pipeop$param_set
#> <ParamSet(1)>
#>        id    class lower upper nlevels default  value
#>    <char>   <char> <num> <num>   <num>  <list> <list>
#> 1:  lambd ParamDbl     0   Inf     Inf     0.5 [NULL]