sklears-neural 0.1.1

Neural network implementations for the sklears machine learning library
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
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
use scirs2_core::ndarray::{Array1, Array2, ScalarOperand};
use scirs2_core::numeric::{Float, ToPrimitive};
use std::fmt::Debug;

use crate::self_supervised::{DenseLayer, SimpleMLP};
use sklears_core::error::SklearsError;
use sklears_core::types::FloatBounds;

// Numerical gradient checking utilities for neural networks
//
// This module provides tools for validating analytical gradients by comparing them
// with numerically computed gradients using finite differences.

/// Gradient checking configuration
#[derive(Debug, Clone)]
pub struct GradientCheckConfig<T: Float> {
    /// Finite difference step size (epsilon)
    pub epsilon: T,
    /// Relative tolerance for gradient comparison
    pub relative_tolerance: T,
    /// Absolute tolerance for gradient comparison
    pub absolute_tolerance: T,
    /// Whether to use centered differences (more accurate but 2x slower)
    pub use_centered_differences: bool,
    /// Maximum number of parameters to check (for efficiency)
    pub max_params_to_check: Option<usize>,
    /// Random seed for parameter sampling
    pub random_seed: Option<u64>,
}

impl<T: Float> Default for GradientCheckConfig<T> {
    fn default() -> Self {
        Self {
            epsilon: T::from(1e-7).unwrap_or_else(|| T::zero()),
            relative_tolerance: T::from(1e-5).unwrap_or_else(|| T::zero()),
            absolute_tolerance: T::from(1e-8).unwrap_or_else(|| T::zero()),
            use_centered_differences: true,
            max_params_to_check: Some(100),
            random_seed: Some(42),
        }
    }
}

/// Results of gradient checking
#[derive(Debug, Clone)]
pub struct GradientCheckResults<T: Float> {
    /// Whether all gradients passed the check
    pub all_passed: bool,
    /// Number of parameters checked
    pub num_checked: usize,
    /// Number of parameters that passed
    pub num_passed: usize,
    /// Maximum relative error found
    pub max_relative_error: T,
    /// Maximum absolute error found
    pub max_absolute_error: T,
    /// Average relative error
    pub avg_relative_error: T,
    /// Average absolute error
    pub avg_absolute_error: T,
    /// Detailed results for each parameter
    pub parameter_results: Vec<ParameterGradientResult<T>>,
}

/// Results for a single parameter gradient check
#[derive(Debug, Clone)]
pub struct ParameterGradientResult<T: Float> {
    /// Parameter index/identifier
    pub param_index: usize,
    /// Analytical gradient value
    pub analytical_gradient: T,
    /// Numerical gradient value
    pub numerical_gradient: T,
    /// Relative error
    pub relative_error: T,
    /// Absolute error
    pub absolute_error: T,
    /// Whether this parameter passed the check
    pub passed: bool,
}

/// Loss function trait for gradient checking
pub trait LossFunction<T: FloatBounds + ScalarOperand> {
    /// Compute loss given predictions and targets
    fn compute_loss(&self, predictions: &Array2<T>, targets: &Array2<T>)
        -> Result<T, SklearsError>;

    /// Compute loss gradient with respect to predictions
    fn compute_gradient(
        &self,
        predictions: &Array2<T>,
        targets: &Array2<T>,
    ) -> Result<Array2<T>, SklearsError>;
}

/// Mean Squared Error loss function
#[derive(Debug, Clone)]
/// Mean squared error loss function for gradient checking
#[derive(Default)]
pub struct MeanSquaredError<T: FloatBounds + ScalarOperand> {
    _phantom: std::marker::PhantomData<T>,
}

impl<T: FloatBounds + ScalarOperand> MeanSquaredError<T> {
    /// Create a new MeanSquaredError loss function
    pub fn new() -> Self {
        Self {
            _phantom: std::marker::PhantomData,
        }
    }
}

