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