API Reference

Complete API documentation for shap-monitor.

Modules

• Monitor - SHAPMonitor class for logging explanations
• Analysis - SHAPAnalyzer class for analyzing logged data
• Backends - Storage backend implementations
• Types - Type definitions and protocols

Quick Links

Main Classes

• SHAPMonitor - Monitor SHAP explanations over time
• SHAPAnalyzer - Analyze logged SHAP data
• ParquetBackend - Parquet storage backend

Key Methods

SHAPMonitor:

• log_batch() - Log explanations for a batch
• compute() - Compute SHAP values

SHAPAnalyzer:

• summary() - Summary statistics
• compare_time_periods() - Compare periods

ParquetBackend:

• read() - Read data from date range
• write() - Write batch to storage
• delete() - Delete old data