Index

_

_2d_adaptive() (in module distributions) __1d_parts() (box.BoxInternal method) __2d_parts() (box.BoxInternal method) __3d_parts() (box.BoxInternal method) __batch() (evaluation.Evaluation method) __build_contrastive_masks() (explanation.Explanation method) __build_insertion_mask() (explanation.Explanation method) __combinations (in module mutant) __complete() (explanation.Explanation method) __dice() (multi_explanation.MultiExplanation method) __draw_circle() (explanation.Explanation method) __eq__() (box.BoxInternal method) __generate_circle_coordinates() (explanation.Explanation method) __get_shape() (input_data.Data method) __global() (explanation.Explanation method) __hash__() (box.BoxInternal method) __local_update() (resp_maps.ResponsibilityMaps method) __random_location() (multi_explanation.MultiExplanation method) __random_step_from() (multi_explanation.MultiExplanation method) __repr__() (_utils.ReXPositions method) (box.BoxInternal method) (config.Args method) (config.CausalArgs method) (explanation.Explanation method) (input_data.Data method) (multi_explanation.MultiExplanation method) (mutant.Mutant method) (prediction.Prediction method) (resp_maps.ResponsibilityMaps method)

__save_multi() (in module visualisation) __spatial() (explanation.Explanation method) __split_groups() (in module occlusions) __str__() (_utils.ReXDataError method) (_utils.ReXMapError method) (_utils.ReXPathError method) (_utils.ReXScriptError method) (_utils.ReXTomlError method) __tablename__ (database.DataBaseEntry attribute) __transpose_mask() (in module visualisation) _apply_to_data() (in module mutant) _betabinom2d() (in module distributions) _blend() (in module distributions) _dataframe() (in module database) _explanation() (in module rex) _guess_mode() (in module input_data) _normalise_rgb_data() (input_data.Data method) _to_numpy() (in module database) _transparent_cmap() (in module visualisation) _utils module _xlogx() (in module _utils)

A

active (mutant.Mutant attribute) add_boundaries() (in module _utils) add_children_to_tree() (box.Box method) add_to_database() (in module database) all (config.Args attribute) alpha (config.Args attribute) analyse (config.Args attribute) analyse() (rex_xai.lib.ReX method) analyze() (in module rex) apply_boundaries_to_image() (in module visualisation)

apply_dict_to_args() (in module config) apply_to_data() (mutant.Mutant method) area (database.DataBaseEntry attribute) area() (box.BoxInternal method) (mutant.Mutant method) Args (class in config) args (explanation.Explanation attribute) (rex_xai.lib.ReX attribute) average_box_size() (in module box) avg_box_size (database.DataBaseEntry attribute) Axes (class in box)

B

background (input_data.Data attribute) Base (class in database) batch_size (config.Args attribute) binary_threshold (config.Args attribute) blank() (explanation.Explanation method) blend (config.CausalArgs attribute)

bounding_box (prediction.Prediction attribute) box module Box (class in box) box_dimensions() (in module box) boxes_name_and_dimensions() (in module box) BoxInternal (class in box)

C

cache_ok (database.NumpyType attribute) calculate_responsibility() (in module rex) (rex_xai.lib.ReX method) causal_explanation() (in module responsibility) CausalArgs (class in config) channels (mutant.Mutant attribute) children (box.Box attribute) chunk_size (config.Args attribute) classification (prediction.Prediction attribute) clause_area() (in module _utils) cmdargs() (in module config) cmdargs_parser() (in module config) COL (box.Axes attribute) col_start (box.BoxInternal attribute) col_stop (box.BoxInternal attribute) colour (config.Args attribute) complete (config.Args attribute) complete_classification (database.DataBaseEntry attribute) complete_confidence (database.DataBaseEntry attribute) complete_mask (database.DataBaseEntry attribute) (explanation.Explanation attribute)

compute_masked_responsibility() (explanation.Explanation method) concentrate (config.CausalArgs attribute) confidence (database.DataBaseEntry attribute) (prediction.Prediction attribute) confidence_filter (config.CausalArgs attribute) config module config_location (config.Args attribute) (config.CausalArgs attribute) context (config.Args attribute) (input_data.Data attribute) context_location (config.Args attribute) context_noise (input_data.Data attribute) context_occlusion() (in module occlusions) contrastive() (explanation.Explanation method) contrastive_confidence (database.DataBaseEntry attribute) contrastive_mask (database.DataBaseEntry attribute) contrastive_position (_utils.ReXPositions attribute) corners() (box.BoxInternal method) counts (resp_maps.ResponsibilityMaps attribute) create_box() (box.BoxInternal method) current_max_necessity (_utils.ReXPositions attribute)

