Enum ModelFormat

pub enum ModelFormat {
    Shallow {
        hidden: usize,
    },
    Deep {
        hidden: usize,
        layers: usize,
    },
}

The ModelFormat type enumerates the various formats a neural network may take, either shallow or deep, providing a unified interface for accessing the number of hidden features and layers in the model. This is done largely for simplicity, as it eliminates the need to define a particular type of network as its composition has little impact on the actual requirements / algorithms used to train or evaluate the model (that is, outside of the obvious need to account for additional hidden layers in deep configurations). In other words, both shallow and deep networks are requried to implement the same traits and fulfill the same requirements, so it makes sense to treat them as a single type with different configurations. The differences between the networks are largely left to the developer and their choice of activation functions, optimizers, and other considerations.

Variants

Shallow

Fields

hidden: usize

Deep

Fields

hidden: usize

layers: usize

Implementations

impl ModelFormat

pub const fn is_shallow(&self) -> bool

Returns true if the enum is ModelFormat::Shallow otherwise false

pub const fn is_deep(&self) -> bool

Returns true if the enum is ModelFormat::Deep otherwise false

impl ModelFormat

pub const fn deep(hidden: usize, layers: usize) -> Self

initialize a new Deep variant for a deep neural network with the given number of hidden features and layers

pub const fn shallow(hidden: usize) -> Self

create a new instance of ModelFormat for a shallow neural network, using the given number of hidden features

pub const fn hidden(&self) -> usize

returns a copy of the number of hidden features

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

returns a mutable reference to the hidden features for the model

pub const fn layers(&self) -> usize

returns a copy of the number of layers for the model; if the variant is Shallow, it returns 1 returns n if the variant is Deep

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

returns a mutable reference to the number of layers for the model; this will panic on Shallow variants

pub fn set_hidden(&mut self, value: usize) -> &mut Self

update the number of hidden features for the model

pub fn set_layers(&mut self, value: usize) -> &mut Self

update the number of layers for the model;

note: this method will automatically convert the model to a Deep variant if it is currently a Shallow variant and the number of layers becomes greater than 1

pub fn with_hidden(self, hidden: usize) -> Self

consumes the current instance and returns a new instance with the given hidden features

pub fn with_layers(self, layers: usize) -> Self

consumes the current instance and returns a new instance with the given number of hidden layers

note: this method will automatically convert the model to a Deep variant if it is currently a Shallow variant and the number of layers becomes greater than 1

Trait Implementations

impl Clone for ModelFormat

fn clone(&self) -> ModelFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelFormat

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

Formats the value using the given formatter.

impl Default for ModelFormat

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ModelFormat

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

Formats the value using the given formatter.

impl EnumCount for ModelFormat

const COUNT: usize = 2usize

impl Hash for ModelFormat

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 ModelFormat

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

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

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

const 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 ModelFormat

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ModelFormat

impl Eq for ModelFormat

impl StructuralPartialEq for ModelFormat