Skip to main content

RmsNorm

Struct RmsNorm 

Source
pub struct RmsNorm<D: Dtype, IT, OT, const RANK: usize> {
    pub normalized_shape: Vec<usize>,
    pub eps: f64,
    pub affine: bool,
    /* private fields */
}
Expand description

Root Mean Square normalisation.

Normalises over the last normalized_shape.len() dimensions by dividing by the RMS (no mean subtraction): y = x / rms(x) * γ

Output shape equals input shape.

Parameters:

  • normalized_shape — axes to normalise over
  • eps — numerical stability constant (default 1e-8)
  • affine — if true, learns per-element γ (default true)

Fields§

§normalized_shape: Vec<usize>

The shape of the trailing axes to normalize over.

§eps: f64

Numerical stability constant.

§affine: bool

Whether to learn a per-element scale (gamma) parameter.

Implementations§

Source§

impl<D: Dtype, IT, OT, const RANK: usize> RmsNorm<D, IT, OT, RANK>

Source

pub fn new(normalized_shape: impl Into<Vec<usize>>) -> Self

Creates a new layer with default eps, affine on.

Source

pub fn with_eps(self, eps: f64) -> Self

Sets the numerical stability constant.

Source

pub fn with_affine(self, affine: bool) -> Self

Sets whether to learn a per-element scale parameter.

Trait Implementations§

Source§

impl<D: Dtype, IT: Tensor<D, RANK> + EagerTensor, OT: Tensor<D, RANK>, const RANK: usize> Layer<IT> for RmsNorm<D, IT, OT, RANK>

Source§

type Output = OT

This layer’s output type.
Source§

fn call(&self, _input: IT) -> Self::Output

Applies this layer to input.
Source§

impl<D: Dtype, const RANK: usize> Layer<SymTensor> for RmsNorm<D, SymTensor, SymTensor, RANK>

Source§

type Output = SymTensor

This layer’s output type.
Source§

fn call(&self, input: SymTensor) -> SymTensor

Applies this layer to input.

Auto Trait Implementations§

§

impl<D, IT, OT, const RANK: usize> Freeze for RmsNorm<D, IT, OT, RANK>

§

impl<D, IT, OT, const RANK: usize> RefUnwindSafe for RmsNorm<D, IT, OT, RANK>

§

impl<D, IT, OT, const RANK: usize> Send for RmsNorm<D, IT, OT, RANK>
where D: Send, IT: Send, OT: Send,

§

impl<D, IT, OT, const RANK: usize> Sync for RmsNorm<D, IT, OT, RANK>
where D: Sync, IT: Sync, OT: Sync,

§

impl<D, IT, OT, const RANK: usize> Unpin for RmsNorm<D, IT, OT, RANK>
where D: Unpin, IT: Unpin, OT: Unpin,

§

impl<D, IT, OT, const RANK: usize> UnsafeUnpin for RmsNorm<D, IT, OT, RANK>

§

impl<D, IT, OT, const RANK: usize> UnwindSafe for RmsNorm<D, IT, OT, RANK>
where D: UnwindSafe, IT: UnwindSafe, OT: UnwindSafe,

Blanket Implementations§

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.