Skip to content

Commit 598deb3

Browse files
[API Compatibility] add paddle.nn.init.* (PaddlePaddle#7382)
* add paddle.nn.init.* * fix * fix * fix * add init.* to overview
1 parent 4997b2c commit 598deb3

15 files changed

+215
-0
lines changed

docs/api/paddle/nn/Overview_cn.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -572,17 +572,30 @@ Embedding 相关函数
572572
" :ref:`paddle.nn.initializer.Assign <cn_api_paddle_nn_initializer_Assign>` ", "使用 Numpy 数组、Python 列表、Tensor 来初始化参数"
573573
" :ref:`paddle.nn.initializer.Bilinear <cn_api_paddle_nn_Bilinear>` ", "该接口为参数初始化函数,用于转置卷积函数中"
574574
" :ref:`paddle.nn.initializer.Constant <cn_api_paddle_nn_initializer_Constant>` ", "用于权重初始化,通过输入的 value 值初始化输入变量"
575+
" :ref:`paddle.nn.init.constant_ <cn_api_paddle_nn_init_constant_>` ", "函数式版本的 :ref:`paddle.nn.initializer.Constant <cn_api_paddle_nn_initializer_Constant>` API"
575576
" :ref:`paddle.nn.initializer.KaimingNormal <cn_api_paddle_nn_initializer_KaimingNormal>` ", "实现 Kaiming 正态分布方式的权重初始化"
577+
" :ref:`paddle.nn.init.kaiming_normal_ <cn_api_paddle_nn_init_kaiming_normal_>` ", "函数式版本的 :ref:`paddle.nn.initializer.KaimingNormal <cn_api_paddle_nn_initializer_KaimingNormal>` API"
576578
" :ref:`paddle.nn.initializer.KaimingUniform <cn_api_paddle_nn_initializer_KaimingUniform>` ", "实现 Kaiming 均匀分布方式的权重初始化"
579+
" :ref:`paddle.nn.init.kaiming_uniform_ <cn_api_paddle_nn_init_kaiming_uniform_>` ", "函数式版本的 :ref:`paddle.nn.initializer.KaimingUniform <cn_api_paddle_nn_initializer_KaimingUniform>` API"
577580
" :ref:`paddle.nn.initializer.Normal <cn_api_paddle_nn_initializer_Normal>` ", "随机正态(高斯)分布初始化函数"
581+
" :ref:`paddle.nn.init.normal_ <cn_api_paddle_nn_init_normal_>` ", "函数式版本的 :ref:`paddle.nn.initializer.Normal <cn_api_paddle_nn_initializer_Normal>` API"
578582
" :ref:`paddle.nn.initializer.set_global_initializer <cn_api_paddle_nn_initializer_set_global_initializer>` ", "用于设置 Paddle 框架中全局的参数初始化方法"
579583
" :ref:`paddle.nn.initializer.calculate_gain <cn_api_paddle_nn_initializer_calculate_gain>` ", "获取某些激活函数的推荐增益值(增益值可用于对某些初始化 API 进行设置,以调整初始化值)"
580584
" :ref:`paddle.nn.initializer.Dirac <cn_api_paddle_nn_initializer_Dirac>` ", "通过狄拉克 delta 函数来初始化 3D/4D/5D Tensor,一般用于卷积层,能最大程度保留卷积层输入的特性"
585+
" :ref:`paddle.nn.init.dirac_ <cn_api_paddle_nn_init_dirac_>` ", "函数式版本的 :ref:`paddle.nn.initializer.Dirac <cn_api_paddle_nn_initializer_Dirac>` API"
581586
" :ref:`paddle.nn.initializer.Orthogonal <cn_api_paddle_nn_initializer_Orthogonal>` ", "正交矩阵初始化方式,被初始化的参数为(半)正交的"
587+
" :ref:`paddle.nn.init.orthogonal_ <cn_api_paddle_nn_init_orthogonal_>` ", "函数式版本的 :ref:`paddle.nn.initializer.Orthogonal <cn_api_paddle_nn_initializer_Orthogonal>` API"
582588
" :ref:`paddle.nn.initializer.TruncatedNormal <cn_api_paddle_nn_initializer_TruncatedNormal>` ", "随机截断正态(高斯)分布初始化函数"
589+
" :ref:`paddle.nn.init.trunc_normal_ <cn_api_paddle_nn_init_trunc_normal_>` ", "函数式版本的 :ref:`paddle.nn.initializer.TruncatedNormal <cn_api_paddle_nn_initializer_TruncatedNormal>` API"
583590
" :ref:`paddle.nn.initializer.Uniform <cn_api_paddle_nn_initializer_Uniform>` ", "随机均匀分布初始化函数"
591+
" :ref:`paddle.nn.init.uniform_ <cn_api_paddle_nn_init_uniform_>` ", "函数式版本的 :ref:`paddle.nn.initializer.Uniform <cn_api_paddle_nn_initializer_Uniform>` API"
584592
" :ref:`paddle.nn.initializer.XavierNormal <cn_api_paddle_nn_initializer_XavierNormal>` ", "实现 Xavier 权重初始化方法( Xavier weight initializer)"
593+
" :ref:`paddle.nn.init.xavier_normal_ <cn_api_paddle_nn_init_xavier_normal_>` ", "函数式版本的 :ref:`paddle.nn.initializer.XavierNormal <cn_api_paddle_nn_initializer_XavierNormal>` API"
585594
" :ref:`paddle.nn.initializer.XavierUniform <cn_api_paddle_nn_initializer_XavierUniform>` ", "实现 Xavier 权重初始化方法( Xavier weight initializer)"
595+
" :ref:`paddle.nn.init.xavier_uniform_ <cn_api_paddle_nn_init_xavier_uniform_>` ", "函数式版本的 :ref:`paddle.nn.initializer.XavierUniform <cn_api_paddle_nn_initializer_XavierUniform>` API"
596+
" :ref:`paddle.nn.init.eye_ <cn_api_paddle_nn_init_eye_>` ", "将二维输入张量的值设置为单位矩阵"
597+
" :ref:`paddle.nn.init.ones_ <cn_api_paddle_nn_init_ones_>` ", "将输入张量的值设置为 1"
598+
" :ref:`paddle.nn.init.zeros_ <cn_api_paddle_nn_init_zeros_>` ", "将输入张量的值设置为 0"
586599

587600
.. _about_quantization:
588601

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. _cn_api_paddle_nn_init_calculate_gain:
2+
3+
calculate_gain
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.init.calculate_gain(nonlinearity, param=None)
7+
8+
返回给定非线性函数的推荐增益值。
9+
10+
参数
11+
::::::::::::
12+
13+
- **nonlinearity** (str) - 非线形函数的名称。
14+
- **param** (float,可选) - 某些非线性函数的可选参数。目前,该参数仅适用于'leaky_relu'。默认值:无(在公式中会自动计算为 0.01)。
15+
16+
返回
17+
::::::::::::
18+
19+
float 类型增益值。
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _cn_api_paddle_nn_init_constant_:
2+
3+
constant\_
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.init.constant_(tensor, val)
7+
8+
将输入张量的值设置为指定的常量,该操作会直接修改输入张量。
9+
10+
参数
11+
::::::::::::
12+
13+
- **tensor** (Tensor) - 输入张量。
14+
- **val** (float) - 指定的填充输入张量的常量。
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _cn_api_paddle_nn_init_dirac_:
2+
3+
dirac\_
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.init.dirac_(tensor, groups=1)
7+
8+
将输入张量的值设置为 Dirac delta 函数,该操作会直接修改输入张量。支持 3D、4D 和 5D 输入张量。
9+
10+
参数
11+
::::::::::::
12+
13+
- **tensor** (Tensor) - 输入张量。
14+
- **groups** (int,可选) - 输入张量的组数,默认值为 1。
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _cn_api_paddle_nn_init_eye_:
2+
3+
eye\_
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.init.eye_(tensor)
7+
8+
将二维输入张量的值设置为单位矩阵,该操作会直接修改输入张量。
9+
10+
参数
11+
::::::::::::
12+
13+
- **tensor** (Tensor) - 输入张量。
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _cn_api_paddle_nn_init_kaiming_normal_:
2+
3+
kaiming_normal\_
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.init.kaiming_normal_(tensor, a=0, mode='fan_in', nonlinearity='leaky_relu')
7+
8+
将输入张量的值设置为 Kaiming 正态分布的随机数,该操作会直接修改输入张量。
9+
10+
参数
11+
::::::::::::
12+
13+
- **tensor** (Tensor) - 输入张量。
14+
- **a** (float,可选) - 该层之后使用的修正函数的负斜率(仅在使用'leaky_relu'时使用),默认值为 0。
15+
- **mode** (str,可选) - 计算增益的方法,可选值为'fan_in'、'fan_out',默认值为'fan_in'。
16+
- **nonlinearity** (str,可选) - 非线性函数的名称,默认值为'leaky_relu'。
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _cn_api_paddle_nn_init_kaiming_uniform_:
2+
3+
kaiming_uniform\_
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.init.kaiming_uniform_(tensor, a=0, mode='fan_in', nonlinearity='leaky_relu')
7+
8+
将输入张量的值设置为 Kaiming 均匀分布的随机数,该操作会直接修改输入张量。
9+
10+
参数
11+
::::::::::::
12+
13+
- **tensor** (Tensor) - 输入张量。
14+
- **a** (float,可选) - 该层之后使用的修正函数的负斜率(仅在使用'leaky_relu'时使用),默认值为 0。
15+
- **mode** (str,可选) - 计算增益的方法,可选值为'fan_in'、'fan_out',默认值为'fan_in'。
16+
- **nonlinearity** (str,可选) - 非线性函数的名称,默认值为'leaky_relu'。
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _cn_api_paddle_nn_init_normal_:
2+
3+
normal\_
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.init.normal_(tensor, mean=0.0, std=1.0)
7+
8+
将输入张量的值设置为正态分布的随机数,该操作会直接修改输入张量。
9+
10+
参数
11+
::::::::::::
12+
13+
- **tensor** (Tensor) - 输入张量。
14+
- **mean** (float) - 正态分布的均值,默认值为 0.0。
15+
- **std** (float) - 正态分布的标准差,默认值为 1.0。
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _cn_api_paddle_nn_init_ones_:
2+
3+
ones\_
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.init.ones_(tensor)
7+
8+
将输入张量的值设置为 1,该操作会直接修改输入张量。
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _cn_api_paddle_nn_init_orthogonal_:
2+
3+
orthogonal\_
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.init.orthogonal_(tensor, gain=1)
7+
8+
将输入张量的值设置为截断的正态分布的随机数,该操作会直接修改输入张量。
9+
10+
参数
11+
::::::::::::
12+
13+
- **tensor** (Tensor) - 输入张量。
14+
- **gain** (float,可选) - 比例因子,默认值为 1.0。

0 commit comments

Comments
 (0)