Counts the number of features whose attribution magnitude exceeds a threshold, representing the effective number of features the explanation relies on. ↓ better.
effective_complexity
effective_complexity(
forward_func: Callable,
inputs: TensorOrTupleOfTensorsGeneric,
attributions: TensorOrTupleOfTensorsGeneric | list[TensorOrTupleOfTensorsGeneric],
baselines: BaselineType = None,
feature_mask: TensorOrTupleOfTensorsGeneric | None = None,
additional_forward_args: Any = None,
target: ExplanationTarget | list[ExplanationTarget] = NoTarget(),
perturb_func: Callable = default_fixed_baseline_perturb_func(),
n_perturbations_per_feature: int = 10,
max_features_processed_per_batch: int | None = None,
percentage_feature_removal_per_step: float = 0.0,
frozen_features: list[Tensor] | None = None,
zero_variance_threshold: float = 0.01,
return_ratio: bool = False,
multi_target: bool = False,
show_progress: bool = True,
return_intermediate_results: bool = False,
return_dict: bool = False,
) -> dict | tuple | Tensor | list[Tensor]
Implementation of Effective complexity metric by Nguyen at el., 2020. This implementation reuses the batch-computation ideas from captum and therefore it is fully compatible with the Captum library. In addition, the implementation takes some ideas about the implementation of the metric from the python Quantus library.
Effective complexity measures how many attributions in absolute values are exceeding a certain threshold (eps) where a value above the specified threshold implies that the features are important and under indicates it is not. Effective complexity requires the attributions to be normalized to return reasonable outputs since the original attributions may have different scales and effective complexity is sensitive to the scale of the attributions.
References
1) An-phi Nguyen and María Rodríguez Martínez.: "On quantitative aspects of model interpretability." arXiv preprint arXiv:2007.07584 (2020).
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.
-
(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. -
(baselinesscalar, Tensor, tuple of scalar, or Tensor, default:None) –Baselines define reference values against which the completeness is measured which sometimes represent ablated values and are used to compare with the actual inputs to compute importance scores in attribution algorithms. 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. Default: None -
(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 -
(perturb_funcCallable, default:default_fixed_baseline_perturb_func()) –The perturbation function of model inputs. This function takes model inputs and the corresponding feature masks to be perturbed. Optionally it also takes baselines as input arguments and returns a tuple of perturbed inputs. For example: >>> def my_perturb_func(inputs, masks, baselines): >>> <MY-LOGIC-HERE> >>> return perturbed_inputs If there are more than one inputs passed to this function those will be passed to `perturb_func` as tuples in the same order as they are passed to the function. In addition the corresponding feature masks will also be passed as a tuple in the same order as inputs. See default_perturb_func in metrics._utils.perturbation.py for an example of a perturbation function. If inputs - is a single tensor, the function needs to return single tensor of perturbed inputs. - is a tuple of tensors, corresponding perturbed inputs must be computed and returned as tuples in the following format: (perturbed_input1, perturbed_input2, ... perturbed_inputN) It is important to note that for performance reasons `perturb_func` isn't called for each example individually but on a batch of input examples that are repeated `max_features_processed_per_batch / batch_size` times within the batch. -
(n_perturbations_per_featureint, default:10) –The number of times each feature is perturbed. Each input example in the inputs tensor is expanded
n_perturbations_per_featuretimes before callingperturb_funcfunction for every single feature in the input. So if you have an input tensor of shape (N, C, H, W) and you setn_perturbations_per_feature, then each example in the batch will be handled separately and for each example a total ofC * H * Wperturbation steps will be performed and in each perturbation step a single feature will be repeatedn_perturbations_per_featuretimes. This means that the total number of perturbation steps will beC * H * W * n_perturbations_per_featurefor each example in the batch.Default: 10 -
(max_features_processed_per_batchint, default:None) –The number of maximum input features that are processed together for every example. In case the number of features in each example (
C * H * W) exceedsmax_features_processed_per_batch, they will be sliced into batches ofmax_features_processed_per_batchexamples and processed sequentially. -
(percentage_feature_removal_per_stepint, default:0.0) –The number of steps to process the features in a single batch. This is useful for reducing the computation time for large models. This allows 'percentage_feature_removal_per_step' ascending features to be removed together in each step instead of removing all the features. Therefore, if percentage_feature_removal_per_step=10, instead of removing the features X1, <X2, <X3... in each step, we will remove the features <X1-10, <X10-X20, <X20-X30 ... Default: 1
-
(frozen_featuresList[Tensor], default:None) –A list of frozen features that are not perturbed. This can be useful for ignoring the input structure features like padding, etc. Default: None In case CLS,PAD,SEP tokens are present in the input, they can be frozen by passing the indices of feature masks that correspond to these tokens.
-
(zero_variance_thresholdfloat, default:0.01) –A small value that is used to threshold the output variance
-
(return_ratiobool, default:False) –A boolean flag that indicates whether the effective complexity is returned as a ratio of the number of important features to the total number of features. 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. Default is False.
-
(show_progressbool, default:True) –Displays the progress of the computation. Default: True
-
(return_intermediate_resultsbool, default:False) –A boolean flag that indicates whether the intermediate results are returned. Default: False
-
(return_dictbool, default:False) –A boolean flag that indicates whether the metric outputs are returned as a dictionary
Returns: A tuple of tensors: effective_complexity_batch (Tensor): A tensor of scalar effective_complexity scores per input example. The first dimension is equal to the number of examples in the input batch and the second dimension is one. non_sensitivity_batch (Tensor): A tensor of scalar non_sensitivity scores per input example. The first dimension is equal to the number of examples in the input batch and the second dimension is one. n_features_batch (Tensor): A tensor of scalar values that represent the total number of features that are processed in the input batch. 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) >>> baselines = torch.zeros(2, 3, 32, 32) >>> # Computes saliency maps for class 3. >>> attribution = saliency.attribute(input, target=3) >>> # define a perturbation function for the input
>>> # Computes the effective complexity for saliency maps
>>> effective_complexity, non_sens, n_features = effective_complexity(net, input, attribution, baselines)
Source code in torchxai/metrics/complexity/effective_complexity.py
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 | |