Skip to content

Commit 964ebdb

Browse files
committed
[Docs] Normalize spaces around inline literals in CN text
1 parent 39f8476 commit 964ebdb

11 files changed

Lines changed: 168 additions & 168 deletions

File tree

docs/api/paddle/Tensor__upper_cn.rst

Lines changed: 117 additions & 117 deletions
Large diffs are not rendered by default.

docs/api/paddle/distributed/fleet/Fleet_cn.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -265,17 +265,17 @@ COPY-FROM: paddle.distributed.fleet.Fleet.stop_worker
265265
save_inference_model(executor, dirname, feeded_var_names, target_vars, main_program=None, export_for_deployment=True)
266266
'''''''''
267267

268-
修剪指定的 ``main_program`` 以构建一个专门用于预测的 ``Inference Program`` ( ``Program`` 含义详见 :ref:`api_guide_Program` )。所得到的 ``Inference Program`` 及其对应的所>有相关参数均被保存到 ``dirname`` 指定的目录中。
268+
修剪指定的``main_program``以构建一个专门用于预测的``Inference Program`` ( ``Program``含义详见 :ref:`api_guide_Program` )。所得到的``Inference Program``及其对应的所>有相关参数均被保存到``dirname``指定的目录中。
269269
270270
271271
**参数**
272272
273-
- **executor** (Executor) – 用于保存预测模型的 ``executor``,详见 :ref:`api_guide_executor` 。
273+
- **executor** (Executor) – 用于保存预测模型的``executor``,详见 :ref:`api_guide_executor` 。
274274
- **dirname** (str) – 指定保存预测模型结构和参数的文件目录。
275275
- **feeded_var_names** (list[str]) – 字符串列表,包含着 Inference Program 预测时所需提供数据的所有变量名称(即所有输入变量的名称)。
276276
- **target_vars** (list[Tensor]) – ``Tensor`` (详见 :ref:`api_guide_Program` )类型列表,包含着模型的所有输出变量。通过这些输出变量即可得到模型的预测结果。
277-
- **main_program** (Program,可选) – 通过该参数指定的 ``main_program`` 可构建一个专门用于预测的 ``Inference Program``。若为 None,则使用全局默认的 ``_main_program_`` 。>默认值为 None。
278-
- **export_for_deployment** (bool,可选) – 若为 True,则 ``main_program`` 指定的 Program 将被修改为只支持直接预测部署的 Program。否则,将存储更多的信息,方便优化和再训练。目前
277+
- **main_program** (Program,可选) – 通过该参数指定的``main_program``可构建一个专门用于预测的``Inference Program``。若为 None,则使用全局默认的``_main_program_`` 。>默认值为 None。
278+
- **export_for_deployment** (bool,可选) – 若为 True,则``main_program``指定的 Program 将被修改为只支持直接预测部署的 Program。否则,将存储更多的信息,方便优化和再训练。目前
279279
只支持设置为 True,且默认值为 True。
280280

281281

@@ -295,9 +295,9 @@ save_persistables(executor, dirname, main_program=None)
295295

296296
**参数**
297297

298-
- **executor** (Executor) – 用于保存持久性变量的 ``executor``,详见 :ref:`api_guide_executor` 。
298+
- **executor** (Executor) – 用于保存持久性变量的``executor``,详见 :ref:`api_guide_executor` 。
299299
- **dirname** (str) – 用于储存持久性变量的文件目录。
300-
- **main_program** (Program,可选) – 需要保存持久性变量的 Program( ``Program`` 含义详见 :ref:`api_guide_Program` )。如果为 None,则使用 default_main_Program。默认值为 None>。
300+
- **main_program** (Program,可选) – 需要保存持久性变量的 Program( ``Program``含义详见 :ref:`api_guide_Program` )。如果为 None,则使用 default_main_Program。默认值为 None>。
301301
302302
**返回**
303303
@@ -441,10 +441,10 @@ state_dict()
441441
442442
**1. 该 API 只在** `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ **模式下生效**
443443
444-
``dict`` 返回当前 ``optimizer`` 使用的所有 Tensor。比如对于 Adam 优化器,将返回 beta1, beta2, momentum 等 Tensor。
444+
以``dict``返回当前``optimizer``使用的所有 Tensor。比如对于 Adam 优化器,将返回 beta1, beta2, momentum 等 Tensor。
445445
446446
**返回**
447-
dict,当前 ``optimizer`` 使用的所有 Tensor。
447+
dict,当前``optimizer``使用的所有 Tensor。
448448
449449
450450
**代码示例**
@@ -479,7 +479,7 @@ set_state_dict(state_dict)
479479
480480
**1. 该 API 只在** `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ **模式下生效**
481481
482-
加载 ``optimizer`` 的 Tensor 字典给当前 ``optimizer`` 。
482+
加载``optimizer``的 Tensor 字典给当前``optimizer`` 。
483483

484484
**返回**
485485
None
@@ -520,7 +520,7 @@ set_lr(value)
520520

521521
**1. 该 API 只在** `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ **模式下生效**
522522

523-
手动设置当前 ``optimizer`` 的学习率。
523+
手动设置当前``optimizer``的学习率。
524524

525525
**参数**
526526

@@ -573,7 +573,7 @@ set_lr_scheduler(scheduler)
573573

574574
**1. 该 API 只在** `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ **模式下生效**
575575

576-
手动设置当前 ``optimizer`` 的学习率为 LRScheduler 类。
576+
手动设置当前``optimizer``的学习率为 LRScheduler 类。
577577

578578
**参数**
579579

docs/api/paddle/metric/Metric_cn.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Metric
1717
m.update(prediction, label)
1818
m.accumulate()
1919
20-
``compute`` 接口的进阶用法:
20+
``compute``接口的进阶用法:
2121
22-
``compute`` 中可以使用 PaddlePaddle 内置的算子进行评估器的状态,而不是通过
23-
Python/NumPy,这样可以加速计算。``update`` 接口将 ``compute`` 的输出作为
22+
在``compute``中可以使用 PaddlePaddle 内置的算子进行评估器的状态,而不是通过
23+
Python/NumPy,这样可以加速计算。``update``接口将``compute``的输出作为
2424
输入,内部采用 Python/NumPy 计算。
2525
26-
``Metric`` 计算流程如下 (在{}中的表示模型和评估器的计算):
26+
``Metric``计算流程如下 (在{}中的表示模型和评估器的计算):
2727
2828
.. code-block:: text
2929
@@ -46,17 +46,17 @@ Python/NumPy,这样可以加速计算。``update`` 接口将 ``compute`` 的
4646
代码示例 1
4747
::::::::::::
4848
49-
以 计算正确率的 ``Accuracy`` 为例,该评估器的输入为 ``pred````label``,可以在 ``compute`` 中通过 ``pred````label``先计算正确预测的矩阵。
50-
例如,预测结果包含 10 类,``pred`` 的 shape 是[N, 10],``label`` 的 shape 是[N, 1],N 是 batch size,我们需要计算 top-1 和 top-5 的准确率,
51-
可以在 ``compute`` 中计算每个样本的 top-5 得分,正确预测的矩阵的 shape 是[N, 5]。
49+
以 计算正确率的``Accuracy``为例,该评估器的输入为``pred````label``,可以在``compute``中通过``pred````label``先计算正确预测的矩阵。
50+
例如,预测结果包含 10 类,``pred``的 shape 是[N, 10],``label``的 shape 是[N, 1],N 是 batch size,我们需要计算 top-1 和 top-5 的准确率,
51+
可以在``compute``中计算每个样本的 top-5 得分,正确预测的矩阵的 shape 是[N, 5]。
5252
5353
5454
COPY-FROM: paddle.metric.Metric:code-compute-example
5555
5656
代码示例 2
5757
::::::::::::
5858
59-
``compute`` 中的计算,使用内置的算子(可以跑在 GPU 上,使得速度更快)。作为 ``update`` 的输入,该接口计算如下:
59+
在``compute``中的计算,使用内置的算子(可以跑在 GPU 上,使得速度更快)。作为``update``的输入,该接口计算如下:
6060
6161
COPY-FROM: paddle.metric.Metric:code-update-example
6262
@@ -75,10 +75,10 @@ reset()
7575
update(*args)
7676
'''''''''
7777
78-
更新状态。如果定义了 ``compute`` , ``update`` 的输入是 ``compute`` 的输出。如果没有定义,则输入是网络的输出**output**和标签**label**,
78+
更新状态。如果定义了``compute`` , ``update``的输入是``compute``的输出。如果没有定义,则输入是网络的输出**output**和标签**label**,
7979
如:``update(output1, output2, ..., label1, label2,...)`` 。
8080

