Struct ModelFeatures 

pub struct ModelFeatures { /* private fields */ }

The ModelFeatures provides a common way of defining the layout of a model. This is used to define the number of input features, the number of hidden layers, the number of hidden features, and the number of output features.

Implementations

impl ModelFeatures

pub fn from_shape_and_size(shape: &[usize], size: usize) -> Self

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

creates a new instance of ModelFeatures for a neural network with n layers. If the number of layers is <=1 then the ModelFormat is automatically configured as a shallow neural network.

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

creates a new instance of ModelFeatures for a deep neural network, using the given input, hidden, and output features with the given number of hidden layers

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

returns a new instance of ModelFeatures for a shallow neural network, using the given features for the input, output, and single hidden layer

pub fn from_layout<L>(layout: L) -> Self

where L: RawModelLayout,

pub const fn input(&self) -> usize

returns a copy of the input features for the model

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

returns a mutable reference to the input features for the model

pub const fn inner(&self) -> ModelFormat

returns a copy of the inner format for the model

pub const fn inner_mut(&mut self) -> &mut ModelFormat

returns a mutable reference to the inner format for the model

pub const fn hidden(&self) -> usize

returns a copy of the hidden features for the model

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 hidden layers for the model

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

returns a mutable reference to the number of hidden layers for the model

pub const fn output(&self) -> usize

returns a copy of the output features for the model

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

returns a mutable reference to the output features for the model

pub fn set_input(&mut self, input: usize) -> &mut Self

sets the input features for the model

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

sets the hidden features for the model

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

sets the number of hidden layers for the model

pub fn set_output(&mut self, output: usize) -> &mut Self

sets the output features for the model

pub fn with_input(self, input: usize) -> Self

consumes the current instance and returns a new instance with the given input

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

pub fn with_output(self, output: usize) -> Self

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

pub fn dim_input(&self) -> (usize, usize)

the dimension of the input layer; (input, hidden)

pub fn dim_hidden(&self) -> (usize, usize)

the dimension of the hidden layers; (hidden, hidden)

pub fn dim_output(&self) -> (usize, usize)

the dimension of the output layer; (hidden, output)

pub fn size(&self) -> usize

the total number of parameters in the model

pub fn size_input(&self) -> usize

the total number of input parameters in the model

pub fn size_hidden(&self) -> usize

the total number of hidden parameters in the model

pub fn size_output(&self) -> usize

the total number of output parameters in the model

Trait Implementations

impl Clone for ModelFeatures

fn clone(&self) -> ModelFeatures

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelFeatures

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

Formats the value using the given formatter.

impl Default for ModelFeatures

fn default() -> Self

Returns the “default value” for a type.

impl Display for ModelFeatures

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

Formats the value using the given formatter.

impl Hash for ModelFeatures

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 ModelFeatures

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

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

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

fn input(&self) -> usize

returns the total number of input features defined for the model

fn hidden(&self) -> usize

returns the number of hidden features for the model

fn depth(&self) -> usize

returns the number of hidden layers within the network

fn output(&self) -> usize

the number of output features for the model

fn dim_input(&self) -> (usize, usize)

the dimension of the input layer; (input, hidden)

fn dim_hidden(&self) -> (usize, usize)

the dimension of the hidden layers; (hidden, hidden)

fn dim_output(&self) -> (usize, usize)

the dimension of the output layer; (hidden, output)

fn size(&self) -> usize

the total number of parameters in the model

fn size_input(&self) -> usize

the total number of input parameters in the model

fn size_hidden(&self) -> usize

the total number of hidden parameters in the model

fn size_output(&self) -> usize

the total number of output parameters in the model

impl RawModelLayoutMut for ModelFeatures

fn input_mut(&mut self) -> &mut usize

returns a mutable reference to number of the input features for the model

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

returns a mutable reference to the number of hidden features for the model

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

returns a mutable reference to the number of hidden layers for the model

fn output_mut(&mut self) -> &mut usize

returns a mutable reference to the output features for the model

fn set_input(&mut self, input: usize) -> &mut Self

update the number of input features for the model and return a mutable reference to the current layout.

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

update the number of hidden features for the model and return a mutable reference to the current layout.

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

update the number of hidden layers for the model and return a mutable reference to the current layout.

fn set_output(&mut self, output: usize) -> &mut Self

update the number of output features for the model and return a mutable reference to the current layout.

impl Copy for ModelFeatures

impl Eq for ModelFeatures

impl StructuralPartialEq for ModelFeatures