impl<T: FloatBounds + ScalarOperand> LossFunction<T> for MeanSquaredError<T> {
    fn compute_loss(
        &self,
        predictions: &Array2<T>,
        targets: &Array2<T>,
    ) -> Result<T, SklearsError> {
        let diff = predictions - targets;
        let squared_diff = diff.mapv(|x| x * x);
        let mse = squared_diff.sum() / T::from(predictions.len()).unwrap_or_else(|| T::zero());
        Ok(mse)
    }

    fn compute_gradient(
        &self,
        predictions: &Array2<T>,
        targets: &Array2<T>,
    ) -> Result<Array2<T>, SklearsError> {
        let diff = predictions - targets;
        let factor = T::from(2.0).unwrap_or_else(|| T::zero())
            / T::from(predictions.len()).unwrap_or_else(|| T::zero());
        Ok(diff * factor)
    }
}

/// Cross-entropy loss function
#[derive(Debug, Clone)]
pub struct CrossEntropyLoss<T: FloatBounds + ScalarOperand> {
    _phantom: std::marker::PhantomData<T>,
}

impl<T: FloatBounds + ScalarOperand> Default for CrossEntropyLoss<T> {
    fn default() -> Self {
        Self::new()
    }
}

impl<T: FloatBounds + ScalarOperand> CrossEntropyLoss<T> {
    /// Create a new cross-entropy loss function
    pub fn new() -> Self {
        Self {
            _phantom: std::marker::PhantomData,
        }
    }
}

impl<T: FloatBounds + ScalarOperand> LossFunction<T> for CrossEntropyLoss<T> {
    fn compute_loss(
        &self,
        predictions: &Array2<T>,
        targets: &Array2<T>,
    ) -> Result<T, SklearsError> {
        let epsilon = T::from(1e-15).unwrap_or_else(|| T::zero());
        let clipped_preds = predictions.mapv(|x| x.max(epsilon).min(T::one() - epsilon));

        let log_preds = clipped_preds.mapv(|x| x.ln());
        let loss = -(targets * log_preds).sum()
            / T::from(predictions.nrows()).unwrap_or_else(|| T::zero());
        Ok(loss)
    }

    fn compute_gradient(
        &self,
        predictions: &Array2<T>,
        targets: &Array2<T>,
    ) -> Result<Array2<T>, SklearsError> {
        let epsilon = T::from(1e-15).unwrap_or_else(|| T::zero());
        let clipped_preds = predictions.mapv(|x| x.max(epsilon).min(T::one() - epsilon));

        let grad =
            -(targets / clipped_preds) / T::from(predictions.nrows()).unwrap_or_else(|| T::zero());
        Ok(grad)
    }
}

/// Gradient checker for neural networks
#[derive(Debug)]
pub struct GradientChecker<T: FloatBounds + ScalarOperand + ToPrimitive> {
    config: GradientCheckConfig<T>,
}

impl<T: FloatBounds + ScalarOperand + ToPrimitive> GradientChecker<T> {
    /// Create a new gradient checker
    pub fn new(config: GradientCheckConfig<T>) -> Self {
        Self { config }
    }

    /// Check gradients for a neural network
    pub fn check_network_gradients(
        &self,
        network: &mut SimpleMLP<T>,
        inputs: &Array2<T>,
        targets: &Array2<T>,
        loss_fn: &dyn LossFunction<T>,
    ) -> Result<GradientCheckResults<T>, SklearsError> {
        // Forward pass to get predictions
        let _predictions = network.forward(inputs)?;

        // Compute analytical gradients using backpropagation
        let analytical_grads =
            self.compute_analytical_gradients(network, inputs, targets, loss_fn)?;

        // Compute numerical gradients using finite differences
        let numerical_grads =
            self.compute_numerical_gradients(network, inputs, targets, loss_fn)?;

        // Compare gradients and generate results
        self.compare_gradients(&analytical_grads, &numerical_grads)
    }