81-
也可以参考 ``update`` 。
81+
也可以参考``update`` 。
8282

8383

8484
accumulate()
@@ -107,6 +107,6 @@ compute()
107107
此接口可以通过 PaddlePaddle 内置的算子计算 metric 的状态,可以加速 metric 的计算,为可选的高阶接口。
108108

109109
- 如果这个接口定义了,输入是网络的输出 **outputs** 和 标签 **labels**,定义如:``compute(output1, output2, ..., label1, label2,...)`` 。
110-
- 如果这个接口没有定义,默认的行为是直接将输入参数返回给 ``update``,则其定义如:``update(output1, output2, ..., label1, label2,...)`` 。
110+
- 如果这个接口没有定义,默认的行为是直接将输入参数返回给``update``,则其定义如:``update(output1, output2, ..., label1, label2,...)`` 。
111111

112-
也可以参考 ``compute`` 。
112+
也可以参考``compute`` 。

docs/api/paddle/nn/Fold_cn.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ Fold
1616
C_{out} &= \frac{C_{in}}{kernel\_sizes[0]\times kernel\_sizes[1]} \\
1717
1818
.. note::
19-
对应的 ``functional 方法`` 请参考::ref:`cn_api_paddle_nn_functional_fold` 。
19+
对应的``functional 方法``请参考::ref:`cn_api_paddle_nn_functional_fold` 。
2020

