Skip to content

Commit 2541c9d

Browse files
authored
[Docathon][Fix Doc Format No.25-27] fix 3 API docs (unify term '傅里叶') (#7488)
* Fix typo: unify term '傅里叶' (replace '傅立叶') in 2 API doc files with '#' will be ignored, and an empty message aborts the commit. * style(./docs/api/paddle/fft/irfft_cn.rst):移除不必要换行 * fix(irfft_cn.rsh: 修复列表项渲染换行问题
1 parent de14b66 commit 2541c9d

File tree

3 files changed

+14
-33
lines changed

3 files changed

+14
-33
lines changed

docs/api/paddle/fft/hfft_cn.rst

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,9 @@ hfft
1313
:::::::::
1414

1515
- **x** (Tensor) - 输入数据,其数据类型为复数。
16-
- **n** (int,可选) - 输出 Tensor 在傅里叶变换轴的长度。输入 Tensor 在该轴的长度必须为
17-
``n//2+1``,如果输入 Tensor 的长度大于 ``n//2+1``,输入 Tensor 会被截断。如果输入
18-
Tensor 的长度小于 ``n//2+1``,则输入 Tensor 会被补零。如果 ``n`` 没有被指定,则取
19-
``2*(m-1)``,其中,``m`` 是输入 Tensor 在 ``axis`` 维的长度。
16+
- **n** (int,可选) - 输出 Tensor 在傅里叶变换轴的长度。输入 Tensor 在该轴的长度必须为 ``n//2+1``,如果输入 Tensor 的长度大于 ``n//2+1``,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``n//2+1``,则输入 Tensor 会被补零。如果 ``n`` 没有被指定,则取 ``2*(m-1)``,其中, ``m`` 是输入 Tensor 在 ``axis`` 维的长度。
2017
- **axis** (int,可选) - 傅里叶变换的轴。如果没有指定,默认是使用最后一维。
21-
- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取
22-
值必须是 "forward", "backward", "ortho" 之一,默认值为 "backward"。三种缩放模式对
23-
应的行为如下:
18+
- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取值必须是 "forward", "backward", "ortho" 之一,默认值为 "backward"。三种缩放模式对应的行为如下:
2419

2520
- "backward":正向和逆向变换的缩放系数分别为 ``1`` 和 ``1/n``;
2621
- "forward":正向和逆向变换的缩放系数分别为 ``1/n`` 和 ``1``;
@@ -31,9 +26,7 @@ hfft
3126

3227
返回
3328
:::::::::
34-
Tensor,数据类型为实数。由输入 Tensor(可能被截断或者补零之后)在指定维度进行傅里叶变换的输
35-
出。如果指定 n,则输出 Tensor 在傅立叶变换轴的长度为 n,否则为 ``2*(m-1)``,其中``m``
36-
是输入 Tensor 在 ``axis`` 维的长度。
29+
Tensor,数据类型为实数。由输入 Tensor(可能被截断或者补零之后)在指定维度进行傅里叶变换的输出。如果指定 ``n`` ,则输出 Tensor 在傅立叶变换轴的长度为 ``n`` ,否则为 ``2*(m-1)``,其中 ``m`` 是输入 Tensor 在 ``axis`` 维的长度。
3730

3831
代码示例
3932
:::::::::

docs/api/paddle/fft/irfft_cn.rst

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,20 @@ irfft
1313
:::::::::
1414

1515
- **x** (Tensor) - 输入数据,其数据类型为复数。
16-
- **n** (int,可选) - 输出 Tensor 在傅里叶变换轴的长度。输入 Tensor 在该轴的长度必须为
17-
``n//2+1``,如果输入 Tensor 的长度大于 ``n//2+1``,输入 Tensor 会被截断。如果输入
18-
Tensor 的长度小于 ``n//2+1``,则输入 Tensor 会被补零。如果 ``n``
19-
没有被指定,则取 ``2*(m-1)``,其中,``m`` 是输入 Tensor 在 ``axis`` 维的长度。
16+
- **n** (int,可选) - 输出 Tensor 在傅里叶变换轴的长度。输入 Tensor 在该轴的长度必须为 ``n//2+1`` ,如果输入 Tensor 的长度大于 ``n//2+1`` ,输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``n//2+1`` ,则输入 Tensor 会被补零。如果 ``n`` 没有被指定,则取 ``2*(m-1)`` ,其中, ``m`` 是输入 Tensor 在 ``axis`` 维的长度。
2017
- **axis** (int,可选) - 傅里叶变换的轴。如果没有指定,默认是使用最后一维。
21-
- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取
22-
值必须是 "forward", "backward", "ortho" 之一,默认值为 "backward"。三种缩放模式对
23-
应的行为如下:
18+
- **norm** (str,可选) - 傅里叶变换的缩放模式,缩放系数由变换的方向和缩放模式同时决定。取值必须是 "forward", "backward", "ortho" 之一,默认值为 "backward"。三种缩放模式对应的行为如下:
2419

25-
- "backward":正向和逆向变换的缩放系数分别为 ``1`` ``1/n``;
26-
- "forward":正向和逆向变换的缩放系数分别为 ``1/n`` ``1``;
27-
- "ortho":正向和逆向变换的缩放系数均为 ``1/sqrt(n)``;
20+
- "backward":正向和逆向变换的缩放系数分别为 ``1`` ``1/n``
21+
- "forward":正向和逆向变换的缩放系数分别为 ``1/n`` ``1``
22+
- "ortho":正向和逆向变换的缩放系数均为 ``1/sqrt(n)``
2823

2924
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
3025

3126

3227
返回
3328
:::::::::
34-
Tensor,数据类型为实数。由输入 Tensor(可能被截断或者补零之后)在指定维度进行傅里叶变换的输
35-
出。如果指定 n,则输出 Tensor 在傅立叶变换轴的长度为 n,否则为 ``2*(m-1)``,其中``m``
36-
是输入 Tensor 在 ``axis`` 维的长度。
29+
Tensor,数据类型为实数。由输入 Tensor(可能被截断或者补零之后)在指定维度进行傅里叶变换的输出。如果指定 ``n`` ,则输出 Tensor 在傅立叶变换轴的长度为 ``n`` ,否则为 ``2*(m-1)`` ,其中 ``m`` 是输入 Tensor 在 ``axis`` 维的长度。
3730

3831
代码示例
3932
:::::::::

docs/api/paddle/fft/irfftn_cn.rst

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

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

1413
参数
1514
:::::::::
1615

1716
- **x** (Tensor) - 输入数据,其数据类型为复数。
18-
- **s** (Sequence[int],可选) - 输出 Tensor 在每一个傅里叶变换轴上的长度(类似一维傅里
19-
叶变换中的参数 ``n``)。
17+
- **s** (Sequence[int],可选) - 输出 Tensor 在每一个傅里叶变换轴上的长度(类似一维傅里叶变换中的参数 ``n``)。
2018

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

25-
- **axes** (Sequence[int],可选) - 计算快速傅里叶变换的轴。如果没有指定,默认是使用最后
26-
``len(s)`` 个轴,如果 ``s`` 也没有指定则使用输入数据的全部的轴。
27-
- **norm** (str,可选) - 指定傅里叶变换的缩放模式,缩放系数由变换的方向和模式同时决定。取
28-
值必须是 "forward","backward","ortho"之一,默认值为 "backward"。三种缩放模式对应的
29-
行为如下:
23+
- **axes** (Sequence[int],可选) - 计算快速傅里叶变换的轴。如果没有指定,默认是使用最后 ``len(s)`` 个轴,如果 ``s`` 也没有指定则使用输入数据的全部的轴。
24+
- **norm** (str,可选) - 指定傅里叶变换的缩放模式,缩放系数由变换的方向和模式同时决定。取值必须是 "forward","backward","ortho"之一,默认值为 "backward"。三种缩放模式对应的行为如下:
3025

3126
- "backward":正向和逆向变换的缩放系数分别为 ``1`` 和 ``1/n``;
3227
- "forward":正向和逆向变换的缩放系数分别为 ``1/n`` 和 ``1``;

0 commit comments

Comments
 (0)