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
use crate::compat::*;
use crate::module::Module;
use crate::state::{get_state, State};
use hodu_core::{error::HoduResult, scalar::Scalar, tensor::Tensor, types::dtype::DType};

#[derive(Module, Clone)]
pub struct BatchNorm1D {
    num_features: usize,
    eps: Scalar,
    momentum: Scalar,
    affine: bool,
    gamma: Option<Tensor>,
    beta: Option<Tensor>,
    running_mean: RefCell<Tensor>,
    running_var: RefCell<Tensor>,
}

impl BatchNorm1D {
    pub fn new(
        num_features: usize,
        eps: impl Into<Scalar>,
        momentum: impl Into<Scalar>,
        affine: bool,
        dtype: DType,
    ) -> HoduResult<Self> {
        let eps = eps.into();
        let momentum = momentum.into();

        let (gamma, beta) = if affine {
            let gamma = Tensor::ones(&[num_features], dtype)?;
            gamma.set_requires_grad(true)?;

            let beta = Tensor::zeros(&[num_features], dtype)?;
            beta.set_requires_grad(true)?;

            (Some(gamma), Some(beta))
        } else {
            (None, None)
        };

        let running_mean = RefCell::new(Tensor::zeros(&[num_features], dtype)?);
        let running_var = RefCell::new(Tensor::ones(&[num_features], dtype)?);

        Ok(Self {
            num_features,
            eps,
            momentum,
            affine,
            gamma,
            beta,
            running_mean,
            running_var,
        })
    }

    pub fn forward(&self, input: &Tensor) -> HoduResult<Tensor> {
        let input_layout = input.get_layout();
        let input_shape = input_layout.get_shape();

        if get_state() == State::Training {
            // Training mode: compute batch statistics
            let mean = if input_shape.len() == 2 {
                // [N, C] -> mean over N (axis 0)
                input.mean(&[0], true)?
            } else if input_shape.len() == 3 {
                // [N, C, L] -> mean over N, L (axes 0, 2)
                input.mean(&[0, 2], true)?
            } else {
                return Err(hodu_core::error::HoduError::InternalError(format!(
                    "BatchNorm1d expects 2D [N, C] or 3D [N, C, L] input, got {}D",
                    input_shape.len()
                )));
            };

            let var = if input_shape.len() == 2 {
                let centered = input.sub(&mean)?;
                let squared = centered.mul(&centered)?;
                squared.mean(&[0], true)?
            } else {
                let centered = input.sub(&mean)?;
                let squared = centered.mul(&centered)?;
                squared.mean(&[0, 2], true)?
            };

            // Update running statistics (during training)
            // running_mean = momentum * running_mean + (1 - momentum) * mean
            // running_var = momentum * running_var + (1 - momentum) * var
            {
                let mut rm = self.running_mean.borrow_mut();
                let mut rv = self.running_var.borrow_mut();

                let momentum_typed = self.momentum.to_dtype(rm.get_dtype());
                let one_minus_momentum = Scalar::from_f32(1.0, rm.get_dtype()) - momentum_typed;

                // Squeeze mean and var to match running stats shape [C]
                let mean_squeezed = mean.reshape(&[self.num_features])?;
                let var_squeezed = var.reshape(&[self.num_features])?;

                let new_mean = rm
                    .mul_scalar(momentum_typed)?
                    .add(&mean_squeezed.mul_scalar(one_minus_momentum)?)?;
                let new_var = rv
                    .mul_scalar(momentum_typed)?
                    .add(&var_squeezed.mul_scalar(one_minus_momentum)?)?;

                *rm = new_mean;
                *rv = new_var;
            }

            // Normalize
            let normalized = self.normalize(input, &mean, &var)?;

            Ok(normalized)
        } else {
            // Evaluation mode: use running statistics
            let mean = self.running_mean.borrow();
            let var = self.running_var.borrow();

            // Reshape for broadcasting
            let mean = if input_shape.len() == 2 {
                mean.reshape(&[1, self.num_features])?
            } else {
                mean.reshape(&[1, self.num_features, 1])?
            };

            let var = if input_shape.len() == 2 {
                var.reshape(&[1, self.num_features])?
            } else {
                var.reshape(&[1, self.num_features, 1])?
            };

            let normalized = self.normalize(input, &mean, &var)?;

            Ok(normalized)
        }
    }

