native_neural_network_std 0.2.1

Ergonomic std wrapper for the `native_neural_network` crate (no_std) — std-friendly re-exports and utilities.
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

#[derive(Debug)]
pub enum OptimizerStdError {
    InvalidHyperParams,
    ShapeMismatch,
    StepOverflow,
}

impl From<native_neural_network::optimizers::OptimizerError> for OptimizerStdError {
    fn from(e: native_neural_network::optimizers::OptimizerError) -> Self {
        match e {
            native_neural_network::optimizers::OptimizerError::InvalidHyperParams => {
                OptimizerStdError::InvalidHyperParams
            }
            native_neural_network::optimizers::OptimizerError::ShapeMismatch => {
                OptimizerStdError::ShapeMismatch
            }
            native_neural_network::optimizers::OptimizerError::StepOverflow => {
                OptimizerStdError::StepOverflow
            }
        }
    }
}

#[derive(Clone, Copy, Debug)]
pub enum OptimizerKind {
    Sgd {
        momentum: f32,
        nesterov: bool,
    },
    AdamW {
        beta1: f32,
        beta2: f32,
        eps: f32,
        weight_decay: f32,
    },
}

impl From<OptimizerKind> for native_neural_network::optimizers::OptimizerKind {
    fn from(k: OptimizerKind) -> Self {
        match k {
            OptimizerKind::Sgd { momentum, nesterov } => {
                native_neural_network::optimizers::OptimizerKind::Sgd { momentum, nesterov }
            }
            OptimizerKind::AdamW {
                beta1,
                beta2,
                eps,
                weight_decay,
            } => native_neural_network::optimizers::OptimizerKind::AdamW {
                beta1,
                beta2,
                eps,
                weight_decay,
            },
        }
    }
}

impl From<native_neural_network::optimizers::OptimizerKind> for OptimizerKind {
    fn from(k: native_neural_network::optimizers::OptimizerKind) -> Self {
        match k {
            native_neural_network::optimizers::OptimizerKind::Sgd { momentum, nesterov } => {
                OptimizerKind::Sgd { momentum, nesterov }
            }
            native_neural_network::optimizers::OptimizerKind::AdamW {
                beta1,
                beta2,
                eps,
                weight_decay,
            } => OptimizerKind::AdamW {
                beta1,
                beta2,
                eps,
                weight_decay,
            },
        }
    }
}

pub fn optimizer_state_len(kind: OptimizerKind, param_len: usize) -> Option<usize> {
    native_neural_network::optimizers::optimizer_state_len(kind.into(), param_len)
}

pub fn apply_optimizer_step(
    kind: OptimizerKind,
    params: &mut [f32],
    grads: &[f32],
    state: &mut [f32],
    learning_rate: f32,
    step: u32,
) -> Result<(), OptimizerStdError> {
    native_neural_network::optimizers::apply_optimizer_step(
        kind.into(),
        params,
        grads,
        state,
        learning_rate,
        step,
    )
    .map_err(|e| e.into())
}

pub fn step_sgd(
    params: &mut [f32],
    grads: &[f32],
    velocity: &mut [f32],
    learning_rate: f32,
    momentum: f32,
    nesterov: bool,
) -> Result<(), OptimizerStdError> {
    let kind = OptimizerKind::Sgd { momentum, nesterov };
    apply_optimizer_step(kind, params, grads, velocity, learning_rate, 1)
}

#[derive(Clone, Copy, Debug)]
pub struct AdamWParams {
    pub beta1: f32,
    pub beta2: f32,
    pub eps: f32,
    pub weight_decay: f32,
}

pub fn step_adamw(
    params: &mut [f32],
    grads: &[f32],
    state: &mut [f32],
    learning_rate: f32,
    step: u32,
    opts: AdamWParams,
) -> Result<(), OptimizerStdError> {
    let kind = OptimizerKind::AdamW {
        beta1: opts.beta1,
        beta2: opts.beta2,
        eps: opts.eps,
        weight_decay: opts.weight_decay,
    };
    apply_optimizer_step(kind, params, grads, state, learning_rate, step)
}

impl core::fmt::Display for OptimizerStdError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "OptimizerStdError::{:?}", self)
    }
}

impl std::error::Error for OptimizerStdError {}