Struct MlBatchSize 

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

Implementations

impl MlBatchSize

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

Examples found in repository

examples/basic_usage.rs (line 5)

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 get(self) -> usize

Examples found in repository

examples/basic_usage.rs (line 10)

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 MlBatchSize

fn clone(&self) -> MlBatchSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MlBatchSize

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

Formats the value using the given formatter.

impl Hash for MlBatchSize

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MlBatchSize

fn cmp(&self, other: &MlBatchSize) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MlBatchSize

fn eq(&self, other: &MlBatchSize) -> 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 MlBatchSize

fn partial_cmp(&self, other: &MlBatchSize) -> 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 MlBatchSize

impl Eq for MlBatchSize

impl StructuralPartialEq for MlBatchSize