    fn normalize(&self, input: &Tensor, mean: &Tensor, var: &Tensor) -> HoduResult<Tensor> {
        let input_layout = input.get_layout();
        let input_shape = input_layout.get_shape();

        // x_normalized = (x - mean) / sqrt(var + eps)
        let centered = input.sub(mean)?;
        let eps_typed = self.eps.to_dtype(input.get_dtype());
        let std = var.add_scalar(eps_typed)?.sqrt()?;
        let normalized = centered.div(&std)?;

        // Apply affine transformation if enabled
        if self.affine {
            let gamma = self.gamma.as_ref().unwrap();
            let beta = self.beta.as_ref().unwrap();

            let gamma_reshaped = if input_shape.len() == 2 {
                gamma.reshape(&[1, self.num_features])?
            } else {
                gamma.reshape(&[1, self.num_features, 1])?
            };

            let beta_reshaped = if input_shape.len() == 2 {
                beta.reshape(&[1, self.num_features])?
            } else {
                beta.reshape(&[1, self.num_features, 1])?
            };

            let scaled = normalized.mul(&gamma_reshaped)?;
            scaled.add(&beta_reshaped)
        } else {
            Ok(normalized)
        }
    }

    pub fn parameters(&mut self) -> Vec<&mut Tensor> {
        let mut params = Vec::new();
        if self.affine {
            if let Some(ref mut gamma) = self.gamma {
                params.push(gamma);
            }
            if let Some(ref mut beta) = self.beta {
                params.push(beta);
            }
        }
        params
    }
}

#[derive(Module, Clone)]
pub struct BatchNorm2D {
    num_features: usize,
    eps: Scalar,
    momentum: Scalar,
    affine: bool,
    gamma: Option<Tensor>,
    beta: Option<Tensor>,
    running_mean: RefCell<Tensor>,
    running_var: RefCell<Tensor>,
}

impl BatchNorm2D {
    pub fn new(
        num_features: usize,
        eps: impl Into<Scalar>,
        momentum: impl Into<Scalar>,
        affine: bool,
        dtype: DType,
    ) -> HoduResult<Self> {
        let eps = eps.into();
        let momentum = momentum.into();

        let (gamma, beta) = if affine {
            let gamma = Tensor::ones(&[num_features], dtype)?;
            gamma.set_requires_grad(true)?;

            let beta = Tensor::zeros(&[num_features], dtype)?;
            beta.set_requires_grad(true)?;

            (Some(gamma), Some(beta))
        } else {
            (None, None)
        };

        let running_mean = RefCell::new(Tensor::zeros(&[num_features], dtype)?);
        let running_var = RefCell::new(Tensor::ones(&[num_features], dtype)?);

        Ok(Self {
            num_features,
            eps,
            momentum,
            affine,
            gamma,
            beta,
            running_mean,
            running_var,
        })
    }

    pub fn forward(&self, input: &Tensor) -> HoduResult<Tensor> {
        let input_layout = input.get_layout();
        let input_shape = input_layout.get_shape();

        if input_shape.len() != 4 {
            return Err(hodu_core::error::HoduError::InternalError(format!(
                "BatchNorm2d expects 4D input [N, C, H, W], got {}D",
                input_shape.len()
            )));
        }

        if get_state() == State::Training {
            // Training mode: compute batch statistics
            // Mean over [N, H, W] (axes 0, 2, 3)
            let mean = input.mean(&[0, 2, 3], true)?;
            let centered = input.sub(&mean)?;
            let squared = centered.mul(&centered)?;
            let var = squared.mean(&[0, 2, 3], true)?;

            // Update running statistics (during training)
            {
                let mut rm = self.running_mean.borrow_mut();
                let mut rv = self.running_var.borrow_mut();

                let momentum_typed = self.momentum.to_dtype(rm.get_dtype());
                let one_minus_momentum = Scalar::from_f32(1.0, rm.get_dtype()) - momentum_typed;

                // Squeeze mean and var to match running stats shape [C]
                let mean_squeezed = mean.reshape(&[self.num_features])?;
                let var_squeezed = var.reshape(&[self.num_features])?;

                let new_mean = rm
                    .mul_scalar(momentum_typed)?
                    .add(&mean_squeezed.mul_scalar(one_minus_momentum)?)?;
                let new_var = rv
                    .mul_scalar(momentum_typed)?
                    .add(&var_squeezed.mul_scalar(one_minus_momentum)?)?;

                *rm = new_mean;
                *rv = new_var;
            }

            let normalized = self.normalize(input, &mean, &var)?;
            Ok(normalized)
        } else {
            // Evaluation mode: use running statistics
            let mean = self.running_mean.borrow();
            let var = self.running_var.borrow();

            let mean = mean.reshape(&[1, self.num_features, 1, 1])?;
            let var = var.reshape(&[1, self.num_features, 1, 1])?;

            let normalized = self.normalize(input, &mean, &var)?;
            Ok(normalized)
        }
    }