D

Data (class in input_data) data (explanation.Explanation attribute) (rex_xai.lib.ReX attribute) data_location (config.CausalArgs attribute) database module DataBaseEntry (class in database) db (config.Args attribute) db_to_pandas() (in module database) default_prediction_function() (in module prediction) deletion_curve (database.DataBaseEntry attribute) DEPTH (box.Axes attribute) depth (mutant.Mutant attribute) (resp_maps.ResponsibilityMaps attribute)

depth_reached (database.DataBaseEntry attribute) depth_start (box.BoxInternal attribute) depth_stop (box.BoxInternal attribute) device (input_data.Data attribute) (onnx.OnnxRunner attribute) (rex_xai.lib.ReX attribute) distribution (box.BoxInternal attribute) (config.CausalArgs attribute) (database.DataBaseEntry attribute) Distribution (in module distributions) distribution_args (box.BoxInternal attribute) (config.CausalArgs attribute) (database.DataBaseEntry attribute) distributions module

E

entropy (database.DataBaseEntry attribute) evaluation module Evaluation (class in evaluation) explanation module Explanation (class in explanation) explanation (evaluation.Evaluation attribute) (rex_xai.lib.ReX attribute)

explanation() (in module rex) explanation_confidences (multi_explanation.MultiExplanation attribute) explanations (multi_explanation.MultiExplanation attribute) extract() (explanation.Explanation method) (multi_explanation.MultiExplanation method) extract_complete_explanation() (rex_xai.lib.ReX method) extract_contrastive_explanation() (rex_xai.lib.ReX method) extract_sufficient_explanation() (rex_xai.lib.ReX method)

F

failing (database.DataBaseEntry attribute) ff() (in module _utils) find_complete_prediction() (in module _utils)

find_config_path() (in module config) find_required_prediction() (in module _utils) from_pytorch_tensor() (in module prediction)

G

gen_prediction_function() (onnx.OnnxRunner method) generate_colours() (in module visualisation) generate_explanation_object() (rex_xai.lib.ReX method) generic_image_preprocess() (input_data.Data method) generic_tab_preprocess() (input_data.Data method) get() (resp_maps.ResponsibilityMaps method) get_active_boxes() (mutant.Mutant method) get_all_args() (in module config) get_class() (prediction.Prediction method) get_combinations() (in module mutant)

get_default_prediction_function() (rex_xai.lib.ReX method) get_device() (in module _utils) get_dict_repr() (config.Args method) (config.CausalArgs method) get_length() (mutant.Mutant method) get_map_locations() (in module _utils) get_name() (mutant.Mutant method) get_prediction_func_from_args() (in module rex) get_prediction_function() (in module onnx) gpu (config.Args attribute) grid (config.Args attribute)

H

heatmap (config.Args attribute) heatmap_colours (config.Args attribute)

heatmap_plot() (explanation.Explanation method) (in module visualisation) height (resp_maps.ResponsibilityMaps attribute)

I

id (database.DataBaseEntry attribute) impl (database.NumpyType attribute) info (config.Args attribute) initialise_rex_db() (in module database) initialise_tree() (in module box) input (input_data.Data attribute) input_data module input_name (onnx.OnnxRunner attribute) input_shape (onnx.OnnxRunner attribute) insertion_curve (database.DataBaseEntry attribute)

insertion_deletion_curve() (evaluation.Evaluation method) insertion_step (config.Args attribute) inter_op_num_threads (config.Args attribute) intra_op_num_threads (config.Args attribute) inverse_classification (database.DataBaseEntry attribute) inverse_confidence (database.DataBaseEntry attribute) is_empty() (_utils.ReXPositions method) (prediction.Prediction method) is_passing() (prediction.Prediction method) items() (resp_maps.ResponsibilityMaps method) iters (config.CausalArgs attribute) (database.DataBaseEntry attribute)

K

keys() (resp_maps.ResponsibilityMaps method)

L

len() (resp_maps.ResponsibilityMaps method) load_and_preprocess_data() (in module rex) load_config() (in module config)

load_data() (input_data.Data method) logger module logger (in module logger)

M

