burn::nn::modules::norm

Enum NormalizationConfig

#[non_exhaustive]pub enum NormalizationConfig {
    Batch(BatchNormConfig),
    Group(GroupNormConfig),
    Instance(InstanceNormConfig),
    Layer(LayerNormConfig),
    Rms(RmsNormConfig),
}

Expand description

[‘Normalization’] Configuration.

The enum is non-exhaustive to prepare for future additions.

Can be used as a generic configuration for normalization layers:

Construct a config with arbitrary input features (we suggest 0).
Clone and match that config to the target input layer, using the NormalizationConfig::with_num_features() method.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Batch(BatchNormConfig)

[‘BatchNorm’] Configuration.

Group(GroupNormConfig)

[‘GroupNorm’] Configuration.

Instance(InstanceNormConfig)

[‘InstanceNorm’] Configuration.

Layer(LayerNormConfig)

[‘LayerNorm’] Configuration.

Rms(RmsNormConfig)

[‘RmsNorm’] Configuration.

Implementations§

impl NormalizationConfig

pub fn init<B>(&self, device: &<B as Backend>::Device) -> Normalization<B>
where B: Backend,

Initialize a [‘Norm’] layer.

pub fn with_num_features(self, num_features: usize) -> NormalizationConfig

Set the number of features.

pub fn num_features(&self) -> usize

Get the number of features.

Trait Implementations§

impl Clone for NormalizationConfig

fn clone(&self) -> NormalizationConfig

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Config for NormalizationConfig

fn save<P>(&self, file: P) -> Result<(), Error>
where P: AsRef<Path>,

Saves the configuration to a file. Read more

fn load<P>(file: P) -> Result<Self, ConfigError>
where P: AsRef<Path>,

Loads the configuration from a file. Read more

fn load_binary(data: &[u8]) -> Result<Self, ConfigError>

Loads the configuration from a binary buffer. Read more

impl Debug for NormalizationConfig

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for NormalizationConfig

fn deserialize<D>( deserializer: D, ) -> Result<NormalizationConfig, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for NormalizationConfig

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

Formats the value using the given formatter. Read more

impl From<BatchNormConfig> for NormalizationConfig

fn from(config: BatchNormConfig) -> NormalizationConfig

Converts to this type from the input type.

impl From<GroupNormConfig> for NormalizationConfig

fn from(config: GroupNormConfig) -> NormalizationConfig

Converts to this type from the input type.

impl From<InstanceNormConfig> for NormalizationConfig

fn from(config: InstanceNormConfig) -> NormalizationConfig

Converts to this type from the input type.

impl From<LayerNormConfig> for NormalizationConfig

fn from(config: LayerNormConfig) -> NormalizationConfig

Converts to this type from the input type.

impl From<RmsNormConfig> for NormalizationConfig

fn from(config: RmsNormConfig) -> NormalizationConfig

Converts to this type from the input type.

impl Serialize for NormalizationConfig

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for NormalizationConfig

impl RefUnwindSafe for NormalizationConfig

impl Send for NormalizationConfig

impl Sync for NormalizationConfig

impl Unpin for NormalizationConfig

impl UnwindSafe for NormalizationConfig

Blanket Implementations§

impl<T> Adaptor<()> for T

fn adapt(&self)

Adapt the type to be passed to a metric.

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

impl<T> ToCompactString for T
where T: Display,

fn try_to_compact_string(&self) -> Result<CompactString, ToCompactStringError>

Fallible version of [ToCompactString::to_compact_string()] Read more

fn to_compact_string(&self) -> CompactString

Converts the given value to a [CompactString]. Read more

impl<T> ToLine for T
where T: Display,

fn to_line(&self) -> Line<'_>

Converts the value to a [Line].

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToSpan for T
where T: Display,

fn to_span(&self) -> Span<'_>

Converts the value to a [Span].

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> ToText for T
where T: Display,

fn to_text(&self) -> Text<'_>

Converts the value to a [Text].

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

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

fn vzip(self) -> V

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> WasmNotSend for T
where T: Send,

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

impl<T> WasmNotSync for T
where T: Sync,