    /// Check gradients for a single layer
    pub fn check_layer_gradients(
        &self,
        _layer: &mut DenseLayer<T>,
        _inputs: &Array2<T>,
        _output_gradients: &Array2<T>,
    ) -> Result<GradientCheckResults<T>, SklearsError> {
        // This is a simplified version for demonstration
        // In practice, you'd implement full gradient checking for each layer type

        let mut parameter_results = Vec::new();
        let mut num_passed = 0;
        let mut max_rel_error = T::zero();
        let mut max_abs_error = T::zero();
        let mut sum_rel_error = T::zero();
        let mut sum_abs_error = T::zero();

        // For demonstration, we'll just check a few parameters
        // In practice, you'd check all weights and biases
        let num_to_check = std::cmp::min(10, 100); // Simplified

        for i in 0..num_to_check {
            let analytical_grad = T::from(0.1).unwrap_or_else(|| T::zero()); // Placeholder
            let numerical_grad = T::from(0.101).unwrap_or_else(|| T::zero()); // Placeholder

            let abs_error = (analytical_grad - numerical_grad).abs();
            let rel_error = if numerical_grad.abs() > T::zero() {
                abs_error / numerical_grad.abs()
            } else {
                abs_error
            };

            let passed = rel_error < self.config.relative_tolerance
                && abs_error < self.config.absolute_tolerance;

            if passed {
                num_passed += 1;
            }

            max_rel_error = max_rel_error.max(rel_error);
            max_abs_error = max_abs_error.max(abs_error);
            sum_rel_error += rel_error;
            sum_abs_error += abs_error;

            parameter_results.push(ParameterGradientResult {
                param_index: i,
                analytical_gradient: analytical_grad,
                numerical_gradient: numerical_grad,
                relative_error: rel_error,
                absolute_error: abs_error,
                passed,
            });
        }

        let avg_rel_error = sum_rel_error / T::from(num_to_check).unwrap_or_else(|| T::zero());
        let avg_abs_error = sum_abs_error / T::from(num_to_check).unwrap_or_else(|| T::zero());

        Ok(GradientCheckResults {
            all_passed: num_passed == num_to_check,
            num_checked: num_to_check,
            num_passed,
            max_relative_error: max_rel_error,
            max_absolute_error: max_abs_error,
            avg_relative_error: avg_rel_error,
            avg_absolute_error: avg_abs_error,
            parameter_results,
        })
    }

    /// Compute analytical gradients using backpropagation
    fn compute_analytical_gradients(
        &self,
        network: &mut SimpleMLP<T>,
        inputs: &Array2<T>,
        targets: &Array2<T>,
        loss_fn: &dyn LossFunction<T>,
    ) -> Result<Vec<Array1<T>>, SklearsError> {
        // Forward pass
        let predictions = network.forward(inputs)?;

        // Compute loss gradient
        let _loss_grad = loss_fn.compute_gradient(&predictions, targets)?;

        // Backward pass through network
        // This is simplified - in practice you'd implement full backpropagation
        let mut gradients = Vec::new();

        // For demonstration, we'll create some dummy gradients
        // In practice, this would be the actual backpropagation implementation
        for i in 0..10 {
            let grad = Array1::from_vec(vec![
                T::from(i as f64 * 0.1).unwrap_or_else(|| T::zero());
                10
            ]);
            gradients.push(grad);
        }

        Ok(gradients)
    }

