Skip to main content

Module interpretability_tools

Module interpretability_tools 

Source
Expand description

§Interpretability Tools

Comprehensive model interpretability toolkit including SHAP integration, LIME support, attention analysis, feature attribution, and counterfactual generation for TrustformeRS models.

§Refactoring Summary

Previously this was a single 2,803-line file containing all interpretability functionality. It has been split into focused modules:

  • interpretability/config.rs - Configuration structures and enums (77 lines)
  • interpretability/shap.rs - SHAP analysis types and functionality (66 lines)
  • interpretability/lime.rs - LIME analysis types and functionality (78 lines)
  • interpretability/attention.rs - Attention analysis for transformers (426 lines)
  • interpretability/attribution.rs - Feature attribution methods (103 lines)
  • interpretability/counterfactual.rs - Counterfactual generation (191 lines)
  • interpretability/analyzer.rs - Main analyzer implementation (318 lines)
  • interpretability/report.rs - Reporting functionality (23 lines)

This refactoring improves:

  • Code maintainability and readability
  • Module compilation times
  • Test isolation
  • Code reuse through focused modules
  • Developer experience when working on specific interpretability methods

Structs§

ActionableInsight
Actionable insight from counterfactual analysis
AttentionAnalysisResult
Attention analysis result for transformer models
AttentionBottleneck
Attention bottleneck
AttentionFlowAnalysis
Attention flow analysis
AttentionFlowPath
Attention flow path
AttentionHeadResult
Attention analysis for a single head
AttentionInsight
Attention insight
AttentionLayerResult
Attention analysis for a single layer
AttentionPatterns
Overall attention patterns
AttentionStatistics
Attention statistics
AttributionMethodResult
Attribution result for a specific method
AttributionVisualizationData
Data for visualizing attributions
BlockPattern
Block attention pattern (sequence segments)
BoundaryCrossingPoint
Point where instance crosses decision boundary
Counterfactual
Individual counterfactual example
CounterfactualQualityMetrics
Quality metrics for counterfactuals
CounterfactualResult
Counterfactual generation result
DecisionBoundaryAnalysis
Decision boundary analysis
DiagonalPattern
Diagonal attention pattern (local dependencies)
FeatureAttribution
Individual feature attribution
FeatureAttributionResult
Feature attribution analysis result
FeatureChange
Change made to a feature in counterfactual
FeatureContribution
Individual feature contribution
FeatureImportance
Feature importance from LIME
FeatureInteraction
Feature interaction information
FeatureSensitivityAnalysis
Feature sensitivity analysis from counterfactuals
FlowEfficiencyMetrics
Flow efficiency metrics
HeadCluster
Cluster of similar attention heads
HeadRedundancyAnalysis
Head redundancy analysis
HeadSpecializationAnalysis
Head specialization analysis
InteractionEffect
Effect of feature interactions on sensitivity
InterpretabilityAnalyzer
Main interpretability analyzer
InterpretabilityConfig
Configuration for interpretability tools
InterpretabilityReport
Comprehensive interpretability report
LayerAttentionPatterns
Layer-level attention patterns
LayerAttentionStats
Layer attention statistics
LayerFlowStats
Layer flow statistics
LayerFlowStep
Flow step through a layer
LimeAnalysisResult
LIME (Local Interpretable Model-agnostic Explanations) analysis result
MethodAgreementAnalysis
Analysis of agreement between attribution methods
NeighborhoodStats
Local neighborhood statistics
PerturbationAnalysis
Perturbation analysis details
PerturbationResult
Individual perturbation result
PruningImpact
Expected impact of pruning a head
PruningRecommendation
Recommendation for head pruning
RedundantHeadPair
Pair of redundant attention heads
RepetitivePattern
Repetitive attention pattern
ShapAnalysisResult
SHAP (SHapley Additive exPlanations) analysis result
ShapSummary
SHAP analysis summary
SparsityDistribution
Sparsity distribution across layers and heads
SpecializationEvolution
Evolution of specialization across layers
SpecializationTransition
Transition between specialization types
ThresholdAnalysis
Analysis of decision thresholds
TimelinePoint
Point in attribution timeline
TokenAttentionScore
Token attention information
TopFeature
Top attributed feature with additional information
VerticalPattern
Vertical attention pattern (specific token focus)

Enums§

AttributionMethod
Attribution methods for feature importance
BottleneckType
Type of attention bottleneck
ChangeDirection
Direction of feature change
FlowTransformation
Type of flow transformation
HeadSpecializationType
Types of attention head specialization
ImplementationDifficulty
Difficulty of implementing suggested changes
InsightType
Type of attention insight
InteractionEffectType
Type of interaction effect
InteractionType
Type of feature interaction
RedundancyType
Type of redundancy between heads
RiskLevel
Risk level for pruning
SpecializationTrend
Overall specialization trend
TimeHorizon
Time horizon for implementing changes