Skip to content
Merged
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
75803c7
Merge pull request #2 from PaddlePaddle/develop
Liyulingyue May 22, 2022
2f34cea
Merge pull request #3 from PaddlePaddle/develop
Liyulingyue Aug 6, 2022
314d758
Update irfftn_cn.rst
Liyulingyue Aug 7, 2022
43372b8
Update irfftn_cn.rst
Liyulingyue Aug 7, 2022
e64da3e
Update rfft_cn.rst
Liyulingyue Aug 7, 2022
ae876d4
Update rfftfreq_cn.rst
Liyulingyue Aug 7, 2022
2cc9446
Update rfftfreq_cn.rst
Liyulingyue Aug 7, 2022
998992b
Update rfftfreq_cn.rst
Liyulingyue Aug 7, 2022
e34f38e
Update random_split_cn.rst
Liyulingyue Aug 7, 2022
8a12d69
Update rfft_cn.rst
Liyulingyue Aug 23, 2022
ec5f98a
Update rfft_cn.rst
Liyulingyue Aug 23, 2022
3fa6dc9
Update rfftfreq_cn.rst
Liyulingyue Aug 23, 2022
5038585
Update rfft_cn.rst
Liyulingyue Aug 23, 2022
e1ee632
Update Embedding_cn.rst
Liyulingyue Aug 23, 2022
a7e51b9
Update embedding_cn.rst
Liyulingyue Aug 23, 2022
44e75b1
Update embedding_cn.rst
Liyulingyue Aug 23, 2022
008f12f
Update embedding_cn.rst
Liyulingyue Aug 23, 2022
b0fc29b
Update embedding_cn.rst
Liyulingyue Aug 23, 2022
8087605
Update Fold_cn.rst
Liyulingyue Aug 23, 2022
cb327ea
Update Fold_cn.rst
Liyulingyue Aug 23, 2022
39d4050
Update fold_cn.rst
Liyulingyue Aug 23, 2022
5e02ba0
Update GELU_cn.rst
Liyulingyue Aug 23, 2022
ed3152a
Update gelu_cn.rst
Liyulingyue Aug 23, 2022
5ba5d75
Update hardshrink_cn.rst
Liyulingyue Aug 23, 2022
c63d24d
delete the '该OP'
Liyulingyue Aug 23, 2022
f80b542
Update irfftn_cn.rst
Ligoml Aug 24, 2022
9ec2474
Update fft_cn.rst
Ligoml Aug 24, 2022
86510b7
Update irfftn_cn.rst
Ligoml Aug 24, 2022
f95cc12
Update hfftn_cn.rst
Ligoml Aug 24, 2022
cc387aa
Update Subset_cn.rst
Ligoml Aug 25, 2022
0c3ff6c
Update one_hot_cn.rst
Ligoml Aug 25, 2022
7db1533
Update adaptive_pool2d_cn.rst
Ligoml Aug 25, 2022
6e1a13f
Update adaptive_pool3d_cn.rst
Ligoml Aug 25, 2022
78dd982
Update adaptive_pool3d_cn.rst
Ligoml Aug 25, 2022
0a2dadb
Update DetectionMAP_cn.rst
Ligoml Aug 25, 2022
f29be76
Update NumpyArrayInitializer_cn.rst
Ligoml Aug 25, 2022
449a1ee
Update data_cn.rst
Ligoml Aug 25, 2022
27fe225
Update save_params_cn.rst
Ligoml Aug 25, 2022
83df8c0
Update DetectionMAP_cn.rst
Ligoml Aug 25, 2022
fa393fa
Update data_cn.rst
Ligoml Aug 25, 2022
e7f8a8e
Update save_persistables_cn.rst
Ligoml Aug 25, 2022
7c79f6e
Update data_cn.rst
Ligoml Aug 25, 2022
39594bf
Update data_cn.rst
Ligoml Aug 25, 2022
18ac010
Update Fold_cn.rst
Ligoml Aug 25, 2022
cfb93bb
Update fold_cn.rst
Ligoml Aug 25, 2022
23fe4f0
Update data_cn.rst
Ligoml Aug 25, 2022
069e5de
Update data_cn.rst
Ligoml Aug 25, 2022
84d8d02
Update fold_cn.rst
Ligoml Aug 25, 2022
1e372e7
Update Fold_cn.rst
Ligoml Aug 25, 2022
da3b8fb
Update Fold_cn.rst
Ligoml Aug 25, 2022
79c60c0
Update fold_cn.rst
Ligoml Aug 25, 2022
ddd5f02
Update Fold_cn.rst
Liyulingyue Aug 25, 2022
0a34288
Update Fold_cn.rst
Liyulingyue Aug 25, 2022
d26a7a8
Update Fold_cn.rst
Liyulingyue Aug 25, 2022
2e6352c
Update Fold_cn.rst
Liyulingyue Aug 25, 2022
34ebfec
Update Fold_cn.rst
Liyulingyue Aug 25, 2022
4ee20a4
Update fold_cn.rst
Ligoml Aug 26, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions docs/api/paddle/fft/fft_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@ fft
:::::::::