    fn normalize(&self, input: &Tensor, mean: &Tensor, var: &Tensor) -> HoduResult<Tensor> {
        // x_normalized = (x - mean) / sqrt(var + eps)
        let centered = input.sub(mean)?;
        let eps_typed = self.eps.to_dtype(input.get_dtype());
        let std = var.add_scalar(eps_typed)?.sqrt()?;
        let normalized = centered.div(&std)?;

        // Apply affine transformation if enabled
        if self.affine {
            let gamma = self.gamma.as_ref().unwrap();
            let beta = self.beta.as_ref().unwrap();

            let gamma_reshaped = gamma.reshape(&[1, self.num_features, 1, 1])?;
            let beta_reshaped = beta.reshape(&[1, self.num_features, 1, 1])?;

            let scaled = normalized.mul(&gamma_reshaped)?;
            scaled.add(&beta_reshaped)
        } else {
            Ok(normalized)
        }
    }

    pub fn parameters(&mut self) -> Vec<&mut Tensor> {
        let mut params = Vec::new();
        if self.affine {
            if let Some(ref mut gamma) = self.gamma {
                params.push(gamma);
            }
            if let Some(ref mut beta) = self.beta {
                params.push(beta);
            }
        }
        params
    }
}

#[derive(Module, Clone)]
pub struct BatchNorm3D {
    num_features: usize,
    eps: Scalar,
    momentum: Scalar,
    affine: bool,
    gamma: Option<Tensor>,
    beta: Option<Tensor>,
    running_mean: RefCell<Tensor>,
    running_var: RefCell<Tensor>,
}

impl BatchNorm3D {
    pub fn new(
        num_features: usize,
        eps: impl Into<Scalar>,
        momentum: impl Into<Scalar>,
        affine: bool,
        dtype: DType,
    ) -> HoduResult<Self> {
        let eps = eps.into();
        let momentum = momentum.into();

        let (gamma, beta) = if affine {
            let gamma = Tensor::ones(&[num_features], dtype)?;
            gamma.set_requires_grad(true)?;

            let beta = Tensor::zeros(&[num_features], dtype)?;
            beta.set_requires_grad(true)?;

            (Some(gamma), Some(beta))
        } else {
            (None, None)
        };

        let running_mean = RefCell::new(Tensor::zeros(&[num_features], dtype)?);
        let running_var = RefCell::new(Tensor::ones(&[num_features], dtype)?);

        Ok(Self {
            num_features,
            eps,
            momentum,
            affine,
            gamma,
            beta,
            running_mean,
            running_var,
        })
    }

    pub fn forward(&self, input: &Tensor) -> HoduResult<Tensor> {
        let input_layout = input.get_layout();
        let input_shape = input_layout.get_shape();

        if input_shape.len() != 5 {
            return Err(hodu_core::error::HoduError::InternalError(format!(
                "BatchNorm3D expects 5D input [N, C, D, H, W], got {}D",
                input_shape.len()
            )));
        }

        if get_state() == State::Training {
            // Training mode: compute batch statistics
            // Mean over [N, D, H, W] (axes 0, 2, 3, 4)
            let mean = input.mean(&[0, 2, 3, 4], true)?;
            let centered = input.sub(&mean)?;
            let squared = centered.mul(&centered)?;
            let var = squared.mean(&[0, 2, 3, 4], true)?;

            // Update running statistics (during training)
            {
                let mut rm = self.running_mean.borrow_mut();
                let mut rv = self.running_var.borrow_mut();

                let momentum_typed = self.momentum.to_dtype(rm.get_dtype());
                let one_minus_momentum = Scalar::from_f32(1.0, rm.get_dtype()) - momentum_typed;

                // Squeeze mean and var to match running stats shape [C]
                let mean_squeezed = mean.reshape(&[self.num_features])?;
                let var_squeezed = var.reshape(&[self.num_features])?;

                let new_mean = rm
                    .mul_scalar(momentum_typed)?
                    .add(&mean_squeezed.mul_scalar(one_minus_momentum)?)?;
                let new_var = rv
                    .mul_scalar(momentum_typed)?
                    .add(&var_squeezed.mul_scalar(one_minus_momentum)?)?;

                *rm = new_mean;
                *rv = new_var;
            }

            let normalized = self.normalize(input, &mean, &var)?;
            Ok(normalized)
        } else {
            // Evaluation mode: use running statistics
            let mean = self.running_mean.borrow();
            let var = self.running_var.borrow();

            let mean = mean.reshape(&[1, self.num_features, 1, 1, 1])?;
            let var = var.reshape(&[1, self.num_features, 1, 1, 1])?;

            let normalized = self.normalize(input, &mean, &var)?;
            Ok(normalized)
        }
    }

