Enum burn::nn::Initializer

pub enum Initializer {
    Constant {
        value: f64,
    },
    Ones,
    Zeros,
    Uniform {
        min: f64,
        max: f64,
    },
    Normal {
        mean: f64,
        std: f64,
    },
    KaimingUniform {
        gain: f64,
        fan_out_only: bool,
    },
    KaimingNormal {
        gain: f64,
        fan_out_only: bool,
    },
    XavierUniform {
        gain: f64,
    },
    XavierNormal {
        gain: f64,
    },
}

Enum specifying with what values a tensor should be initialized

Variants

Constant

Fills tensor with specified value everywhere

Fields

value: f64

The value to fill the tensor with

Ones

Fills tensor with 1s everywhere

Zeros

Fills tensor with 0s everywhere

Uniform

Fills tensor with values drawn uniformly between specified values

Fields

min: f64

The minimum value to draw from

max: f64

The maximum value to draw from

Normal

Fills tensor with values drawn from normal distribution with specified mean and std

Fields

mean: f64

The mean of the normal distribution

std: f64

The standard deviation of the normal distribution

KaimingUniform

Fills tensor with values according to the uniform version of Kaiming initialization

Fields

gain: f64

The gain to use in initialization formula

fan_out_only: bool

Whether to use fan out only in initialization formula

KaimingNormal

Fills tensor with values according to the uniform version of Kaiming initialization

Fields

gain: f64

The gain to use in initialization formula

fan_out_only: bool

Whether to use fan out only in initialization formula

XavierUniform

Fills tensor with values according to the uniform version of Xavier Glorot initialization described in Understanding the difficulty of training deep feedforward neural networks

Fields

gain: f64

The gain to use in initialization formula

XavierNormal

Fills tensor with values according to the normal version of Xavier Glorot initialization described in Understanding the difficulty of training deep feedforward neural networks

Fields

gain: f64

The gain to use in initialization formula

Implementations

impl Initializer

pub fn init<B, const D: usize, S>( &self, shape: S, device: &<B as Backend>::Device, ) -> Param<Tensor<B, D>>

where B: Backend, S: Into<Shape>,

Inits a tensor parameter of given shape with values depending on initializer kind.

Params

• shape: Shape of the initiated tensor.

pub fn init_with<B, const D: usize, S>( &self, shape: S, fan_in: Option<usize>, fan_out: Option<usize>, device: &<B as Backend>::Device, ) -> Param<Tensor<B, D>>

where B: Backend, S: Into<Shape>,

Inits a tensor parameter of given shape with values depending on initializer kind.

Params

• shape: Shape of the initiated tensor.

Trait Implementations

impl Clone for Initializer

fn clone(&self) -> Initializer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Config for Initializer

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

where P: AsRef<Path>,

Saves the configuration to a file.

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

where P: AsRef<Path>,

Loads the configuration from a file.

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

Loads the configuration from a binary buffer.

impl Debug for Initializer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Initializer

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Initializer

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

Formats the value using the given formatter.

impl PartialEq for Initializer

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Initializer

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.

impl StructuralPartialEq for Initializer