Skip to content

Commit a2435a4

Browse files
authored
[Docs] Fix inline backticks in 1D pooling CN docs (#7857)
1 parent 835a173 commit a2435a4

8 files changed

Lines changed: 27 additions & 27 deletions

File tree

docs/api/paddle/nn/AdaptiveMaxPool1D_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ AdaptiveMaxPool1D
55

66
.. py:class:: paddle.nn.AdaptiveMaxPool1D(output_size, return_mask=False, name=None)
77
8-
根据输入 `x` , `output_size` 等参数对一个输入 Tensor 计算 1D 的自适应最大池化。输入和输出都是 3-D Tensor,
9-
默认是以 `NCL` 格式表示的,其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。
8+
根据输入 ``x`` , ``output_size`` 等参数对一个输入 Tensor 计算 1D 的自适应最大池化。输入和输出都是 3-D Tensor,
9+
默认是以 ``NCL`` 格式表示的,其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。
1010

1111
计算公式如下:
1212

docs/api/paddle/nn/AvgPool1D_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ AvgPool1D
55

66
.. py:class:: paddle.nn.AvgPool1D(kernel_size, stride=None, padding=0, exclusive=True, ceil_mode=False, name=None)
77
8-
根据输入 `x` , `kernel_size` 等参数对一个输入 Tensor 计算 1D 的平均池化。输入和输出都是 3-D Tensor,
9-
默认是以 `NCL` 格式表示的,其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。
8+
根据输入 ``x`` , ``kernel_size`` 等参数对一个输入 Tensor 计算 1D 的平均池化。输入和输出都是 3-D Tensor,
9+
默认是以 ``NCL`` 格式表示的,其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。
1010

1111
假设输入形状是(N, C, L),输出形状是 (N, C, L_{out}),卷积核尺寸是 k, 1d 平均池化计算公式如下:
1212

@@ -18,7 +18,7 @@ AvgPool1D
1818
:::::::::
1919
- **kernel_size** (int|list|tuple) - 池化核的尺寸大小。如果 kernel_size 为 list 或 tuple 类型,其必须包含一个整数,最终池化核的大小为该数值。
2020
- **stride** (int|list|tuple,可选) - 池化操作步长。如果 stride 为 list 或 tuple 类型,其必须包含一个整数,最终池化操作的步长为该数值。默认值为 None,这时会使用 kernel_size 作为 stride。
21-
- **padding** (str|int|list|tuple,可选) - 池化补零的方式。如果 padding 是一个字符串,则必须为 `SAME` 或者 `VALID`。如果是 tuple 或者 list 类型,若其长度为 1,则会在输入的两端都填充上长度为 padding[0] 的 0,若其长度为 2,则应是 `[pad_before, pad_after]` 形式。如果 padding 是一个非 0 整数,那么表示会在输入的两端都填充上同样长度的 0。如果 padding 是长度为 2 的序列组成的 list 或 tuple,则其中的每个元素表示在相应维度上的填充长度。注意:在 batch_size 维度和通道维度应该设置为 [0, 0] 或 (0, 0)。默认值为 0。
21+
- **padding** (str|int|list|tuple,可选) - 池化补零的方式。如果 padding 是一个字符串,则必须为 ``SAME`` 或者 ``VALID``。如果是 tuple 或者 list 类型,若其长度为 1,则会在输入的两端都填充上长度为 padding[0] 的 0,若其长度为 2,则应是 ``[pad_before, pad_after]`` 形式。如果 padding 是一个非 0 整数,那么表示会在输入的两端都填充上同样长度的 0。如果 padding 是长度为 2 的序列组成的 list 或 tuple,则其中的每个元素表示在相应维度上的填充长度。注意:在 batch_size 维度和通道维度应该设置为 [0, 0] 或 (0, 0)。默认值为 0。
2222
- **exclusive** (bool,可选) - 是否用额外 padding 的值计算平均池化结果,默认为 True。
2323
- **ceil_mode** (bool,可选) - 是否用 ceil 函数计算输出的 height 和 width,如果设置为 False,则使用 floor 函数来计算,默认为 False。
2424
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

docs/api/paddle/nn/LPPool1D_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ LPPool1D
55

66
.. py:function:: paddle.nn.LPPool1D(norm_type, kernel_size, stride=None, padding=0, ceil_mode=False, data_format="NCL", name=None)
77
8-
根据输入 `x` , `kernel_size` 等参数对一个输入 Tensor 计算 1D 的幂平均池化。输入和输出都是 3-D Tensor,
9-
默认是以 `NCL` 格式表示的,其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。
8+
根据输入 ``x`` , ``kernel_size`` 等参数对一个输入 Tensor 计算 1D 的幂平均池化。输入和输出都是 3-D Tensor,
9+
默认是以 ``NCL`` 格式表示的,其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。
1010

1111
假设输入形状是(N, C, L),输出形状是 (N, C, L_{out}),卷积核尺寸是 k, 1d 平均池化计算公式如下:
1212

docs/api/paddle/nn/MaxPool1D_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ MaxPool1D
55

66
.. py:class:: paddle.nn.MaxPool1D(kernel_size, stride=None, padding=0, return_mask=False, ceil_mode=False, dilation=1, name=None)
77
8-
根据输入 `x` , `kernel_size` 等参数对一个输入 Tensor 计算 1D 的最大值池化。输入和输出都是 3-D Tensor,默认是以 `NCL` 格式表示的,其中 `N` 是 batch size,`C` 是通道数,`L` 是输入特征的长度。
8+
根据输入 ``x`` , ``kernel_size`` 等参数对一个输入 Tensor 计算 1D 的最大值池化。输入和输出都是 3-D Tensor,默认是以 ``NCL`` 格式表示的,其中 ``N`` 是 batch size,``C`` 是通道数,``L`` 是输入特征的长度。
99

1010
假设输入形状是(N, C, L),输出形状是 (N, C, L_{out}),卷积核尺寸是 k, 1d 最大值池化计算公式如下:
1111

docs/api/paddle/nn/functional/adaptive_max_pool1d_cn.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ adaptive_max_pool1d
55

66
.. py:function:: paddle.nn.functional.adaptive_max_pool1d(x, output_size, return_mask=False, name=None)
77
8-
根据输入 `x` , `output_size` 等参数对一个输入 Tensor 计算 1D 的自适应最大值池化。输入和输出都是 3-D Tensor,
9-
默认是以 `NCL` 格式表示的,其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。
8+
根据输入 ``x`` , ``output_size`` 等参数对一个输入 Tensor 计算 1D 的自适应最大值池化。输入和输出都是 3-D Tensor,
9+
默认是以 ``NCL`` 格式表示的,其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。
1010

1111

1212
.. note::
@@ -15,14 +15,14 @@ adaptive_max_pool1d
1515

1616
参数
1717
:::::::::
18-
- **x** (Tensor):当前算子的输入,其是一个形状为 `[N, C, L]` 的 3-D Tensor。其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。其数据类型为 float32 或者 float64。别名 ``input``。
18+
- **x** (Tensor):当前算子的输入,其是一个形状为 ``[N, C, L]`` 的 3-D Tensor。其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。其数据类型为 float32 或者 float64。别名 ``input``。
1919
- **output_size** (int|list|tuple):算子输出特征图的长度,其数据类型为 int 或 list,tuple。
2020
- **return_mask** (bool):如果设置为 True,则会与输出一起返回最大值的索引,默认为 False。别名 ``return_indices``。
2121
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2222

2323
返回
2424
:::::::::
25-
``Tensor``,输入 `x` 经过自适应池化计算得到的目标 3-D Tensor,其数据类型与输入相同。
25+
``Tensor``,输入 ``x`` 经过自适应池化计算得到的目标 3-D Tensor,其数据类型与输入相同。
2626

2727

2828
代码示例

docs/api/paddle/nn/functional/avg_pool1d_cn.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ avg_pool1d
55

66
.. py:function:: paddle.nn.functional.avg_pool1d(x, kernel_size, stride=None, padding=0, exclusive=True, ceil_mode=False, name=None)
77
8-
根据输入 `x` , `kernel_size` 等参数对一个输入 Tensor 计算 1D 的平均池化。输入和输出都是 3-D Tensor,
9-
默认是以 `NCL` 格式表示的,其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。
8+
根据输入 ``x`` , ``kernel_size`` 等参数对一个输入 Tensor 计算 1D 的平均池化。输入和输出都是 3-D Tensor,
9+
默认是以 ``NCL`` 格式表示的,其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。
1010

1111
.. note::
1212
详细请参考对应的 `Class` 请参考::ref:`cn_api_paddle_nn_AvgPool1D` 。
1313

1414

1515
参数
1616
:::::::::
17-
- **x** (Tensor):当前算子的输入,其是一个形状为 `[N, C, L]` 的 3-D Tensor。其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。其数据类型为 float16、float32 和 float64。
17+
- **x** (Tensor):当前算子的输入,其是一个形状为 ``[N, C, L]`` 的 3-D Tensor。其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。其数据类型为 float16、float32 和 float64。
1818
- **kernel_size** (int|list|tuple):池化核的尺寸大小。如果 kernel_size 为 list 或 tuple 类型,其必须包含一个整数。
1919
- **stride** (int|list|tuple):池化操作步长。如果 stride 为 list 或 tuple 类型,其必须包含一个整数。
20-
- **padding** (string|int|list|tuple):池化补零的方式。如果 padding 是一个字符串,则必须为 `SAME` 或者 `VALID`。如果是 tuple 或者 list 类型,则应是 `[pad_left, pad_right]` 形式。如果 padding 是一个非 0 值,那么表示会在输入的两端都 padding 上同样长度的 0。
20+
- **padding** (string|int|list|tuple):池化补零的方式。如果 padding 是一个字符串,则必须为 ``SAME`` 或者 ``VALID``。如果是 tuple 或者 list 类型,则应是 ``[pad_left, pad_right]`` 形式。如果 padding 是一个非 0 值,那么表示会在输入的两端都 padding 上同样长度的 0。
2121
- **exclusive** (bool):是否用额外 padding 的值计算平均池化结果,默认为 True。
2222
- **ceil_mode** (bool):是否用 ceil 函数计算输出的 height 和 width,如果设置为 False,则使用 floor 函数来计算,默认为 False。
2323
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
@@ -26,7 +26,7 @@ avg_pool1d
2626

2727
返回
2828
:::::::::
29-
``Tensor``,输入 `x` 经过平均池化计算得到的目标 3-D Tensor,其数据类型与输入相同。
29+
``Tensor``,输入 ``x`` 经过平均池化计算得到的目标 3-D Tensor,其数据类型与输入相同。
3030

3131

3232

docs/api/paddle/nn/functional/lp_pool1d_cn.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ lp_pool1d
55

66
.. py:function:: paddle.nn.functional.lp_pool1d(x, norm_type, kernel_size, stride=None, padding=0, ceil_mode=False, data_format="NCL", name=None)
77
8-
根据输入 `x` , `kernel_size` 等参数对一个输入 Tensor 计算 1D 的幂平均池化。输入和输出都是 3-D Tensor,
9-
默认是以 `NCL` 格式表示的,其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。
8+
根据输入 ``x`` , ``kernel_size`` 等参数对一个输入 Tensor 计算 1D 的幂平均池化。输入和输出都是 3-D Tensor,
9+
默认是以 ``NCL`` 格式表示的,其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。
1010

1111
.. note::
1212
详细请参考对应的 `Class` 请参考::ref:`cn_api_paddle_nn_LPPool1D` 。
1313

1414

1515
参数
1616
:::::::::
17-
- **x** (Tensor):当前算子的输入,其是一个形状为 `[N, C, L]` 的 3-D Tensor。其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。其数据类型为 float16、float32 和 float64。
17+
- **x** (Tensor):当前算子的输入,其是一个形状为 ``[N, C, L]`` 的 3-D Tensor。其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。其数据类型为 float16、float32 和 float64。
1818
- **norm_type** (int|float):幂平均池化的指数,不可以为 0。
1919
- **kernel_size** (int|list|tuple):池化核的尺寸大小。如果 kernel_size 为 list 或 tuple 类型,其必须包含一个整数。
2020
- **stride** (int|list|tuple):池化操作步长。如果 stride 为 list 或 tuple 类型,其必须包含一个整数。
21-
- **padding** (string|int|list|tuple):池化补零的方式。如果 padding 是一个字符串,则必须为 `SAME` 或者 `VALID`。如果是 tuple 或者 list 类型,则应是 `[pad_left, pad_right]` 形式。如果 padding 是一个非 0 值,那么表示会在输入的两端都 padding 上同样长度的 0。
21+
- **padding** (string|int|list|tuple):池化补零的方式。如果 padding 是一个字符串,则必须为 ``SAME`` 或者 ``VALID``。如果是 tuple 或者 list 类型,则应是 ``[pad_left, pad_right]`` 形式。如果 padding 是一个非 0 值,那么表示会在输入的两端都 padding 上同样长度的 0。
2222
- **ceil_mode** (bool):是否用 ceil 函数计算输出的 height 和 width,如果设置为 False,则使用 floor 函数来计算,默认为 False。
2323
- **data_format** (str):输入和输出的数据格式,可以是"NCL"和"NLC"。N 是批尺寸,C 是通道数,L 是特征长度。默认值:"NCL"
2424
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
@@ -27,7 +27,7 @@ lp_pool1d
2727

2828
返回
2929
:::::::::
30-
``Tensor``,输入 `x` 经过幂平均池化计算得到的目标 3-D Tensor,其数据类型与输入相同。
30+
``Tensor``,输入 ``x`` 经过幂平均池化计算得到的目标 3-D Tensor,其数据类型与输入相同。
3131

3232

3333

docs/api/paddle/nn/functional/max_pool1d_cn.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ max_pool1d
55

66
.. py:function:: paddle.nn.functional.max_pool1d(x, kernel_size, stride=None, padding=0, return_mask=False, ceil_mode=False, dilation=1, name=None)
77
8-
根据输入 `x` , `kernel_size` 等参数对一个输入 Tensor 计算 1D 的最大值池化。输入和输出都是 3-D Tensor,
9-
默认是以 `NCL` 格式表示的,其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。
8+
根据输入 ``x`` , ``kernel_size`` 等参数对一个输入 Tensor 计算 1D 的最大值池化。输入和输出都是 3-D Tensor,
9+
默认是以 ``NCL`` 格式表示的,其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。
1010

1111
.. note::
1212
详细请参考对应的 `Class` 请参考::ref:`cn_api_paddle_nn_MaxPool1D` 。
1313

1414
参数
1515
:::::::::
16-
- **x** (Tensor) - 当前算子的输入,其是一个形状为 `[N, C, L]` 的 3-D Tensor。其中 `N` 是 batch size, `C` 是通道数,`L` 是输入特征的长度。其数据类型为 float32 或者 float64。别名 ``input``。
16+
- **x** (Tensor) - 当前算子的输入,其是一个形状为 ``[N, C, L]`` 的 3-D Tensor。其中 ``N`` 是 batch size, ``C`` 是通道数,``L`` 是输入特征的长度。其数据类型为 float32 或者 float64。别名 ``input``。
1717
- **kernel_size** (int|list|tuple) - 池化核的尺寸大小。如果 kernel_size 为 list 或 tuple 类型,其必须包含一个整数。
1818
- **stride** (int|list|tuple) - 池化操作步长。如果 stride 为 list 或 tuple 类型,其必须包含一个整数。
19-
- **padding** (string|int|list|tuple) - 池化补零的方式。如果 padding 是一个字符串,则必须为 `SAME` 或者 `VALID`。如果是 tuple 或者 list 类型,则应是 `[pad_left, pad_right]` 形式。如果 padding 是一个非 0 值,那么表示会在输入的两端都 padding 上同样长度的 0。
19+
- **padding** (string|int|list|tuple) - 池化补零的方式。如果 padding 是一个字符串,则必须为 ``SAME`` 或者 ``VALID``。如果是 tuple 或者 list 类型,则应是 ``[pad_left, pad_right]`` 形式。如果 padding 是一个非 0 值,那么表示会在输入的两端都 padding 上同样长度的 0。
2020
- **return_mask** (bool) - 是否返回最大值的索引,默认为 False。别名 ``return_indices``。
2121
- **ceil_mode** (bool) - 是否用 ceil 函数计算输出的 height 和 width,如果设置为 False,则使用 floor 函数来计算,默认为 False。
2222
- **dilation** (int|list|tuple,可选) - 空洞池化步长,如果 dilation 为 list 或 tuple 类型,其必须包含一个整数。默认值为 1。
@@ -27,7 +27,7 @@ max_pool1d
2727

2828
返回
2929
:::::::::
30-
``Tensor``,输入 `x` 经过最大值池化计算得到的目标 3-D Tensor,其数据类型与输入相同。
30+
``Tensor``,输入 ``x`` 经过最大值池化计算得到的目标 3-D Tensor,其数据类型与输入相同。
3131

3232

3333
代码示例

0 commit comments

Comments
 (0)