Index

A

ACLARC (class in detoxai.methods.clarcs.aclarc) add_clarc_hook() (detoxai.methods.leace.leace.LEACE method) (in module detoxai.methods.clarcs.hooks) add_mass_mean_probe_hook() (in module detoxai.methods.clarcs.hooks) ADR (class in detoxai.core.xai) aggregate() (detoxai.core.xai.SailRectMetric method) ALL_LOGITS (detoxai.methods.clarcs.rrclarc.RRMaskingPattern attribute) ALL_LOGITS_RANDOM (detoxai.methods.clarcs.rrclarc.RRMaskingPattern attribute) AllMetrics (class in detoxai.metrics.fairness_metrics) apply_hook() (detoxai.methods.savani.savani_base.SavaniBase method) apply_model_correction() (detoxai.methods.clarcs.aclarc.ACLARC method) (detoxai.methods.clarcs.clarc.CLARC method) (detoxai.methods.clarcs.pclarc.PCLARC method) (detoxai.methods.clarcs.rrclarc.RRCLARC method) (detoxai.methods.leace.leace.LEACE method) (detoxai.methods.model_correction.ModelCorrectionMethod method) (detoxai.methods.other.fine_tune.FineTune method) (detoxai.methods.posthoc.naive_threshold.NaiveThresholdOptimizer method) (detoxai.methods.posthoc.posthoc_base.PosthocBase method) (detoxai.methods.posthoc.reject_option_classification.RejectOptionClassification method) (detoxai.methods.savani.adversarial.SavaniAFT method) (detoxai.methods.savani.lay_wis_opt.SavaniLWO method) (detoxai.methods.savani.random_perturbation.SavaniRP method) (detoxai.methods.savani.savani_base.SavaniBase method) (detoxai.methods.savani.zhang.ZhangM method)

attach_logger() (detoxai.visualization.Visualizer.Visualizer method)

B

balance_dataset() (in module detoxai.utils.datasets) balanced_accuracy_torch() (in module detoxai.metrics.metrics)

BaseLightningWrapper (class in detoxai.core.model_wrappers) BiasMetrics (class in detoxai.metrics.bias_metrics) BinaryGroupStatRatesUnwrapped (class in detoxai.metrics.fairness_metrics)

C

calculate() (detoxai.visualization.LRPHandler.LRPHandler method) calculate_batch() (detoxai.core.xai.SailRectMetric method) calculate_bias_metric_torch() (in module detoxai.metrics.bias_metrics) calculate_demographic_parity() (detoxai.metrics.fairness_metrics.FairnessMetrics method) calculate_equality_of_opportunity() (detoxai.metrics.fairness_metrics.FairnessMetrics method) calculate_equalized_odds() (detoxai.metrics.fairness_metrics.FairnessMetrics method) calculate_max_samples() (in module detoxai.utils.datasets) calculate_metrics() (detoxai.core.xai.XAIMetricsCalculator method) calculate_treatment_equality() (detoxai.metrics.fairness_metrics.FairnessMetrics method) canonize_results() (detoxai.visualization.MetricsVisualizer.MetricsVisualizer class method) check_layer_name_exists() (detoxai.methods.savani.savani_base.SavaniBase method) CLARC (class in detoxai.methods.clarcs.clarc) clarc_hook() (in module detoxai.methods.clarcs.hooks) close_plot() (detoxai.visualization.Visualizer.Visualizer method) comprehensive_metrics_torch() (in module detoxai.metrics.metrics) compute() (detoxai.metrics.fairness_metrics.BinaryGroupStatRatesUnwrapped method) (detoxai.metrics.fairness_metrics.FairnessMetrics method)

compute_cav() (in module detoxai.cavs.cav) compute_cavs() (detoxai.methods.clarcs.clarc.CLARC method) compute_mass_mean_probe() (in module detoxai.cavs.mass_mean_probe) ConditionOn (class in detoxai.visualization.enums) configure_optimizers() (detoxai.core.model_wrappers.BaseLightningWrapper method) construct_metrics_config() (in module detoxai.core.interface_helpers) copy_data_loader() (in module detoxai.utils.dataloader) CorrectionResult (class in detoxai.core.results_class) COSINE (detoxai.methods.clarcs.rrclarc.RRLossType attribute) cosine_dist() (in module detoxai.metrics.distance_metrics) cosine_similarities_batch() (in module detoxai.metrics.distance_metrics) create_plot() (detoxai.visualization.ScatterVisualizer.ScatterVisualizer method) create_structure() (in module detoxai.datasets.catalog.torchvision_utils) create_structure2() (in module detoxai.datasets.catalog.torchvision_utils) create_table() (detoxai.visualization.TableVisualizer.TableVisualizer method) curl_download() (in module detoxai.datasets.catalog.download)

