Skip to content

Commit f62341b

Browse files
authored
【Hackathon 6th No.3】为 Paddle 新增 ZeroPad1D / ZeroPad3D / block_diag API (#6651)
* ZeroPad1D and ZeroPad3D and block_diag docs * update * update * finish
1 parent ee74fd0 commit f62341b

File tree

5 files changed

+100
-0
lines changed

5 files changed

+100
-0
lines changed

docs/api/paddle/Tensor_cn.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3253,6 +3253,17 @@ signbit(x, name=None)
32533253

32543254
请参考 :ref:`cn_api_paddle_signbit`
32553255

3256+
block_diag(inputs, name=None)
3257+
:::::::::
3258+
3259+
根据 `inputs` 创建对角矩阵。
3260+
3261+
返回:对角矩阵 Tensor。
3262+
3263+
返回类型:Tensor
3264+
3265+
请参考 :ref:`cn_api_paddle_block_diag`
3266+
32563267
ormqr(x, tau, other, left=True, transpose=False)
32573268
:::::::::
32583269

docs/api/paddle/block_diag_cn.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _cn_api_paddle_block_diag:
2+
3+
block_diag
4+
-------------------------------
5+
6+
.. py:function:: paddle.block_diag(inputs, name=None)
7+
8+
根据 `inputs` 创建对角矩阵。
9+
10+
参数
11+
:::::::::
12+
- **inputs** (list|tuple) - 是一个 Tensor 列表或 Tensor 元组,其子项为 0、1、2 维的 Tensor 。数据类型为: `bool`、 `float16`、 `float32`、 `float64`、 `uint8`、 `int8`、 `int16`、 `int32`、 `int64`、 `bfloat16`、 `complex64`、 `complex128`。
13+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 `None`。
14+
15+
返回
16+
:::::::::
17+
18+
Tensor, 与 ``inputs`` 数据类型相同。
19+
20+
代码示例
21+
:::::::::
22+
23+
COPY-FROM: paddle.block_diag

docs/api/paddle/nn/Overview_cn.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,9 @@ Padding 层
108108
" :ref:`paddle.nn.Pad1D <cn_api_paddle_nn_Pad1D>` ", "一维填充层"
109109
" :ref:`paddle.nn.Pad2D <cn_api_paddle_nn_Pad2D>` ", "二维填充层"
110110
" :ref:`paddle.nn.Pad3D <cn_api_paddle_nn_Pad3D>` ", "三维填充层"
111+
" :ref:`paddle.nn.ZeroPad1D <cn_api_paddle_nn_ZeroPad1D>` ", "一维零填充层"
111112
" :ref:`paddle.nn.ZeroPad2D <cn_api_paddle_nn_ZeroPad2D>` ", "二维零填充层"
113+
" :ref:`paddle.nn.ZeroPad3D <cn_api_paddle_nn_ZeroPad3D>` ", "三维零填充层"
112114

113115
.. _activation_layers:
114116

docs/api/paddle/nn/ZeroPad1D_cn.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _cn_api_paddle_nn_ZeroPad1D:
2+
3+
ZeroPad1D
4+
-------------------------------
5+
.. py:class:: paddle.nn.ZeroPad1D(padding, data_format="NCL", name=None)
6+
7+
**ZeroPad1D**
8+
9+
按照 padding 属性对输入进行零填充。
10+
11+
参数
12+
:::::::::
13+
14+
- **padding** (Tensor | List[int] | int) - 如果输入数据类型为 int,则在所有待填充边界使用相同的填充,
15+
否则填充的格式为[pad_left, pad_right]。
16+
- **data_format** (str) - 指定输入的 format,可为 ``'NCL'`` 或者 ``'NLC'``,默认值为 ``'NCL'``,其中 `N` 是 batch size, `C` 是通道数, `L` 输入特征的长度。
17+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
18+
19+
返回
20+
::::::::::::
21+
22+
23+
形状
24+
:::::::::
25+
26+
- x(Tensor): ZeroPadD 层的输入,要求形状为 3-D,dtype 为 ``'float32'`` 或 ``'float64'``
27+
- output(Tensor):输出,形状为 3-D,dtype 与 ``'input'`` 相同
28+
29+
代码示例
30+
:::::::::
31+
32+
COPY-FROM: paddle.nn.ZeroPad1D

docs/api/paddle/nn/ZeroPad3D_cn.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _cn_api_paddle_nn_ZeroPad3D:
2+
3+
ZeroPad3D
4+
-------------------------------
5+
.. py:class:: paddle.nn.ZeroPad3D(padding, data_format="NCDHW", name=None)
6+
7+
**ZeroPad3D**
8+
9+
按照 padding 属性对输入进行零填充。
10+
11+
参数
12+
:::::::::
13+
14+
- **padding** (Tensor | List[int] | int) - 如果输入数据类型为 int,则在所有待填充边界使用相同的填充,
15+
否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。
16+
- **data_format** (str,可选) - 指定输入的 format,可为 ``'NCDHW'`` 或者 ``'NDHWC'``,默认值为 ``'NCDHW'``,其中 `N` 是批尺寸, `C` 是通道数, `D` 是特征层深度, `H` 是特征层高度, `W` 是特征层宽度。。
17+
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
18+
19+
返回
20+
::::::::::::
21+
22+
23+
形状
24+
:::::::::
25+
26+
- x(Tensor): ZeroPadD 层的输入,要求形状为 5-D,dtype 为 ``'float32'`` 或 ``'float64'``
27+
- output(Tensor):输出,形状为 5-D,dtype 与 ``'input'`` 相同
28+
29+
代码示例
30+
:::::::::
31+
32+
COPY-FROM: paddle.nn.ZeroPad3D

0 commit comments

Comments
 (0)