FairXAI

Contents

  • Guide to integrating an explanation method in FAIRXAI
    • 1. Architecture Overview
    • 2. Implementing the Adapter
      • Step A: Inheritance and Metadata
        • explainer_name
        • supported_datasets
        • supported_models
      • Step B: Required Methods
      • Code Example
    • 3. Handling Results (Explanation)
      • Available subclasses
    • 4. Registration and Verification
    • 5. Usage via Configuration
    • Developer Checklist
  • FAIRXAI API Reference
    • fairxai package
      • Subpackages
        • fairxai.app package
        • fairxai.bbox package
        • fairxai.data package
        • fairxai.explain package
        • fairxai.project package
      • Submodules
      • fairxai.logger module
      • fairxai.main module
        • main()
      • Module contents
    • fairxai.app package
      • Submodules
      • fairxai.app.app module
        • app_main()
      • Module contents
    • fairxai.app.explainability package
      • Submodules
      • fairxai.app.explainability.create_project_tab module
        • create_project_page()
      • fairxai.app.explainability.explainability_page module
        • show()
      • fairxai.app.explainability.project_tab module
        • projects_page()
      • fairxai.app.explainability.run_pipeline_tab module
        • run_pipeline_page()
      • fairxai.app.explainability.view_results_tab module
        • results_page()
      • fairxai.app.explainability.visualization module
        • visualize_explanation()
      • Module contents
    • fairxai.bbox package
      • Submodules
      • fairxai.bbox.bbox module
        • AbstractBBox
      • fairxai.bbox.bbox_factory module
        • ModelFactory
      • Module contents
        • AbstractBBox
    • fairxai.data package
      • Subpackages
        • fairxai.data.dataset package
        • fairxai.data.descriptor package
      • Module contents
    • fairxai.data.dataset package
      • Submodules
      • fairxai.data.dataset.dataset module
        • Dataset
      • fairxai.data.dataset.dataset_factory module
        • DatasetFactory
      • fairxai.data.dataset.image_dataset module
        • ImageDataset
      • fairxai.data.dataset.tabular_dataset module
        • TabularDataset
      • fairxai.data.dataset.text_dataset module
        • TextDataset
      • fairxai.data.dataset.timeserie_dataset module
        • TimeSeriesDataset
      • Module contents
        • Dataset
        • TabularDataset
    • fairxai.data.descriptor package
      • Submodules
      • fairxai.data.descriptor.base_descriptor module
        • BaseDatasetDescriptor
      • fairxai.data.descriptor.image_descriptor module
        • ImageDatasetDescriptor
      • fairxai.data.descriptor.tabular_descriptor module
        • TabularDatasetDescriptor
      • fairxai.data.descriptor.text_descriptor module
        • TextDatasetDescriptor
      • fairxai.data.descriptor.timeserie_descriptor module
        • TimeSeriesDatasetDescriptor
      • Module contents
    • fairxai.explain package
      • Subpackages
        • fairxai.explain.adapter package
        • fairxai.explain.explaination package
        • fairxai.explain.explainer_manager package
      • Module contents
    • fairxai.explain.adapter package
      • Submodules
      • fairxai.explain.adapter.generic_explainer_adapter module
        • GenericExplainerAdapter
      • Module contents
    • fairxai.explain.explaination package
      • Submodules
      • fairxai.explain.explaination.counter_example_explanation module
        • CounterExampleExplanation
      • fairxai.explain.explaination.counterfactual_rule_explanation module
        • CounterfactualRuleExplanation
      • fairxai.explain.explaination.example_explanation module
        • ExampleExplanation
      • fairxai.explain.explaination.feature_importance_explanation module
        • FeatureImportanceExplanation
      • fairxai.explain.explaination.generic_explanation module
        • GenericExplanation
      • fairxai.explain.explaination.rule_based_explanation module
        • RuleBasedExplanation
      • Module contents
    • fairxai.explain.explainer_manager package
      • Submodules
      • fairxai.explain.explainer_manager.basic_io_handler module
        • BaseIoHandler
      • fairxai.explain.explainer_manager.explainer_manager module
        • ExplainerManager
        • import_all_adapters()
      • fairxai.explain.explainer_manager.guided_explanation_wizard module
        • GuidedExplanationWizard
      • Module contents
    • fairxai.project package
      • Submodules
      • fairxai.project.project module
        • Project
      • fairxai.project.project_registry module
        • ProjectRegistry
      • Module contents
  • fairxai
    • fairxai package
      • Subpackages
        • fairxai.app package
        • fairxai.bbox package
        • fairxai.data package
        • fairxai.explain package
        • fairxai.project package
      • Submodules
      • fairxai.logger module
      • fairxai.main module
        • main()
      • Module contents
FairXAI
  • fairxai
  • View page source

fairxai

  • fairxai package
    • Subpackages
      • fairxai.app package
        • Submodules
        • fairxai.app.app module
        • Module contents
      • fairxai.bbox package
        • Submodules
        • fairxai.bbox.bbox module
        • fairxai.bbox.bbox_factory module
        • Module contents
      • fairxai.data package
        • Subpackages
        • Module contents
      • fairxai.explain package
        • Subpackages
        • Module contents
      • fairxai.project package
        • Submodules
        • fairxai.project.project module
        • fairxai.project.project_registry module
        • Module contents
    • Submodules
    • fairxai.logger module
    • fairxai.main module
      • main()
    • Module contents
Previous

© Copyright 2025, Kode.

Built with Sphinx using a theme provided by Read the Docs.