Skip to content

Commit e2d630f

Browse files
LiyulingyueLigoml
andauthored
fix cn docs in fft and io.dataset (#5111)
* Update irfftn_cn.rst * Update irfftn_cn.rst * Update rfft_cn.rst * Update rfftfreq_cn.rst * Update rfftfreq_cn.rst * Update rfftfreq_cn.rst * Update random_split_cn.rst * Update rfft_cn.rst * Update rfft_cn.rst * Update rfftfreq_cn.rst * Update rfft_cn.rst * Update Embedding_cn.rst * Update embedding_cn.rst * Update embedding_cn.rst * Update embedding_cn.rst * Update embedding_cn.rst * Update Fold_cn.rst * Update Fold_cn.rst * Update fold_cn.rst * Update GELU_cn.rst * Update gelu_cn.rst * Update hardshrink_cn.rst * delete the '该OP' * Update irfftn_cn.rst * Update fft_cn.rst * Update irfftn_cn.rst * Update hfftn_cn.rst * Update Subset_cn.rst * Update one_hot_cn.rst * Update adaptive_pool2d_cn.rst * Update adaptive_pool3d_cn.rst * Update adaptive_pool3d_cn.rst * Update DetectionMAP_cn.rst * Update NumpyArrayInitializer_cn.rst * Update data_cn.rst * Update save_params_cn.rst * Update DetectionMAP_cn.rst * Update data_cn.rst * Update save_persistables_cn.rst * Update data_cn.rst * Update data_cn.rst * Update Fold_cn.rst * Update fold_cn.rst * Update data_cn.rst * Update data_cn.rst * Update fold_cn.rst * Update Fold_cn.rst * Update Fold_cn.rst * Update fold_cn.rst * Update Fold_cn.rst * Update Fold_cn.rst * Update Fold_cn.rst * Update Fold_cn.rst * Update Fold_cn.rst * Update fold_cn.rst Co-authored-by: Ligoml <39876205+Ligoml@users.noreply.github.com>
1 parent d85b054 commit e2d630f

18 files changed

+57
-69
lines changed

docs/api/paddle/fft/fft_cn.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ fft
1313
:::::::::
1414

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

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

3734
代码示例
3835
:::::::::

docs/api/paddle/fft/hfftn_cn.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,9 @@ hfftn
1717
输入 Tensor 的长度大于 ``s[-1]//2+1``,输入 Tensor 会被截断。如果输入 Tensor 的长度
1818
小于 ``s[-1]//2+1``,则输入 Tensor 会被补零;
1919

20-
对于傅里变换其他每一个轴 ``i``,如果输入 Tensor 的长度大于 ``s[i]``,输入 Tensor 会
21-
被截断。如果输入 Tensor 的长度小于 ``s[i]``,则输入 Tensor 会被补零;
22-
23-
如果未指定 `s`,则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``,其中 ``m`` 是输入
24-
Tensor 在最后一个傅里叶变换轴的长度,其余轴为输入 Tensor 在该轴的长度。
20+
- 对于傅里变换其他每一个轴 ``i``,如果输入 Tensor 的长度大于 ``s[i]``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[i]``,则输入 Tensor 会被补零;
21+
- 如果未指定 `s`,则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``,其中 ``m`` 是输入 Tensor 在最后一个傅里叶变换轴的长度,其余轴为输入 Tensor 在该轴的长度。
22+
2523
- **axes** (Sequence[int],可选) - 计算快速傅里叶变换的轴。如果没有指定,默认是使用最
2624
后 ``len(s)`` 个轴,如果 ``s`` 也没有指定则使用输入数据的全部的轴。
2725
- **norm** (str,可选) - 指定傅里叶变换的缩放模式,缩放系数由变换的方向和模式同时决定。取

docs/api/paddle/fft/irfftn_cn.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ irfftn
77
88
通过快速傅里叶变换(FFT)算法计算 N 维实数傅里叶变换 (rfftn)的逆变换。
99

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

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

18-
对于傅里叶变换的最后一个轴,输入长度要求是 ``s[-1]//2+1``,如果输入 Tensor 的长度大于
19-
``s[-1]//2+1``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[-1]//2+1``,
20-
则输入 Tensor 会被补零;
21-
22-
对于傅里变换其他每一个轴 ``i``,如果输入 Tensor 的长度大于 ``s[i]``,输入 Tensor 会
23-
被截断。如果输入 Tensor 的长度小于 ``s[i]``,则输入 Tensor 会被补零;
24-
25-
如果未指定 `s`,则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``,其中 ``m`` 是输
26-
入 Tensor 在最后一个傅里叶变换轴的长度,其余轴为输入 Tensor 在该轴的长度。
21+
- 对于傅里叶变换的最后一个轴,输入长度要求是 ``s[-1]//2+1``,如果输入 Tensor 的长度大于``s[-1]//2+1``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[-1]//2+1``,则输入 Tensor 会被补零;
22+
- 对于傅里变换其他每一个轴 ``i``,如果输入 Tensor 的长度大于 ``s[i]``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[i]``,则输入 Tensor 会被补零;
23+
- 如果未指定 `s`,则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``,其中 ``m`` 是输入 Tensor 在最后一个傅里叶变换轴的长度,其余轴为输入 Tensor 在该轴的长度。
24+
2725
- **axes** (Sequence[int],可选) - 计算快速傅里叶变换的轴。如果没有指定,默认是使用最后
2826
``len(s)`` 个轴,如果 ``s`` 也没有指定则使用输入数据的全部的轴。
2927
- **norm** (str,可选) - 指定傅里叶变换的缩放模式,缩放系数由变换的方向和模式同时决定。取

docs/api/paddle/fft/rfft_cn.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ rfft
77
88
通过快速傅里叶变换(FFT)算法计算一维实数傅里叶变换。
99

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

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

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

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

3534
代码示例
3635
:::::::::

docs/api/paddle/fft/rfftfreq_cn.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ rfftfreq
88
返回离散傅里叶变换的频率窗口(frequency bins)中心,以 "循环/采样间隔" 为单位。例如,采样间
99
隔以秒为单位,则频谱的单位是 "循环/秒"。用于 ``rfft`` 和 ``irfft``。
1010

11-
对于窗口长度 n 和采样间隔 d,输出的频率序列 f 排布如下::
11+
对于窗口长度 n 和采样间隔 d,输出的频率序列 f 排布如下:
12+
13+
.. code-block:: text
1214
1315
f = [0, 1, ..., n/2-1, n/2] / (d*n) (当 n 为偶数)
1416
f = [0, 1, ..., (n-1)/2-1, (n-1)/2] / (d*n) (当 n 为奇数)
@@ -26,8 +28,7 @@ rfftfreq
2628
返回
2729
:::::::::
2830

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

3233
代码示例
3334
:::::::::

docs/api/paddle/fluid/data_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ Variable
4040
代码示例
4141
::::::::::::
4242

43-
COPY-FROM: paddle.fluid.data
43+
COPY-FROM: paddle.fluid.data

docs/api/paddle/fluid/initializer/NumpyArrayInitializer_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ NumpyArrayInitializer
2626
代码示例
2727
::::::::::::
2828

29-
COPY-FROM: paddle.fluid.initializer.NumpyArrayInitializer
29+
COPY-FROM: paddle.fluid.initializer.NumpyArrayInitializer

docs/api/paddle/fluid/io/save_params_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ save_params
3232
代码示例
3333
::::::::::::
3434

35-
COPY-FROM: paddle.fluid.io.save_params
35+
COPY-FROM: paddle.fluid.io.save_params

docs/api/paddle/fluid/io/save_persistables_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ save_persistables
2828
代码示例
2929
::::::::::::
3030

31-
COPY-FROM: paddle.fluid.io.save_persistables
31+
COPY-FROM: paddle.fluid.io.save_persistables

docs/api/paddle/io/Subset_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Subset
1111
参数
1212
:::::::::
1313

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

1717
返回
1818
:::::::::

0 commit comments

Comments
 (0)