Struct BatchNorm

pub struct BatchNorm {
    pub feature_count: i32,
    pub eps: Array,
    pub momentum: Array,
    pub weight: Param<Option<Array>>,
    pub bias: Param<Option<Array>>,
    pub running_mean: Param<Option<Array>>,
    pub running_var: Param<Option<Array>>,
    pub training: bool,
}

Applies batch normalization [1] on the inputs.

References

1. https://arxiv.org/abs/1502.03167

Fields

feature_count: i32

Number of features in the input

eps: Array

Value added to the denominator for numerical stability.

momentum: Array

Momentum for updating the running mean and variance.

weight: Param<Option<Array>>

An optional trainable weight

bias: Param<Option<Array>>

An optional trainable bias

running_mean: Param<Option<Array>>

Tracked running mean

running_var: Param<Option<Array>>

Tracked running variance

training: bool

If true, the module is in training mode.

Implementations

impl BatchNorm

pub fn new( feature_count: impl Into<i32>, ) -> Result<Self, <<Self as Buildable>::Builder as Builder<Self>>::Error>

Creates a new instance of BatchNorm.

impl BatchNorm

pub const DEFAULT_EPS: f32 = 9.99999974E-6f32

Default value for eps.

pub const DEFAULT_MOMENTUM: f32 = 0.100000001f32

Default value for momentum.

pub const DEFAULT_AFFINE: bool = true

Enable trainable weight and bias by default.

pub const DEFAULT_TRACK_RUNNING_STATS: bool = true

Enable tracking of running mean and variance by default.

pub const DEFAULT_TRAINING: bool = true

Enable training mode by default.

Trait Implementations

impl Buildable for BatchNorm

type Builder = BatchNormBuilder

The builder type for this buildable type

impl Builder<BatchNorm> for BatchNormBuilder

type Error = Exception

Error with building

fn build(self) -> Result<BatchNorm, Self::Error>

Build the type

impl Clone for BatchNorm

fn clone(&self) -> BatchNorm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchNorm

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

Formats the value using the given formatter.

impl Module<&Array> for BatchNorm

type Error = Exception

Error type for the module.

type Output = Array

Output type of the module.

fn forward(&mut self, x: &Array) -> Result<Array, Self::Error>

Forward pass of the module.

fn training_mode(&mut self, mode: bool)

Set whether the module is in training mode.

impl ModuleParameters for BatchNorm

fn freeze_parameters(&mut self, recursive: bool)

Freeze all parameters in the module.

fn unfreeze_parameters(&mut self, recursive: bool)

Unfreeze all parameters in the module.

fn parameters(&self) -> ModuleParamRef<'_>

Get references to the module parameters.

fn parameters_mut(&mut self) -> ModuleParamMut<'_>

Get mutable references to the module parameters.

fn trainable_parameters(&self) -> ModuleParamRef<'_>

Get references to the trainable parameters. A parameter is trainable if it is NOT frozen.

fn all_frozen(&self) -> Option<bool>

Check if all parameters in the module are frozen. Returns None if there are no parameters.

fn any_frozen(&self) -> Option<bool>

Check if any parameter in the module is frozen. Returns None if there are no parameters.

fn update(&mut self, parameters: ModuleParam)

Update the module parameters.

fn update_flattened(&mut self, flattened_parameters: FlattenedModuleParam)

Update the module parameters from a flattened representation.