D

DataVisualizer (class in detoxai.visualization.DataVisualizer) debias() (in module detoxai.core.interface) DET (class in detoxai.core.xai) detoxai module detoxai.cavs module detoxai.cavs.cav module detoxai.cavs.extract_activations module detoxai.cavs.mass_mean_probe module detoxai.core module detoxai.core.evaluation module detoxai.core.interface module detoxai.core.interface_helpers module detoxai.core.mcda_helpers module detoxai.core.model_wrappers module detoxai.core.results_class module detoxai.core.xai module detoxai.datasets module detoxai.datasets.catalog module detoxai.datasets.catalog.download module detoxai.datasets.catalog.torchvision_utils module detoxai.methods module detoxai.methods.clarcs module detoxai.methods.clarcs.aclarc module detoxai.methods.clarcs.clarc module detoxai.methods.clarcs.hooks module detoxai.methods.clarcs.pclarc module detoxai.methods.clarcs.rrclarc module detoxai.methods.leace module detoxai.methods.leace.leace module detoxai.methods.model_correction module detoxai.methods.other module detoxai.methods.other.fine_tune module detoxai.methods.posthoc module detoxai.methods.posthoc.naive_threshold module detoxai.methods.posthoc.posthoc_base module detoxai.methods.posthoc.reject_option_classification module

detoxai.methods.savani module detoxai.methods.savani.adversarial module detoxai.methods.savani.lay_wis_opt module detoxai.methods.savani.random_perturbation module detoxai.methods.savani.savani_base module detoxai.methods.savani.utils module detoxai.methods.savani.zhang module detoxai.methods.utils module detoxai.metrics module detoxai.metrics.bias_metrics module detoxai.metrics.distance_metrics module detoxai.metrics.fairness_metrics module detoxai.metrics.metrics module detoxai.utils module detoxai.utils.dataloader module detoxai.utils.datasets module detoxai.utils.decorators module detoxai.utils.experiment_logger module detoxai.utils.transformations module detoxai.visualization module detoxai.visualization.DataVisualizer module detoxai.visualization.enums module detoxai.visualization.HeatmapVisualizer module detoxai.visualization.ImageVisualizer module detoxai.visualization.LRPHandler module detoxai.visualization.MetricsVisualizer module detoxai.visualization.ScatterVisualizer module detoxai.visualization.SSVisualizer module detoxai.visualization.TableVisualizer module detoxai.visualization.Visualizer module DetoxaiDataLoader (class in detoxai.utils.dataloader) DetoxaiDataset (class in detoxai.utils.datasets) DIF (class in detoxai.core.xai) download() (detoxai.utils.datasets.DetoxaiDataset method) download_datasets() (in module detoxai.datasets.catalog.download) download_stuff() (in module detoxai.datasets.catalog.download) DP_GAP (detoxai.metrics.bias_metrics.BiasMetrics attribute)

E

ensure_metrics_config_not_empty() (in module detoxai.utils.decorators) EO_GAP (detoxai.metrics.bias_metrics.BiasMetrics attribute) euclidean_dist() (in module detoxai.metrics.distance_metrics) evaluate_model() (in module detoxai.core.evaluation)

ExperimentLogger (class in detoxai.utils.experiment_logger) extract_activations() (detoxai.methods.clarcs.clarc.CLARC method) (detoxai.methods.leace.leace.LEACE method) (in module detoxai.cavs.extract_activations)

F

fair_loss() (detoxai.methods.savani.adversarial.SavaniAFT method) FairnessLightningWrapper (class in detoxai.core.model_wrappers) FairnessMetrics (class in detoxai.metrics.fairness_metrics) filter_pareto_front() (in module detoxai.core.mcda_helpers) FineTune (class in detoxai.methods.other.fine_tune)