    /// Compute numerical gradients using finite differences
    fn compute_numerical_gradients(
        &self,
        network: &mut SimpleMLP<T>,
        inputs: &Array2<T>,
        targets: &Array2<T>,
        loss_fn: &dyn LossFunction<T>,
    ) -> Result<Vec<Array1<T>>, SklearsError> {
        let mut numerical_grads = Vec::new();

        // For each parameter in the network
        for param_group in 0..10 {
            // Simplified
            let mut param_grads = Vec::new();

            for param_idx in 0..10 {
                // Simplified
                let grad = if self.config.use_centered_differences {
                    self.compute_centered_difference(
                        network,
                        inputs,
                        targets,
                        loss_fn,
                        param_group,
                        param_idx,
                    )?
                } else {
                    self.compute_forward_difference(
                        network,
                        inputs,
                        targets,
                        loss_fn,
                        param_group,
                        param_idx,
                    )?
                };
                param_grads.push(grad);
            }

            numerical_grads.push(Array1::from_vec(param_grads));
        }

        Ok(numerical_grads)
    }

    /// Compute centered finite difference for a parameter
    fn compute_centered_difference(
        &self,
        network: &mut SimpleMLP<T>,
        inputs: &Array2<T>,
        targets: &Array2<T>,
        loss_fn: &dyn LossFunction<T>,
        param_group: usize,
        param_idx: usize,
    ) -> Result<T, SklearsError> {
        // Get current parameter value
        let original_param = T::from(0.5).unwrap_or_else(|| T::zero()); // Placeholder

        // Compute loss with parameter + epsilon
        // (This is simplified - in practice you'd modify the actual network parameters)
        let loss_plus = self.compute_loss_with_perturbed_param(
            network,
            inputs,
            targets,
            loss_fn,
            param_group,
            param_idx,
            original_param + self.config.epsilon,
        )?;

        // Compute loss with parameter - epsilon
        let loss_minus = self.compute_loss_with_perturbed_param(
            network,
            inputs,
            targets,
            loss_fn,
            param_group,
            param_idx,
            original_param - self.config.epsilon,
        )?;

        // Centered difference
        let grad = (loss_plus - loss_minus)
            / (T::from(2.0).unwrap_or_else(|| T::zero()) * self.config.epsilon);
        Ok(grad)
    }

    /// Compute forward finite difference for a parameter
    fn compute_forward_difference(
        &self,
        network: &mut SimpleMLP<T>,
        inputs: &Array2<T>,
        targets: &Array2<T>,
        loss_fn: &dyn LossFunction<T>,
        param_group: usize,
        param_idx: usize,
    ) -> Result<T, SklearsError> {
        // Get current parameter value
        let original_param = T::from(0.5).unwrap_or_else(|| T::zero()); // Placeholder

        // Compute original loss
        let original_loss = self.compute_loss_with_perturbed_param(
            network,
            inputs,
            targets,
            loss_fn,
            param_group,
            param_idx,
            original_param,
        )?;

        // Compute loss with parameter + epsilon
        let perturbed_loss = self.compute_loss_with_perturbed_param(
            network,
            inputs,
            targets,
            loss_fn,
            param_group,
            param_idx,
            original_param + self.config.epsilon,
        )?;

        // Forward difference
        let grad = (perturbed_loss - original_loss) / self.config.epsilon;
        Ok(grad)
    }

    /// Compute loss with a perturbed parameter (simplified)
    fn compute_loss_with_perturbed_param(
        &self,
        network: &mut SimpleMLP<T>,
        inputs: &Array2<T>,
        targets: &Array2<T>,
        loss_fn: &dyn LossFunction<T>,
        _param_group: usize,
        _param_idx: usize,
        _param_value: T,
    ) -> Result<T, SklearsError> {
        // This is simplified - in practice you'd:
        // 1. Save the original parameter value
        // 2. Set the parameter to the new value
        // 3. Run forward pass
        // 4. Compute loss
        // 5. Restore original parameter value

        let predictions = network.forward(inputs)?;
        loss_fn.compute_loss(&predictions, targets)
    }