2121

2222

2323
参数
2424
:::::::::
25-
- **output_sizes** (int|list|tuple) – 输出尺寸,整数或者整型列表。如为列表类型应包含两个元素 ``[output_size_h, output_size_w]``。如果为整数 o,则输出形状会被认为 ``[o, o]``。
26-
- **kernel_size** (int|list|tuple) - 卷积核大小,整数或者整型列表。如为列表类型应包含两个元素 ``[k_h, k_w]``。如果为整数 k,则输出形状会被认为 ``[k, k]``。
27-
- **strides** (int|list|tuple,可选) - 步长大小,整数或者整型列表。如为列表类型应包含两个元素 ``[stride_h, stride_w]``。如果为整数 stride,则输出形状会被认为 ``[sride, stride]``。默认为[1,1]。
25+
- **output_sizes** (int|list|tuple) – 输出尺寸,整数或者整型列表。如为列表类型应包含两个元素``[output_size_h, output_size_w]``。如果为整数 o,则输出形状会被认为``[o, o]``。
26+
- **kernel_size** (int|list|tuple) - 卷积核大小,整数或者整型列表。如为列表类型应包含两个元素``[k_h, k_w]``。如果为整数 k,则输出形状会被认为``[k, k]``。
27+
- **strides** (int|list|tuple,可选) - 步长大小,整数或者整型列表。如为列表类型应包含两个元素``[stride_h, stride_w]``。如果为整数 stride,则输出形状会被认为``[sride, stride]``。默认为[1,1]。
2828
- **paddings** (int|list|tuple,可选) – 每个维度的扩展,整数或者整型列表。如果为整型列表,长度应该为 4 或者 2;长度为 4 对应的 padding 参数是:[padding_top, padding_left,padding_bottom, padding_right],长度为 2 对应的 padding 参数是[padding_h, padding_w],会被当作[padding_h, padding_w, padding_h, padding_w]处理。如果为整数 padding,则会被当作[padding, padding, padding, padding]处理。默认值为 0。
2929
- **dilations** (int|list|tuple,可选) – 卷积膨胀,整型列表或者整数。如果为整型列表,应该包含两个元素[dilation_h, dilation_w]。如果是整数 dilation,会被当作整型列表[dilation, dilation]处理。默认值为 1。
3030
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
@@ -33,7 +33,7 @@ Fold
3333
形状
3434
:::::::::
3535
- **输入** :4-D Tensor,形状为[N, C_in, L],数据类型为 float32 或者 float64
36-
- **输出** :形状如上面所描述的[N, Cout, H, W],数据类型与 ``x`` 相同
36+
- **输出** :形状如上面所描述的[N, Cout, H, W],数据类型与``x``相同
3737

3838

3939
代码示例

