burn_optim/lib.rs
1#![cfg_attr(not(feature = "std"), no_std)]
2#![warn(missing_docs)]
3#![cfg_attr(docsrs, feature(doc_cfg))]
4
5//! Burn optimizers.
6
7#[macro_use]
8extern crate derive_new;
9
10extern crate alloc;
11
12/// Optimizer module.
13mod optim;
14pub use optim::*;
15
16/// Gradient clipping module.
17pub mod grad_clipping;
18
19/// Learning rate scheduler module.
20#[cfg(feature = "std")]
21pub mod lr_scheduler;
22
23/// Type alias for the learning rate.
24///
25/// LearningRate also implements [learning rate scheduler](crate::lr_scheduler::LrScheduler) so it
26/// can be used for constant learning rate.
27pub type LearningRate = f64; // We could potentially change the type.