Struct BatchNormConfig 

pub struct BatchNormConfig {
    pub num_features: usize,
    pub epsilon: f64,
    pub momentum: f64,
}

BatchNorm Configuration.

Used to create a BatchNorm layer using the BatchNormConfig::init.

Fields

num_features: usize

The number of features. Must be greater than zero.

epsilon: f64

A finite, positive value required for numerical stability. Default: 1e-5

momentum: f64

A finite momentum in [0, 1] used to update the running statistics. Default: 0.1

A value of 0 preserves the running statistics; 1 replaces them with the current batch statistics.

Implementations

impl BatchNormConfig

pub fn new(num_features: usize) -> BatchNormConfig

Create a new instance of the config.

Arguments

Required Arguments

num_features

The number of features. Must be greater than zero.

Default Arguments

epsilon

A finite, positive value required for numerical stability. Default: 1e-5

• Defaults to 1e-5

momentum

A finite momentum in [0, 1] used to update the running statistics. Default: 0.1

A value of 0 preserves the running statistics; 1 replaces them with the current batch statistics.

• Defaults to 0.1

impl BatchNormConfig

pub fn with_epsilon(self, epsilon: f64) -> BatchNormConfig

Sets the value for the field epsilon.

A finite, positive value required for numerical stability. Default: 1e-5

• Defaults to 1e-5

pub fn with_momentum(self, momentum: f64) -> BatchNormConfig

Sets the value for the field momentum.

A finite momentum in [0, 1] used to update the running statistics. Default: 0.1

A value of 0 preserves the running statistics; 1 replaces them with the current batch statistics.

• Defaults to 0.1

impl BatchNormConfig

pub fn init(&self, device: &Device) -> BatchNorm

Initializes a new batch norm module.

Panics

Panics if num_features is zero, epsilon is not finite and positive, or momentum is not finite and within [0, 1].

Trait Implementations

impl Clone for BatchNormConfig

fn clone(&self) -> BatchNormConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for BatchNormConfig

fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Saves the configuration to a file.

fn load<P>(file: P) -> Result<Self, ConfigError>

where P: AsRef<Path>,

Loads the configuration from a file.

fn load_binary(data: &[u8]) -> Result<Self, ConfigError>

Loads the configuration from a binary buffer.

impl Debug for BatchNormConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatchNormConfig

fn deserialize<D>( deserializer: D, ) -> Result<BatchNormConfig, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BatchNormConfig

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

Formats the value using the given formatter.

impl From<BatchNormConfig> for NormalizationConfig

fn from(config: BatchNormConfig) -> NormalizationConfig

Converts to this type from the input type.

impl Serialize for BatchNormConfig

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.