- **x** (Tensor) - 输入 Tensor,数据类型为实数或复数。
- **n** (int,可选) - 输出 Tensor 中傅里叶变换轴的长度。如果 ``n`` 比输入 Tensor 中对应
轴的长度小,输入数据会被截断。如果 ``n`` 比输入 Tensor 中对应轴的长度大,则输入会被补零
。如果 ``n`` 没有被指定,则使用输入 Tensor 中由 ``axis`` 指定的轴的长度。
- **n** (int,可选) - 输出 Tensor 中傅里叶变换轴的长度。如果 ``n`` 比输入 Tensor 中对应轴的长度小,输入数据会被截断。如果 ``n`` 比输入 Tensor 中对应轴的长度大,则输入会被补零。如果 ``n`` 没有被指定,则使用输入 Tensor 中由 ``axis`` 指定的轴的长度。
- **axis** (int,可选) - 傅里叶变换的轴。如果没有指定,默认使用最后一维。
- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取
值必须是 "forward","backward","ortho" 之一,默认值为 "backward"。三种缩放模式对应
Expand All @@ -31,8 +29,7 @@ fft
返回
:::::::::

Tensor,形状和输入 Tensor 相同,数据类型为复数。由输入 Tensor(可能被截断或者补零之后)在指
定维度进行傅里叶变换的输出。
Tensor,形状和输入 Tensor 相同,数据类型为复数。由输入 Tensor(可能被截断或者补零之后)在指定维度进行傅里叶变换的输出。

代码示例
:::::::::
Expand Down
8 changes: 3 additions & 5 deletions docs/api/paddle/fft/hfftn_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@ hfftn
输入 Tensor 的长度大于 ``s[-1]//2+1``,输入 Tensor 会被截断。如果输入 Tensor 的长度
小于 ``s[-1]//2+1``,则输入 Tensor 会被补零;

对于傅里变换其他每一个轴 ``i``,如果输入 Tensor 的长度大于 ``s[i]``,输入 Tensor 会
被截断。如果输入 Tensor 的长度小于 ``s[i]``,则输入 Tensor 会被补零;

如果未指定 `s`,则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``,其中 ``m`` 是输入
Tensor 在最后一个傅里叶变换轴的长度,其余轴为输入 Tensor 在该轴的长度。
- 对于傅里变换其他每一个轴 ``i``,如果输入 Tensor 的长度大于 ``s[i]``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[i]``,则输入 Tensor 会被补零;
- 如果未指定 `s`,则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``,其中 ``m`` 是输入 Tensor 在最后一个傅里叶变换轴的长度,其余轴为输入 Tensor 在该轴的长度。

- **axes** (Sequence[int],可选) - 计算快速傅里叶变换的轴。如果没有指定,默认是使用最
后 ``len(s)`` 个轴,如果 ``s`` 也没有指定则使用输入数据的全部的轴。
- **norm** (str,可选) - 指定傅里叶变换的缩放模式,缩放系数由变换的方向和模式同时决定。取
Expand Down
16 changes: 7 additions & 9 deletions docs/api/paddle/fft/irfftn_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ irfftn

通过快速傅里叶变换(FFT)算法计算 N 维实数傅里叶变换 (rfftn)的逆变换。

该函数通过快速傅立叶变换(FFT)计算M-D矩阵中任意轴上实输入的N-D离散傅立叶变换的逆。即,在计算精度内 ``irfftn(rfftn(x), x.shape) == x`` 成立。( ``x.shape`` 的信息是必要的,其存在原因与 `irfft` 中的 ``len(x)`` 相同)。

