Struct ModelLayout 

pub struct ModelLayout<F, D = Deep>
where
    D: NetworkDepth,
    F: RawModelLayout,
{ /* private fields */ }

In contrast to the ModelFeatures type, the ModelLayout implementation aims to provide a generic foundation for using type-based features / layouts within neural network. Our goal with this struct is to eventually push the implementation to the point of being able to sufficiently describe everything about a model’s layout (similar to what the ndarray developers have attained with the LayoutRef).

Implementations

impl<F, D> ModelLayout<F, D>

where F: RawModelLayout, D: NetworkDepth,

pub const fn new(features: F) -> Self

creates a new instance of ModelLayout using the given features

pub const fn features(&self) -> &F

returns a reference to the features of the model layout

pub const fn features_mut(&mut self) -> &mut F

returns a mutable reference to the features of the model layout

pub fn input(&self) -> usize

returns a reference to the input of the model layout

pub fn output(&self) -> usize

returns a reference to the output of the model layout

pub fn hidden(&self) -> usize

returns a reference to the hidden features of the model layout

pub fn layers(&self) -> usize

returns a reference to the depth, or number of hidden layers, of the model

impl<F> ModelLayout<F, Deep>

where F: RawModelLayout,

pub const fn deep(features: F) -> Self

creates a new instance of ModelLayout using the given features

impl<F> ModelLayout<F, Shallow>

where F: RawModelLayout,

pub const fn shallow(features: F) -> Self

returns a new instance of the model layout using the given features and a shallow depth

Trait Implementations

impl<F, D> Clone for ModelLayout<F, D>

where D: NetworkDepth + Clone, F: RawModelLayout + Clone,

fn clone(&self) -> ModelLayout<F, D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F, D> Debug for ModelLayout<F, D>

where D: NetworkDepth + Debug, F: RawModelLayout + Debug,

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

Formats the value using the given formatter.

impl<F, D> Deref for ModelLayout<F, D>

where F: RawModelLayout, D: NetworkDepth,

type Target = F

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<F, D> DerefMut for ModelLayout<F, D>

where F: RawModelLayout, D: NetworkDepth,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<F, D> Hash for ModelLayout<F, D>

where D: NetworkDepth + Hash, F: RawModelLayout + Hash,

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<F, D> Ord for ModelLayout<F, D>

where D: NetworkDepth + Ord, F: RawModelLayout + Ord,

fn cmp(&self, other: &ModelLayout<F, D>) -> 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<F, D> PartialEq for ModelLayout<F, D>

where D: NetworkDepth + PartialEq, F: RawModelLayout + PartialEq,

fn eq(&self, other: &ModelLayout<F, D>) -> 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<F, D> PartialOrd for ModelLayout<F, D>

where D: NetworkDepth + PartialOrd, F: RawModelLayout + PartialOrd,

fn partial_cmp(&self, other: &ModelLayout<F, D>) -> 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<F, D> Copy for ModelLayout<F, D>

where D: NetworkDepth + Copy, F: RawModelLayout + Copy,

impl<F, D> Eq for ModelLayout<F, D>

where D: NetworkDepth + Eq, F: RawModelLayout + Eq,

impl<F, D> StructuralPartialEq for ModelLayout<F, D>

where D: NetworkDepth, F: RawModelLayout,