    fn normalize(&self, input: &Tensor, mean: &Tensor, var: &Tensor) -> HoduResult<Tensor> {
        // x_normalized = (x - mean) / sqrt(var + eps)
        let centered = input.sub(mean)?;
        let eps_typed = self.eps.to_dtype(input.get_dtype());
        let std = var.add_scalar(eps_typed)?.sqrt()?;
        let normalized = centered.div(&std)?;

        // Apply affine transformation if enabled
        if self.affine {
            let gamma = self.gamma.as_ref().unwrap();
            let beta = self.beta.as_ref().unwrap();

            let gamma_reshaped = gamma.reshape(&[1, self.num_features, 1, 1, 1])?;
            let beta_reshaped = beta.reshape(&[1, self.num_features, 1, 1, 1])?;

            let scaled = normalized.mul(&gamma_reshaped)?;
            scaled.add(&beta_reshaped)
        } else {
            Ok(normalized)
        }
    }

    pub fn parameters(&mut self) -> Vec<&mut Tensor> {
        let mut params = Vec::new();
        if self.affine {
            if let Some(ref mut gamma) = self.gamma {
                params.push(gamma);
            }
            if let Some(ref mut beta) = self.beta {
                params.push(beta);
            }
        }
        params
    }
}

#[derive(Module, Clone)]
pub struct LayerNorm {
    normalized_shape: Vec<usize>,
    eps: Scalar,
    elementwise_affine: bool,
    gamma: Option<Tensor>,
    beta: Option<Tensor>,
}

impl LayerNorm {
    pub fn new(
        normalized_shape: Vec<usize>,
        eps: impl Into<Scalar>,
        elementwise_affine: bool,
        dtype: DType,
    ) -> HoduResult<Self> {
        let eps = eps.into();

        let (gamma, beta) = if elementwise_affine {
            let gamma = Tensor::ones(&normalized_shape, dtype)?;
            gamma.set_requires_grad(true)?;

            let beta = Tensor::zeros(&normalized_shape, dtype)?;
            beta.set_requires_grad(true)?;

            (Some(gamma), Some(beta))
        } else {
            (None, None)
        };

        Ok(Self {
            normalized_shape,
            eps,
            elementwise_affine,
            gamma,
            beta,
        })
    }

    pub fn forward(&self, input: &Tensor) -> HoduResult<Tensor> {
        let input_layout = input.get_layout();
        let input_shape = input_layout.get_shape();
        let input_rank = input_shape.len();
        let norm_rank = self.normalized_shape.len();

        // Verify that the last dimensions match normalized_shape
        if input_rank < norm_rank {
            return Err(hodu_core::error::HoduError::InternalError(format!(
                "Input rank {} is less than normalized_shape rank {}",
                input_rank, norm_rank
            )));
        }

        for i in 0..norm_rank {
            if input_shape[input_rank - norm_rank + i] != self.normalized_shape[i] {
                return Err(hodu_core::error::HoduError::InternalError(format!(
                    "Input shape mismatch at dimension {}",
                    i
                )));
            }
        }

        // Compute axes to normalize over (last norm_rank dimensions)
        let axes: Vec<usize> = (0..norm_rank).map(|i| input_rank - norm_rank + i).collect();

        // Compute mean and variance over the normalized dimensions
        let mean = input.mean(&axes, true)?;
        let centered = input.sub(&mean)?;
        let squared = centered.mul(&centered)?;
        let var = squared.mean(&axes, true)?;

        // Normalize: (x - mean) / sqrt(var + eps)
        let eps_typed = self.eps.to_dtype(input.get_dtype());
        let std = var.add_scalar(eps_typed)?.sqrt()?;
        let normalized = centered.div(&std)?;

        // Apply elementwise affine transformation if enabled
        if self.elementwise_affine {
            let gamma = self.gamma.as_ref().unwrap();
            let beta = self.beta.as_ref().unwrap();

            let scaled = normalized.mul(gamma)?;
            scaled.add(beta)
        } else {
            Ok(normalized)
        }
    }

    pub fn parameters(&mut self) -> Vec<&mut Tensor> {
        let mut params = Vec::new();
        if self.elementwise_affine {
            if let Some(ref mut gamma) = self.gamma {
                params.push(gamma);
            }
            if let Some(ref mut beta) = self.beta {
                params.push(beta);
            }
        }
        params
    }
}