Case-Explainer

API Reference

  • CaseExplainer
    • CaseExplainer
    • Core Methods
      • Building the Explainer
        • CaseExplainer.__init__()
      • Explaining Predictions
        • CaseExplainer.explain_instance()
        • CaseExplainer.explain_batch()
      • Similarity Strategies
        • Features
        • HiddenActivations
        • CustomActivations
        • TreeLeaf
        • ForestProximity
        • Blend
      • Deprecated Retrieval Configurations
        • HiddenActivationRetrieval
        • CustomActivationRetrieval
        • TreeLeafRetrieval
        • ForestProximityRetrieval
    • Example Usage
      • Basic Example
      • Batch Explanations
      • Working with Metadata
    • Configuration Options
      • Algorithm Selection
      • Feature Scaling
      • Class Weights
    • Notes
    • Activation-Based Similarity
      • Quick Start
      • Output weighting
      • Layer modes
      • Using an explicit extractor
      • Feature/activation hybrid
      • Model preprocessing
      • Decision-tree leaves
      • Random-forest proximity
      • Convenience aliases
    • See Also
  • Explanation Objects
    • Explanation
      • Explanation
      • Key Attributes
        • Explanation.correspondence
        • Explanation.correspondence_interpretation
        • Explanation.neighbors
        • Explanation.predicted_class
        • Explanation.true_class
      • Methods
        • Explanation.is_correct()
        • Explanation.summary()
        • Explanation.to_dict()
        • Explanation.plot()
    • Neighbor
      • Neighbor
      • Key Attributes
        • Neighbor.index
        • Neighbor.distance
        • Neighbor.label
        • Neighbor.features
        • Neighbor.metadata
    • Example Usage
      • Accessing Explanation Details
      • Inspecting Neighbors
      • Exporting Explanations
      • Generating Summaries
      • Visualizing Explanations
      • Batch Analysis
    • See Also
  • Metrics
    • Functions
      • compute_correspondence
        • compute_correspondence()
      • euclidean_distance
        • euclidean_distance()
    • Theory
      • Correspondence Metric
        • Mathematical Definition
        • Interpretation
      • Distance Weighting
    • Example Usage
      • Computing Correspondence
      • Distance Computation
      • Understanding Correspondence Behavior
      • Class Weights
    • Notes
    • See Also

Additional Information

  • Citation
    • BibTeX
    • Related Publications
    • Acknowledgments
  • Legacy Activation Migration
    • Renamed retrieval= parameter
  • License
    • MIT License
    • What This Means
Case-Explainer
  • Search

© Copyright 2025, Paul Whitten, Francis Wolff, Chris Papachristou.

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