Document feedback

Question document fragment

When a question document fragment contains a formula, it is displayed as a space.

Submission type

issue

It's a little complicated...

I'd like to ask someone.

Please select the submission type

Problem type

Specifications and Common Mistakes

- Specifications and Common Mistakes:

- Misspellings or punctuation mistakes,incorrect formulas, abnormal display.

- Incorrect links, empty cells, or wrong formats.

- Chinese characters in English context.

- Minor inconsistencies between the UI and descriptions.

- Low writing fluency that does not affect understanding.

- Incorrect version numbers, including software package names and version numbers on the UI.

Usability

- Usability:

- Incorrect or missing key steps.

- Missing main function descriptions, keyword explanation, necessary prerequisites, or precautions.

- Ambiguous descriptions, unclear reference, or contradictory context.

- Unclear logic, such as missing classifications, items, and steps.

Correctness

- Correctness:

- Technical principles, function descriptions, supported platforms, parameter types, or exceptions inconsistent with that of software implementation.

- Incorrect schematic or architecture diagrams.

- Incorrect commands or command parameters.

- Incorrect code.

- Commands inconsistent with the functions.

- Wrong screenshots.

- Sample code running error, or running results inconsistent with the expectation.

Risk Warnings

- Risk Warnings:

- Lack of risk warnings for operations that may damage the system or important data.

Content Compliance

- Content Compliance:

- Contents that may violate applicable laws and regulations or geo-cultural context-sensitive words and expressions.

- Copyright infringement.

Please select the type of question

Problem description

Describe the bug so that we can quickly locate the problem.

Submit

Document feedback

mindspore.common.initializer

Initializer for cell parameters.

class mindspore.common.initializer.Constant(value)

Initialize a constant.

Parameters

value (Union[int, numpy.ndarray]) – The value to initialize.

Returns

Array, an array after being assigned.

class mindspore.common.initializer.HeNormal(negative_slope=0, mode=fan_in, nonlinearity=leaky_relu)

Initialize the array with He kaiming Normal algorithm, and from a normal distribution collect samples within N(0, sigma).

Parameters

• negative_slope (int, float, bool) – The negativa slope of the rectifier used after this layer (only used when nonlinearity is ‘leaky_relu’). Default: 0.

• mode (str) – Either ‘fan_in’ or ‘fan_out’. Choosing ‘fan_in’ preserves the magnitude of the variance of the weights in the forward pass. Choosing ‘fan_out’ preserves the magnitudes in the backwards pass. Default: fan_in.

• nonlinearity (str) – The non-linear function, recommended to use only with ‘relu’ or ‘leaky_relu’. Default: leaky_relu.

Returns

Array, assigned array.

class mindspore.common.initializer.HeUniform(negative_slope=0, mode=fan_in, nonlinearity=leaky_relu)

Initialize the array with He kaiming uniform algorithm, and from a uniform distribution collect samples within U[-boundary, boundary] The boundary is defined as:

$$boundary=\sqrt{\frac{6}{(1+a^2)\times \text{fan\_in}}}$$

Parameters

• negative_slope (int, float, bool) – The negativa slope of the rectifier used after this layer (only used when nonlinearity is ‘leaky_relu’). Default: 0.

• mode (str) – Either ‘fan_in’ or ‘fan_out’. Choosing ‘fan_in’ preserves the magnitude of the variance of the weights in the forward pass. Choosing ‘fan_out’ preserves the magnitudes in the backwards pass. Default: fan_in.

• nonlinearity (str) – The non-linear function, recommended to use only with ‘relu’ or ‘leaky_relu’. Default: leaky_relu.

Returns

Array, assigned array.

class mindspore.common.initializer.Initializer(**kwargs)

The base class of the initializer. Initialization of tensor basic attributes and model weight values.

Parameters

kwargs (dict) – Keyword arguments for Initializer.

Returns

Array, an array after being initialized.

class mindspore.common.initializer.Normal(sigma=0.01)

Initialize a normal array, and obtain values N(0, sigma) from the uniform distribution to fill the input tensor.

Parameters

sigma (float) – The sigma of the array. Default: 0.01.

Returns

Array, normal array.

class mindspore.common.initializer.One(**kwargs)

Initialize the array to one.

Parameters

arr (Array) – The array to be assigned.

Returns

Array, assigned array.

class mindspore.common.initializer.TruncatedNormal(sigma=0.01)

Initialize a truncated normal distribution which is a bounded normal distribution within N(low, high).

Parameters

sigma (float) – The sigma of the array. Default: 0.01.

Returns

Array, truncated normal array.

class mindspore.common.initializer.Uniform(scale=0.07)

Initialize a uniform array, and obtain values U(-scale, scale) from the uniform distribution to fill the input tensor.

Parameters

scale (float) – The scale of the array. Default: 0.07.

Returns

Array, uniform array.

class mindspore.common.initializer.XavierUniform(gain=1)

Initialize the array with xavier uniform algorithm, and from a uniform distribution collect samples within U[-boundary, boundary] The boundary is defined as:

$$boundary=gain\ast \sqrt{\frac{6}{n_{in}+n_{out}}}$$

• where $n_{in}$ is the number of input units in the weight tensor.

• where $n_{out}$ is the number of output units in the weight tensor.

Parameters

gain (float) – An optional scaling factor. Default: 1.

Returns

Array, assigned array.

class mindspore.common.initializer.Zero(**kwargs)

Initialize the array to zero.

Parameters

arr (Array) – The array to be assigned.

Returns

Array, an array after being assigned.

mindspore.common.initializer.initializer(init, shape=None, dtype=mindspore.float32)

Create and initialize a tensor.

Parameters

• init (Union[Tensor, str, Initializer, numbers.Number]) –

  Initialize value.

  • str: The init should be the alias of the class inheriting from Initializer and the corresponding class will be called.

  • Initializer: The init should be the class inheriting from Initializer to initialize tensor.

  • numbers.Number: The Constant will be called to initialize tensor.

• shape (Union[tuple, list, int]) – A list of integers, a tuple of integers or an integer as the shape of output. Default: None.

• dtype (mindspore.dtype) – The type of data in initialized tensor. Default: mindspore.float32.

Returns

Union[Tensor], return is Tensor object.

Examples

>>> import mindspore
>>> from mindspore.common.initializer import initializer, One
>>> tensor = initializer('ones', [1, 2, 3], mindspore.float32)
>>> tensor = initializer(One(), [1, 2, 3], mindspore.float32)
>>> tensor = initializer(0, [1, 2, 3], mindspore.float32)