DetoxAI

Modules

• detoxai.cavs
  • Submodules
  • detoxai.cavs.cav submodule
    • compute_cav()
  • detoxai.cavs.extract_activations submodule
    • get_all_layers()
    • get_layer_by_name()
    • load_activations()
    • extract_activations()
  • detoxai.cavs.mass_mean_probe submodule
    • compute_mass_mean_probe()
  • Module contents
• detoxai.core
  • Submodules
  • detoxai.core.evaluation submodule
    • evaluate_model()
  • detoxai.core.interface submodule
    • parse_methods_config()
    • debias()
    • run_correction()
    • get_supported_methods()
  • detoxai.core.interface_helpers submodule
    • load_supported_tags()
    • construct_metrics_config()
    • resolve_layer()
    • infer_layers()
  • detoxai.core.mcda_helpers submodule
    • is_pareto_efficient()
    • filter_pareto_front()
    • select_best_method()
  • detoxai.core.model_wrappers submodule
    • BaseLightningWrapper
      • BaseLightningWrapper.training_step()
      • BaseLightningWrapper.on_train_batch_end()
      • BaseLightningWrapper.on_train_epoch_end()
      • BaseLightningWrapper.test_step()
      • BaseLightningWrapper.on_test_batch_end()
      • BaseLightningWrapper.on_test_epoch_end()
      • BaseLightningWrapper.configure_optimizers()
      • BaseLightningWrapper.forward()
      • BaseLightningWrapper.predict_step()
    • FairnessLightningWrapper
      • FairnessLightningWrapper.training_step()
      • FairnessLightningWrapper.on_train_batch_end()
      • FairnessLightningWrapper.on_train_epoch_end()
      • FairnessLightningWrapper.test_step()
      • FairnessLightningWrapper.on_test_batch_end()
      • FairnessLightningWrapper.on_test_epoch_end()
      • FairnessLightningWrapper.predict_step()
  • detoxai.core.results_class submodule
    • CorrectionResult
      • CorrectionResult.get_all_metrics()
      • CorrectionResult.get_metric()
      • CorrectionResult.get_model()
      • CorrectionResult.get_method()
  • detoxai.core.xai submodule
    • XAIMetricsCalculator
      • XAIMetricsCalculator.calculate_metrics()
    • SailRectMetric
      • SailRectMetric.calculate_batch()
      • SailRectMetric.reduce()
      • SailRectMetric.aggregate()
      • SailRectMetric.structure_output()
    • RRF
    • HRF
    • MRR
    • DET
      • DET.reduce()
    • ADR
    • DIF
    • RDDT
      • RDDT.reduce()
  • Module contents
• detoxai.datasets
  • Subpackages
    • detoxai.datasets.catalog
      • Submodules
      • detoxai.datasets.catalog.download submodule
        • gdown_download()
        • curl_download()
        • download_stuff()
        • run_handler()
        • download_datasets()
      • detoxai.datasets.catalog.torchvision_utils submodule
        • create_structure2()
        • create_structure()
      • Module contents
  • Module contents
• detoxai.methods
  • Subpackages
    • detoxai.methods.clarcs
      • Submodules
      • detoxai.methods.clarcs.aclarc submodule
        • ACLARC
      • detoxai.methods.clarcs.clarc submodule
        • require_activations_and_cav()
        • CLARC
      • detoxai.methods.clarcs.hooks submodule
        • stabilize()
        • mass_mean_probe_hook()
        • add_mass_mean_probe_hook()
        • clarc_hook()
        • add_clarc_hook()
      • detoxai.methods.clarcs.pclarc submodule
        • PCLARC
      • detoxai.methods.clarcs.rrclarc submodule
        • RRMaskingPattern
        • RRLossType
        • RRCLARC
      • Module contents
    • detoxai.methods.leace
      • Submodules
      • detoxai.methods.leace.leace submodule
        • LEACE
      • Module contents
    • detoxai.methods.other
      • Submodules
      • detoxai.methods.other.fine_tune submodule
        • FineTune
      • Module contents
    • detoxai.methods.posthoc
      • Submodules
      • detoxai.methods.posthoc.naive_threshold submodule
        • NaiveThresholdOptimizer
      • detoxai.methods.posthoc.posthoc_base submodule
        • PosthocBase
      • detoxai.methods.posthoc.reject_option_classification submodule
        • ROCModelWrapper
        • RejectOptionClassification
      • Module contents
    • detoxai.methods.savani
      • Submodules
      • detoxai.methods.savani.adversarial submodule
        • SavaniAFT
      • detoxai.methods.savani.lay_wis_opt submodule
        • SavaniLWO
      • detoxai.methods.savani.random_perturbation submodule
        • SavaniRP
      • detoxai.methods.savani.savani_base submodule
        • SavaniBase
      • detoxai.methods.savani.utils submodule
        • phi_torch()
      • detoxai.methods.savani.zhang submodule
        • ZhangM
      • Module contents
  • Submodules
  • detoxai.methods.model_correction submodule
    • ModelCorrectionMethod
      • ModelCorrectionMethod.apply_model_correction()
      • ModelCorrectionMethod.get_model()
      • ModelCorrectionMethod.get_lightning_model()
      • ModelCorrectionMethod.remove_hooks()
  • detoxai.methods.utils submodule
  • Module contents
