Struct MlLearningRate 

pub struct MlLearningRate(/* private fields */);

Implementations

impl MlLearningRate

pub fn new(value: f64) -> Result<Self, MlTrainingError>

Examples found in repository

examples/basic_usage.rs (line 6)

fn main() -> Result<(), use_ml_training::MlTrainingError> {
    let run_id = MlTrainingRunId::new("run-001")?;
    let batch_size = MlBatchSize::new(32)?;
    let learning_rate = MlLearningRate::new(0.001)?;
    let optimizer: MlOptimizerKind = "adamw".parse()?;

    assert_eq!(run_id.as_str(), "run-001");
    assert_eq!(batch_size.get(), 32);
    assert_eq!(learning_rate.value(), 0.001);
    assert_eq!(optimizer, MlOptimizerKind::AdamW);
    Ok(())
}

pub const fn value(self) -> f64

Examples found in repository

examples/basic_usage.rs (line 11)

fn main() -> Result<(), use_ml_training::MlTrainingError> {
    let run_id = MlTrainingRunId::new("run-001")?;
    let batch_size = MlBatchSize::new(32)?;
    let learning_rate = MlLearningRate::new(0.001)?;
    let optimizer: MlOptimizerKind = "adamw".parse()?;

    assert_eq!(run_id.as_str(), "run-001");
    assert_eq!(batch_size.get(), 32);
    assert_eq!(learning_rate.value(), 0.001);
    assert_eq!(optimizer, MlOptimizerKind::AdamW);
    Ok(())
}

Trait Implementations

impl Clone for MlLearningRate

fn clone(&self) -> MlLearningRate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MlLearningRate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MlLearningRate

fn eq(&self, other: &MlLearningRate) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MlLearningRate

fn partial_cmp(&self, other: &MlLearningRate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for MlLearningRate

impl StructuralPartialEq for MlLearningRate