trustformers-debug 0.1.1

Advanced debugging tools for TrustformeRS models
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
//! Activation visualization tools for layer-wise debugging
//!
//! This module provides tools to inspect and visualize activations from different layers
//! of a neural network, including heatmaps, distributions, and statistical analysis.

use anyhow::Result;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::path::Path;

// Note: scirs2_core types available for advanced operations if needed in future

/// Activation visualizer for inspecting layer outputs
#[derive(Debug)]
pub struct ActivationVisualizer {
    /// Stored activations by layer name
    activations: HashMap<String, ActivationData>,
    /// Configuration for visualization
    config: ActivationConfig,
}

/// Configuration for activation visualization
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ActivationConfig {
    /// Number of histogram bins
    pub num_bins: usize,
    /// Whether to compute detailed statistics
    pub detailed_stats: bool,
    /// Threshold for outlier detection (in standard deviations)
    pub outlier_threshold: f64,
    /// Maximum number of activations to store (to prevent memory overflow)
    pub max_stored_activations: usize,
}

impl Default for ActivationConfig {
    fn default() -> Self {
        Self {
            num_bins: 50,
            detailed_stats: true,
            outlier_threshold: 3.0,
            max_stored_activations: 10000,
        }
    }
}

/// Stored activation data for a layer
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ActivationData {
    /// Layer name
    pub layer_name: String,
    /// Activation values (flattened)
    pub values: Vec<f32>,
    /// Original shape of the activation tensor
    pub shape: Vec<usize>,
    /// Statistics computed from the activations
    pub statistics: ActivationStatistics,
    /// Timestamp when captured
    pub timestamp: u64,
}

/// Statistical summary of activations
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ActivationStatistics {
    /// Mean activation value
    pub mean: f64,
    /// Standard deviation
    pub std_dev: f64,
    /// Minimum value
    pub min: f64,
    /// Maximum value
    pub max: f64,
    /// Median value
    pub median: f64,
    /// 25th percentile
    pub q25: f64,
    /// 75th percentile
    pub q75: f64,
    /// Number of zero activations
    pub num_zeros: usize,
    /// Number of negative activations
    pub num_negative: usize,
    /// Number of positive activations
    pub num_positive: usize,
    /// Outlier count (values beyond threshold std devs)
    pub num_outliers: usize,
    /// Sparsity ratio (fraction of zeros)
    pub sparsity: f64,
}

/// Histogram data for activation distribution
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ActivationHistogram {
    /// Bin edges
    pub bin_edges: Vec<f64>,
    /// Bin counts
    pub bin_counts: Vec<usize>,
    /// Total count
    pub total_count: usize,
}

/// Heatmap data for 2D activation visualization
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ActivationHeatmap {
    /// Layer name
    pub layer_name: String,
    /// 2D values for heatmap
    pub values: Vec<Vec<f64>>,
    /// Row labels (optional)
    pub row_labels: Option<Vec<String>>,
    /// Column labels (optional)
    pub col_labels: Option<Vec<String>>,
}

impl ActivationVisualizer {
    /// Create a new activation visualizer
    ///
    /// # Example
    ///
    /// ```
    /// use trustformers_debug::ActivationVisualizer;
    ///
    /// let visualizer = ActivationVisualizer::new();
    /// ```
    pub fn new() -> Self {
        Self {
            activations: HashMap::new(),
            config: ActivationConfig::default(),
        }
    }

    /// Create a new activation visualizer with custom configuration
    pub fn with_config(config: ActivationConfig) -> Self {
        Self {
            activations: HashMap::new(),
            config,
        }
    }

    /// Register activations from a layer
    ///
    /// # Arguments
    ///
    /// * `layer_name` - Name of the layer
    /// * `values` - Flattened activation values
    /// * `shape` - Original shape of the activation tensor
    ///
    /// # Example
    ///
    /// ```
    /// # use trustformers_debug::ActivationVisualizer;
    /// # let mut visualizer = ActivationVisualizer::new();
    /// let activations = vec![0.1, 0.5, 0.3, 0.8];
    /// visualizer.register("layer1", activations, vec![2, 2]).unwrap();
    /// ```
    pub fn register(
        &mut self,
        layer_name: &str,
        values: Vec<f32>,
        shape: Vec<usize>,
    ) -> Result<()> {
        // Limit stored activations to prevent memory overflow
        let values = if values.len() > self.config.max_stored_activations {
            values.into_iter().take(self.config.max_stored_activations).collect()
        } else {
            values
        };

        let statistics = self.compute_statistics(&values)?;

        let timestamp =
            std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH)?.as_secs();

