mushin/nn/
mod.rs

1//! This module exposes tooling for Deep Learning built upon the **Mushin** auto-grad core.
2//!
3//! ## Usage
4//! ```rust
5//! use mushin as mu;
6//! use mu::nn::{layers::Linear, activations::relu, losses::mse, optimizers::SGD};
7//!
8//! let x = mu::eye::<16, 1, 1, 3>(1.0).freeze();
9//! let y = mu::eye::<16, 1, 1, 5>(3.0).freeze();
10//!
11//! let linear = Linear::<16, 3, 5, _, _>::new();
12//! let optim = SGD::new(&linear.parameters(), 0.01);
13//!
14//! for _ in 0..5 {
15//!     let z = relu(&linear.forward(&x));
16//!     let loss = mse(&z, &y);
17//!
18//!     loss.backward();
19//!     optim.step();
20//!     loss.reset();
21//! }
22//! ```
23
24pub mod activations;
25pub mod layers;
26pub mod losses;
27pub mod optimizers;