此函数输入的排序方式应与rfftn返回的方式相同。

参数
:::::::::
Expand All @@ -15,15 +18,10 @@ irfftn
- **s** (Sequence[int],可选) - 输出 Tensor 在每一个傅里叶变换轴上的长度(类似一维傅里
叶变换中的参数 ``n``)。

对于傅里叶变换的最后一个轴,输入长度要求是 ``s[-1]//2+1``,如果输入 Tensor 的长度大于
``s[-1]//2+1``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[-1]//2+1``,
则输入 Tensor 会被补零;

对于傅里变换其他每一个轴 ``i``,如果输入 Tensor 的长度大于 ``s[i]``,输入 Tensor 会
被截断。如果输入 Tensor 的长度小于 ``s[i]``,则输入 Tensor 会被补零;

如果未指定 `s`,则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``,其中 ``m`` 是输
入 Tensor 在最后一个傅里叶变换轴的长度,其余轴为输入 Tensor 在该轴的长度。
- 对于傅里叶变换的最后一个轴,输入长度要求是 ``s[-1]//2+1``,如果输入 Tensor 的长度大于``s[-1]//2+1``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[-1]//2+1``,则输入 Tensor 会被补零;
- 对于傅里变换其他每一个轴 ``i``,如果输入 Tensor 的长度大于 ``s[i]``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[i]``,则输入 Tensor 会被补零;
- 如果未指定 `s`,则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``,其中 ``m`` 是输入 Tensor 在最后一个傅里叶变换轴的长度,其余轴为输入 Tensor 在该轴的长度。

- **axes** (Sequence[int],可选) - 计算快速傅里叶变换的轴。如果没有指定,默认是使用最后
``len(s)`` 个轴,如果 ``s`` 也没有指定则使用输入数据的全部的轴。
- **norm** (str,可选) - 指定傅里叶变换的缩放模式,缩放系数由变换的方向和模式同时决定。取
Expand Down
9 changes: 4 additions & 5 deletions docs/api/paddle/fft/rfft_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ rfft

通过快速傅里叶变换(FFT)算法计算一维实数傅里叶变换。

当输入是实数时,输出是厄米特对称的。由于该函数不计算负频率项,因此输出的变换轴长度为 ``n//2 + 1`` 。


参数
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

一些多余的空格

:::::::::
Expand All @@ -16,9 +18,7 @@ rfft
的长度小,输入数据会被截断。如果 ``n`` 比输入 Tensor 中对应轴的长度大,则输入会被补零。如果
``n`` 没有被指定,则使用输入 Tensor 中由 ``axis`` 指定的轴的长度。
- **axis** (int,可选) - 傅里叶变换的轴。如果没有指定,默认使用最后一维。
- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取值必
须是 "forward","backward","ortho" 之一,默认值为 "backward"。三种缩放模式对应的行为
如下:
- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取值必须是 "forward","backward","ortho" 之一,默认值为 "backward"。三种缩放模式对应的行为如下:

- "backward":正向和逆向变换的缩放系数分别为 ``1`` 和 ``1/n``;
- "forward":正向和逆向变换的缩放系数分别为 ``1/n`` 和 ``1``;
Expand All @@ -29,8 +29,7 @@ rfft