main() (in module rex_xai.rex_wrapper) make_composite_mask() (in module visualisation) maps (resp_maps.ResponsibilityMaps attribute) (rex_xai.lib.ReX attribute) mark_segments (config.Args attribute) mask (mutant.Mutant attribute) mask_shape (database.DataBaseEntry attribute) mask_value (config.CausalArgs attribute) (input_data.Data attribute) masking_func (mutant.Mutant attribute) match_data_to_model_shape() (input_data.Data method) match_queue_style() (in module config) match_resposnibility_style() (in module _utils) match_strategy() (in module config) max_spotlight_budget (config.Args attribute) means (config.Args attribute) merge() (resp_maps.ResponsibilityMaps method) message (_utils.ReXDataError attribute) (_utils.ReXMapError attribute) (_utils.ReXPathError attribute) (_utils.ReXScriptError attribute) (_utils.ReXTomlError attribute) method (database.DataBaseEntry attribute) min_box_size (config.CausalArgs attribute) min_size (database.DataBaseEntry attribute) minimum_confidence_threshold (config.Args attribute) mode (config.Args attribute) (input_data.Data attribute) (mutant.Mutant attribute) (rex_xai.lib.ReX attribute) model (config.Args attribute) (rex_xai.lib.ReX attribute) model_channels (input_data.Data attribute) model_depth (input_data.Data attribute) model_height (input_data.Data attribute)

model_order (input_data.Data attribute) model_shape (input_data.Data attribute) (rex_xai.lib.ReX attribute) model_width (input_data.Data attribute) module _utils box config database distributions evaluation explanation input_data logger multi_explanation mutant occlusions onnx prediction resp_maps responsibility rex rex_xai rex_xai.lib rex_xai.rex_wrapper visualisation multi (database.DataBaseEntry attribute) multi_class (config.Args attribute) multi_explanation module multi_no (database.DataBaseEntry attribute) multi_style (config.Args attribute) MultiExplanation (class in multi_explanation) mutant module Mutant (class in mutant)

N

name (box.BoxInternal attribute) necessity_mask (explanation.Explanation attribute) negative_responsibility (config.CausalArgs attribute) negative_responsibility() (resp_maps.ResponsibilityMaps method) new_map() (resp_maps.ResponsibilityMaps method)

no_expansions (config.Args attribute) no_extract (config.Args attribute) norm (config.Args attribute) normalise_curves (config.Args attribute) NumpyType (class in database)

O

obj_function (database.DataBaseEntry attribute) occlusion_noise (config.Args attribute) occlusions module one_d_permute() (in module _utils) onnx module

OnnxRunner (class in onnx) order (mutant.Mutant attribute) ort_logger (config.Args attribute) output (config.Args attribute) output_name (onnx.OnnxRunner attribute) output_shape (onnx.OnnxRunner attribute) overlay_grid() (in module visualisation)

P

parent (box.Box attribute) passing (database.DataBaseEntry attribute) (mutant.Mutant attribute) path (config.Args attribute) (database.DataBaseEntry attribute) permitted_overlap (config.Args attribute) plot_3d() (in module visualisation) plot_curve() (in module visualisation) plot_image_grid() (in module visualisation) powerset() (in module _utils) predict_target() (in module rex) prediction module Prediction (class in prediction)

prediction (mutant.Mutant attribute) prediction_func (explanation.Explanation attribute) prediction_function (rex_xai.lib.ReX attribute) process_bind_param() (database.NumpyType method) process_cmd_args() (in module config) process_config_dict() (in module config) process_custom_script() (in module config) process_mask_column() (in module database) process_responsibility_column() (in module database) process_result_value() (database.NumpyType method) processed (config.Args attribute) progress_bar (config.Args attribute) prune() (in module responsibility) Python Enhancement Proposals PEP 484, [1]

Q

Queue (in module _utils)

queue_len (config.CausalArgs attribute) queue_style (config.CausalArgs attribute)

R

random_coords() (in module distributions) ratio() (evaluation.Evaluation method) raw (config.Args attribute) read_config_file() (in module config) remove_background() (in module visualisation) rerun_with() (rex_xai.lib.ReX method) resp_maps module responsibility module responsibility (database.DataBaseEntry attribute) responsibility() (resp_maps.ResponsibilityMaps method) responsibility_entropy() (evaluation.Evaluation method) responsibility_shape (database.DataBaseEntry attribute) responsibility_style (config.CausalArgs attribute) ResponsibilityMaps (class in resp_maps) ResponsibilityStyle (in module _utils) rex module ReX (class in rex_xai.lib)

rex_ascii() (in module config) rex_xai module rex_xai.lib module rex_xai.rex_wrapper module ReXDataError ReXError ReXMapError ReXPathError ReXPositions (class in _utils) ReXScriptError ReXTomlError robustness() (evaluation.Evaluation method) ROW (box.Axes attribute) row_start (box.BoxInternal attribute) row_stop (box.BoxInternal attribute) run_on_cpu() (onnx.OnnxRunner method) run_stats (explanation.Explanation attribute) run_with_data_on_device() (onnx.OnnxRunner method)

