quantus.helpers package

Subpackages

• quantus.helpers.model package
  • Submodules
    • quantus.helpers.model.model_interface module
      • ModelInterface
    • quantus.helpers.model.models module
    • quantus.helpers.model.pytorch_model module
    • quantus.helpers.model.tf_model module

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
    • DataType.IMAGE
    • DataType.TABULAR
    • DataType.TEXT
    • DataType.TIMESERIES
  • EvaluationCategory
    • EvaluationCategory.AXIOMATIC
    • EvaluationCategory.COMPLEXITY
    • EvaluationCategory.FAITHFULNESS
    • EvaluationCategory.LOCALISATION
    • EvaluationCategory.NONE
    • EvaluationCategory.RANDOMISATION
    • EvaluationCategory.ROBUSTNESS
  • ModelType
    • ModelType.TF
    • ModelType.TORCH
  • ScoreDirection
    • ScoreDirection.HIGHER
    • ScoreDirection.LOWER
• 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()