SmoothGrad | R Documentation |

`\times`

Input*SmoothGrad* was introduced by D. Smilkov et al. (2017) and is an extension
to the classical *Vanilla Gradient* method. It takes the mean of the
gradients for `n`

perturbations of each data point, i.e., with
`\epsilon \sim N(0,\sigma)`

`1/n \sum_n d f(x+ \epsilon)_j / d x_j.`

Analogous to the *Gradient \timesInput* method, you can also use the argument

`times_input`

to multiply the gradients by the inputs before taking the
average (`\times`

InputThe R6 class can also be initialized using the `run_smoothgrad`

function
as a helper function so that no prior knowledge of R6 classes is required.

`innsight::InterpretingMethod`

-> `innsight::GradientBased`

-> `SmoothGrad`

`n`

(

`integer(1)`

)

Number of perturbations of the input data (default:`50`

).`noise_level`

(

`numeric(1)`

)

The standard deviation of the Gaussian perturbation, i.e.,`\sigma = (max(x) - min(x)) *`

`noise_level`

.

`new()`

Create a new instance of the `SmoothGrad`

R6 class. When initialized,
the method *SmoothGrad* or *SmoothGrad \timesInput* is applied to
the given data and the results are stored in the field

`result`

.
SmoothGrad$new( converter, data, channels_first = TRUE, output_idx = NULL, output_label = NULL, ignore_last_act = TRUE, times_input = FALSE, n = 50, noise_level = 0.1, verbose = interactive(), dtype = "float" )

`converter`

(

`Converter`

)

An instance of the`Converter`

class that includes the torch-converted model and some other model-specific attributes. See`Converter`

for details.`data`

(

`array`

,`data.frame`

,`torch_tensor`

or`list`

)

The data to which the method is to be applied. These must have the same format as the input data of the passed model to the converter object. This means eitheran

`array`

,`data.frame`

,`torch_tensor`

or array-like format of size*(batch_size, dim_in)*, if e.g., the model has only one input layer, ora

`list`

with the corresponding input data (according to the upper point) for each of the input layers.

`channels_first`

(

`logical(1)`

)

The channel position of the given data (argument`data`

). If`TRUE`

, the channel axis is placed at the second position between the batch size and the rest of the input axes, e.g.,`c(10,3,32,32)`

for a batch of ten images with three channels and a height and width of 32 pixels. Otherwise (`FALSE`

), the channel axis is at the last position, i.e.,`c(10,32,32,3)`

. If the data has no channel axis, use the default value`TRUE`

.`output_idx`

(

`integer`

,`list`

or`NULL`

)

These indices specify the output nodes for which the method is to be applied. In order to allow models with multiple output layers, there are the following possibilities to select the indices of the output nodes in the individual output layers:An

`integer`

vector of indices: If the model has only one output layer, the values correspond to the indices of the output nodes, e.g.,`c(1,3,4)`

for the first, third and fourth output node. If there are multiple output layers, the indices of the output nodes from the first output layer are considered.A

`list`

of`integer`

vectors of indices: If the method is to be applied to output nodes from different layers, a list can be passed that specifies the desired indices of the output nodes for each output layer. Unwanted output layers have the entry`NULL`

instead of a vector of indices, e.g.,`list(NULL, c(1,3))`

for the first and third output node in the second output layer.-
`NULL`

(default): The method is applied to all output nodes in the first output layer but is limited to the first ten as the calculations become more computationally expensive for more output nodes.

`output_label`

(

`character`

,`factor`

,`list`

or`NULL`

)

These values specify the output nodes for which the method is to be applied. Only values that were previously passed with the argument`output_names`

in the`converter`

can be used. In order to allow models with multiple output layers, there are the following possibilities to select the names of the output nodes in the individual output layers:A

`character`

vector or`factor`

of labels: If the model has only one output layer, the values correspond to the labels of the output nodes named in the passed`Converter`

object, e.g.,`c("a", "c", "d")`

for the first, third and fourth output node if the output names are`c("a", "b", "c", "d")`

. If there are multiple output layers, the names of the output nodes from the first output layer are considered.A

`list`

of`charactor`

/`factor`

vectors of labels: If the method is to be applied to output nodes from different layers, a list can be passed that specifies the desired labels of the output nodes for each output layer. Unwanted output layers have the entry`NULL`

instead of a vector of labels, e.g.,`list(NULL, c("a", "c"))`

for the first and third output node in the second output layer.-
`NULL`

(default): The method is applied to all output nodes in the first output layer but is limited to the first ten as the calculations become more computationally expensive for more output nodes.

`ignore_last_act`

(

`logical(1)`

)

Set this logical value to include the last activation functions for each output layer, or not (default:`TRUE`

). In practice, the last activation (especially for softmax activation) is often omitted.`times_input`

(

`logical(1`

)

Multiplies the gradients with the input features. This method is called*SmoothGrad*.`\times`

Input`n`

(

`integer(1)`

)

Number of perturbations of the input data (default:`50`

).`noise_level`

(

`numeric(1)`

)

Determines the standard deviation of the Gaussian perturbation, i.e.,`\sigma = (max(x) - min(x)) *`

`noise_level`

.`verbose`

(

`logical(1)`

)

This logical argument determines whether a progress bar is displayed for the calculation of the method or not. The default value is the output of the primitive R function`interactive()`

.`dtype`

(

`character(1)`

)

The data type for the calculations. Use either`'float'`

for torch_float or`'double'`

for torch_double.

`clone()`

The objects of this class are cloneable with this method.

SmoothGrad$clone(deep = FALSE)

`deep`

Whether to make a deep clone.

D. Smilkov et al. (2017) *SmoothGrad: removing noise by adding noise.*
CoRR, abs/1706.03825

Other methods:
`ConnectionWeights`

,
`DeepLift`

,
`DeepSHAP`

,
`ExpectedGradient`

,
`Gradient`

,
`IntegratedGradient`

,
`LIME`

,
`LRP`

,
`SHAP`

```
# ------------------------- Example 1: Torch -------------------------------
library(torch)
# Create nn_sequential model and data
model <- nn_sequential(
nn_linear(5, 10),
nn_relu(),
nn_linear(10, 2),
nn_sigmoid()
)
data <- torch_randn(25, 5)
# Create Converter
converter <- convert(model, input_dim = c(5))
# Calculate the smoothed Gradients
smoothgrad <- SmoothGrad$new(converter, data)
# You can also use the helper function `run_smoothgrad` for initializing
# an R6 SmoothGrad object
smoothgrad <- run_smoothgrad(converter, data)
# Print the result as a data.frame for first 5 rows
head(get_result(smoothgrad, "data.frame"), 5)
# Plot the result for both classes
plot(smoothgrad, output_idx = 1:2)
# Plot the boxplot of all datapoints
boxplot(smoothgrad, output_idx = 1:2)
# ------------------------- Example 2: Neuralnet ---------------------------
if (require("neuralnet")) {
library(neuralnet)
data(iris)
# Train a neural network
nn <- neuralnet(Species ~ ., iris,
linear.output = FALSE,
hidden = c(10, 5),
act.fct = "logistic",
rep = 1
)
# Convert the trained model
converter <- convert(nn)
# Calculate the smoothed gradients
smoothgrad <- run_smoothgrad(converter, iris[, -5], times_input = FALSE)
# Plot the result for the first and 60th data point and all classes
plot(smoothgrad, data_idx = c(1, 60), output_idx = 1:3)
# Calculate SmoothGrad x Input and do not ignore the last activation
smoothgrad <- run_smoothgrad(converter, iris[, -5], ignore_last_act = FALSE)
# Plot the result again
plot(smoothgrad, data_idx = c(1, 60), output_idx = 1:3)
}
# ------------------------- Example 3: Keras -------------------------------
if (require("keras") & keras::is_keras_available()) {
library(keras)
# Make sure keras is installed properly
is_keras_available()
data <- array(rnorm(64 * 60 * 3), dim = c(64, 60, 3))
model <- keras_model_sequential()
model %>%
layer_conv_1d(
input_shape = c(60, 3), kernel_size = 8, filters = 8,
activation = "softplus", padding = "valid") %>%
layer_conv_1d(
kernel_size = 8, filters = 4, activation = "tanh",
padding = "same") %>%
layer_conv_1d(
kernel_size = 4, filters = 2, activation = "relu",
padding = "valid") %>%
layer_flatten() %>%
layer_dense(units = 64, activation = "relu") %>%
layer_dense(units = 16, activation = "relu") %>%
layer_dense(units = 3, activation = "softmax")
# Convert the model
converter <- convert(model)
# Apply the SmoothGrad method
smoothgrad <- run_smoothgrad(converter, data, channels_first = FALSE)
# Plot the result for the first datapoint and all classes
plot(smoothgrad, output_idx = 1:3)
# Plot the result as boxplots for first two classes
boxplot(smoothgrad, output_idx = 1:2)
}
#------------------------- Plotly plots ------------------------------------
if (require("plotly")) {
# You can also create an interactive plot with plotly.
# This is a suggested package, so make sure that it is installed
library(plotly)
# Result as boxplots
boxplot(smoothgrad, as_plotly = TRUE)
# Result of the second data point
plot(smoothgrad, data_idx = 2, as_plotly = TRUE)
}
```

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.