Initializers#

class ivy.stateful.initializers.Constant(constant)[source]#

Bases: Initializer

__init__(constant)[source]#

Constant initializer, will fill in all values with the value of constant.

Parameters:

constant (float) – Constant value for initialization.

create_variables(var_shape, device, fan_out=None, fan_in=None, dtype=None)[source]#

Create internal variables for the layer.

Parameters:

  • var_shape (Tuple[int, int]) –

    Tuple representing the shape of the desired array. If considering

    the array as a rectangular matrix, this tuple is represented as ‘(ROWS, COLUMNS)’.

  • device (Union[Device, NativeDevice]) – Device on which to create the layer’s variables ‘cuda:0’, ‘cuda:1’, ‘cpu’ etc. Default is cpu.

  • fan_out (Optional[float], default: None) – The number of nodes in the next layer.

  • fan_in (Optional[float], default: None) – The number of nodes in the previous layer.

  • dtype (Optional[Union[Dtype, NativeDtype]], default: None) – Desired data type.

Return type:

Array

class ivy.stateful.initializers.FirstLayerSiren[source]#

Bases: Uniform

__init__()[source]#

Initialize Siren uniform for the first layer.

It draws values from a uniform distribution [-limit, limit] where limit=fan_in where fan_in is the number of input features.

class ivy.stateful.initializers.GlorotUniform[source]#

Bases: Uniform

__init__()[source]#

Initialize Glorot uniform, also known as the Xavier uniform initializer.

It draws values from a uniform distribution [-limit, limit] where limit = sqrt(6 / (fan_in + fan_out)) where fan_in and fan_out are the number of input and output features respectively.

class ivy.stateful.initializers.Initializer[source]#

Bases: ABC

An initializer for internal variables for a layer.

A neuron is a function of the form a = g(z), where g is the activation functions and z = w_1x_1 + w_2x_2 + … + w_nx_n where the w_i are the weights and the x_i are the inputs. To prevent this z from vanishing (getting too small) or exploding (getting too big), the initial weights must be picked carefully.

abstract create_variables(var_shape, device, fan_out=None, fan_in=None, dtype=None)[source]#

Create internal variables for the layer.

Parameters:

  • var_shape (Tuple[int, int]) –

    Tuple representing the shape of the desired array. If considering

    the array as a rectangular matrix, this tuple is represented as ‘(ROWS, COLUMNS)’.

  • device (Union[Device, NativeDevice]) – Device on which to create the layer’s variables ‘cuda:0’, ‘cuda:1’, ‘cpu’ etc. Default is cpu.

  • fan_out (Optional[float], default: None) – The number of nodes in the next layer.

  • fan_in (Optional[float], default: None) – The number of nodes in the previous layer.

  • dtype (Optional[Union[Dtype, NativeDtype]], default: None) – Desired data type.

Return type:

Array

class ivy.stateful.initializers.KaimingNormal(mean=0, fan_mode='fan_in')[source]#

Bases: Initializer

__init__(mean=0, fan_mode='fan_in')[source]#

Initialize Kaiming normal, also known as He Initialization.

It is an method for initializing layers that takes into account the non-linearity of activation functions. It uses a normal distribution centered at mean with standard distribution sqrt(2 / ((1 + negative_slope^2) * fan)).

Parameters:

  • mean (default: 0) – Sets the expected value, average, and center of the normal distribution.

  • fan_mode (default: 'fan_in') –

    Determines how fan is calculated. - fan_out sets fan to the number of output features of this neuron.

    This is useful when training using back-propogation.

    • fan_in sets fan to the number of input features of this neuron. This is useful when training using forward-propogation.

    • fan_sum sets fan to the sum of the number of input features and output features of this neuron.

    • fan_sum sets fan to the average of the number of input features and output features of this neuron.

create_variables(var_shape, device, fan_out=None, fan_in=None, negative_slope=0.0, dtype=None)[source]#

Create internal variables for the layer.

