Wraps infidelity with a random n-feature perturbation function: it randomly zeroes out n features at a time and measures the Pearson correlation between attributions and the resulting output changes (Ancona et al.). Lower score indicates the attributions better predict which features matter. Supports feature masks and multi-target mode.
sensitivity_n
Functions:
-
sensitivity_n–A wrapper around the Captum library's infidelity metric that computes senstivity_n.
sensitivity_n
sensitivity_n(
n_features_perturbed: int | float,
forward_func: Callable,
inputs: TensorOrTupleOfTensorsGeneric,
attributions: list[TensorOrTupleOfTensorsGeneric] | TensorOrTupleOfTensorsGeneric,
baselines: BaselineType,
feature_mask: TensorOrTupleOfTensorsGeneric | None = None,
additional_forward_args: Any = None,
target: ExplanationTarget | list[ExplanationTarget] = NoTarget(),
frozen_features: list[Tensor] | None = None,
n_perturb_samples: int = 10,
max_examples_per_batch: int | None = None,
normalize: bool = False,
multi_target: bool = False,
return_dict: bool = False,
) -> Tensor | list[Tensor] | dict[str, Tensor] | dict[str, list[Tensor]]
A wrapper around the Captum library's infidelity metric that computes senstivity_n.
The metric returns a list of senstivity_n scores if multi_target is True using the
torchxai.metrics.faithfulness.multi_target._multi_target_infidelity,
otherwise it returns a single sensitivity_n score using the captum implementation captum.metrics.infidelity.
Sensitivity-n takes the same implementation as infidelity but defines a fixed perturbation function that perturbs n features for each sample at a time.
Explanation infidelity represents the expected mean-squared error between the explanation multiplied by a meaningful input perturbation and the differences between the predictor function at its input and perturbed input. More details about the measure can be found in the following paper: https://arxiv.org/abs/1901.09392
It is derived from the completeness property of well-known attribution algorithms and is a computationally more efficient and generalized notion of Sensitivy-n. The latter measures correlations between the sum of the attributions and the differences of the predictor function at its input and fixed baseline. More details about the Sensitivity-n can be found here: https://arxiv.org/abs/1711.06104
The users can perturb the inputs any desired way by providing any perturbation function that takes the inputs (and optionally baselines) and returns perturbed inputs or perturbed inputs and corresponding perturbations.
This specific implementation is primarily tested for attribution-based explanation methods but the idea can be expanded to use for non attribution-based interpretability methods as well.
Parameters:
-
(forward_funcCallable) –The forward function of the model or any modification of it. -
(inputsTensor or tuple[Tensor, ...]) –Input for which attributions are computed. If forward_func takes a single tensor as input, a single input tensor should be provided. If forward_func takes multiple tensors as input, a tuple of the input tensors should be provided. It is assumed that for all given input tensors, dimension 0 corresponds to the number of examples (aka batch size), and if multiple input tensors are provided, the examples must be aligned appropriately.
-
(baselinesscalar, Tensor, tuple of scalar, or Tensor) –Baselines define reference values which sometimes represent ablated values and are used to compare with the actual inputs to compute importance scores in attribution algorithms. For sensitivity-n baselines are required to compute the perturbations. Baselines can be provided as: They can be represented as: - a single tensor, if inputs is a single tensor, with exactly the same dimensions as inputs or the first dimension is one and the remaining dimensions match with inputs. - a single scalar, if inputs is a single tensor, which will be broadcasted for each input value in input tensor. - a tuple of tensors or scalars, the baseline corresponding to each tensor in the inputs' tuple can be: - either a tensor with matching dimensions to corresponding tensor in the inputs' tuple or the first dimension is one and the remaining dimensions match with the corresponding input tensor. - or a scalar, corresponding to a tensor in the inputs' tuple. This scalar value is broadcasted for corresponding input tensor. -
(n_features_perturbedint or float) –Number of features to perturb for each sample at a time. This n corresponds to the sensitivity-n value. The perturbation function will perturb n features for each sample n_perturb_samples times to compute the sensitivity-n for each sample. Alternatively, if n_features_perturbed is a float, it will be interpreted as a percentage of the total number of features in the input. For example, if n_features_perturbed=0.1, 10% of the total number of features will be perturbed for each sample at a time.
-
(attributionsTensor or tuple[Tensor, ...]) –Attribution scores computed based on an attribution algorithm. This attribution scores can be computed using the implementations provided in the `captum.attr` package. Some of those attribution approaches are so called global methods, which means that they factor in model inputs' multiplier, as described in: https://arxiv.org/abs/1711.06104 Many global attribution algorithms can be used in local modes, meaning that the inputs multiplier isn't factored in the attribution scores. This can be done duing the definition of the attribution algorithm by passing `multipy_by_inputs=False` flag. For example in case of Integrated Gradients (IG) we can obtain local attribution scores if we define the constructor of IG as: ig = IntegratedGradients(multipy_by_inputs=False) Some attribution algorithms are inherently local. Examples of inherently local attribution methods include: Saliency, Guided GradCam, Guided Backprop and Deconvolution. For local attributions we can use real-valued perturbations whereas for global attributions that perturbation is binary. https://arxiv.org/abs/1901.09392 If we want to compute the infidelity of global attributions we can use a binary perturbation matrix that will allow us to select a subset of features from `inputs` or `inputs - baselines` space. This will allow us to approximate sensitivity-n for a global attribution algorithm. `infidelity_perturb_func_decorator` function decorator is a helper function that computes perturbations under the hood if perturbed inputs are provided. For more details about how to use `infidelity_perturb_func_decorator`, please, read the documentation about `perturb_func` Attributions have the same shape and dimensionality as the inputs. If inputs is a single tensor then the attributions is a single tensor as well. If inputs is provided as a tuple of tensors then attributions will be tuples of tensors as well. -
(feature_maskTensor or tuple[Tensor, ...], default:None) –feature_mask defines a mask for the input, grouping features which should be perturbed together. feature_mask should contain the same number of tensors as inputs. Each tensor should be the same size as the corresponding input or broadcastable to match the input tensor. Each tensor should contain integers in the range 0 to num_features - 1, and indices corresponding to the same feature should have the same value. Note that features within each input tensor are perturbed independently (not across tensors). If the forward function returns a single scalar per batch, we enforce that the first dimension of each mask must be 1, since attributions are returned batch-wise rather than per example, so the attributions must correspond to the same features (indices) in each input example. If None, then a feature mask is constructed which assigns each scalar within a tensor as a separate feature, which is perturbed independently. Default: None -
(additional_forward_argsAny, default:None) –If the forward function requires additional arguments other than the inputs for which attributions should not be computed, this argument can be provided. It must be either a single additional argument of a Tensor or arbitrary (non-tuple) type or a tuple containing multiple additional arguments including tensors or any arbitrary python types. These arguments are provided to forward_func in order, following the arguments in inputs. Note that the perturbations are not computed with respect to these arguments. This means that these arguments aren't being passed to
perturb_funcas an input argument.Default: None -
(targetint, tuple, Tensor, or list, default:NoTarget()) –Indices for selecting predictions from output(for classification cases, this is usually the target class). If the network returns a scalar value per example, no target index is necessary. For general 2D outputs, targets can be either:
- A single integer or a tensor containing a single integer, which is applied to all input examples - A list of integers or a 1D tensor, with length matching the number of examples in inputs (dim 0). Each integer is applied as the target for the corresponding example. For outputs with > 2 dimensions, targets can be either: - A single tuple, which contains #output_dims - 1 elements. This target index is applied to all examples. - A list of tuples with length equal to the number of examples in inputs (dim 0), and each tuple containing #output_dims - 1 elements. Each tuple is applied as the target for the corresponding example. Default: None -
(n_perturb_samplesint, default:10) –The number of times input tensors are perturbed. Each input example in the inputs tensor is expanded
n_perturb_samplestimes before callingperturb_funcfunction.Default: 10 -
(max_examples_per_batchint, default:None) –The number of maximum input examples that are processed together. In case the number of examples (
input batch size * n_perturb_samples) exceedsmax_examples_per_batch, they will be sliced into batches ofmax_examples_per_batchexamples and processed in a sequential order. Ifmax_examples_per_batchis None, all examples are processed together.max_examples_per_batchshould at least be equalinput batch sizeand at mostinput batch size * n_perturb_samples.Default: None -
(normalizebool, default:False) –Normalize the dot product of the input perturbation and the attribution so the infidelity value is invariant to constant scaling of the attribution values. The normalization factor beta is defined as the ratio of two mean values:
.. math:: \beta = \frac{ \mathbb{E}_{I \sim \mu_I} [ I^T \Phi(f, x) (f(x) - f(x - I)) ] }{ \mathbb{E}_{I \sim \mu_I} [ (I^T \Phi(f, x))^2 ] } Please refer the original paper for the meaning of the symbols. Same normalization can be found in the paper's official implementation https://github.com/chihkuanyeh/saliency_evaluation Default: False -
(multi_targetbool, default:False) –A boolean flag that indicates whether the metric computation is for multi-target explanations. if set to true, the targets are required to be a list of integers each corresponding to a required target class in the output. The corresponding metric outputs are then returned as a list of metric outputs corresponding to each target class. For multi-target infidelity, captum implementation is extened in _multi_target_infidelity function. Default is False.
-
(return_dictbool, default:False) –A boolean flag that indicates whether the metric outputs are returned as a dictionary with keys as the metric names and values as the corresponding metric outputs. Default is False.
Returns:
infidelities (Tensor): A tensor of scalar infidelity scores per
input example. The first dimension is equal to the
number of examples in the input batch and the second
dimension is one.
Examples:: >>> # ImageClassifier takes a single input tensor of images Nx3x32x32, >>> # and returns an Nx10 tensor of class probabilities. >>> net = ImageClassifier() >>> saliency = Saliency(net) >>> input = torch.randn(2, 3, 32, 32, requires_grad=True) >>> # Computes saliency maps for class 3. >>> attribution = saliency.attribute(input, target=3) >>> # define a perturbation function for the input >>> def perturb_fn(inputs): >>> noise = torch.tensor(np.random.normal(0, 0.003, inputs.shape)).float() >>> return noise, inputs - noise >>> # Computes sensitivity_n score for saliency maps >>> infid = sensitivity_n(net, n_features_perturbed=1, baselines=0, input, attribution)
Source code in torchxai/metrics/faithfulness/sensitivity_n.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 | |