    /// Compare analytical and numerical gradients
    fn compare_gradients(
        &self,
        analytical: &[Array1<T>],
        numerical: &[Array1<T>],
    ) -> Result<GradientCheckResults<T>, SklearsError> {
        let mut parameter_results = Vec::new();
        let mut num_passed = 0;
        let mut max_rel_error = T::zero();
        let mut max_abs_error = T::zero();
        let mut sum_rel_error = T::zero();
        let mut sum_abs_error = T::zero();
        let mut total_checked = 0;

        for (group_idx, (anal_group, num_group)) in
            analytical.iter().zip(numerical.iter()).enumerate()
        {
            for (param_idx, (&anal_grad, &num_grad)) in
                anal_group.iter().zip(num_group.iter()).enumerate()
            {
                let abs_error = (anal_grad - num_grad).abs();
                let rel_error = if num_grad.abs() > T::zero() {
                    abs_error / num_grad.abs()
                } else {
                    abs_error
                };

                let passed = rel_error < self.config.relative_tolerance
                    && abs_error < self.config.absolute_tolerance;

                if passed {
                    num_passed += 1;
                }

                max_rel_error = max_rel_error.max(rel_error);
                max_abs_error = max_abs_error.max(abs_error);
                sum_rel_error += rel_error;
                sum_abs_error += abs_error;
                total_checked += 1;

                parameter_results.push(ParameterGradientResult {
                    param_index: group_idx * 1000 + param_idx, // Simple encoding
                    analytical_gradient: anal_grad,
                    numerical_gradient: num_grad,
                    relative_error: rel_error,
                    absolute_error: abs_error,
                    passed,
                });

                // Limit number of parameters checked for efficiency
                if let Some(max_params) = self.config.max_params_to_check {
                    if total_checked >= max_params {
                        break;
                    }
                }
            }

            if let Some(max_params) = self.config.max_params_to_check {
                if total_checked >= max_params {
                    break;
                }
            }
        }

        let avg_rel_error = if total_checked > 0 {
            sum_rel_error / T::from(total_checked).unwrap_or_else(|| T::zero())
        } else {
            T::zero()
        };

        let avg_abs_error = if total_checked > 0 {
            sum_abs_error / T::from(total_checked).unwrap_or_else(|| T::zero())
        } else {
            T::zero()
        };

        Ok(GradientCheckResults {
            all_passed: num_passed == total_checked,
            num_checked: total_checked,
            num_passed,
            max_relative_error: max_rel_error,
            max_absolute_error: max_abs_error,
            avg_relative_error: avg_rel_error,
            avg_absolute_error: avg_abs_error,
            parameter_results,
        })
    }
}

/// Utility functions for gradient checking
impl<T: FloatBounds + ScalarOperand + ToPrimitive> GradientChecker<T> {
    /// Check if gradients are approximately equal
    pub fn gradients_are_equal(&self, analytical: T, numerical: T) -> bool {
        let abs_error = (analytical - numerical).abs();
        let rel_error = if numerical.abs() > T::zero() {
            abs_error / numerical.abs()
        } else {
            abs_error
        };

        rel_error < self.config.relative_tolerance && abs_error < self.config.absolute_tolerance
    }

    /// Compute relative error between two gradients
    pub fn compute_relative_error(&self, analytical: T, numerical: T) -> T {
        let abs_error = (analytical - numerical).abs();
        if numerical.abs() > T::zero() {
            abs_error / numerical.abs()
        } else {
            abs_error
        }
    }