返回
:::::::::
Tensor,数据类型为复数。由输入 Tensor(可能被截断或者补零之后)在指定
维度进行傅里叶变换的输出,傅里叶变换轴的输出长度为 ``(n//2)+1``,其余轴长度与输入一致。
Tensor,数据类型为复数。

代码示例
:::::::::
Expand Down
7 changes: 4 additions & 3 deletions docs/api/paddle/fft/rfftfreq_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ rfftfreq
返回离散傅里叶变换的频率窗口(frequency bins)中心,以 "循环/采样间隔" 为单位。例如,采样间
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

一些多余的空格

隔以秒为单位,则频谱的单位是 "循环/秒"。用于 ``rfft`` 和 ``irfft``。

对于窗口长度 n 和采样间隔 d,输出的频率序列 f 排布如下::
对于窗口长度 n 和采样间隔 d,输出的频率序列 f 排布如下:

.. code-block:: text

f = [0, 1, ..., n/2-1, n/2] / (d*n) (当 n 为偶数)
f = [0, 1, ..., (n-1)/2-1, (n-1)/2] / (d*n) (当 n 为奇数)
Expand All @@ -26,8 +28,7 @@ rfftfreq
返回
:::::::::

Tensor,形状为 ``[n // 2 + 1]``,数据类型为 ``dtype`` 指定的数据类型,包含频率窗口中心序
列。
Tensor,形状为 ``[n // 2 + 1]``,数据类型为 ``dtype`` 指定的数据类型,包含频率窗口中心序列。

代码示例
:::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/fluid/data_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ data



该OP会在全局block中创建变量(Variable),该全局变量可被计算图中的算子(operator)访问。该变量可作为占位符用于数据输入。例如用执行器(Executor)feed数据进该变量
在全局block中创建变量(Variable),该全局变量可被计算图中的算子(operator)访问。该变量可作为占位符用于数据输入。例如用执行器(Executor)feed数据进该变量

注意:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/fluid/evaluator/DetectionMAP_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ DetectionMAP



该OP用于计算检测网络的平均精度(mAP)。 mAP是衡量object detectors精度的指标,比如 Faster R-CNN,SSD等。它不同于召回率,它是最大精度的平均值。
用于计算检测网络的平均精度(mAP)。 mAP是衡量object detectors精度的指标,比如 Faster R-CNN,SSD等。它不同于召回率,它是最大精度的平均值。

通常步骤如下:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ NumpyArrayInitializer



该OP使用Numpy型数组来初始化参数变量
使用Numpy型数组来初始化参数变量

参数
::::::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/fluid/io/save_params_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ save_params



该OP从 ``main_program`` 中取出所有参数,然后将它们保存到 ``dirname`` 目录下或名为 ``filename`` 的文件中。
``main_program`` 中取出所有参数,然后将它们保存到 ``dirname`` 目录下或名为 ``filename`` 的文件中。

``dirname`` 用于指定保存参数的目标路径。若想将参数保存到多个独立文件中,设置 ``filename=None``;若想将所有参数保存在单个文件中,请设置 ``filename`` 来指定该文件的名称。

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/fluid/io/save_persistables_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ save_persistables



该OP从给定 ``main_program`` 中取出所有持久性变量(详见 :ref:`api_guide_model_save_reader` ),然后将它们保存到目录 ``dirname`` 中或 ``filename`` 指定的文件中。
从给定 ``main_program`` 中取出所有持久性变量(详见 :ref:`api_guide_model_save_reader` ),然后将它们保存到目录 ``dirname`` 中或 ``filename`` 指定的文件中。

``dirname`` 用于指定保存持久性变量的目录。如果想将持久性变量保存到指定目录的若干文件中,请设置 ``filename=None``;若想将所有持久性变量保存在同一个文件中,请设置 ``filename`` 来指定文件的名称。

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/fluid/layers/adaptive_pool2d_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ adaptive_pool2d



该OP使用上述输入参数的池化配置,为二维空间自适应池化操作,根据 ``input``,池化类型 ``pool_type``,池化核大小 ``pool_size`` 这些参数得到输出。
使用上述输入参数的池化配置,为二维空间自适应池化操作,根据 ``input``,池化类型 ``pool_type``,池化核大小 ``pool_size`` 这些参数得到输出。

输入X和输出Out是NCHW格式,N为批大小,C是通道数,H是特征高度,W是特征宽度。参数 ``pool_size`` 含有两个整型元素,分别代表高度和宽度上的参数。输出Out的H和W维由 ``pool_size`` 决定,即输出shape为 :math:`\left ( N,C,pool_size[0],pool_size[1] \right )`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/fluid/layers/adaptive_pool3d_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ adaptive_pool3d



该OP使用上述输入参数的池化配置,为二维空间自适应池化操作,根据 ``input``,池化类型 ``pool_type``,池化核大小 ``pool_size`` 这些参数得到输出。
使用输入参数的池化配置,为二维空间自适应池化操作,根据 ``input``,池化类型 ``pool_type``,池化核大小 ``pool_size`` 这些参数得到输出。

输入X和输出Out是NCDHW格式,N为批大小,D是特征深度,C是通道数,H是特征高度,W是特征宽度。参数 ``pool_size`` 含有两个整型元素,分别代表深度,高度和宽度上的参数。输出Out的D, H和W维由 ``pool_size`` 决定,即输出shape为 :math:`\left ( N,C,pool_size[0],pool_size[1],pool_size[2] \right )`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/fluid/metrics/DetectionMAP_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ DetectionMAP



该OP用于计算检测网络的平均精度(mAP)。 mAP是衡量object detectors精度的指标,比如 Faster R-CNN,SSD等。它不同于召回率,它是最大精度的平均值。
用于计算检测网络的平均精度(mAP)。 mAP是衡量object detectors精度的指标,比如 Faster R-CNN,SSD等。它不同于召回率,它是最大精度的平均值。

通常步骤如下:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/fluid/one_hot_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ one_hot

**注意:此OP要求输入Tensor shape的最后一维必须为1。此OP将在未来的版本中被移除!推荐使用fluid.** :ref:`cn_api_fluid_one_hot` 。

该OP将输入(input)中的每个id转换为一个one-hot向量,其长度为 ``depth``,该id对应的向量维度上的值为1,其余维度的值为0。
将输入(input)中的每个id转换为一个one-hot向量,其长度为 ``depth``,该id对应的向量维度上的值为1,其余维度的值为0。

输出的Tensor(或LoDTensor)的shape是将输入shape的最后一维替换为depth的维度。

Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/io/Subset_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Subset
参数
:::::::::

- **datasets** 原数据集。
- **indices** 用于提取子集的原数据集合指标数组。
- **datasets** (Dataset) - 原数据集。
- **indices** (sequence) - 用于提取子集的原数据集合指标数组。

返回
:::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/io/random_split_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ random_split

- **dataset** (Dataset) - 此参数必须是 ``paddle.io.Dataset`` 或 ``paddle.io.IterableDataset`` 的一个子类实例或实现了 ``__len__`` 的 Python 对象,用于生成样本下标。默认值为 None。
- **lengths** (list) - 总和为原数组长度的,子集合长度数组。
- **generator** (Generator) - 指定采样 ``data_source`` 的采样器。默认值为 None。
- **generator** (Generator,可选) - 指定采样 ``data_source`` 的采样器。默认值为 None。

返回
::::::::::::
Expand Down
16 changes: 6 additions & 10 deletions docs/api/paddle/nn/Embedding_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,12 @@ Embedding

.. py:class:: paddle.nn.Embedding(num_embeddings, embedding_dim, padding_idx=None, sparse=False, weight_attr=None, name=None)



嵌入层(Embedding Layer)

该接口用于构建 ``Embedding`` 的一个可调用对象,具体用法参照 ``代码示例``。其根据 input 中的 id 信息从 embedding 矩阵中查询对应 embedding 信息,并会根据输入的 size (num_embeddings, embedding_dim)和 weight_attr 自动构造一个二维 embedding 矩阵。
嵌入层(Embedding Layer),用于构建 ``Embedding`` 的一个可调用对象,具体用法参照 ``代码示例``。其根据 input 中的 id 信息从 embedding 矩阵中查询对应 embedding 信息,并会根据输入的 size (num_embeddings, embedding_dim)和 weight_attr 自动构造一个二维 embedding 矩阵。

输出的 Tensor 的 shape 是在输入 Tensor shape 的最后一维后面添加了 embedding_dim 的维度。

注:input 中的 id 必须满足 ``0 =< id < size[0]``,否则程序会抛异常退出。

.. note::
input 中的 id 必须满足 ``0 =< id < size[0]``,否则程序会抛异常退出。

.. code-block:: text

Expand All @@ -41,9 +37,9 @@ Embedding

- **num_embeddings** (int) - 嵌入字典的大小,input 中的 id 必须满足 ``0 =< id < num_embeddings`` 。 。
- **embedding_dim** (int) - 每个嵌入向量的维度。
- **padding_idx** (int|long|None) - padding_idx 的配置区间为 ``[-weight.shape[0], weight.shape[0]``,如果配置了 padding_idx,那么在训练过程中遇到此 id 时,其参数及对应的梯度将会以 0 进行填充。
- **sparse** (bool) - 是否使用稀疏更新,在词嵌入权重较大的情况下,使用稀疏更新能够获得更快的训练速度及更小的内存/显存占用。
- **weight_attr** (ParamAttr|None) - 指定嵌入向量的配置,包括初始化方法,具体用法请参见 :ref:`api_guide_ParamAttr`,一般无需设置,默认值为 None。
- **padding_idx** (int|long|None,可选) - padding_idx 的配置区间为 ``[-weight.shape[0], weight.shape[0]``,如果配置了 padding_idx,那么在训练过程中遇到此 id 时,其参数及对应的梯度将会以 0 进行填充。
- **sparse** (bool,可选) - 是否使用稀疏更新,在词嵌入权重较大的情况下,使用稀疏更新能够获得更快的训练速度及更小的内存/显存占用。
- **weight_attr** (ParamAttr|None,可选) - 指定嵌入向量的配置,包括初始化方法,具体用法请参见 :ref:`api_guide_ParamAttr`,一般无需设置,默认值为 None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。


Expand Down
3 changes: 2 additions & 1 deletion docs/api/paddle/nn/Fold_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ Fold

.. py:function:: paddle.nn.Fold(output_sizes, kernel_sizes, dilations=1, paddings=0, strides=1, name=None)

该 Op 用于将一个滑动局部块组合成一个大的张量。通常也被称为 col2im,用于批处理二维图像张量。Fold 通过对所有包含块的值求和来计算结果中的每个大张量的组合值。
将一个滑动局部块组合成一个大的张量。通常也被称为 col2im,用于批处理二维图像张量。Fold 通过对所有包含块的值求和来计算结果中的每个大张量的组合值。

对于输入 x,如果形状为[N, C_in, L],其输出形状[N, C_out, H_out, W_out],计算过程如下:

.. math::

H_out &= output_size[0]
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/nn/GELU_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ GELU 激活层(GELU Activation Operator)

参数
::::::::::
- approximate (bool,可选) - 是否使用近似计算,默认值为 False,即不使用近似计算。
- **approximate** (bool,可选) - 是否使用近似计算,默认值为 False,即不使用近似计算。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

形状:
Expand Down
13 changes: 6 additions & 7 deletions docs/api/paddle/nn/functional/embedding_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,17 @@
embedding
-------------------------------


.. py:function:: paddle.nn.functional.embedding(x, weight, padding_idx=None, sparse=False, name=None)



嵌入层(Embedding Layer)

该 OP 根据 input 中的 id 信息从 embedding 矩阵中查询对应 embedding 信息,并会根据输入的 size (vocab_size, emb_size)和 dtype 自动构造一个二维 embedding 矩阵。
嵌入层(Embedding Layer),根据 input 中的 id 信息从 embedding 矩阵中查询对应 embedding 信息,并会根据输入的 size (vocab_size, emb_size)和 dtype 自动构造一个二维 embedding 矩阵。

输出的 Tensor 的 shape 是将输入 Tensor shape 后追加一维 emb_size。

注:input 中的 id 必须满足 ``0 =< id < size[0]``,否则程序会抛异常退出。
.. note::

input 中的 id 必须满足 ``0 =< id < size[0]``,否则程序会抛异常退出。


.. code-block:: text
Expand Down Expand Up @@ -42,8 +41,8 @@ embedding

- **input** (Tensor) - 存储 id 信息的 Tensor,数据类型必须为:int32/int64。input 中的 id 必须满足 ``0 =< id < size[0]`` 。
- **weight** (Tensor) - 存储词嵌入权重参数的 Tensor,形状为(num_embeddings, embedding_dim)。
- **sparse** (bool) - 是否使用稀疏更新,在词嵌入权重较大的情况下,使用稀疏更新能够获得更快的训练速度及更小的内存/显存占用。
- **padding_idx** (int|long|None) - padding_idx 的配置区间为 ``[-weight.shape[0], weight.shape[0]``,如果配置了 padding_idx,那么在训练过程中遇到此 id 时,其参数及对应的梯度将会以 0 进行填充。
- **sparse** (bool,可选) - 是否使用稀疏更新,在词嵌入权重较大的情况下,使用稀疏更新能够获得更快的训练速度及更小的内存/显存占用。
- **padding_idx** (int|long|None,可选) - padding_idx 的配置区间为 ``[-weight.shape[0], weight.shape[0]``,如果配置了 padding_idx,那么在训练过程中遇到此 id 时,其参数及对应的梯度将会以 0 进行填充。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。


Expand Down
Loading