Struct StandardModelConfig 

pub struct StandardModelConfig<T> {
    pub batch_size: usize,
    pub epochs: usize,
    pub hyperspace: HashMap<String, T>,
}

The StandardModelConfig struct is a standard implementation of the

Fields

batch_size: usize

epochs: usize

hyperspace: HashMap<String, T>

Implementations

impl<T> StandardModelConfig<T>

pub fn new() -> Self

pub const fn batch_size(&self) -> usize

returns a copy of the batch size

pub const fn batch_size_mut(&mut self) -> &mut usize

returns a mutable reference to the batch size

pub const fn epochs(&self) -> usize

returns a copy of the epochs

pub const fn epochs_mut(&mut self) -> &mut usize

returns a mutable reference to the epochs

pub const fn hyperparameters(&self) -> &HashMap<String, T>

returns a reference to the hyperparameters map

pub const fn hyperparameters_mut(&mut self) -> &mut HashMap<String, T>

returns a mutable reference to the hyperparameters map

pub fn add_parameter<K: ToString>(&mut self, key: K, value: T) -> Option<T>

inserts a hyperparameter into the map, returning the previous value if it exists

pub fn get<Q>(&self, key: &Q) -> Option<&T>

where Q: ?Sized + Eq + Hash, String: Borrow<Q>,

gets a reference to a hyperparameter by key, returning None if it does not exist

pub fn parameter<Q: ToString>( &mut self, key: Q, ) -> Entry<'_, String, T, DefaultHashBuilder>

returns an entry for the hyperparameter, allowing for insertion or modification

pub fn remove_hyperparameter<Q>(&mut self, key: &Q) -> Option<T>

where Q: ?Sized + Hash + Eq, String: Borrow<Q>,

removes a hyperparameter from the map, returning the value if it exists

pub fn set_batch_size(&mut self, batch_size: usize) -> &mut Self

sets the batch size, returning a mutable reference to the current instance

pub fn set_epochs(&mut self, epochs: usize) -> &mut Self

sets the number of epochs, returning a mutable reference to the current instance

pub fn with_batch_size(self, batch_size: usize) -> Self

consumes the current instance to create another with the given batch size

pub fn with_epochs(self, epochs: usize) -> Self

consumes the current instance to create another with the given epochs

impl<T> StandardModelConfig<T>

pub fn set_decay(&mut self, decay: T) -> Option<T>

sets the decay hyperparameter, returning the previous value if it exists

pub fn set_learning_rate(&mut self, learning_rate: T) -> Option<T>

pub fn set_momentum(&mut self, momentum: T) -> Option<T>

sets the momentum hyperparameter, returning the previous value if it exists

pub fn set_weight_decay(&mut self, decay: T) -> Option<T>

sets the weight decay hyperparameter, returning the previous value if it exists

pub fn learning_rate(&self) -> Option<&T>

returns a reference to the learning rate hyperparameter, if it exists

pub fn momentum(&self) -> Option<&T>

returns a reference to the momentum hyperparameter, if it exists

pub fn decay(&self) -> Option<&T>

returns a reference to the decay hyperparameter, if it exists

pub fn weight_decay(&self) -> Option<&T>

returns a reference to the weight decay hyperparameter, if it exists

Trait Implementations

impl<T: Clone> Clone for StandardModelConfig<T>

fn clone(&self) -> StandardModelConfig<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for StandardModelConfig<T>

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

Formats the value using the given formatter.

impl<T> Default for StandardModelConfig<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> ExtendedModelConfig<T> for StandardModelConfig<T>

fn epochs(&self) -> usize

fn batch_size(&self) -> usize

fn learning_rate(&self) -> Option<&T>

fn epsilon(&self) -> Option<&T>

fn momentum(&self) -> Option<&T>

fn weight_decay(&self) -> Option<&T>

fn dropout(&self) -> Option<&T>

fn decay(&self) -> Option<&T>

fn beta(&self) -> Option<&T>

fn beta1(&self) -> Option<&T>

fn beta2(&self) -> Option<&T>

impl<T> ModelConfiguration<T> for StandardModelConfig<T>

fn get<K>(&self, key: K) -> Option<&T>

where K: AsRef<str>,

fn get_mut<K>(&mut self, key: K) -> Option<&mut T>

where K: AsRef<str>,

fn set<K>(&mut self, key: K, value: T) -> Option<T>

where K: AsRef<str>,

fn remove<K>(&mut self, key: K) -> Option<T>

where K: AsRef<str>,

fn contains<K>(&self, key: K) -> bool

where K: AsRef<str>,

fn keys(&self) -> Vec<&str>

impl<T> NetworkConfig<String, T> for StandardModelConfig<T>

type Store = HashMap<String, T>

the type of key-value store used to handle the hyperparameters of the network

fn store(&self) -> &Self::Store

returns a reference to the key-value store

fn store_mut(&mut self) -> &mut Self::Store

returns a mutable reference to the key-value store

fn get<'a>(&'a self, key: &K) -> Option<&'a V>

where Self::Store: 'a,

get a reference to a value in the store by key

fn get_mut<'a>(&'a mut self, key: &K) -> Option<&'a mut V>

where Self::Store: 'a + RawStoreMut<K, V>,

returns a mutable reference to a value in the store by key

fn hyperparam<'a>( &'a mut self, key: K, ) -> <Self::Store as Store<K, V>>::Entry<'a>

where Self::Store: 'a + Store<K, V>,

returns the entry associated with the given key

impl<T> RawConfig for StandardModelConfig<T>

type Ctx = T

impl<T> Send for StandardModelConfig<T>

where T: Send,

impl<T> Sync for StandardModelConfig<T>

where T: Sync,