Skip to main content

TensorBatchNorm

Struct TensorBatchNorm 

Source
pub struct TensorBatchNorm {
    pub config: BatchNormConfig,
    pub gamma: Vec<f64>,
    pub beta: Vec<f64>,
    pub running_mean: Vec<f64>,
    pub running_var: Vec<f64>,
    pub mode: NormMode,
    pub stats: BatchNormStats,
}
Expand description

Batch normalisation layer.

§Layout

Input is expected to have shape [batch_size, num_features].

§Example

use ipfrs_tensorlogic::{TensorBatchNorm, BatchNormConfig, NormMode};

let config = BatchNormConfig::default_for(4);
let mut bn = TensorBatchNorm::new(config);

let batch = vec![
    vec![1.0_f64, 2.0, 3.0, 4.0],
    vec![5.0_f64, 6.0, 7.0, 8.0],
];
let output = bn.forward(&batch).expect("forward failed");
assert_eq!(output.len(), 2);
assert_eq!(output[0].len(), 4);

Fields§

§config: BatchNormConfig

Layer configuration.

§gamma: Vec<f64>

Learnable scale parameters, one per feature (γ, initialised to 1.0).

§beta: Vec<f64>

Learnable shift parameters, one per feature (β, initialised to 0.0).

§running_mean: Vec<f64>

Exponential moving average of per-feature batch means.

§running_var: Vec<f64>

Exponential moving average of per-feature batch variances.

§mode: NormMode

Current execution mode.

§stats: BatchNormStats

Collected statistics.

Implementations§

Source§

impl TensorBatchNorm

Source

pub fn new(config: BatchNormConfig) -> Self

Construct a new TensorBatchNorm from a BatchNormConfig.

Source

pub fn set_mode(&mut self, mode: NormMode)

Switch the layer between training and inference mode.

Source

pub fn forward(&mut self, input: &[Vec<f64>]) -> Option<Vec<Vec<f64>>>

Run a forward pass through the batch normalisation layer.

  • input — a slice of rows, each of length num_features.

Returns None when:

  • input is empty, or
  • any row does not have exactly num_features elements.
Source

pub fn set_gamma(&mut self, gamma: Vec<f64>) -> bool

Replace the gamma (scale) parameters.

Returns false and leaves gamma unchanged when gamma.len() != num_features.

Source

pub fn set_beta(&mut self, beta: Vec<f64>) -> bool

Replace the beta (shift) parameters.

Returns false and leaves beta unchanged when beta.len() != num_features.

Source

pub fn stats(&self) -> &BatchNormStats

Borrow the accumulated statistics.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more