• detoxai.metrics
  • Submodules
  • detoxai.metrics.bias_metrics submodule
    • BiasMetrics
      • BiasMetrics.TPR_GAP
      • BiasMetrics.FPR_GAP
      • BiasMetrics.TNR_GAP
      • BiasMetrics.FNR_GAP
      • BiasMetrics.EO_GAP
      • BiasMetrics.DP_GAP
    • stabilize()
    • calculate_bias_metric_torch()
  • detoxai.metrics.distance_metrics submodule
    • cosine_similarities_batch()
    • euclidean_dist()
    • cosine_dist()
    • largest_vals()
  • detoxai.metrics.fairness_metrics submodule
    • stabilize()
    • results_to_tidy_df()
    • PerformanceMetrics
      • PerformanceMetrics.infer_metrics()
    • AllMetrics
      • AllMetrics.get_performance_metrics()
      • AllMetrics.get_fairness_metrics()
    • BinaryGroupStatRatesUnwrapped
      • BinaryGroupStatRatesUnwrapped.update()
      • BinaryGroupStatRatesUnwrapped.compute()
    • FairnessMetrics
      • FairnessMetrics.compute()
      • FairnessMetrics.calculate_equalized_odds()
      • FairnessMetrics.calculate_demographic_parity()
      • FairnessMetrics.calculate_equality_of_opportunity()
      • FairnessMetrics.calculate_treatment_equality()
  • detoxai.metrics.metrics submodule
    • stabilize_torch()
    • balanced_accuracy_torch()
    • comprehensive_metrics_torch()
  • Module contents
• detoxai.utils
  • Submodules
  • detoxai.utils.dataloader submodule
    • DetoxaiDataLoader
      • DetoxaiDataLoader.get_class_names()
      • DetoxaiDataLoader.get_nth_batch()
      • DetoxaiDataLoader.get_nth_batch2()
      • DetoxaiDataLoader.get_num_classes()
    • WrappedDataLoader
      • WrappedDataLoader.get_num_classes()
      • WrappedDataLoader.get_class_names()
    • copy_data_loader()
  • detoxai.utils.datasets submodule
    • calculate_max_samples()
    • balance_dataset()
    • make_detoxai_datasets_variant()
    • get_detoxai_datasets()
    • DetoxaiDataset
      • DetoxaiDataset.download()
      • DetoxaiDataset.get_class_names()
      • DetoxaiDataset.get_num_classes()
      • DetoxaiDataset.get_collate_fn()
  • detoxai.utils.decorators submodule
    • ensure_metrics_config_not_empty()
  • detoxai.utils.experiment_logger submodule
    • ExperimentLogger
      • ExperimentLogger.log_metric()
      • ExperimentLogger.log_image()
      • ExperimentLogger.log_table()
  • detoxai.utils.transformations submodule
    • SquarePad
  • Module contents
• detoxai.visualization
  • Submodules
  • detoxai.visualization.DataVisualizer submodule
    • DataVisualizer
      • DataVisualizer.visualize_batch()
      • DataVisualizer.visualize_agg()
  • detoxai.visualization.HeatmapVisualizer submodule
    • HeatmapVisualizer
      • HeatmapVisualizer.visualize_batch()
      • HeatmapVisualizer.visualize_agg()
  • detoxai.visualization.ImageVisualizer submodule
    • ImageVisualizer
      • ImageVisualizer.visualize_batch()
      • ImageVisualizer.visualize_agg()
      • ImageVisualizer.init_rectangle_painter()
      • ImageVisualizer.maybe_paint_rectangle()
  • detoxai.visualization.LRPHandler submodule
    • LRPHandler
      • LRPHandler.calculate()
  • detoxai.visualization.MetricsVisualizer submodule
    • MetricsVisualizer
      • MetricsVisualizer.metrics_config
      • MetricsVisualizer.canonize_results()
    • results_to_tidy_df()
  • detoxai.visualization.SSVisualizer submodule
    • SSVisualizer
      • SSVisualizer.visualize_batch()
      • SSVisualizer.visualize_agg()
  • detoxai.visualization.ScatterVisualizer submodule
    • ScatterVisualizer
      • ScatterVisualizer.create_plot()
  • detoxai.visualization.TableVisualizer submodule
    • TableVisualizer
      • TableVisualizer.create_table()
      • TableVisualizer.get_table()
      • TableVisualizer.get_latex_table()
      • TableVisualizer.get_raw_results()
      • TableVisualizer.save_to_csv()
  • detoxai.visualization.Visualizer submodule
    • Visualizer
      • Visualizer.set_up_plots_configuration()
      • Visualizer.attach_logger()
      • Visualizer.show_plot()
      • Visualizer.show()
      • Visualizer.close_plot()
      • Visualizer.get_canvas()
      • Visualizer.local_save()
      • Visualizer.log()
      • Visualizer.log_image()
      • Visualizer.log_table()
  • detoxai.visualization.enums submodule
    • ConditionOn
      • ConditionOn.PROPER_LABEL
      • ConditionOn.IMPROPER_LABEL
  • Module contents

Module contents