docs/api/paddle/nn/Unfold_cn.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Unfold
88
99
1010
11-
实现的功能与卷积中用到的 im2col 函数一样,通常也被称作为 im2col 过程。对于每一个卷积核覆盖下的区域,元素会被重新排成一列。当卷积核在整个图片上滑动时,将会形成一系列的列向量。对于每一个输入形状为[N, C, H, W]的 ``x``,都将会按照下面公式计算出一个形状为[N, Cout, Lout]的输出。
11+
实现的功能与卷积中用到的 im2col 函数一样,通常也被称作为 im2col 过程。对于每一个卷积核覆盖下的区域,元素会被重新排成一列。当卷积核在整个图片上滑动时,将会形成一系列的列向量。对于每一个输入形状为[N, C, H, W]的``x``,都将会按照下面公式计算出一个形状为[N, Cout, Lout]的输出。
1212

1313
.. note::
14-
对应的 ``functional 方法`` 请参考::ref:`cn_api_paddle_nn_functional_unfold`。
14+
对应的``functional 方法``请参考::ref:`cn_api_paddle_nn_functional_unfold`。
1515

1616

1717
**样例**:
@@ -31,16 +31,16 @@ Unfold
3131
参数
3232
::::::::::::
3333

34-
- **kernel_sizes** (int|list(tuple) of int) – 卷积核的尺寸,整数或者整型列表。如果为整型列表,应包含两个元素 ``[k_h, k_w]``,卷积核大小为 ``k_h * k_w``;如果为整数 k,会被当作整型列表 ``[k, k]`` 处理
34+
- **kernel_sizes** (int|list(tuple) of int) – 卷积核的尺寸,整数或者整型列表。如果为整型列表,应包含两个元素``[k_h, k_w]``,卷积核大小为``k_h * k_w``;如果为整数 k,会被当作整型列表``[k, k]``处理
3535
- **dilations** (int|list(tuple) of int,可选) – 卷积膨胀,整型列表或者整数。如果为整型列表,应该包含两个元素[dilation_h, dilation_w]。如果是整数 dilation,会被当作整型列表[dilation, dilation]处理。默认值为 1
3636
- **paddings** (int|list(tuple) of int,可选) – 每个维度的扩展,整数或者整型列表。如果为整型列表,长度应该为 4 或者 2;长度为 4 对应的 padding 参数是:[padding_top, padding_left,padding_bottom, padding_right],长度为 2 对应的 padding 参数是[padding_h, padding_w],会被当作[padding_h, padding_w, padding_h, padding_w]处理。如果为整数 padding,则会被当作[padding, padding, padding, padding]处理。默认值为 0
37-
- **strides** (int|list(tuple) of int,可选) – 卷积步长,整数或者整型列表。如果为整型列表,应该包含两个元素 ``[stride_h, stride_w]``。如果为整数,则 ``stride_h = stride_w = strides``。默认值为 1
37+
- **strides** (int|list(tuple) of int,可选) – 卷积步长,整数或者整型列表。如果为整型列表,应该包含两个元素``[stride_h, stride_w]``。如果为整数,则``stride_h = stride_w = strides``。默认值为 1
3838
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
3939

4040
形状
4141
:::::::::
4242
- **输入** : 4-D Tensor,形状为[N, C, H, W],数据类型为 float32 或者 float64
43-
- **输出**:形状如上面所描述的[N, Cout, Lout],Cout 每一个滑动 block 里面覆盖的元素个数,Lout 是滑动 block 的个数,数据类型与 ``x`` 相同
43+
- **输出**:形状如上面所描述的[N, Cout, Lout],Cout 每一个滑动 block 里面覆盖的元素个数,Lout 是滑动 block 的个数,数据类型与``x``相同
4444

4545

4646
代码示例

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

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

66
.. py:function:: paddle.nn.functional.max_unpool1d(x, indices, kernel_size, stride=None, padding=0, data_format="NCL", output_size=None, name=None)
77
8-
这个 API 实现了 ``1D 最大反池化`` 操作
8+
这个 API 实现了``1D 最大反池化``操作
99

1010
.. note::
11-
更多细节请参考对应的 ``Class`` 请参考 :ref:`cn_api_paddle_nn_MaxUnPool1D` 。
11+
更多细节请参考对应的``Class``请参考 :ref:`cn_api_paddle_nn_MaxUnPool1D` 。
1212

1313

1414
输入:
@@ -19,7 +19,7 @@ max_unpool1d
1919
.. math::
2020
L_{out} = (L_{in} - 1) \times \text{stride} - 2 \times \text{padding} + \text{kernel_size}
2121
22-
或由参数 ``output_size`` 直接指定
22+
或由参数``output_size``直接指定
2323

2424

2525
参数

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

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