    /// Generate a summary report of gradient checking results
    pub fn generate_report(&self, results: &GradientCheckResults<T>) -> String {
        let mut report = String::new();

        report.push_str("=== Gradient Checking Report ===\n");
        report.push_str(&format!(
            "Overall Status: {}\n",
            if results.all_passed {
                "PASSED"
            } else {
                "FAILED"
            }
        ));
        report.push_str(&format!("Parameters Checked: {}\n", results.num_checked));
        report.push_str(&format!("Parameters Passed: {}\n", results.num_passed));
        report.push_str(&format!(
            "Pass Rate: {:.2}%\n",
            (results.num_passed as f64 / results.num_checked as f64) * 100.0
        ));
        report.push_str(&format!(
            "Max Relative Error: {:.2e}\n",
            results.max_relative_error.to_f64().unwrap_or(0.0)
        ));
        report.push_str(&format!(
            "Max Absolute Error: {:.2e}\n",
            results.max_absolute_error.to_f64().unwrap_or(0.0)
        ));
        report.push_str(&format!(
            "Avg Relative Error: {:.2e}\n",
            results.avg_relative_error.to_f64().unwrap_or(0.0)
        ));
        report.push_str(&format!(
            "Avg Absolute Error: {:.2e}\n",
            results.avg_absolute_error.to_f64().unwrap_or(0.0)
        ));

        // Add details for failed parameters
        let failed_params: Vec<_> = results
            .parameter_results
            .iter()
            .filter(|r| !r.passed)
            .collect();

        if !failed_params.is_empty() {
            report.push_str("\nFailed Parameters:\n");
            for param in failed_params.iter().take(10) {
                // Show first 10 failures
                report.push_str(&format!(
                    "  Param {}: analytical={:.6e}, numerical={:.6e}, rel_err={:.2e}, abs_err={:.2e}\n",
                    param.param_index,
                    param.analytical_gradient.to_f64().unwrap_or(0.0),
                    param.numerical_gradient.to_f64().unwrap_or(0.0),
                    param.relative_error.to_f64().unwrap_or(0.0),
                    param.absolute_error.to_f64().unwrap_or(0.0)
                ));
            }

            if failed_params.len() > 10 {
                report.push_str(&format!(
                    "  ... and {} more failures\n",
                    failed_params.len() - 10
                ));
            }
        }

        report
    }
}

#[allow(non_snake_case)]
#[cfg(test)]
mod tests {
    use super::*;
    use crate::Activation;
    use approx::assert_abs_diff_eq;

    #[test]
    fn test_gradient_check_config_default() {
        let config = GradientCheckConfig::<f32>::default();
        assert!(config.epsilon > 0.0);
        assert!(config.use_centered_differences);
        assert_eq!(config.max_params_to_check, Some(100));
    }

    #[test]
    fn test_mse_loss_function() {
        let mse = MeanSquaredError::<f32>::new();

        let predictions =
            Array2::from_shape_vec((2, 2), vec![1.0, 2.0, 3.0, 4.0]).expect("array shape mismatch");
        let targets =
            Array2::from_shape_vec((2, 2), vec![1.1, 1.9, 3.1, 3.9]).expect("array shape mismatch");

        let loss = mse
            .compute_loss(&predictions, &targets)
            .expect("operation should succeed");
        assert!(loss > 0.0);

        let gradient = mse
            .compute_gradient(&predictions, &targets)
            .expect("operation should succeed");
        assert_eq!(gradient.dim(), predictions.dim());
    }

    #[test]
    fn test_cross_entropy_loss_function() {
        let ce = CrossEntropyLoss::<f32>::new();

        let predictions =
            Array2::from_shape_vec((2, 2), vec![0.8, 0.2, 0.3, 0.7]).expect("array shape mismatch");
        let targets =
            Array2::from_shape_vec((2, 2), vec![1.0, 0.0, 0.0, 1.0]).expect("array shape mismatch");

        let loss = ce
            .compute_loss(&predictions, &targets)
            .expect("operation should succeed");
        assert!(loss > 0.0);

        let gradient = ce
            .compute_gradient(&predictions, &targets)
            .expect("operation should succeed");
        assert_eq!(gradient.dim(), predictions.dim());
    }

    #[test]
    fn test_gradient_checker_creation() {
        let config = GradientCheckConfig::<f32>::default();
        let checker = GradientChecker::new(config);
        assert!(checker.config.epsilon > 0.0);
    }

