trustformers_debug/gradient_debugger/
mod.rs

1//! Gradient Debugging and Analysis Tools
2//!
3//! This module provides comprehensive gradient debugging capabilities including
4//! real-time monitoring, anomaly detection, performance tracking, conflict analysis,
5//! visualization, and enhanced analysis for gradient flow in neural networks.
6//!
7//! ## Architecture
8//!
9//! The gradient debugging system is organized into several focused modules:
10//! - [`types`] - Core types, enums, and configuration for gradient debugging
11//! - [`monitoring`] - Real-time gradient monitoring and adaptive thresholds
12//! - [`anomaly_detection`] - Advanced gradient anomaly detection system
13//! - [`performance_tracking`] - Performance tracking and bottleneck analysis
14//! - [`conflict_analysis`] - Gradient conflict analysis between layers
15//! - [`visualization`] - Gradient flow visualization data generation
16//! - [`enhanced_analysis`] - Enhanced layer analysis and network-level insights
17//! - [`debugger`] - Main GradientDebugger orchestrating all components
18
19pub mod anomaly_detection;
20pub mod conflict_analysis;
21pub mod debugger;
22pub mod enhanced_analysis;
23pub mod monitoring;
24pub mod performance_tracking;
25pub mod types;
26pub mod visualization;
27
28// Re-export core types for backward compatibility
29pub use debugger::GradientDebugger;
30pub use types::*;
31
32// Re-export component types for easy access
33pub use monitoring::{
34    AdaptiveThresholds, MonitoringConfig, MonitoringResults, RealTimeGradientMonitor,
35};
36
37pub use anomaly_detection::{
38    AnomalyContext, AnomalySummary, AnomalyTrend, AnomalyType, BaselineGradientStats,
39    GradientAnomaly, GradientAnomalyDetector,
40};
41
42pub use performance_tracking::{
43    GradientPerformanceTracker, LayerPerformanceMetrics, OptimizationIssue,
44    OptimizationRecommendation, OptimizationSeverity, PerformanceSnapshot, PerformanceTimer,
45    PerformanceTrends, ResourceUtilization,
46};
47
48pub use conflict_analysis::{
49    ConflictLevel, ConflictMitigationStrategy, ConflictReport, ConflictType, GradientConflict,
50    GradientConflictAnalysis, MitigationComplexity,
51};
52
53pub use visualization::{
54    CriticalGradientPath, ExplodingRegion, FlowEdge, FlowNode, GradientDeadZone,
55    GradientFlowNetwork, GradientFlowVisualization, GradientLayerFlow, GradientVisualizationConfig,
56    TemporalGradientFlow, VanishingRegion,
57};
58
59pub use enhanced_analysis::{
60    EnhancedLayerGradientAnalysis, GradientHierarchy, LayerGradientDetails,
61    LayerOptimizationSuggestion, NetworkLevelAnalysis, OptimizationPriority,
62};
63
64pub use debugger::{
65    ComprehensiveGradientReport, GradientDebugStatus, GradientRecommendation, LayerGradientStatus,
66    PerformanceInsights, RecommendationType,
67};
68pub use trustformers_core::RecommendationPriority;
69
70// Backward compatibility alias
71pub type GradientDebugReport = ComprehensiveGradientReport;