flatten_select() (detoxai.methods.savani.lay_wis_opt.SavaniLWO method) FNR_GAP (detoxai.metrics.bias_metrics.BiasMetrics attribute) forward() (detoxai.core.model_wrappers.BaseLightningWrapper method) (detoxai.methods.posthoc.reject_option_classification.ROCModelWrapper method) FPR_GAP (detoxai.metrics.bias_metrics.BiasMetrics attribute)

G

gdown_download() (in module detoxai.datasets.catalog.download) get_all_layers() (in module detoxai.cavs.extract_activations) get_all_metrics() (detoxai.core.results_class.CorrectionResult method) get_canvas() (detoxai.visualization.Visualizer.Visualizer method) get_class_names() (detoxai.utils.dataloader.DetoxaiDataLoader method) (detoxai.utils.dataloader.WrappedDataLoader method) (detoxai.utils.datasets.DetoxaiDataset method) get_collate_fn() (detoxai.utils.datasets.DetoxaiDataset method) get_critic() (detoxai.methods.savani.adversarial.SavaniAFT method) (detoxai.methods.savani.zhang.ZhangM method) get_detoxai_datasets() (in module detoxai.utils.datasets) get_fairness_metrics() (detoxai.metrics.fairness_metrics.AllMetrics method) get_latex_table() (detoxai.visualization.TableVisualizer.TableVisualizer method) get_layer_by_name() (in module detoxai.cavs.extract_activations)

get_lightning_model() (detoxai.methods.model_correction.ModelCorrectionMethod method) get_method() (detoxai.core.results_class.CorrectionResult method) get_metric() (detoxai.core.results_class.CorrectionResult method) get_model() (detoxai.core.results_class.CorrectionResult method) (detoxai.methods.model_correction.ModelCorrectionMethod method) get_nth_batch() (detoxai.utils.dataloader.DetoxaiDataLoader method) get_nth_batch2() (detoxai.utils.dataloader.DetoxaiDataLoader method) get_num_classes() (detoxai.utils.dataloader.DetoxaiDataLoader method) (detoxai.utils.dataloader.WrappedDataLoader method) (detoxai.utils.datasets.DetoxaiDataset method) get_performance_metrics() (detoxai.metrics.fairness_metrics.AllMetrics method) get_pred_true_prot() (detoxai.methods.savani.savani_base.SavaniBase method) get_raw_results() (detoxai.visualization.TableVisualizer.TableVisualizer method) get_supported_methods() (in module detoxai.core.interface) get_table() (detoxai.visualization.TableVisualizer.TableVisualizer method)

H

HeatmapVisualizer (class in detoxai.visualization.HeatmapVisualizer)

HRF (class in detoxai.core.xai)

I

ImageVisualizer (class in detoxai.visualization.ImageVisualizer) IMPROPER_LABEL (detoxai.visualization.enums.ConditionOn attribute) infer_layers() (in module detoxai.core.interface_helpers)

infer_metrics() (detoxai.metrics.fairness_metrics.PerformanceMetrics class method) init_rectangle_painter() (detoxai.visualization.ImageVisualizer.ImageVisualizer method) initialize_dataloader() (detoxai.methods.savani.savani_base.SavaniBase method) is_pareto_efficient() (in module detoxai.core.mcda_helpers)

L

L1 (detoxai.methods.clarcs.rrclarc.RRLossType attribute) L2 (detoxai.methods.clarcs.rrclarc.RRLossType attribute) largest_vals() (in module detoxai.metrics.distance_metrics) LEACE (class in detoxai.methods.leace.leace) load_activations() (in module detoxai.cavs.extract_activations) load_supported_tags() (in module detoxai.core.interface_helpers) local_save() (detoxai.visualization.Visualizer.Visualizer method)

log() (detoxai.visualization.Visualizer.Visualizer method) log_image() (detoxai.utils.experiment_logger.ExperimentLogger method) (detoxai.visualization.Visualizer.Visualizer method) log_metric() (detoxai.utils.experiment_logger.ExperimentLogger method) log_table() (detoxai.utils.experiment_logger.ExperimentLogger method) (detoxai.visualization.Visualizer.Visualizer method) LOGPROBS (detoxai.methods.clarcs.rrclarc.RRMaskingPattern attribute) LRPHandler (class in detoxai.visualization.LRPHandler)

M

