Struct burn::nn::RmsNorm

pub struct RmsNorm<B>
where
    B: Backend,
{
    pub gamma: Param<Tensor<B, 1>>,
    pub epsilon: f64,
}

Applies RMS Normalization over an input tensor along the last dimension.

Y = X / sqrt(mean(X^2) + eps) * gamma

Where:

• X is the input tensor
• Y is the output tensor
• gamma is the learnable weight
• mean is the mean operation
• eps is a small value to avoid division by zero.

Should be created using the RmsNormConfig configuration.

Fields

gamma: Param<Tensor<B, 1>>

The learnable parameter to scale the normalized tensor

epsilon: f64

A value required for numerical stability

Implementations

impl<B> RmsNorm<B>

where B: Backend,

pub fn forward<const D: usize>(&self, x: Tensor<B, D>) -> Tensor<B, D>

Applies the forward pass on the input tensor.

See the RmsNorm documentation for more information.

Shapes

• input: [..., any, d_model]
• output: [..., any, d_model]

Trait Implementations

impl<B> AutodiffModule<B> for RmsNorm<B>

where B: Backend + AutodiffBackend, <B as AutodiffBackend>::InnerBackend: Backend,

type InnerModule = RmsNorm<<B as AutodiffBackend>::InnerBackend>

Inner module without auto-differentiation.

fn valid(&self) -> <RmsNorm<B> as AutodiffModule<B>>::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl<B> Clone for RmsNorm<B>

where B: Backend,

fn clone(&self) -> RmsNorm<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> Debug for RmsNorm<B>

where B: Debug + Backend,

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

Formats the value using the given formatter.

impl<B> Display for RmsNorm<B>

where B: Backend,

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

Formats the value using the given formatter.

impl<B> Module<B> for RmsNorm<B>

where B: Backend,

type Record = RmsNormRecord<B>

Type to save and load the module.

fn load_record(self, record: <RmsNorm<B> as Module<B>>::Record) -> RmsNorm<B>

Load the module state from a record.

fn into_record(self) -> <RmsNorm<B> as Module<B>>::Record

Convert the module into a record containing the state.

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

fn visit<Visitor>(&self, visitor: &mut Visitor)

where Visitor: ModuleVisitor<B>,

Visit each tensor parameter in the module with a visitor.

fn map<Mapper>(self, mapper: &mut Mapper) -> RmsNorm<B>

where Mapper: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.

fn collect_devices( &self, devices: Vec<<B as Backend>::Device>, ) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn to_device(self, device: &<B as Backend>::Device) -> RmsNorm<B>

Move the module and all of its sub-modules to the given device.

fn fork(self, device: &<B as Backend>::Device) -> RmsNorm<B>

Fork the module and all of its sub-modules to the given device.

fn devices(&self) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree without duplicates.

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Save the module to a file using the provided file recorder.

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder.

fn quantize_weights<C>(self, quantizer: &mut Quantizer<C>) -> Self

where C: Calibration,

Quantize the weights of the module.

impl<B> ModuleDisplay for RmsNorm<B>

where B: Backend,

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module.

fn custom_content(&self, content: Content) -> Option<Content>

Custom attributes for the module.

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings.

impl<B> ModuleDisplayDefault for RmsNorm<B>

where B: Backend,

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes.

fn num_params(&self) -> usize

Gets the number of the parameters of the module.