Enum ModelFormat 

pub enum ModelFormat {
    Layer,
    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 primarily used to generalize the allowed formats of a neural network without introducing any additional complexity with typing or other constructs.

Variants

Layer

Shallow

Fields

hidden: usize

Deep

Fields

hidden: usize

layers: usize

Implementations

impl ModelFormat

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

pub const fn layer() -> Self

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

impl ModelFormat

pub const fn is_layer(&self) -> bool

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

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

Trait Implementations

impl Clone for ModelFormat

fn clone(&self) -> ModelFormat

Returns a duplicate of the value.

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 Display for ModelFormat

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

Formats the value using the given formatter.

impl EnumCount for ModelFormat

const COUNT: usize = 3usize

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 ==.

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 Copy for ModelFormat

impl Eq for ModelFormat

impl StructuralPartialEq for ModelFormat