make_detoxai_datasets_variant() (in module detoxai.utils.datasets) masked_criterion() (detoxai.methods.clarcs.rrclarc.RRCLARC method) mass_mean_probe_hook() (in module detoxai.methods.clarcs.hooks) MAX_LOGIT (detoxai.methods.clarcs.rrclarc.RRMaskingPattern attribute) maybe_paint_rectangle() (detoxai.visualization.ImageVisualizer.ImageVisualizer method) metrics_config (detoxai.visualization.MetricsVisualizer.MetricsVisualizer attribute) MetricsVisualizer (class in detoxai.visualization.MetricsVisualizer) ModelCorrectionMethod (class in detoxai.methods.model_correction) modified_training_step() (detoxai.methods.clarcs.rrclarc.RRCLARC method) module detoxai detoxai.cavs detoxai.cavs.cav detoxai.cavs.extract_activations detoxai.cavs.mass_mean_probe detoxai.core detoxai.core.evaluation detoxai.core.interface detoxai.core.interface_helpers detoxai.core.mcda_helpers detoxai.core.model_wrappers detoxai.core.results_class detoxai.core.xai detoxai.datasets detoxai.datasets.catalog detoxai.datasets.catalog.download detoxai.datasets.catalog.torchvision_utils detoxai.methods detoxai.methods.clarcs detoxai.methods.clarcs.aclarc detoxai.methods.clarcs.clarc detoxai.methods.clarcs.hooks detoxai.methods.clarcs.pclarc detoxai.methods.clarcs.rrclarc detoxai.methods.leace detoxai.methods.leace.leace detoxai.methods.model_correction detoxai.methods.other detoxai.methods.other.fine_tune detoxai.methods.posthoc detoxai.methods.posthoc.naive_threshold detoxai.methods.posthoc.posthoc_base detoxai.methods.posthoc.reject_option_classification detoxai.methods.savani detoxai.methods.savani.adversarial detoxai.methods.savani.lay_wis_opt detoxai.methods.savani.random_perturbation detoxai.methods.savani.savani_base detoxai.methods.savani.utils detoxai.methods.savani.zhang detoxai.methods.utils detoxai.metrics detoxai.metrics.bias_metrics detoxai.metrics.distance_metrics detoxai.metrics.fairness_metrics detoxai.metrics.metrics detoxai.utils detoxai.utils.dataloader detoxai.utils.datasets detoxai.utils.decorators detoxai.utils.experiment_logger detoxai.utils.transformations detoxai.visualization detoxai.visualization.DataVisualizer detoxai.visualization.enums detoxai.visualization.HeatmapVisualizer detoxai.visualization.ImageVisualizer detoxai.visualization.LRPHandler detoxai.visualization.MetricsVisualizer detoxai.visualization.ScatterVisualizer detoxai.visualization.SSVisualizer detoxai.visualization.TableVisualizer detoxai.visualization.Visualizer

MRR (class in detoxai.core.xai)

N

NaiveThresholdOptimizer (class in detoxai.methods.posthoc.naive_threshold)

O

objective_LWO() (detoxai.methods.savani.lay_wis_opt.SavaniLWO method) objective_thresh() (detoxai.methods.savani.savani_base.SavaniBase method) on_test_batch_end() (detoxai.core.model_wrappers.BaseLightningWrapper method) (detoxai.core.model_wrappers.FairnessLightningWrapper method) on_test_epoch_end() (detoxai.core.model_wrappers.BaseLightningWrapper method) (detoxai.core.model_wrappers.FairnessLightningWrapper method)

on_train_batch_end() (detoxai.core.model_wrappers.BaseLightningWrapper method) (detoxai.core.model_wrappers.FairnessLightningWrapper method) on_train_epoch_end() (detoxai.core.model_wrappers.BaseLightningWrapper method) (detoxai.core.model_wrappers.FairnessLightningWrapper method) optimize_tau() (detoxai.methods.savani.savani_base.SavaniBase method)

P

parse_methods_config() (in module detoxai.core.interface) PCLARC (class in detoxai.methods.clarcs.pclarc) PerformanceMetrics (class in detoxai.metrics.fairness_metrics) phi_torch() (detoxai.methods.savani.savani_base.SavaniBase method) (in module detoxai.methods.savani.utils)

PosthocBase (class in detoxai.methods.posthoc.posthoc_base) predict_step() (detoxai.core.model_wrappers.BaseLightningWrapper method) (detoxai.core.model_wrappers.FairnessLightningWrapper method) PROPER_LABEL (detoxai.visualization.enums.ConditionOn attribute)