    #[test]
    fn test_gradients_are_equal() {
        let config = GradientCheckConfig {
            epsilon: 1e-7,
            relative_tolerance: 1e-5,
            absolute_tolerance: 1e-6, // Increased tolerance for the test
            use_centered_differences: true,
            max_params_to_check: Some(100),
            random_seed: Some(42),
        };
        let checker = GradientChecker::new(config);

        // Test equal gradients
        assert!(checker.gradients_are_equal(1.0, 1.0));

        // Test nearly equal gradients (within tolerance)
        assert!(checker.gradients_are_equal(1.0, 1.000001));

        // Test different gradients
        assert!(!checker.gradients_are_equal(1.0, 1.1));
    }

    #[test]
    fn test_compute_relative_error() {
        let config = GradientCheckConfig::<f32>::default();
        let checker = GradientChecker::new(config);

        let rel_error = checker.compute_relative_error(1.0, 1.1);
        assert_abs_diff_eq!(rel_error, 0.090909, epsilon = 1e-5);

        // Test with zero numerical gradient
        let rel_error_zero = checker.compute_relative_error(0.1, 0.0);
        assert_abs_diff_eq!(rel_error_zero, 0.1, epsilon = 1e-6);
    }

    #[test]
    fn test_parameter_gradient_result() {
        let result = ParameterGradientResult {
            param_index: 0,
            analytical_gradient: 1.0,
            numerical_gradient: 1.01,
            relative_error: 0.0099,
            absolute_error: 0.01,
            passed: true,
        };

        assert_eq!(result.param_index, 0);
        assert!(result.passed);
        assert_eq!(result.analytical_gradient, 1.0);
    }

    #[test]
    fn test_gradient_check_results() {
        let param_results = vec![
            ParameterGradientResult {
                param_index: 0,
                analytical_gradient: 1.0,
                numerical_gradient: 1.01,
                relative_error: 0.0099,
                absolute_error: 0.01,
                passed: true,
            },
            ParameterGradientResult {
                param_index: 1,
                analytical_gradient: 2.0,
                numerical_gradient: 2.2,
                relative_error: 0.091,
                absolute_error: 0.2,
                passed: false,
            },
        ];

        let results = GradientCheckResults {
            all_passed: false,
            num_checked: 2,
            num_passed: 1,
            max_relative_error: 0.091,
            max_absolute_error: 0.2,
            avg_relative_error: 0.05045,
            avg_absolute_error: 0.105,
            parameter_results: param_results,
        };

        assert!(!results.all_passed);
        assert_eq!(results.num_checked, 2);
        assert_eq!(results.num_passed, 1);
    }

    #[test]
    fn test_generate_report() {
        let config = GradientCheckConfig::<f32>::default();
        let checker = GradientChecker::new(config);

        let results = GradientCheckResults {
            all_passed: true,
            num_checked: 10,
            num_passed: 10,
            max_relative_error: 1e-6,
            max_absolute_error: 1e-8,
            avg_relative_error: 1e-7,
            avg_absolute_error: 1e-9,
            parameter_results: Vec::new(),
        };

        let report = checker.generate_report(&results);
        assert!(report.contains("PASSED"));
        assert!(report.contains("Parameters Checked: 10"));
        assert!(report.contains("Pass Rate: 100.00%"));
    }

    #[test]
    fn test_layer_gradient_checking() {
        let config = GradientCheckConfig::<f32>::default();
        let checker = GradientChecker::new(config);

        let mut layer = DenseLayer::<f32>::new(5, 3, Some(Activation::Relu));
        let inputs = Array2::from_shape_vec((2, 5), vec![1.0; 10]).expect("array shape mismatch");
        let output_grads =
            Array2::from_shape_vec((2, 3), vec![0.1; 6]).expect("array shape mismatch");

        let results = checker
            .check_layer_gradients(&mut layer, &inputs, &output_grads)
            .expect("operation should succeed");
        assert!(results.num_checked > 0);
        // Note: This is a simplified test since the actual gradient checking is not fully implemented
    }
}