Parameters:

  • var_shape –

    Tuple representing the shape of the desired array. If considering

    the array as a rectangular matrix, this tuple is represented as ‘(ROWS, COLUMNS)’.

  • device – Device on which to create the layer’s variables ‘cuda:0’, ‘cuda:1’, ‘cpu’ etc. Default is cpu.

  • fan_out (default: None) – The number of nodes in the next layer.

  • fan_in (default: None) – The number of nodes in the previous layer.

  • negative_slope (default: 0.0) – How much a higher fan should lower the standard deviation. A value of 0 gives a relationship proportional to 1/fan.

  • dtype (default: None) – Desired data type.

class ivy.stateful.initializers.Ones[source]#

Bases: Constant

__init__()[source]#

Constant initializer that fills with the constant value 1.0.

class ivy.stateful.initializers.RandomNormal(mean=0.0, stddev=0.05, seed=None)[source]#

Bases: Initializer

__init__(mean=0.0, stddev=0.05, seed=None)[source]#

Initialize with Random Normal Distribution.

It draws values from a Random Normal Distribution with given mean and standard deviation.

Parameters:

  • mean (default: 0.0) – Sets the expected value, average, and center of the normal distribution.

  • stddev (default: 0.05) – Sets the standard deviation of the normal distribution.

  • seed (default: None) – Used to create a random seed distribution.(Default:None)

create_variables(var_shape=None, device=None, dtype=None)[source]#

Create internal variables for the layer.

Parameters:

  • var_shape (default: None) –

    Tuple representing the shape of the desired array. If considering

    the array as a rectangular matrix, this tuple is represented as ‘(ROWS, COLUMNS)’.

  • device (default: None) – Device on which to create the layer’s variables ‘cuda:0’, ‘cuda:1’, ‘cpu’ etc. Default is cpu.

  • dtype (default: None) – Desired data type.

class ivy.stateful.initializers.Siren(w0=30)[source]#

Bases: Uniform

__init__(w0=30)[source]#

Initialize Siren uniform initializer for the first layer.

It draws values from a uniform distribution [-limit, limit] where limit=sqrt(6 / fan_in) / w0 where fan_in is the number of input features.

class ivy.stateful.initializers.Uniform(numerator, fan_mode, power, gain)[source]#

Bases: Initializer

__init__(numerator, fan_mode, power, gain)[source]#

Initialize based on a uniform distribution, will fill in all values with values drawn from a uniform (all values have an equal probability) distribution.

with range [-wlim, wlim] (endpoints included) with wlim being calculated as gain * (numerator / fan)**power. This distribution helps with issues when trying to optimize and train networks. The expected value of this distribution is 0 and the variance is (gain * numerator / fan)^power / 4.

This is intended as a base-class for special predefined initializers.

Parameters:

  • numerator –

  • fan_mode –

    Determines how fan is calculated. - fan_out sets fan to the number of output features of this neuron.

    This is useful when training using back-propogation.

    • fan_in sets fan to the number of input features of this neuron. This is useful when training using forward-propogation.

    • fan_sum sets fan to the sum of the number of input features and output features of this neuron.

    • fan_avg sets fan to the average of the number of input features and output features of this neuron.

  • power – Sets the drop-off factor for the calculated fan.

  • gain – Scales the output of the distribution.

create_variables(var_shape, device, fan_out=None, fan_in=None, dtype=None)[source]#

Create internal variables for the layer.

Parameters:

  • var_shape –

    Tuple representing the shape of the desired array. If considering

    the array as a rectangular matrix, this tuple is represented as ‘(ROWS, COLUMNS)’.

  • device – Device on which to create the layer’s variables ‘cuda:0’, ‘cuda:1’, ‘cpu’ etc. Default is cpu.

  • fan_out (default: None) – The number of nodes in the next layer.

  • fan_in (default: None) – The number of nodes in the previous layer.

  • dtype (default: None) – Desired data type.

class ivy.stateful.initializers.Zeros[source]#

Bases: Constant

__init__()[source]#

Constant initializer that fills with the constant value 0.0.

This should have hopefully given you an overview of the initializers submodule, if you have any questions, please feel free to reach out on our discord in the initializers channel!