Struct NormSpec 

#[non_exhaustive]
pub struct NormSpec { /* private fields */ }

Kind, eps and optional affine parameters of an ErasedNormPlan.

The optional weight (scale) and bias (shift) are vectors along the normalized axis, each with its own element stride; the result is y * weight + bias.

Examples

use strided_basic::{NormKind, NormSpec};
let spec = NormSpec::layer_norm(1e-5).with_weight(1).with_bias(-1);
assert_eq!(spec.kind(), NormKind::Layer);
assert_eq!(spec.eps(), 1e-5);
assert_eq!(spec.weight_stride(), Some(1));
assert_eq!(spec.bias_stride(), Some(-1));
assert_eq!(NormSpec::rms_norm(0.0).weight_stride(), None);

Implementations

impl NormSpec

pub const fn layer_norm(eps: f64) -> NormSpec

Layer normalization with the given eps and no affine parameters.

Examples

use strided_basic::{NormKind, NormSpec};
assert_eq!(NormSpec::layer_norm(1e-6).kind(), NormKind::Layer);

pub const fn rms_norm(eps: f64) -> NormSpec

RMS normalization with the given eps and no affine parameters.

Examples

use strided_basic::{NormKind, NormSpec};
assert_eq!(NormSpec::rms_norm(1e-6).kind(), NormKind::Rms);

pub const fn with_weight(self, stride: isize) -> NormSpec

Multiply by a weight vector with the given element stride.

Examples

use strided_basic::NormSpec;
assert_eq!(NormSpec::rms_norm(0.0).with_weight(2).weight_stride(), Some(2));

pub const fn with_bias(self, stride: isize) -> NormSpec

Add a bias vector with the given element stride.

Examples

use strided_basic::NormSpec;
assert_eq!(NormSpec::rms_norm(0.0).with_bias(1).bias_stride(), Some(1));

pub const fn kind(&self) -> NormKind

Normalization kind.

Examples

use strided_basic::{NormKind, NormSpec};
assert_eq!(NormSpec::rms_norm(0.0).kind(), NormKind::Rms);

pub const fn eps(&self) -> f64

The eps added to the variance (or mean square) before the square root.

Examples

use strided_basic::NormSpec;
assert_eq!(NormSpec::rms_norm(0.25).eps(), 0.25);

pub const fn weight_stride(&self) -> Option<isize>

Element stride of the weight vector, if any.

Examples

use strided_basic::NormSpec;
assert_eq!(NormSpec::layer_norm(0.0).weight_stride(), None);

pub const fn bias_stride(&self) -> Option<isize>

Element stride of the bias vector, if any.

Examples

use strided_basic::NormSpec;
assert_eq!(NormSpec::layer_norm(0.0).bias_stride(), None);

Trait Implementations

impl Clone for NormSpec

fn clone(&self) -> NormSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NormSpec

impl Debug for NormSpec

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

Formats the value using the given formatter.

impl PartialEq for NormSpec

fn eq(&self, other: &NormSpec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for NormSpec