        let activation_data = ActivationData {
            layer_name: layer_name.to_string(),
            values,
            shape,
            statistics,
            timestamp,
        };

        self.activations.insert(layer_name.to_string(), activation_data);
        Ok(())
    }

    /// Get activations for a specific layer
    pub fn get_activations(&self, layer_name: &str) -> Option<&ActivationData> {
        self.activations.get(layer_name)
    }

    /// Get all layer names with registered activations
    pub fn get_layer_names(&self) -> Vec<String> {
        self.activations.keys().cloned().collect()
    }

    /// Compute statistics for activation values
    fn compute_statistics(&self, values: &[f32]) -> Result<ActivationStatistics> {
        if values.is_empty() {
            return Ok(ActivationStatistics {
                mean: 0.0,
                std_dev: 0.0,
                min: 0.0,
                max: 0.0,
                median: 0.0,
                q25: 0.0,
                q75: 0.0,
                num_zeros: 0,
                num_negative: 0,
                num_positive: 0,
                num_outliers: 0,
                sparsity: 0.0,
            });
        }

        let mean: f64 = values.iter().map(|&x| x as f64).sum::<f64>() / values.len() as f64;

        let variance: f64 = values
            .iter()
            .map(|&x| {
                let diff = x as f64 - mean;
                diff * diff
            })
            .sum::<f64>()
            / values.len() as f64;

        let std_dev = variance.sqrt();

        let min = values.iter().fold(f32::INFINITY, |a, &b| a.min(b)) as f64;
        let max = values.iter().fold(f32::NEG_INFINITY, |a, &b| a.max(b)) as f64;

        // Count zeros, negatives, positives
        let num_zeros = values.iter().filter(|&&x| x.abs() < 1e-8).count();
        let num_negative = values.iter().filter(|&&x| x < 0.0).count();
        let num_positive = values.iter().filter(|&&x| x > 0.0).count();

        // Count outliers
        let num_outliers = values
            .iter()
            .filter(|&&x| (x as f64 - mean).abs() > self.config.outlier_threshold * std_dev)
            .count();

        // Compute percentiles
        let mut sorted_values: Vec<f32> = values.to_vec();
        sorted_values.sort_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal));

        let median = percentile(&sorted_values, 50.0);
        let q25 = percentile(&sorted_values, 25.0);
        let q75 = percentile(&sorted_values, 75.0);

        let sparsity = num_zeros as f64 / values.len() as f64;

        Ok(ActivationStatistics {
            mean,
            std_dev,
            min,
            max,
            median,
            q25,
            q75,
            num_zeros,
            num_negative,
            num_positive,
            num_outliers,
            sparsity,
        })
    }

    /// Create a histogram of activation values
    pub fn create_histogram(&self, layer_name: &str) -> Result<ActivationHistogram> {
        let activation = self
            .activations
            .get(layer_name)
            .ok_or_else(|| anyhow::anyhow!("Layer {} not found", layer_name))?;

        let min = activation.statistics.min;
        let max = activation.statistics.max;

        let bin_width = (max - min) / self.config.num_bins as f64;
        let mut bin_counts = vec![0; self.config.num_bins];

        for &value in &activation.values {
            let bin_idx = if bin_width > 0.0 {
                ((value as f64 - min) / bin_width).floor() as usize
            } else {
                0
            };
            let bin_idx = bin_idx.min(self.config.num_bins - 1);
            bin_counts[bin_idx] += 1;
        }

        let bin_edges: Vec<f64> =
            (0..=self.config.num_bins).map(|i| min + i as f64 * bin_width).collect();

        Ok(ActivationHistogram {
            bin_edges,
            bin_counts,
            total_count: activation.values.len(),
        })
    }

    /// Create a heatmap from 2D activations
    ///
    /// # Arguments
    ///
    /// * `layer_name` - Name of the layer
    /// * `reshape` - Optional reshape dimensions (e.g., [height, width])
    pub fn create_heatmap(
        &self,
        layer_name: &str,
        reshape: Option<(usize, usize)>,
    ) -> Result<ActivationHeatmap> {
        let activation = self
            .activations
            .get(layer_name)
            .ok_or_else(|| anyhow::anyhow!("Layer {} not found", layer_name))?;

        let (rows, cols) = if let Some((r, c)) = reshape {
            (r, c)
        } else {
            // Try to infer 2D shape
            if activation.shape.len() >= 2 {
                let rows = activation.shape[activation.shape.len() - 2];
                let cols = activation.shape[activation.shape.len() - 1];
                (rows, cols)
            } else {
                // Fallback: make it as square as possible
                let total = activation.values.len();
                let cols = (total as f64).sqrt().ceil() as usize;
                let rows = total.div_ceil(cols);
                (rows, cols)
            }
        };

        let mut values = vec![vec![0.0; cols]; rows];
        for (i, &val) in activation.values.iter().enumerate().take(rows * cols) {
            let row = i / cols;
            let col = i % cols;
            if row < rows {
                values[row][col] = val as f64;
            }
        }

        Ok(ActivationHeatmap {
            layer_name: layer_name.to_string(),
            values,
            row_labels: None,
            col_labels: None,
        })
    }

    /// Export activation statistics to JSON
    pub fn export_statistics(&self, layer_name: &str, output_path: &Path) -> Result<()> {
        let activation = self
            .activations
            .get(layer_name)
            .ok_or_else(|| anyhow::anyhow!("Layer {} not found", layer_name))?;

        let json = serde_json::to_string_pretty(&activation.statistics)?;
        std::fs::write(output_path, json)?;

        Ok(())
    }

    /// Plot distribution as ASCII histogram
    pub fn plot_distribution_ascii(&self, layer_name: &str) -> Result<String> {
        let histogram = self.create_histogram(layer_name)?;

        let max_count = histogram.bin_counts.iter().max().unwrap_or(&0);
        let scale = if *max_count > 0 { 50.0 / *max_count as f64 } else { 1.0 };

        let mut output = String::new();
        output.push_str(&format!("Activation Distribution: {}\n", layer_name));
        output.push_str(&"=".repeat(60));
        output.push('\n');

        for i in 0..histogram.bin_counts.len() {
            let bar_length = (histogram.bin_counts[i] as f64 * scale) as usize;
            let bar = "â–ˆ".repeat(bar_length);
            output.push_str(&format!(
                "{:8.3} - {:8.3} | {} ({})\n",
                histogram.bin_edges[i],
                histogram.bin_edges[i + 1],
                bar,
                histogram.bin_counts[i]
            ));
        }

        Ok(output)
    }

    /// Print summary statistics for all layers
    pub fn print_summary(&self) -> Result<String> {
        let mut output = String::new();
        output.push_str("Activation Summary\n");
        output.push_str(&"=".repeat(80));
        output.push('\n');

        for (layer_name, activation) in &self.activations {
            output.push_str(&format!("\nLayer: {}\n", layer_name));
            output.push_str(&format!("  Shape: {:?}\n", activation.shape));
            output.push_str(&format!("  Mean: {:.6}\n", activation.statistics.mean));
            output.push_str(&format!(
                "  Std Dev: {:.6}\n",
                activation.statistics.std_dev
            ));
            output.push_str(&format!("  Min: {:.6}\n", activation.statistics.min));
            output.push_str(&format!("  Max: {:.6}\n", activation.statistics.max));
            output.push_str(&format!("  Median: {:.6}\n", activation.statistics.median));
            output.push_str(&format!(
                "  Sparsity: {:.2}%\n",
                activation.statistics.sparsity * 100.0
            ));
            output.push_str(&format!(
                "  Outliers: {} ({:.2}%)\n",
                activation.statistics.num_outliers,
                activation.statistics.num_outliers as f64 / activation.values.len() as f64 * 100.0
            ));
        }

        Ok(output)
    }

    /// Clear all stored activations
    pub fn clear(&mut self) {
        self.activations.clear();
    }

    /// Get number of stored activations
    pub fn num_layers(&self) -> usize {
        self.activations.len()
    }
}