S

save() (explanation.Explanation method) (multi_explanation.MultiExplanation method) save_complete() (in module visualisation) save_contrastive() (in module visualisation) save_image() (in module visualisation) save_multi_explanation() (in module visualisation) save_mutant() (mutant.Mutant method) script (config.Args attribute) script_location (config.Args attribute) search_limit (config.CausalArgs attribute) (database.DataBaseEntry attribute) search_limit_per_iter (database.DataBaseEntry attribute) seed (config.Args attribute) segmentation (config.CausalArgs attribute) separate_by() (multi_explanation.MultiExplanation method) session (onnx.OnnxRunner attribute) set_active_mask_regions() (mutant.Mutant method) set_boolean_mask_value() (in module _utils) set_channels() (input_data.Data method) set_classification() (input_data.Data method) set_height() (input_data.Data method) set_input() (rex_xai.lib.ReX method) set_log_level() (in module logger) set_mask_region_to_true() (mutant.Mutant method) set_mask_value() (input_data.Data method) set_prediction_function() (rex_xai.lib.ReX method) set_rgb_image() (rex_xai.lib.ReX method) set_static_mask_regions() (mutant.Mutant method) set_tabular_data() (rex_xai.lib.ReX method) set_target() (rex_xai.lib.ReX method) set_to_true() (explanation.Explanation method) set_transformed_data() (rex_xai.lib.ReX method) set_width() (input_data.Data method) Setup (in module input_data) setup (input_data.Data attribute) (onnx.OnnxRunner attribute) shape (config.Args attribute) (mutant.Mutant attribute) shape() (box.BoxInternal method) shared_args() (in module config) show() (explanation.Explanation method) (multi_explanation.MultiExplanation method) (rex_xai.lib.ReX method)

show_target() (rex_xai.lib.ReX method) show_tree() (in module box) spatial_eta (database.DataBaseEntry attribute) spatial_initial_radius (config.Args attribute) spatial_radius (database.DataBaseEntry attribute) spatial_radius_eta (config.Args attribute) SpatialSearch (in module _utils) spawn_children() (box.BoxInternal method) spectral_entropy() (evaluation.Evaluation method) spectral_occlusion() (in module occlusions) spectral_plot() (in module visualisation) spotlight_eta (config.Args attribute) (database.DataBaseEntry attribute) spotlight_objective_function (config.Args attribute) spotlight_search() (multi_explanation.MultiExplanation method) spotlight_size (config.Args attribute) (database.DataBaseEntry attribute) spotlight_step (config.Args attribute) spotlights (config.Args attribute) (database.DataBaseEntry attribute) static (mutant.Mutant attribute) stats (rex_xai.lib.ReX attribute) stds (config.Args attribute) str2distribution() (in module distributions) strategy (config.Args attribute) Strategy (in module _utils) style (resp_maps.ResponsibilityMaps attribute) subbox() (in module responsibility) subplot_multi_explanations() (in module visualisation) subset() (resp_maps.ResponsibilityMaps method) sufficiency_confidence (database.DataBaseEntry attribute) (explanation.Explanation attribute) sufficiency_found (_utils.ReXPositions attribute) sufficiency_mask (database.DataBaseEntry attribute) (explanation.Explanation attribute) sufficient_position (_utils.ReXPositions attribute) surface (config.Args attribute) surface_plot() (explanation.Explanation method) (in module visualisation)

T

target (database.DataBaseEntry attribute) (input_data.Data attribute) (prediction.Prediction attribute) target_confidence (prediction.Prediction attribute) target_map (explanation.Explanation attribute) time (database.DataBaseEntry attribute) total_work (database.DataBaseEntry attribute)

transposed (input_data.Data attribute) tree_depth (config.CausalArgs attribute) (database.DataBaseEntry attribute) try_detach() (in module _utils) try_preprocess() (in module rex) try_rounding() (in module _utils) try_unsqueeze() (input_data.Data method)

U

update_database() (in module database) update_depth_reached() (in module responsibility) update_maps() (resp_maps.ResponsibilityMaps method)

update_mask_shape() (in module _utils) update_name() (box.BoxInternal method) update_status() (mutant.Mutant method) use_bounding_box (config.CausalArgs attribute)

V

validate_args() (in module config) validate_numeric_arg_more_than() (in module config) validate_numeric_arg_within_bounds() (in module config) validate_shape() (in module rex)

verbosity (config.Args attribute) version() (in module _utils) visualisation module voxel_plot() (in module visualisation)

W

weighted (config.CausalArgs attribute)

width (resp_maps.ResponsibilityMaps attribute)

X

xlogx() (in module _utils)