R

RDDT (class in detoxai.core.xai) reduce() (detoxai.core.xai.DET method) (detoxai.core.xai.RDDT method) (detoxai.core.xai.SailRectMetric method) RejectOptionClassification (class in detoxai.methods.posthoc.reject_option_classification) remove_hooks() (detoxai.methods.model_correction.ModelCorrectionMethod method) require_activations_and_cav() (in module detoxai.methods.clarcs.clarc) resolve_layer() (in module detoxai.core.interface_helpers) results_to_tidy_df() (in module detoxai.metrics.fairness_metrics) (in module detoxai.visualization.MetricsVisualizer)

ROCModelWrapper (class in detoxai.methods.posthoc.reject_option_classification) rr_clarc_hook() (detoxai.methods.clarcs.rrclarc.RRCLARC method) rr_loss() (detoxai.methods.clarcs.rrclarc.RRCLARC method) RRCLARC (class in detoxai.methods.clarcs.rrclarc) RRF (class in detoxai.core.xai) RRLossType (class in detoxai.methods.clarcs.rrclarc) RRMaskingPattern (class in detoxai.methods.clarcs.rrclarc) run_correction() (in module detoxai.core.interface) run_handler() (in module detoxai.datasets.catalog.download)

S

SailRectMetric (class in detoxai.core.xai) sample_batch() (detoxai.methods.savani.savani_base.SavaniBase method) SavaniAFT (class in detoxai.methods.savani.adversarial) SavaniBase (class in detoxai.methods.savani.savani_base) SavaniLWO (class in detoxai.methods.savani.lay_wis_opt) SavaniRP (class in detoxai.methods.savani.random_perturbation) save_to_csv() (detoxai.visualization.TableVisualizer.TableVisualizer method) ScatterVisualizer (class in detoxai.visualization.ScatterVisualizer) select_best_method() (in module detoxai.core.mcda_helpers)

set_up_plots_configuration() (detoxai.visualization.Visualizer.Visualizer method) show() (detoxai.visualization.Visualizer.Visualizer method) show_plot() (detoxai.visualization.Visualizer.Visualizer method) SquarePad (class in detoxai.utils.transformations) SSVisualizer (class in detoxai.visualization.SSVisualizer) stabilize() (in module detoxai.methods.clarcs.hooks) (in module detoxai.metrics.bias_metrics) (in module detoxai.metrics.fairness_metrics) stabilize_torch() (in module detoxai.metrics.metrics) structure_output() (detoxai.core.xai.SailRectMetric method)

T

TableVisualizer (class in detoxai.visualization.TableVisualizer) TARGET_LOGIT (detoxai.methods.clarcs.rrclarc.RRMaskingPattern attribute) test_step() (detoxai.core.model_wrappers.BaseLightningWrapper method) (detoxai.core.model_wrappers.FairnessLightningWrapper method)

TNR_GAP (detoxai.metrics.bias_metrics.BiasMetrics attribute) TPR_GAP (detoxai.metrics.bias_metrics.BiasMetrics attribute) training_step() (detoxai.core.model_wrappers.BaseLightningWrapper method) (detoxai.core.model_wrappers.FairnessLightningWrapper method)

U

unflatten() (detoxai.methods.savani.lay_wis_opt.SavaniLWO method)

update() (detoxai.metrics.fairness_metrics.BinaryGroupStatRatesUnwrapped method)

V

visualize_agg() (detoxai.visualization.DataVisualizer.DataVisualizer method) (detoxai.visualization.HeatmapVisualizer.HeatmapVisualizer method) (detoxai.visualization.ImageVisualizer.ImageVisualizer method) (detoxai.visualization.SSVisualizer.SSVisualizer method)

visualize_batch() (detoxai.visualization.DataVisualizer.DataVisualizer method) (detoxai.visualization.HeatmapVisualizer.HeatmapVisualizer method) (detoxai.visualization.ImageVisualizer.ImageVisualizer method) (detoxai.visualization.SSVisualizer.SSVisualizer method) Visualizer (class in detoxai.visualization.Visualizer)

W

WrappedDataLoader (class in detoxai.utils.dataloader)

X

XAIMetricsCalculator (class in detoxai.core.xai)

Z

ZhangM (class in detoxai.methods.savani.zhang)