impl Default for ActivationVisualizer {
    fn default() -> Self {
        Self::new()
    }
}

/// Helper function to compute percentile
fn percentile(sorted_values: &[f32], p: f64) -> f64 {
    if sorted_values.is_empty() {
        return 0.0;
    }

    let index = (p / 100.0 * (sorted_values.len() - 1) as f64).round() as usize;
    sorted_values[index.min(sorted_values.len() - 1)] as f64
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::env;

    #[test]
    fn test_activation_visualizer_creation() {
        let visualizer = ActivationVisualizer::new();
        assert_eq!(visualizer.num_layers(), 0);
    }

    #[test]
    fn test_register_activations() {
        let mut visualizer = ActivationVisualizer::new();
        let values = vec![0.1, 0.5, 0.3, 0.8, -0.2];

        visualizer
            .register("layer1", values.clone(), vec![5])
            .expect("operation failed in test");
        assert_eq!(visualizer.num_layers(), 1);

        let activation = visualizer.get_activations("layer1").expect("operation failed in test");
        assert_eq!(activation.values, values);
        assert_eq!(activation.shape, vec![5]);
    }

    #[test]
    fn test_compute_statistics() {
        let visualizer = ActivationVisualizer::new();
        let values = vec![1.0, 2.0, 3.0, 4.0, 5.0];

        let stats = visualizer.compute_statistics(&values).expect("operation failed in test");
        assert_eq!(stats.mean, 3.0);
        assert!(stats.std_dev > 0.0);
        assert_eq!(stats.min, 1.0);
        assert_eq!(stats.max, 5.0);
        assert_eq!(stats.num_zeros, 0);
        assert_eq!(stats.num_positive, 5);
    }

    #[test]
    fn test_create_histogram() {
        let mut visualizer = ActivationVisualizer::new();
        let values: Vec<f32> = (0..100).map(|x| x as f32).collect();

        visualizer
            .register("layer1", values, vec![100])
            .expect("operation failed in test");

        let histogram = visualizer.create_histogram("layer1").expect("operation failed in test");
        assert_eq!(histogram.bin_edges.len(), visualizer.config.num_bins + 1);
        assert_eq!(histogram.total_count, 100);
    }

    #[test]
    fn test_create_heatmap() {
        let mut visualizer = ActivationVisualizer::new();
        let values: Vec<f32> = (0..16).map(|x| x as f32).collect();

        visualizer
            .register("layer1", values, vec![4, 4])
            .expect("operation failed in test");

        let heatmap = visualizer
            .create_heatmap("layer1", Some((4, 4)))
            .expect("operation failed in test");
        assert_eq!(heatmap.values.len(), 4);
        assert_eq!(heatmap.values[0].len(), 4);
    }

    #[test]
    fn test_export_statistics() {
        let temp_dir = env::temp_dir();
        let output_path = temp_dir.join("activation_stats.json");

        let mut visualizer = ActivationVisualizer::new();
        let values = vec![1.0, 2.0, 3.0];

        visualizer
            .register("layer1", values, vec![3])
            .expect("operation failed in test");
        visualizer
            .export_statistics("layer1", &output_path)
            .expect("operation failed in test");

        assert!(output_path.exists());

        // Clean up
        let _ = std::fs::remove_file(output_path);
    }

    #[test]
    fn test_plot_distribution_ascii() {
        let mut visualizer = ActivationVisualizer::new();
        let values: Vec<f32> = (0..100).map(|x| x as f32 / 100.0).collect();

        visualizer
            .register("layer1", values, vec![100])
            .expect("operation failed in test");

        let ascii_plot =
            visualizer.plot_distribution_ascii("layer1").expect("operation failed in test");
        assert!(ascii_plot.contains("Activation Distribution"));
        assert!(ascii_plot.contains("layer1"));
    }

    #[test]
    fn test_print_summary() {
        let mut visualizer = ActivationVisualizer::new();

        visualizer
            .register("layer1", vec![1.0, 2.0, 3.0], vec![3])
            .expect("operation failed in test");
        visualizer
            .register("layer2", vec![4.0, 5.0, 6.0], vec![3])
            .expect("operation failed in test");

        let summary = visualizer.print_summary().expect("operation failed in test");
        assert!(summary.contains("layer1"));
        assert!(summary.contains("layer2"));
        assert!(summary.contains("Mean"));
        assert!(summary.contains("Std Dev"));
    }

    #[test]
    fn test_sparsity_calculation() {
        let visualizer = ActivationVisualizer::new();
        let values = vec![0.0, 0.0, 0.0, 1.0, 0.0];

        let stats = visualizer.compute_statistics(&values).expect("operation failed in test");
        assert_eq!(stats.num_zeros, 4);
        assert_eq!(stats.sparsity, 0.8);
    }

    #[test]
    fn test_clear_activations() {
        let mut visualizer = ActivationVisualizer::new();

        visualizer
            .register("layer1", vec![1.0], vec![1])
            .expect("operation failed in test");
        visualizer
            .register("layer2", vec![2.0], vec![1])
            .expect("operation failed in test");

        assert_eq!(visualizer.num_layers(), 2);

        visualizer.clear();
        assert_eq!(visualizer.num_layers(), 0);
    }
}