66
.. py:function:: paddle.nn.functional.max_unpool2d(x, indices, kernel_size, stride=None,padding=0,data_format="NCHW",output_size=None,name=None)
77
8-
这个 API 实现了 ``2D 最大反池化`` 操作
8+
这个 API 实现了``2D 最大反池化``操作
99

1010
.. note::
11-
更多细节请参考对应的 ``Class`` 请参考 :ref:`cn_api_paddle_nn_MaxUnPool2D` 。
11+
更多细节请参考对应的``Class``请参考 :ref:`cn_api_paddle_nn_MaxUnPool2D` 。
1212

1313

1414
输入:
@@ -22,7 +22,7 @@ max_unpool2d
2222
.. math::
2323
W_{out} = (W_{in} - 1) \times \text{stride[1]} - 2 \times \text{padding[1]} + \text{kernel_size[1]}
2424
25-
或由参数 ``output_size`` 直接指定
25+
或由参数``output_size``直接指定
2626

2727

2828
参数

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

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

66
.. py:function:: paddle.nn.functional.max_unpool3d(x, indices, kernel_size, stride=None, padding=0, data_format="NCDHW", output_size=None, name=None)
77
8-
这个 API 实现了 ``3D 最大反池化`` 操作
8+
这个 API 实现了``3D 最大反池化``操作
99

1010
.. note::
11-
更多细节请参考对应的 ``Class`` 请参考 :ref:`cn_api_paddle_nn_MaxUnPool3D` 。
11+
更多细节请参考对应的``Class``请参考 :ref:`cn_api_paddle_nn_MaxUnPool3D` 。
1212

1313

1414
输入:
@@ -25,7 +25,7 @@ max_unpool3d
2525
.. math::
2626
W_{out} = (W_{in} - 1) \times \text{stride[2]} - 2 \times \text{padding[2]} + \text{kernel_size[2]}
2727
28-
或由参数 ``output_size`` 直接指定
28+
或由参数``output_size``直接指定
2929

3030

3131
参数

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ prelu 激活层(PRelu Activation Operator)。计算公式如下:
1111
1212
prelu(x) = max(0, x) + weight * min(0, x)
1313
14-
其中,:math:`x` 和 ``weight`` 为输入的 Tensor
14+
其中,:math:`x` 和``weight``为输入的 Tensor
1515

1616
参数
1717
::::::::::
18-
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
19-
- **weight** (Tensor) - 可训练参数,数据类型同``x`` 一致,形状支持:[]、[1] 或者 [in],其中`in`为输入的通道数。
18+
- **x** (Tensor) - 输入的``Tensor``,数据类型为:float32、float64。
19+
- **weight** (Tensor) - 可训练参数,数据类型同``x``一致,形状支持:[]、[1] 或者 [in],其中`in`为输入的通道数。
2020
- **data_format** (str,可选) – 指定输入的数据格式,输出的数据格式将与输入保持一致,可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值:"NCHW"。
2121
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2222

2323
返回
2424
::::::::::
25-
``Tensor``,数据类型和形状同 ``x`` 一致。
25+
``Tensor``,数据类型和形状同``x``一致。
2626

2727
代码示例
2828
:::::::::

docs/api/paddle/nn/initializer/Dirac_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ Dirac
66
.. py:class:: paddle.nn.initializer.Dirac(groups=1, name=None)
77
88
9-
通过 ``狄拉克 delta 函数`` 来初始化 3D/4D/5D Tensor。
9+
通过``狄拉克 delta 函数``来初始化 3D/4D/5D Tensor。
1010

11-
该初始化方式一般用于 Conv1D/Conv2D/Conv3D 卷积层,能尽可能多的保留卷积层输入的特性。(如果 ``out_channels`` > ``in_channels``,则可保留全部的输入 ``channel`` 特性)
11+
该初始化方式一般用于 Conv1D/Conv2D/Conv3D 卷积层,能尽可能多的保留卷积层输入的特性。(如果``out_channels`` > ``in_channels``,则可保留全部的输入``channel``特性)
1212

1313
被初始化的参数,每个卷积核中间的元素会被置为 1,其余元素为 0。公式可以描述为:
1414

1515
.. math::
1616
1717
X[d, d, shape[2]//2, shape[3]//2, ...]=1 ; d=0,1...N
1818
19-
其中 N 为 ``out_channels````in_channels`` 中的较小值。
19+
其中 N 为``out_channels````in_channels``中的较小值。
2020

2121

2222
参数

0 commit comments

Comments
 (0)