Files
paddlepaddle--paddle/python/paddle/nn/initializer/normal.py
T
2026-07-13 12:40:42 +08:00

409 lines
14 KiB
Python

# Copyright (c) 2020 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
import paddle
from paddle import _C_ops, pir
from ...base import core, framework, unique_name
from ...base.data_feeder import check_variable_and_dtype
from ...base.framework import (
_current_expected_place,
in_dygraph_mode,
in_pir_mode,
)
from .initializer import Initializer
from .lazy_init import lazy_init_helper
__all__ = []
class NormalInitializer(Initializer):
"""Implements the Random Normal(Gaussian) distribution initializer
Args:
loc (float|complex, optional): mean of the normal distribution. Default is 0.0.
scale (float, optional): standard deviation of the normal distribution. Default is 1.0.
seed (int, optional): random seed. Default is 0.
"""
def __init__(
self, loc: float = 0.0, scale: float = 1.0, seed: int = 0
) -> None:
assert loc is not None
assert scale is not None
assert seed is not None
super().__init__()
self._mean = loc
self._std_dev = scale
self._seed = seed
if isinstance(self._mean, complex):
if self._mean.real != self._mean.imag:
raise ValueError(
"if mean is a complex number, its real part should equal imag part, "
f"but got real part: {self._mean.real} != imag part: {self._mean.imag}"
)
self._mean = self._mean.real
def forward(
self, var: paddle.Tensor, block: pir.Block | None = None
) -> paddle.Tensor | None:
"""Initialize the input tensor with Normal distribution.
Args:
var(Tensor): Tensor that needs to be initialized.
block(Block|None, optional): The block in which initialization ops
should be added. Used in static graph only, default None.
Returns:
The initialization op.
"""
assert not (
isinstance(var, framework.EagerParamBase) and var.is_dist()
), "Currently, normal initializer not support lazy init for dist param."
block = self._check_block(block)
assert isinstance(block, (framework.Block, pir.Block))
check_variable_and_dtype(
var,
"Out",
[
"uint16",
"float16",
"float32",
"float64",
"complex64",
"complex128",
],
"gaussian_random",
)
if self._seed == 0:
self._seed = block.program.random_seed
if in_dygraph_mode():
place = _current_expected_place()
out_var = _C_ops.gaussian(
var.shape,
self._mean,
self._std_dev,
self._seed,
var.dtype,
place,
)
out_var._share_underline_tensor_to(var)
return None
elif in_pir_mode():
place = _current_expected_place()
out_var = _C_ops.gaussian(
var.shape,
self._mean,
self._std_dev,
self._seed,
var.dtype,
place,
)
return out_var
else:
op = block.append_op(
type="gaussian_random",
outputs={"Out": var},
attrs={
"shape": var.shape,
"dtype": var.dtype,
"mean": self._mean,
"std": self._std_dev,
"seed": self._seed,
},
stop_gradient=True,
)
var.op = op
return op
class Normal(NormalInitializer):
"""The Random Normal (Gaussian) distribution initializer.
Args:
mean (float|complex, optional): mean of the normal distribution. Default is 0.0.
std (float, optional): standard deviation of the normal distribution. Default is 1.0.
name(str|None, optional): The default value is None. Normally there is no need for user to set this
property. For more information, please refer to :ref:`api_guide_Name`. Default: None.
Returns:
A parameter initialized by Random Normal (Gaussian) distribution.
Examples:
.. code-block:: pycon
>>> import paddle
>>> data = paddle.ones(shape=[3, 1, 2], dtype='float32')
>>> weight_attr = paddle.framework.ParamAttr(
... name="linear_weight",
... initializer=paddle.nn.initializer.Normal(mean=0.0, std=2.0),
... )
>>> bias_attr = paddle.framework.ParamAttr(
... name="linear_bias",
... initializer=paddle.nn.initializer.Normal(mean=0.0, std=2.0),
... )
>>> # doctest: +SKIP('name has been used')
>>> linear = paddle.nn.Linear(2, 2, weight_attr=weight_attr, bias_attr=bias_attr)
>>> print(linear.weight)
Parameter containing:
Tensor(shape=[2, 2], dtype=float32, place=Place(cpu), stop_gradient=False,
[[ 2.1973135 -2.2697184],
[-1.9104223 -1.0541488]])
>>> print(linear.bias)
Parameter containing:
Tensor(shape=[2], dtype=float32, place=Place(cpu), stop_gradient=False,
[ 0.7885926 -0.74719954])
>>> res = linear(data)
>>> print(res)
Tensor(shape=[3, 1, 2], dtype=float32, place=Place(cpu), stop_gradient=False,
[[[ 1.0754838 -4.071067 ]],
[[ 1.0754838 -4.071067 ]],
[[ 1.0754838 -4.071067 ]]])
"""
def __init__(
self, mean: float = 0.0, std: float = 1.0, name: str | None = None
) -> None:
assert mean is not None, 'mean should not be None'
assert std is not None, 'std should not be None'
super().__init__(loc=mean, scale=std, seed=0)
class TruncatedNormalInitializer(Initializer):
"""Implements the Random TruncatedNormal(Gaussian) distribution initializer
Note:
It is better to set `a <= mean <= b`.
If `mean < a - 2*std` or `mean > b + 2*std`, the distribution of values may be incorrect.
Args:
loc (float, optional): Mean of the normal distribution. Default is :math:`0.0`.
scale (float, optional): Standard deviation of the normal distribution. Default is :math:`1.0`.
seed (int, optional): random seed. Default is 0.
a (float, optional): The minimum cutoff value. Default is -2.0.
b (float, optional): The maximum cutoff value. Default is 2.0.
"""
def __init__(
self,
loc: float = 0.0,
scale: float = 1.0,
seed: int = 0,
a: float = -2.0,
b: float = 2.0,
) -> None:
assert loc is not None
assert scale is not None
assert seed is not None
assert a is not None
assert b is not None
super().__init__()
self._mean = loc
self._std_dev = scale
self._seed = seed
self._a = a
self._b = b
def forward(
self, var: paddle.Tensor, block: pir.Block | None = None
) -> paddle.Tensor | None:
"""Initialize the input tensor with TruncatedNormal distribution.
Args:
var(Tensor): Tensor that needs to be initialized.
block(Block|None, optional): The block in which initialization ops
should be added. Used in static graph only, default None.
Returns:
The initialization op
"""
block = self._check_block(block)
if lazy_init_helper().state:
expected = (
framework.Variable,
paddle.pir.core.ParameterMeta,
core.eager.Tensor,
)
else:
expected = (
framework.Variable,
paddle.pir.Value,
paddle.pir.core.ParameterMeta,
)
assert isinstance(var, expected)
assert isinstance(block, (framework.Block, pir.Block))
if self._seed == 0:
self._seed = block.program.random_seed
# to be compatible of fp16 initializers
if var.dtype in [core.VarDesc.VarType.FP16, core.VarDesc.VarType.BF16]:
out_dtype = core.VarDesc.VarType.FP32
out_var = block.create_var(
name=unique_name.generate(
".".join(['truncated_gaussian_random', var.name, 'tmp'])
),
shape=var.shape,
dtype=out_dtype,
type=core.VarDesc.VarType.DENSE_TENSOR,
persistable=False,
)
else:
out_dtype = var.dtype
out_var = var
if in_dygraph_mode():
out_var = _C_ops.truncated_gaussian_random(
var.shape,
self._mean,
self._std_dev,
self._seed,
self._a,
self._b,
out_dtype,
_current_expected_place(),
)
if var.dtype in [
core.VarDesc.VarType.FP16,
core.VarDesc.VarType.BF16,
]:
var_tmp = _C_ops.cast(out_var, var.dtype)
var_tmp._share_underline_tensor_to(var)
else:
out_var._share_underline_tensor_to(var)
return None
elif in_pir_mode():
out_var = _C_ops.truncated_gaussian_random(
var.shape,
self._mean,
self._std_dev,
self._seed,
self._a,
self._b,
out_dtype,
_current_expected_place(),
)
if var.dtype in [
core.VarDesc.VarType.FP16,
core.VarDesc.VarType.BF16,
]:
var_tmp = _C_ops.cast(out_var, var.dtype)
var_tmp._share_underline_tensor_to(var)
return out_var
else:
op = block.append_op(
type="truncated_gaussian_random",
outputs={"Out": out_var},
attrs={
"shape": var.shape,
"dtype": out_dtype,
"mean": self._mean,
"std": self._std_dev,
"seed": self._seed,
"a": self._a,
"b": self._b,
},
stop_gradient=True,
)
if var.dtype in [
core.VarDesc.VarType.FP16,
core.VarDesc.VarType.BF16,
]:
block.append_op(
type="cast",
inputs={"X": out_var},
outputs={"Out": var},
attrs={"in_dtype": out_var.dtype, "out_dtype": var.dtype},
)
var.op = op
return op
class TruncatedNormal(TruncatedNormalInitializer):
"""The truncated normal distribution (Gaussian distribution) initializer.
Note:
It is better to set `a <= mean <= b`.
If `mean < a - 2*std` or `mean > b + 2*std`, the distribution of values may be incorrect.
Args:
mean (float, optional): Mean of the normal distribution. Default is :math:`0.0`.
std (float, optional): Standard deviation of the normal distribution. Default is :math:`1.0`.
a (float, optional): The minimum cutoff value. Default is -2.0.
b (float, optional): The maximum cutoff value. Default is 2.0.
name (str|None, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.
Returns:
A parameter initialized by truncated normal distribution (Gaussian distribution).
Examples:
.. code-block:: pycon
>>> import paddle
>>> data = paddle.ones(shape=[3, 1, 2], dtype='float32')
>>> weight_attr = paddle.framework.ParamAttr(
... name="linear_weight",
... initializer=paddle.nn.initializer.TruncatedNormal(mean=0.0, std=2.0),
... )
>>> bias_attr = paddle.framework.ParamAttr(
... name="linear_bias",
... initializer=paddle.nn.initializer.TruncatedNormal(mean=0.0, std=2.0),
... )
>>> # doctest: +SKIP('name has been used')
>>> linear = paddle.nn.Linear(2, 2, weight_attr=weight_attr, bias_attr=bias_attr)
>>> print(linear.weight)
Parameter containing:
Tensor(shape=[2, 2], dtype=float32, place=Place(cpu), stop_gradient=False,
[[-1.0981836 1.4140984],
[ 3.1390522 -2.8266568]])
>>> print(linear.bias)
Parameter containing:
Tensor(shape=[2], dtype=float32, place=Place(cpu), stop_gradient=False,
[ -2.1546738 -1.6570673])
>>> res = linear(data)
>>> print(res)
Tensor(shape=[3, 1, 2], dtype=float32, place=Place(cpu), stop_gradient=False,
[[[-0.11380529 -3.0696259 ]],
[[-0.11380529 -3.0696259 ]],
[[-0.11380529 -3.0696259 ]]])
"""
def __init__(
self,
mean: float = 0.0,
std: float = 1.0,
a: float = -2.0,
b: float = 2.0,
name: str | None = None,
) -> None:
assert mean is not None, 'mean should not be None'
assert std is not None, 'std should not be None'
assert a is not None, 'a should not be None'
assert b is not None, 'b should not be None'
super().__init__(loc=mean, scale=std, seed=0, a=a, b=b)