Enum HyperParam 

#[non_exhaustive]
pub enum HyperParam {
    Decay,
    Dropout,
    LearningRate,
    Momentum,
    Temperature,
    WeightDecay,
    Beta1,
    Beta2,
    Epsilon,
}

An enumeration of common HyperParams used in neural network configurations.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Decay

Dropout

LearningRate

Momentum

Temperature

WeightDecay

Beta1

Beta2

Epsilon

Implementations

impl HyperParam

pub const fn is_decay(&self) -> bool

Returns true if the enum is HyperParam::Decay otherwise false

pub const fn is_dropout(&self) -> bool

Returns true if the enum is HyperParam::Dropout otherwise false

pub const fn is_learning_rate(&self) -> bool

Returns true if the enum is HyperParam::LearningRate otherwise false

pub const fn is_momentum(&self) -> bool

Returns true if the enum is HyperParam::Momentum otherwise false

pub const fn is_temperature(&self) -> bool

Returns true if the enum is HyperParam::Temperature otherwise false

pub const fn is_weight_decay(&self) -> bool

Returns true if the enum is HyperParam::WeightDecay otherwise false

pub const fn is_beta_1(&self) -> bool

Returns true if the enum is HyperParam::Beta1 otherwise false

pub const fn is_beta_2(&self) -> bool

Returns true if the enum is HyperParam::Beta2 otherwise false

pub const fn is_epsilon(&self) -> bool

Returns true if the enum is HyperParam::Epsilon otherwise false

impl HyperParam

pub const fn variants() -> &'static [&'static str]

returns a list of variants as strings

Trait Implementations

impl AsRef<str> for HyperParam

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for HyperParam

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for HyperParam

fn clone(&self) -> HyperParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HyperParam

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

Formats the value using the given formatter.

impl Display for HyperParam

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

Formats the value using the given formatter.

impl EnumCount for HyperParam

const COUNT: usize = 9usize

impl FromStr for HyperParam

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<HyperParam, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for HyperParam

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 IntoEnumIterator for HyperParam

type Iterator = HyperParamIter

fn iter() -> HyperParamIter

impl Ord for HyperParam

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

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

fn partial_cmp(&self, other: &HyperParam) -> 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 TryFrom<&str> for HyperParam

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<HyperParam, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl VariantNames for HyperParam

const VARIANTS: &'static [&'static str]

Names of the variants of this enum

impl Eq for HyperParam

impl StructuralPartialEq for HyperParam