quantus package

Subpackages

• quantus.functions package
  • Submodules
    • quantus.functions.discretise_func module
      • floating_points()
      • rank()
      • sign()
      • top_n_sign()
    • quantus.functions.explanation_func module
      • explain()
      • generate_captum_explanation()
      • generate_tf_explanation()
      • generate_zennit_explanation()
      • get_explanation()
    • quantus.functions.loss_func module
      • mse()
    • quantus.functions.mosaic_func module
      • build_single_mosaic()
      • mosaic_creation()
    • quantus.functions.norm_func module
      • fro_norm()
      • l2_norm()
      • linf_norm()
    • quantus.functions.normalise_func module
      • denormalise()
      • normalise_by_average_second_moment_estimate()
      • normalise_by_max()
      • normalise_by_negative()
    • quantus.functions.perturb_func module
      • baseline_replacement_by_blur()
      • baseline_replacement_by_indices()
      • baseline_replacement_by_mask()
      • baseline_replacement_by_shift()
      • batch_baseline_replacement_by_indices()
      • batch_gaussian_noise()
      • batch_uniform_noise()
      • batched_translation()
      • gaussian_noise()
      • no_perturbation()
      • noisy_linear_imputation()
      • perturb_batch()
      • rotation()
      • translation_x_direction()
      • translation_y_direction()
      • uniform_noise()
    • quantus.functions.similarity_func module
      • abs_difference()
      • correlation_kendall_tau()
      • correlation_pearson()
      • correlation_spearman()
      • cosine()
      • difference()
      • distance_chebyshev()
      • distance_euclidean()
      • distance_manhattan()
      • lipschitz_constant()
      • squared_difference()
      • ssim()
• quantus.helpers package
  • Subpackages
    • quantus.helpers.model package
      • Submodules
  • Submodules
    • quantus.helpers.asserts module
      • assert_attributions()
      • assert_attributions_order()
      • assert_explain_func()
      • assert_features_in_step()
      • assert_indexed_axes()
      • assert_layer_order()
      • assert_nr_segments()
      • assert_patch_size()
      • assert_plot_func()
      • assert_segmentations()
      • assert_value_smaller_than_input_size()
    • quantus.helpers.constants module
      • available_categories()
      • available_methods_captum()
      • available_methods_tf_explain()
      • available_metrics()
      • available_normalisation_functions()
      • available_perturbation_functions()
      • available_similarity_functions()
    • quantus.helpers.enums module
      • DataType
      • EvaluationCategory
      • ModelType
      • ScoreDirection
    • quantus.helpers.perturbation_utils module
      • changed_prediction_indices()
      • make_changed_prediction_indices_func()
      • make_perturb_func()
    • quantus.helpers.plotting module
      • plot_focus()
      • plot_model_parameter_randomisation_experiment()
      • plot_pixel_flipping_experiment()
      • plot_region_perturbation_experiment()
      • plot_selectivity_experiment()
      • plot_sensitivity_n_experiment()
    • quantus.helpers.utils module
      • blur_at_indices()
      • calculate_auc()
      • create_patch_slice()
      • expand_attribution_channel()
      • expand_indices()
      • filter_compatible_patch_sizes()
      • get_baseline_dict()
      • get_baseline_value()
      • get_block_indices()
      • get_features_in_step()
      • get_leftover_shape()
      • get_name()
      • get_nr_patches()
      • get_padding_size()
      • get_superpixel_segments()
      • get_wrapped_model()
      • identity()
      • infer_attribution_axes()
      • infer_channel_first()
      • make_channel_first()
      • make_channel_last()
      • offset_coordinates()
    • quantus.helpers.warn module
      • check_kwargs()
      • deprecation_warnings()
      • warn_absolute_operation()
      • warn_different_array_lengths()
      • warn_empty_segmentation()
      • warn_iterations_exceed_patch_number()
      • warn_max_size()
      • warn_noise_zero()
      • warn_normalise_operation()
      • warn_parameterisation()
      • warn_perturbation_caused_no_change()
      • warn_segmentation()
• quantus.metrics package
  • Subpackages
    • quantus.metrics.axiomatic package
      • Submodules
    • quantus.metrics.complexity package
      • Submodules
    • quantus.metrics.faithfulness package
      • Submodules
    • quantus.metrics.localisation package
      • Submodules
    • quantus.metrics.randomisation package
      • Submodules
    • quantus.metrics.robustness package
      • Submodules
  • Submodules
    • quantus.metrics.base module
      • Metric
    • quantus.metrics.base_batched module
      • BatchedMetric

Submodules

• quantus.evaluation module
  • evaluate()