scirs2-neural 0.3.3

Neural network building blocks module for SciRS2 (scirs2-neural) - Minimal Version
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

//! Neural network model implementations
//!
//! This module provides implementations of neural network models,
//! including Sequential models and training utilities.

use crate::error::Result;
use crate::losses::Loss;
use crate::optimizers::Optimizer;
use scirs2_core::ndarray::{Array, ScalarOperand};
use scirs2_core::numeric::Float;
use std::fmt::Debug;
/// Trait for neural network models
pub trait Model<F: Float + Debug + ScalarOperand> {
    /// Forward pass through the model
    fn forward(
        &self,
        input: &Array<F, scirs2_core::ndarray::IxDyn>,
    ) -> Result<Array<F, scirs2_core::ndarray::IxDyn>>;
    /// Backward pass to compute gradients
    fn backward(
        &self,
        input: &Array<F, scirs2_core::ndarray::IxDyn>,
        grad_output: &Array<F, scirs2_core::ndarray::IxDyn>,
    ) -> Result<Array<F, scirs2_core::ndarray::IxDyn>>;
    /// Update the model parameters with the given learning rate
    fn update(&mut self, learningrate: F) -> Result<()>;
    /// Train the model on a batch of data
    fn train_batch(
        &mut self,
        inputs: &Array<F, scirs2_core::ndarray::IxDyn>,
        targets: &Array<F, scirs2_core::ndarray::IxDyn>,
        loss_fn: &dyn Loss<F>,
        optimizer: &mut dyn Optimizer<F>,
    ) -> Result<F>;
    /// Predict the output for a batch of inputs
    fn predict(
        &self,
        inputs: &Array<F, scirs2_core::ndarray::IxDyn>,
    ) -> Result<Array<F, scirs2_core::ndarray::IxDyn>>;
    /// Evaluate the model on a batch of data
    fn evaluate(
        &self,
        inputs: &Array<F, scirs2_core::ndarray::IxDyn>,
        targets: &Array<F, scirs2_core::ndarray::IxDyn>,
        loss_fn: &dyn Loss<F>,
    ) -> Result<F>;
}
// Model architectures
pub mod architectures;
pub mod sequential;
pub mod trainer;
pub use architectures::*;
pub use sequential::Sequential;
pub use trainer::{History, Trainer, TrainingConfig};