diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 2ab8ebaa00d..be4c9417701 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -579,7 +579,7 @@ tensor 元素操作相关原位（inplace）版本 :widths: 10, 30 " :ref:`paddle.cast_ ` ", "Inplace 版本的 cast API，对输入 x 采用 Inplace 策略" - " :ref:`paddle.index_add_ ` ", "Inplace 版本的 :ref:`cn_api_paddle_index_add` API，对输入 `x` 采用 Inplace 策略" + " :ref:`paddle.index_add_ ` ", "Inplace 版本的 :ref:`cn_api_paddle_index_add` API，对输入 ``x`` 采用 Inplace 策略" " :ref:`paddle.index_put_ ` ", "依据索引 ``indices`` ，将指定位置的 ``x`` 重新赋值为 ``value`` " " :ref:`paddle.reshape_ ` ", "Inplace 版本的 reshape API，对输入 x 采用 Inplace 策略" " :ref:`paddle.scatter_ ` ", "Inplace 版本的 scatter API，对输入 x 采用 Inplace 策略 " diff --git a/docs/api/paddle/addmm__cn.rst b/docs/api/paddle/addmm__cn.rst index e7e1db46a56..281e9402ac1 100644 --- a/docs/api/paddle/addmm__cn.rst +++ b/docs/api/paddle/addmm__cn.rst @@ -4,7 +4,7 @@ addmm\_ ------------------------------- .. py:function:: paddle.addmm_(input, x, y, beta=1.0, alpha=1.0, name=None) -Inplace 版本的 :ref:`cn_api_paddle_addmm` API，对输入 `input` 采用 Inplace 策略。 +Inplace 版本的 :ref:`cn_api_paddle_addmm` API，对输入 ``input`` 采用 Inplace 策略。 更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 diff --git a/docs/api/paddle/amp/debugging/compare_accuracy_cn.rst b/docs/api/paddle/amp/debugging/compare_accuracy_cn.rst index 5d960b433ba..761932b51b7 100644 --- a/docs/api/paddle/amp/debugging/compare_accuracy_cn.rst +++ b/docs/api/paddle/amp/debugging/compare_accuracy_cn.rst @@ -4,7 +4,7 @@ compare_accuracy ------------------------------- .. py:function:: paddle.amp.debugging.compare_accuracy(dump_path, another_dump_path, output_filename, loss_scale=1, dump_all_tensors=False) -`compare_accuracy` 是一个精度比对的工具，可以用来比较 float16 和 float32 的 log 数据。 +``compare_accuracy`` 是一个精度比对的工具，可以用来比较 float16 和 float32 的 log 数据。 参数 ::::::::: diff --git a/docs/api/paddle/as_tensor_cn.rst b/docs/api/paddle/as_tensor_cn.rst index da43c4fb4ec..09e178b54f9 100644 --- a/docs/api/paddle/as_tensor_cn.rst +++ b/docs/api/paddle/as_tensor_cn.rst @@ -5,4 +5,4 @@ as_tensor .. py:function:: paddle.as_tensor(data, dtype=None, device=None, requires_grad=False, pin_memory=False) -`paddle.tensor` 的别名，详细参考 :ref:`cn_api_paddle_tensor`。 +``paddle.tensor`` 的别名，详细参考 :ref:`cn_api_paddle_tensor`。 diff --git a/docs/api/paddle/baddbmm__cn.rst b/docs/api/paddle/baddbmm__cn.rst index 7a9415e2ed3..6b51e6c55e1 100644 --- a/docs/api/paddle/baddbmm__cn.rst +++ b/docs/api/paddle/baddbmm__cn.rst @@ -5,7 +5,7 @@ baddbmm\_ .. py:function:: paddle.baddbmm_(input, x, y, beta=1.0, alpha=1.0, out_dtype=None, name=None) -Inplace 版本的 :ref:`cn_api_paddle_baddbmm` API，对输入 `input` 采用 Inplace 策略。 +Inplace 版本的 :ref:`cn_api_paddle_baddbmm` API，对输入 ``input`` 采用 Inplace 策略。 更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 .. _3.1.3 原位（Inplace）操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3 diff --git a/docs/api/paddle/binomial_cn.rst b/docs/api/paddle/binomial_cn.rst index c2ffb8197ca..9dc18ccfe33 100644 --- a/docs/api/paddle/binomial_cn.rst +++ b/docs/api/paddle/binomial_cn.rst @@ -5,7 +5,7 @@ binomial .. py:function:: paddle.binomial(count, prob, name=None) -以输入参数 ``count`` 和 ``prob`` 分别为二项分布的 `n` 和 `p` 参数，生成一个二项分布的随机数 Tensor ，支持 Tensor 形状广播。输出 Tensor 的 dtype 为 ``int64`` 。 +以输入参数 ``count`` 和 ``prob`` 分别为二项分布的 ``n`` 和 ``p`` 参数，生成一个二项分布的随机数 Tensor ，支持 Tensor 形状广播。输出 Tensor 的 dtype 为 ``int64`` 。 .. math:: diff --git a/docs/api/paddle/cos_cn.rst b/docs/api/paddle/cos_cn.rst index dd6114addf0..c517eccb626 100644 --- a/docs/api/paddle/cos_cn.rst +++ b/docs/api/paddle/cos_cn.rst @@ -10,7 +10,7 @@ cos 余弦函数。 -输入范围是 `(-inf, inf)`，输出范围是 `[-1,1]`。 +输入范围是 ``(-inf, inf)``，输出范围是 ``[-1,1]``。 .. math:: diff --git a/docs/api/paddle/cosh_cn.rst b/docs/api/paddle/cosh_cn.rst index b2fe0f828fa..122fda43dda 100644 --- a/docs/api/paddle/cosh_cn.rst +++ b/docs/api/paddle/cosh_cn.rst @@ -10,7 +10,7 @@ cosh 双曲余弦函数。 -输入范围是 `(-inf, inf)`，输出范围是 `[1,inf]`。 +输入范围是 ``(-inf, inf)``，输出范围是 ``[1,inf]``。 .. math:: diff --git a/docs/api/paddle/device/Overview_cn.rst b/docs/api/paddle/device/Overview_cn.rst index 6949846188f..afd8cb102a5 100644 --- a/docs/api/paddle/device/Overview_cn.rst +++ b/docs/api/paddle/device/Overview_cn.rst @@ -3,7 +3,7 @@ paddle.device ============================ -`paddle.device` 模块提供了一系列与设备相关的 API，用于管理和配置计算设备。具体如下： +``paddle.device`` 模块提供了一系列与设备相关的 API，用于管理和配置计算设备。具体如下： - :ref:`设备设置与属性获取 ` - :ref:`编译环境检测 ` diff --git a/docs/api/paddle/distributed/fleet/UtilBase_cn.rst b/docs/api/paddle/distributed/fleet/UtilBase_cn.rst index 4086cc9893c..16b624cf7db 100644 --- a/docs/api/paddle/distributed/fleet/UtilBase_cn.rst +++ b/docs/api/paddle/distributed/fleet/UtilBase_cn.rst @@ -78,7 +78,7 @@ COPY-FROM: paddle.distributed.fleet.UtilBase.get_file_shard print_on_rank(message, rank_id) ''''''''''''''''''''''''''''''''' -在编号为 `rank_id` 的节点上打印指定信息。 +在编号为 ``rank_id`` 的节点上打印指定信息。 **参数** diff --git a/docs/api/paddle/distributed/parallelize_cn.rst b/docs/api/paddle/distributed/parallelize_cn.rst index 9fe62aa1905..5f1581113f9 100644 --- a/docs/api/paddle/distributed/parallelize_cn.rst +++ b/docs/api/paddle/distributed/parallelize_cn.rst @@ -46,9 +46,9 @@ parallelize 返回 ::::::::: -Model：一个具有分布式视角的 `Model` 对象。 +Model：一个具有分布式视角的 ``Model`` 对象。 -Optimizer：一个具有分布式视角的 `Optimizer` 对象。如果用户为提供优化器对象，则返回 None。 +Optimizer：一个具有分布式视角的 ``Optimizer`` 对象。如果用户为提供优化器对象，则返回 None。 代码示例 diff --git a/docs/api/paddle/distributed/shard_scaler_cn.rst b/docs/api/paddle/distributed/shard_scaler_cn.rst index f54eacb4949..e4786c6aaea 100644 --- a/docs/api/paddle/distributed/shard_scaler_cn.rst +++ b/docs/api/paddle/distributed/shard_scaler_cn.rst @@ -14,7 +14,7 @@ shard_scaler - **scaler** (paddle.amp.GradScaler) - 单卡视角下的 `GradScaler`。 返回 ::::::::: -GradScaler：一个具有分布式视角的 `GradScaler` 对象。 +GradScaler：一个具有分布式视角的 ``GradScaler`` 对象。 代码示例 diff --git a/docs/api/paddle/distributed/spawn_cn.rst b/docs/api/paddle/distributed/spawn_cn.rst index 94657ba6cea..6a40feb5a60 100644 --- a/docs/api/paddle/distributed/spawn_cn.rst +++ b/docs/api/paddle/distributed/spawn_cn.rst @@ -8,7 +8,7 @@ spawn 使用 ``spawn`` 方法启动多进程任务。 .. note:: - ``spawn`` 目前仅支持 GPU 和 XPU 的 collective 模式。GPU 和 XPU 的 collective 模式不能同时启动，因此 `gpus` 和 `xpus` 这两个参数不能同时配置。 + ``spawn`` 目前仅支持 GPU 和 XPU 的 collective 模式。GPU 和 XPU 的 collective 模式不能同时启动，因此 ``gpus`` 和 ``xpus`` 这两个参数不能同时配置。 参数 ::::::::: diff --git a/docs/api/paddle/distribution/Cauchy_cn.rst b/docs/api/paddle/distribution/Cauchy_cn.rst index d49619b874c..3510298958d 100644 --- a/docs/api/paddle/distribution/Cauchy_cn.rst +++ b/docs/api/paddle/distribution/Cauchy_cn.rst @@ -64,7 +64,7 @@ sample(shape=[], name=None) 生成指定维度的样本。 .. note:: - `sample` 方法没有梯度，如果需要的话，请使用 `rsample` 方法代替。 + ``sample`` 方法没有梯度，如果需要的话，请使用 ``rsample`` 方法代替。 **参数** diff --git a/docs/api/paddle/distribution/LKJCholesky_cn.rst b/docs/api/paddle/distribution/LKJCholesky_cn.rst index d94405fd37a..4876995d989 100644 --- a/docs/api/paddle/distribution/LKJCholesky_cn.rst +++ b/docs/api/paddle/distribution/LKJCholesky_cn.rst @@ -17,7 +17,7 @@ LKJ 分布通常定义为对相关矩阵 :math:`\Omega` 的分布，其密度函 其中，:math:`\Omega` 是一个 :math:`n \times n` 的相关矩阵，:math:`\eta` 是分布的形状参数，:math:`|\Omega|` 是矩阵的行列式。参数 :math:`\eta` 调节矩阵元素的分布集中度。 -相关矩阵的下三角 Choleskey 因子的 LJK 分布支持两种 sample 方法:`onion` 和 `cvine` +相关矩阵的下三角 Choleskey 因子的 LJK 分布支持两种 sample 方法：``onion`` 和 ``cvine``。 参数 :::::::::::: diff --git a/docs/api/paddle/distribution/Normal_cn.rst b/docs/api/paddle/distribution/Normal_cn.rst index b3b3815ea54..b3667a648b6 100644 --- a/docs/api/paddle/distribution/Normal_cn.rst +++ b/docs/api/paddle/distribution/Normal_cn.rst @@ -8,7 +8,7 @@ Normal 正态分布 -若 `loc` 是实数，概率密度函数为： +若 ``loc`` 是实数，概率密度函数为： .. math:: @@ -16,7 +16,7 @@ Normal Z = (2 \pi \sigma^2)^{0.5} -若 `loc` 是复数，概率密度函数为： +若 ``loc`` 是复数，概率密度函数为： .. math:: diff --git a/docs/api/paddle/equal_cn.rst b/docs/api/paddle/equal_cn.rst index b015be888ef..39706a5969c 100644 --- a/docs/api/paddle/equal_cn.rst +++ b/docs/api/paddle/equal_cn.rst @@ -5,7 +5,7 @@ equal .. py:function:: paddle.equal(x, y, name=None) -返回 :math:`x==y` 逐元素比较 x 和 y 是否相等，相同位置的元素相同则返回 True，否则返回 False。使用重载算子 `==` 可以有相同的计算函数效果。 +返回 :math:`x==y` 逐元素比较 x 和 y 是否相等，相同位置的元素相同则返回 True，否则返回 False。使用重载算子 ``==`` 可以有相同的计算函数效果。 .. note:: 输出的结果不返回梯度。 diff --git a/docs/api/paddle/fft/irfftn_cn.rst b/docs/api/paddle/fft/irfftn_cn.rst index 96670beaa1e..e37fe10d6f5 100644 --- a/docs/api/paddle/fft/irfftn_cn.rst +++ b/docs/api/paddle/fft/irfftn_cn.rst @@ -7,8 +7,8 @@ irfftn 通过快速傅里叶变换(FFT)算法计算 N 维实数傅里叶变换 （rfftn）的逆变换。 -该函数通过快速傅立叶变换（FFT）计算 M-D 矩阵中任意轴上实输入的 N-D 离散傅立叶变换的逆。即，在计算精度内 ``irfftn(rfftn(x), x.shape) == x`` 成立。（ ``x.shape`` 的信息是必要的，其存在原因与 `irfft` 中的 ``len(x)`` 相同）。 -此函数输入的排序方式应与 `irfft` 返回的方式相同。 +该函数通过快速傅立叶变换（FFT）计算 M-D 矩阵中任意轴上实输入的 N-D 离散傅立叶变换的逆。即，在计算精度内 ``irfftn(rfftn(x), x.shape) == x`` 成立。（ ``x.shape`` 的信息是必要的，其存在原因与 ``irfft`` 中的 ``len(x)`` 相同）。 +此函数输入的排序方式应与 ``irfft`` 返回的方式相同。 参数 ::::::::: diff --git a/docs/api/paddle/fluid/Overview_cn.rst b/docs/api/paddle/fluid/Overview_cn.rst index 618a71b9566..0e8bca09bb3 100644 --- a/docs/api/paddle/fluid/Overview_cn.rst +++ b/docs/api/paddle/fluid/Overview_cn.rst @@ -3,4 +3,4 @@ paddle.fluid --------------------- .. warning:: - 从飞桨框架 2.5 版本开始，我们已经废弃了 `paddle.fluid` namespace 下的 API，请使用其他的替代 API，请参考 :ref:`cn_guides_api_mapping` 获取更多信息。如有疑问，请于 `Issue 区 `_ 按规范提交 Issue。 + 从飞桨框架 2.5 版本开始，我们已经废弃了 ``paddle.fluid`` namespace 下的 API，请使用其他的替代 API，请参考 :ref:`cn_guides_api_mapping` 获取更多信息。如有疑问，请于 `Issue 区 `_ 按规范提交 Issue。 diff --git a/docs/api/paddle/frac_cn.rst b/docs/api/paddle/frac_cn.rst index 3ddfca784e0..d3abf2d7e12 100644 --- a/docs/api/paddle/frac_cn.rst +++ b/docs/api/paddle/frac_cn.rst @@ -6,7 +6,7 @@ frac .. py:function:: paddle.frac(x, name=None, *, out=None) -得到输入 `Tensor` 的小数部分。 +得到输入 ``Tensor`` 的小数部分。 参数 diff --git a/docs/api/paddle/greater_equal_cn.rst b/docs/api/paddle/greater_equal_cn.rst index d7128ef0662..2f627039572 100644 --- a/docs/api/paddle/greater_equal_cn.rst +++ b/docs/api/paddle/greater_equal_cn.rst @@ -5,7 +5,7 @@ greater_equal .. py:function:: paddle.greater_equal(x, y, name=None) -逐元素地返回 :math:`x >= y` 的逻辑值，相同位置前者输入大于等于后者输入返回 True，否则返回 False。使用重载算子 `>=` 可以有相同的计算函数效果。 +逐元素地返回 :math:`x >= y` 的逻辑值，相同位置前者输入大于等于后者输入返回 True，否则返回 False。使用重载算子 ``>=`` 可以有相同的计算函数效果。 .. note:: 输出的结果不返回梯度。 diff --git a/docs/api/paddle/greater_than_cn.rst b/docs/api/paddle/greater_than_cn.rst index fe31ca7e1fc..fc4f37fc4e1 100644 --- a/docs/api/paddle/greater_than_cn.rst +++ b/docs/api/paddle/greater_than_cn.rst @@ -5,7 +5,7 @@ greater_than .. py:function:: paddle.greater_than(x, y, name=None) -返回 :math:`x>y` 逐元素比较 x 和 y 是否相等，相同位置前者输入大于等于后者输入则返回 True，否则返回 False。使用重载算子 `>` 可以有相同的计算函数效果。 +返回 :math:`x>y` 逐元素比较 x 和 y 是否相等，相同位置前者输入大于等于后者输入则返回 True，否则返回 False。使用重载算子 ``>`` 可以有相同的计算函数效果。 .. note:: 输出的结果不返回梯度。 diff --git a/docs/api/paddle/heaviside_cn.rst b/docs/api/paddle/heaviside_cn.rst index 7782005ef6c..8971de9dcb6 100644 --- a/docs/api/paddle/heaviside_cn.rst +++ b/docs/api/paddle/heaviside_cn.rst @@ -36,7 +36,7 @@ heaviside 返回 ::::::::: -`Tensor`，存储运算后的结果。如果 :attr:`x` 和 :attr:`y` 有不同的形状且是可以广播的，那么返回 Tensor 的形状是 :attr:`x` 和 :attr:`y` 经过广播后的形状。如果 :attr:`x` 和 :attr:`y` 有相同的形状，那么返回 Tensor 的形状与 :attr:`x` 和 :attr:`y` 相同。 +``Tensor``，存储运算后的结果。如果 :attr:`x` 和 :attr:`y` 有不同的形状且是可以广播的，那么返回 Tensor 的形状是 :attr:`x` 和 :attr:`y` 经过广播后的形状。如果 :attr:`x` 和 :attr:`y` 有相同的形状，那么返回 Tensor 的形状与 :attr:`x` 和 :attr:`y` 相同。 代码示例 diff --git a/docs/api/paddle/incubate/asp/decorate_cn.rst b/docs/api/paddle/incubate/asp/decorate_cn.rst index 562bb218d9d..e51952eb809 100644 --- a/docs/api/paddle/incubate/asp/decorate_cn.rst +++ b/docs/api/paddle/incubate/asp/decorate_cn.rst @@ -6,7 +6,7 @@ decorate .. py:function:: paddle.incubate.asp.decorate(optimizer) -用于包装给定的优化器为具有稀疏性保证的优化器 `OptimizerWithSparsityGuarantee`。如果在动态图模式下运行，装饰时 ASP 会为支持的参数创建掩码变量。如果在静态图模式下运行，ASP 会在调用 minimize() 时创建掩码变量并插入必要的掩码操作。 +用于包装给定的优化器为具有稀疏性保证的优化器 ``OptimizerWithSparsityGuarantee``。如果在动态图模式下运行，装饰时 ASP 会为支持的参数创建掩码变量。如果在静态图模式下运行，ASP 会在调用 minimize() 时创建掩码变量并插入必要的掩码操作。 参数 diff --git a/docs/api/paddle/incubate/asp/reset_excluded_layers_cn.rst b/docs/api/paddle/incubate/asp/reset_excluded_layers_cn.rst index 29e16718342..e413d266c30 100644 --- a/docs/api/paddle/incubate/asp/reset_excluded_layers_cn.rst +++ b/docs/api/paddle/incubate/asp/reset_excluded_layers_cn.rst @@ -6,7 +6,7 @@ reset_excluded_layers .. py:function:: paddle.incubate.asp.reset_excluded_layers(main_program=None) -重置与 `main_program` 对应的 excluded_layers 设置。如果 `main_program` 为 None，则 excepted_layers 的所有配置都将被清除。 +重置与 ``main_program`` 对应的 excluded_layers 设置。如果 ``main_program`` 为 None，则 excepted_layers 的所有配置都将被清除。 参数 diff --git a/docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst b/docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst index 85d3db7aad3..0677d4313c2 100644 --- a/docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst +++ b/docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst @@ -30,7 +30,7 @@ forward(x, residual) 返回 :::::::::::: -Tensor|tuple：与 `x` 具有相同数据类型和形状的张量 +Tensor|tuple：与 ``x`` 具有相同数据类型和形状的张量 extra_repr() :::::::::::: diff --git a/docs/api/paddle/incubate/nn/FusedLinear_cn.rst b/docs/api/paddle/incubate/nn/FusedLinear_cn.rst index c188ea2aaf7..2784808ac5e 100644 --- a/docs/api/paddle/incubate/nn/FusedLinear_cn.rst +++ b/docs/api/paddle/incubate/nn/FusedLinear_cn.rst @@ -14,7 +14,7 @@ FusedLinear 层只接受一个 Tensor 作为输入，形状为 :math:`[batch\_si - **in_features** (int) – 线性变换层输入单元的数目。 - **out_features** (int) – 线性变换层输出单元的数目。 - **weight_attr** (ParamAttr，可选) - 指定权重参数的属性。默认值为 None，权重将初始化为零。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。 -- **transpose_weight** (bool) - 在乘积运算前是否转置 `weight` 张量。 +- **transpose_weight** (bool) - 在乘积运算前是否转置 ``weight`` 张量。 - **bias_attr** (ParamAttr|bool，可选) – 指定偏置参数的属性。:math:`bias\_attr` 为 bool 类型且设置为 False 时，表示不会为该层添加偏置。:math:`bias\_attr` 如果设置为 True 或者 None，则表示使用默认的偏置参数属性，将偏置参数初始化为 0。具体用法请参见 :ref:`cn_api_paddle_ParamAttr`。默认值为 None。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/incubate/nn/functional/fused_multi_head_attention_cn.rst b/docs/api/paddle/incubate/nn/functional/fused_multi_head_attention_cn.rst index aefe992da37..e056f29d350 100644 --- a/docs/api/paddle/incubate/nn/functional/fused_multi_head_attention_cn.rst +++ b/docs/api/paddle/incubate/nn/functional/fused_multi_head_attention_cn.rst @@ -42,7 +42,7 @@ fused_multi_head_attention 算子目前只支持在 GPU 下运行，其包含的 out = layer_norm(out) -值得注意的是，该 API 中，q, k, v 的 weight 被统一存储在一个权重 Tensor 中，形状为 `[3, num_heads, head_dim, embed_dim]` , +值得注意的是，该 API 中，q, k, v 的 weight 被统一存储在一个权重 Tensor 中，形状为 ``[3, num_heads, head_dim, embed_dim]`` , 如果想得到单独的 q, k 或 v 的 weight，可以通过转置和切分得到。 diff --git a/docs/api/paddle/is_tensor_cn.rst b/docs/api/paddle/is_tensor_cn.rst index a4c9816d45a..9820910cc58 100644 --- a/docs/api/paddle/is_tensor_cn.rst +++ b/docs/api/paddle/is_tensor_cn.rst @@ -5,7 +5,7 @@ is_tensor .. py:function:: paddle.is_tensor(x) -测试输入对象是否是 `paddle.Tensor` +测试输入对象是否是 ``paddle.Tensor`` .. note:: 别名支持: 参数名 ``obj`` 可替代 ``x``，如 ``is_tensor(obj=tensor_x)`` 等价于 ``is_tensor(x=tensor_x)`` 。 @@ -18,7 +18,7 @@ is_tensor 返回 :::::::::::: -bool 值，如果 x 是 `paddle.Tensor` 类型返回 True，反之返回 False。 +bool 值，如果 x 是 ``paddle.Tensor`` 类型返回 True，反之返回 False。 代码示例 :::::::::::: diff --git a/docs/api/paddle/isfinite_cn.rst b/docs/api/paddle/isfinite_cn.rst index 440f58ebe9d..6c270005225 100644 --- a/docs/api/paddle/isfinite_cn.rst +++ b/docs/api/paddle/isfinite_cn.rst @@ -5,7 +5,7 @@ isfinite .. py:function:: paddle.isfinite(x, name=None) -返回输入 Tensor 的每一个值是否为有限值（既非 `+/-INF` 也非 `+/-NaN` ）。 +返回输入 Tensor 的每一个值是否为有限值（既非 ``+/-INF`` 也非 ``+/-NaN`` ）。 .. note:: 别名支持: 参数名 ``input`` 可替代 ``x``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``。 diff --git a/docs/api/paddle/isinf_cn.rst b/docs/api/paddle/isinf_cn.rst index 35752a71dd0..76be80f3dbb 100644 --- a/docs/api/paddle/isinf_cn.rst +++ b/docs/api/paddle/isinf_cn.rst @@ -5,7 +5,7 @@ isinf .. py:function:: paddle.isinf(x, name=None) -返回输入 tensor 的每一个值是否为 `+/-INF` 。 +返回输入 tensor 的每一个值是否为 ``+/-INF`` 。 .. note:: 别名支持: 参数名 ``input`` 可替代 ``x``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``。 diff --git a/docs/api/paddle/isnan_cn.rst b/docs/api/paddle/isnan_cn.rst index 1c835eed570..c7527ec629a 100644 --- a/docs/api/paddle/isnan_cn.rst +++ b/docs/api/paddle/isnan_cn.rst @@ -5,7 +5,7 @@ isnan .. py:function:: paddle.isnan(x, name=None) -返回输入 tensor 的每一个值是否为 `+/-NaN` 。 +返回输入 tensor 的每一个值是否为 ``+/-NaN`` 。 .. note:: 别名支持: 参数名 ``input`` 可替代 ``x``，如 ``input=tensor_x`` 等价于 ``x=tensor_x``。 diff --git a/docs/api/paddle/isneginf_cn.rst b/docs/api/paddle/isneginf_cn.rst index e5332a7cee0..f025b78cde8 100644 --- a/docs/api/paddle/isneginf_cn.rst +++ b/docs/api/paddle/isneginf_cn.rst @@ -5,7 +5,7 @@ isneginf .. py:function:: paddle.isneginf(x, name=None) -返回输入 tensor 的每一个值是否为 `-INF` 。 +返回输入 tensor 的每一个值是否为 ``-INF`` 。 参数 ::::::::: diff --git a/docs/api/paddle/isposinf_cn.rst b/docs/api/paddle/isposinf_cn.rst index 36da3c14d9c..4c96f272033 100644 --- a/docs/api/paddle/isposinf_cn.rst +++ b/docs/api/paddle/isposinf_cn.rst @@ -5,7 +5,7 @@ isposinf .. py:function:: paddle.isposinf(x, name=None) -返回输入 tensor 的每一个值是否为 `+INF` 。 +返回输入 tensor 的每一个值是否为 ``+INF`` 。 参数 ::::::::: diff --git a/docs/api/paddle/ldexp_cn.rst b/docs/api/paddle/ldexp_cn.rst index c1c1e02f8d2..c59534fd605 100644 --- a/docs/api/paddle/ldexp_cn.rst +++ b/docs/api/paddle/ldexp_cn.rst @@ -5,7 +5,7 @@ ldexp .. py:function:: paddle.ldexp(x, y, name=None) -计算 `x` 乘以 2 的 `y` 次幂 +计算 ``x`` 乘以 2 的 ``y`` 次幂 .. math:: out = x * 2^{y} diff --git a/docs/api/paddle/less_cn.rst b/docs/api/paddle/less_cn.rst index 4c707414c47..9a7227a1c65 100644 --- a/docs/api/paddle/less_cn.rst +++ b/docs/api/paddle/less_cn.rst @@ -5,7 +5,7 @@ less .. py:function:: paddle.less(x, y, name=None) -逐元素地返回 :math:`x < y` 的逻辑值，相同位置前者输入小于后者输入则返回 True，否则返回 False。使用重载算子 `<` 可以有相同的计算函数效果。 +逐元素地返回 :math:`x < y` 的逻辑值，相同位置前者输入小于后者输入则返回 True，否则返回 False。使用重载算子 ``<`` 可以有相同的计算函数效果。 .. note:: 输出的结果不返回梯度。 diff --git a/docs/api/paddle/less_equal_cn.rst b/docs/api/paddle/less_equal_cn.rst index 0a9e1fe0d26..199f8151856 100644 --- a/docs/api/paddle/less_equal_cn.rst +++ b/docs/api/paddle/less_equal_cn.rst @@ -5,7 +5,7 @@ less_equal .. py:function:: paddle.less_equal(x, y, name=None) -逐元素地返回 :math:`x <= y` 的逻辑值，相同位置前者输入小于等于后者输入则返回 True，否则返回 False。使用重载算子 `<=` 可以有相同的计算函数效果。 +逐元素地返回 :math:`x <= y` 的逻辑值，相同位置前者输入小于等于后者输入则返回 True，否则返回 False。使用重载算子 ``<=`` 可以有相同的计算函数效果。 .. note:: 输出的结果不返回梯度。 diff --git a/docs/api/paddle/less_than_cn.rst b/docs/api/paddle/less_than_cn.rst index 77c01ea8727..082086c3b42 100644 --- a/docs/api/paddle/less_than_cn.rst +++ b/docs/api/paddle/less_than_cn.rst @@ -5,7 +5,7 @@ less_than .. py:function:: paddle.less_than(x, y, name=None) -逐元素地返回 :math:`x < y` 的逻辑值，相同位置前者输入小于后者输入则返回 True，否则返回 False。使用重载算子 `<` 可以有相同的计算函数效果。 +逐元素地返回 :math:`x < y` 的逻辑值，相同位置前者输入小于后者输入则返回 True，否则返回 False。使用重载算子 ``<`` 可以有相同的计算函数效果。 .. note:: 输出的结果不返回梯度。 diff --git a/docs/api/paddle/linalg/Overview_cn.rst b/docs/api/paddle/linalg/Overview_cn.rst index 97d4b557dae..5c6e5cc37e1 100644 --- a/docs/api/paddle/linalg/Overview_cn.rst +++ b/docs/api/paddle/linalg/Overview_cn.rst @@ -62,7 +62,7 @@ paddle.linalg 目录下包含飞桨框架支持的线性代数相关 API。具 " :ref:`paddle.linalg.eigh ` ", "计算厄米特矩阵或者实数对称矩阵的特征值和特征向量" " :ref:`paddle.linalg.eigvalsh ` ", "计算厄米特矩阵或者实数对称矩阵的特征值" " :ref:`paddle.linalg.cholesky ` ", "计算一个实数对称正定矩阵的 Cholesky 分解" - " :ref:`paddle.linalg.cholesky_inverse ` ", "使用 Cholesky 因子 `U` 计算对称正定矩阵的逆矩阵" + " :ref:`paddle.linalg.cholesky_inverse ` ", "使用 Cholesky 因子 ``U`` 计算对称正定矩阵的逆矩阵" " :ref:`paddle.linalg.svd ` ", "计算矩阵的奇异值分解" " :ref:`paddle.linalg.svdvals ` ", "计算矩阵的奇异值" " :ref:`paddle.linalg.svd_lowrank ` ", "对低秩矩阵进行奇异值分解" @@ -70,7 +70,7 @@ paddle.linalg 目录下包含飞桨框架支持的线性代数相关 API。具 " :ref:`paddle.linalg.qr ` ", "计算矩阵的正交三角分解（也称 QR 分解）" " :ref:`paddle.linalg.lu ` ", "计算矩阵的 LU 分解" " :ref:`paddle.linalg.lu_unpack ` ", "对矩阵的 LU 分解结果进行展开得到各单独矩阵" - " :ref:`paddle.linalg.householder_product ` ", "计算 Householder 矩阵乘积的前 n 列(输入矩阵为 `[*,m,n]` )" + " :ref:`paddle.linalg.householder_product ` ", "计算 Householder 矩阵乘积的前 n 列(输入矩阵为 ``[*,m,n]`` )" " :ref:`paddle.linalg.ormqr ` ", "计算一个普通矩阵与 Householder 矩阵的乘积" .. _about_solvers: diff --git a/docs/api/paddle/linalg/solve_cn.rst b/docs/api/paddle/linalg/solve_cn.rst index aa43b44043f..6e1a0b9ed49 100644 --- a/docs/api/paddle/linalg/solve_cn.rst +++ b/docs/api/paddle/linalg/solve_cn.rst @@ -8,12 +8,12 @@ solve 计算线性方程组的解。 -记 :math:`X` 为一个或一批方阵，:math:`Y` 一个或一批矩阵，当 `left` 为 True 时，公式为： +记 :math:`X` 为一个或一批方阵，:math:`Y` 一个或一批矩阵，当 ``left`` 为 True 时，公式为： .. math:: Out = X ^ {-1} * Y -当 `left` 为 False 时，公式为： +当 ``left`` 为 False 时，公式为： .. math:: Out = Y * X ^ {-1} diff --git a/docs/api/paddle/linalg/triangular_solve_cn.rst b/docs/api/paddle/linalg/triangular_solve_cn.rst index 389cd4e6c94..68b920f8ee0 100644 --- a/docs/api/paddle/linalg/triangular_solve_cn.rst +++ b/docs/api/paddle/linalg/triangular_solve_cn.rst @@ -6,7 +6,7 @@ triangular_solve .. py:function:: paddle.linalg.triangular_solve(x, y, upper=True, transpose=False, unitriangular=False, name=None) -计算具有唯一解的线性方程组解，其中参数 `x` 是上(下)三角系数矩阵，`y` 为线性方程组右边的矩阵。 +计算具有唯一解的线性方程组解，其中参数 ``x`` 是上(下)三角系数矩阵，``y`` 为线性方程组右边的矩阵。 记 :math:`x` 表示一个或一批方阵，:math:`y` 表示一个或一批矩阵。 diff --git a/docs/api/paddle/linalg/vecdot_cn.rst b/docs/api/paddle/linalg/vecdot_cn.rst index 88d5c652e76..ffd8636aa90 100644 --- a/docs/api/paddle/linalg/vecdot_cn.rst +++ b/docs/api/paddle/linalg/vecdot_cn.rst @@ -6,7 +6,7 @@ vecdot .. py:function:: paddle.linalg.vecdot(x, y, axis=-1, name=None) 计算两个张量沿指定轴的点积。 -该函数对两个张量进行逐元素相乘，并沿指定轴求和以计算它们的点积。支持任意维度的张量（包括 0 维张量），只要张量`x`和`y`的形状在指定轴上可广播即可。 +该函数对两个张量进行逐元素相乘，并沿指定轴求和以计算它们的点积。支持任意维度的张量（包括 0 维张量），只要张量 ``x`` 和 ``y`` 的形状在指定轴上可广播即可。 参数 diff --git a/docs/api/paddle/metric/Precision_cn.rst b/docs/api/paddle/metric/Precision_cn.rst index b029b37c7f4..c970bb7e33b 100644 --- a/docs/api/paddle/metric/Precision_cn.rst +++ b/docs/api/paddle/metric/Precision_cn.rst @@ -43,7 +43,7 @@ update(preds, labels, *args) **参数** - **preds** (numpy.array | Tensor)：预测输出结果通常是 sigmoid 函数的输出，是一个数据类型为 float64 或 float32 的向量。 - - **labels** (numpy.array | Tensor)：真实标签的 shape 和：code: `preds` 相同，数据类型为 int32 或 int64。 + - **labels** (numpy.array | Tensor)：真实标签的 shape 和 ``preds`` 相同，数据类型为 int32 或 int64。 **返回** diff --git a/docs/api/paddle/metric/Recall_cn.rst b/docs/api/paddle/metric/Recall_cn.rst index 503da78b375..2a4deb157e9 100644 --- a/docs/api/paddle/metric/Recall_cn.rst +++ b/docs/api/paddle/metric/Recall_cn.rst @@ -43,7 +43,7 @@ update(preds, labels, *args) **参数** - **preds** (numpy.array | Tensor)：预测输出结果通常是 sigmoid 函数的输出，是一个数据类型为 float64 或 float32 的向量。 - - **labels** (numpy.array | Tensor)：真实标签的 shape 和：code: `preds` 相同，数据类型为 int32 或 int64。 + - **labels** (numpy.array | Tensor)：真实标签的 shape 和 ``preds`` 相同，数据类型为 int32 或 int64。 **返回** diff --git a/docs/api/paddle/neg__cn.rst b/docs/api/paddle/neg__cn.rst index 8892a1a4737..9cbeb45a4e4 100644 --- a/docs/api/paddle/neg__cn.rst +++ b/docs/api/paddle/neg__cn.rst @@ -5,7 +5,7 @@ neg\_ .. py:function:: paddle.neg_(x, name=None) -Inplace 版本的 :ref:`cn_api_paddle_neg` API，对输入 `input` 采用 Inplace 策略。 +Inplace 版本的 :ref:`cn_api_paddle_neg` API，对输入 ``input`` 采用 Inplace 策略。 更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 diff --git a/docs/api/paddle/not_equal_cn.rst b/docs/api/paddle/not_equal_cn.rst index 1e5dc4c56ff..78a246cf9d0 100644 --- a/docs/api/paddle/not_equal_cn.rst +++ b/docs/api/paddle/not_equal_cn.rst @@ -5,7 +5,7 @@ not_equal .. py:function:: paddle.not_equal(x, y, name=None) -返回 :math:`x!=y` 逐元素比较 x 和 y 是否相等，相同位置的元素不相同则返回 True，否则返回 False。使用重载算子 `!=` 可以有相同的计算函数效果。 +返回 :math:`x!=y` 逐元素比较 x 和 y 是否相等，相同位置的元素不相同则返回 True，否则返回 False。使用重载算子 ``!=`` 可以有相同的计算函数效果。 .. note:: 输出的结果不返回梯度。 diff --git a/docs/api/paddle/optimizer/Adadelta_cn.rst b/docs/api/paddle/optimizer/Adadelta_cn.rst index cfeb4644a66..eac1566700e 100644 --- a/docs/api/paddle/optimizer/Adadelta_cn.rst +++ b/docs/api/paddle/optimizer/Adadelta_cn.rst @@ -34,7 +34,7 @@ Adadelta 优化器，是对 :ref:`Adagrad ` 的 默认值为 None，此时将不进行梯度裁剪。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 -Adadelta 优化器出自 `DECOUPLED WEIGHT DECAY REGULARIZATION 论文 `，用来解决 Adam 优化器中 L2 正则化失效的问题。 +Adadelta 优化器出自 `DECOUPLED WEIGHT DECAY REGULARIZATION 论文 `_，用来解决 Adam 优化器中 L2 正则化失效的问题。 diff --git a/docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst b/docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst index 6e13b8542c2..74810402939 100644 --- a/docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst @@ -46,7 +46,7 @@ COPY-FROM: paddle.optimizer.lr.CosineAnnealingDecay step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/CosineAnnealingWarmRestarts_cn.rst b/docs/api/paddle/optimizer/lr/CosineAnnealingWarmRestarts_cn.rst index d75be03d7b8..7b3169ff8b6 100644 --- a/docs/api/paddle/optimizer/lr/CosineAnnealingWarmRestarts_cn.rst +++ b/docs/api/paddle/optimizer/lr/CosineAnnealingWarmRestarts_cn.rst @@ -42,7 +42,7 @@ COPY-FROM: paddle.optimizer.lr.CosineAnnealingWarmRestarts:code-example2 step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/CyclicLR_cn.rst b/docs/api/paddle/optimizer/lr/CyclicLR_cn.rst index 67b9b2b74a0..7f75e47cd95 100644 --- a/docs/api/paddle/optimizer/lr/CyclicLR_cn.rst +++ b/docs/api/paddle/optimizer/lr/CyclicLR_cn.rst @@ -13,7 +13,7 @@ CyclicLR 内置了三种学习率缩放策略：**triangular**：没有任何缩放的三角循环。**triangular2**：每个三角循环里将初始幅度缩放一半。**exp_range**：每个循环中将初始幅度按照指数函数进行缩放，公式为 :math:`gamma^{iterations}`。 -初始幅度由 `max_learning_rate - base_learning_rate` 定义。同时需要注意 CyclicLR 应在每次迭代后调用 ``step`` 方法。 +初始幅度由 ``max_learning_rate - base_learning_rate`` 定义。同时需要注意 CyclicLR 应在每次迭代后调用 ``step`` 方法。 参数 :::::::::::: @@ -43,7 +43,7 @@ COPY-FROM: paddle.optimizer.lr.CyclicLR step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/ExponentialDecay_cn.rst b/docs/api/paddle/optimizer/lr/ExponentialDecay_cn.rst index cc28203da7a..75a25c689e1 100644 --- a/docs/api/paddle/optimizer/lr/ExponentialDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/ExponentialDecay_cn.rst @@ -35,7 +35,7 @@ COPY-FROM: paddle.optimizer.lr.ExponentialDecay step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/InverseTimeDecay_cn.rst b/docs/api/paddle/optimizer/lr/InverseTimeDecay_cn.rst index ebe9f53a9df..a20ae1dcc25 100644 --- a/docs/api/paddle/optimizer/lr/InverseTimeDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/InverseTimeDecay_cn.rst @@ -37,7 +37,7 @@ COPY-FROM: paddle.optimizer.lr.InverseTimeDecay step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/LRScheduler_cn.rst b/docs/api/paddle/optimizer/lr/LRScheduler_cn.rst index 2325f74fa25..de4b4e49940 100644 --- a/docs/api/paddle/optimizer/lr/LRScheduler_cn.rst +++ b/docs/api/paddle/optimizer/lr/LRScheduler_cn.rst @@ -67,7 +67,7 @@ COPY-FROM: paddle.optimizer.lr.LRScheduler step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/LambdaDecay_cn.rst b/docs/api/paddle/optimizer/lr/LambdaDecay_cn.rst index 722a7c28fc1..99a12d7e52e 100644 --- a/docs/api/paddle/optimizer/lr/LambdaDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/LambdaDecay_cn.rst @@ -42,7 +42,7 @@ COPY-FROM: paddle.optimizer.lr.LambdaDecay step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/LinearLR_cn.rst b/docs/api/paddle/optimizer/lr/LinearLR_cn.rst index 7953d27d24d..cfe64cc7419 100644 --- a/docs/api/paddle/optimizer/lr/LinearLR_cn.rst +++ b/docs/api/paddle/optimizer/lr/LinearLR_cn.rst @@ -34,7 +34,7 @@ COPY-FROM: paddle.optimizer.lr.LinearLR:code-static step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst b/docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst index ecfd7f0d1b5..70614a1e10b 100644 --- a/docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst +++ b/docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst @@ -47,7 +47,7 @@ COPY-FROM: paddle.optimizer.lr.LinearWarmup step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/MultiStepDecay_cn.rst b/docs/api/paddle/optimizer/lr/MultiStepDecay_cn.rst index b5d40e896cb..6f96efe2d64 100644 --- a/docs/api/paddle/optimizer/lr/MultiStepDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/MultiStepDecay_cn.rst @@ -44,7 +44,7 @@ COPY-FROM: paddle.optimizer.lr.MultiStepDecay step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/MultiplicativeDecay_cn.rst b/docs/api/paddle/optimizer/lr/MultiplicativeDecay_cn.rst index 4f11fe72d4b..b4b78368bcc 100644 --- a/docs/api/paddle/optimizer/lr/MultiplicativeDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/MultiplicativeDecay_cn.rst @@ -42,7 +42,7 @@ COPY-FROM: paddle.optimizer.lr.MultiplicativeDecay step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/NaturalExpDecay_cn.rst b/docs/api/paddle/optimizer/lr/NaturalExpDecay_cn.rst index 5213933030d..505750fcc2b 100644 --- a/docs/api/paddle/optimizer/lr/NaturalExpDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/NaturalExpDecay_cn.rst @@ -35,7 +35,7 @@ COPY-FROM: paddle.optimizer.lr.NaturalExpDecay step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/NoamDecay_cn.rst b/docs/api/paddle/optimizer/lr/NoamDecay_cn.rst index d5889874af0..4456629d455 100644 --- a/docs/api/paddle/optimizer/lr/NoamDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/NoamDecay_cn.rst @@ -39,7 +39,7 @@ COPY-FROM: paddle.optimizer.lr.NoamDecay step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/OneCycleLR_cn.rst b/docs/api/paddle/optimizer/lr/OneCycleLR_cn.rst index 0b1a2aad343..adbdbe2ea06 100644 --- a/docs/api/paddle/optimizer/lr/OneCycleLR_cn.rst +++ b/docs/api/paddle/optimizer/lr/OneCycleLR_cn.rst @@ -42,7 +42,7 @@ COPY-FROM: paddle.optimizer.lr.OneCycleLR step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/PolynomialDecay_cn.rst b/docs/api/paddle/optimizer/lr/PolynomialDecay_cn.rst index a42fbde5b60..dda6f2780a3 100644 --- a/docs/api/paddle/optimizer/lr/PolynomialDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/PolynomialDecay_cn.rst @@ -51,7 +51,7 @@ COPY-FROM: paddle.optimizer.lr.PolynomialDecay step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/optimizer/lr/StepDecay_cn.rst b/docs/api/paddle/optimizer/lr/StepDecay_cn.rst index fa99559b03a..01f2bc3809e 100644 --- a/docs/api/paddle/optimizer/lr/StepDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/StepDecay_cn.rst @@ -5,7 +5,7 @@ StepDecay .. py:class:: paddle.optimizer.lr.StepDecay(learning_rate, step_size, gamma=0.1, last_epoch=-1, verbose=False) -该接口提供一种学习率按指定 `间隔` 轮数衰减的策略。 +该接口提供一种学习率按指定 ``间隔`` 轮数衰减的策略。 衰减过程可以参考以下代码： @@ -44,7 +44,7 @@ COPY-FROM: paddle.optimizer.lr.StepDecay step(epoch=None) ''''''''' -step 函数需要在优化器的 `optimizer.step()` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 +step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用，调用之后将会根据 epoch 数来更新学习率，更新之后的学习率将会在优化器下一轮更新参数时使用。 **参数** diff --git a/docs/api/paddle/poisson_cn.rst b/docs/api/paddle/poisson_cn.rst index 4091c361f64..985fe821146 100644 --- a/docs/api/paddle/poisson_cn.rst +++ b/docs/api/paddle/poisson_cn.rst @@ -5,7 +5,7 @@ poisson .. py:function:: paddle.poisson(x, name=None) -以输入参数 ``x`` 为泊松分布的 `lambda` 参数，生成一个泊松分布的随机数 Tensor，输出 Tensor 的 shape 和 dtype 与输入 Tensor 相同。 +以输入参数 ``x`` 为泊松分布的 ``lambda`` 参数，生成一个泊松分布的随机数 Tensor，输出 Tensor 的 shape 和 dtype 与输入 Tensor 相同。 .. math:: out_i \sim Poisson(lambda = x_i) @@ -17,7 +17,7 @@ poisson 返回 ::::::::: -`Tensor`：泊松分布的随机数 Tensor，shape 和 dtype 与输入 ``x`` 相同。 +``Tensor``：泊松分布的随机数 Tensor，shape 和 dtype 与输入 ``x`` 相同。 代码示例 diff --git a/docs/api/paddle/reshape_cn.rst b/docs/api/paddle/reshape_cn.rst index 39e121d9233..f86ca8268d9 100644 --- a/docs/api/paddle/reshape_cn.rst +++ b/docs/api/paddle/reshape_cn.rst @@ -9,7 +9,7 @@ reshape 在保持输入 ``x`` 数据不变的情况下，改变 ``x`` 的形状。 请注意，在动态图模式下，输出 Tensor 将与输入 Tensor 共享数据，并且没有 Tensor 数据拷贝的过程。 -如果不希望输入与输出共享数据，请使用 `Tensor.clone`，例如 `reshape_clone_x = x.reshape([-1]).clone()` 。 +如果不希望输入与输出共享数据，请使用 ``Tensor.clone``，例如 ``reshape_clone_x = x.reshape([-1]).clone()`` 。 在指定目标 shape 时存在一些技巧： diff --git a/docs/api/paddle/scatter__cn.rst b/docs/api/paddle/scatter__cn.rst index 0f3ff097cfe..783e5a5d4d1 100644 --- a/docs/api/paddle/scatter__cn.rst +++ b/docs/api/paddle/scatter__cn.rst @@ -19,7 +19,7 @@ Inplace 版本的 :ref:`cn_api_paddle_scatter` API，对输入 ``x`` 采用 Inpl .. py:function:: paddle.scatter_(input, dim, index, src, reduce=None, out=None) -PyTorch 兼容 Inplace 版本的 :ref:`cn_api_paddle_scatter` API，对输入 `input` 采用 Inplace 策略。 +PyTorch 兼容 Inplace 版本的 :ref:`cn_api_paddle_scatter` API，对输入 ``input`` 采用 Inplace 策略。 更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 diff --git a/docs/api/paddle/signal/istft_cn.rst b/docs/api/paddle/signal/istft_cn.rst index 44b11c94471..069c325d960 100644 --- a/docs/api/paddle/signal/istft_cn.rst +++ b/docs/api/paddle/signal/istft_cn.rst @@ -17,8 +17,8 @@ istft 上式中符号的意义： - :math:`t`：短时傅里叶变换中的第 :math:`t` 帧输入信号； -- :math:`N`: `n_fft` 参数的值； -- :math:`H`: `hop_length` 参数的值。 +- :math:`N`: ``n_fft`` 参数的值； +- :math:`H`: ``hop_length`` 参数的值。 ``paddle.signal.istft`` 的结果理论上是 ``paddle.signal.stft`` 的原始输入 ``x``，但 @@ -29,28 +29,28 @@ istft 参数 ::::::::: -- **x** (Tensor) - 输入数据，是维度为 2D 或者 3D 的 Tensor，数据类型必须为复数（复信号），其 - 形状为 ``[..., fft_size, num_frames]``； -- **n_fft** (int) - 离散傅里叶变换的样本点个数； -- **hop_length** (int，可选) - 对输入分帧时，相邻两帧偏移的样本点个数，默认为 ``None`` - (为 ``n_fft//4``)； -- **win_length** (int，可选) - 信号窗的长度，默认为 ``None`` (为 ``n_fft``)； -- **window** (int，可选) - 维度为 1D 长度为 ``win_length`` 的 Tensor，数据类型可为复数。 - 如果 ``win_length < n_fft``，该 Tensor 将被补长至 ``n_fft``。默认为 ``None`` (长 - 度为 ``win_length`` 幅值为 1 的矩形窗)； -- **center** (bool，可选) - 选择是否将输入信号进行补长，使得第 - :math:`t \times hop\_length` 个样本点在第 :math:`t` 帧的中心，默认为 ``True``； -- **normalized** (bool，可选) - 是否将傅里叶变换的结果乘以值为 :math:`1/sqrt(n)` 的缩放 - 系数； -- **onesided** (bool，可选) - 该参数与 ``paddle.signal.stft`` 中的有区别，此处表示 - 告知接口输入的 ``x`` 是否为满足共轭对称性的短时傅里叶变换 Tensor 的一半。若满足上述条件， - 且设为 ``True``，则 ``paddle.signal.istft`` 将返回一个实信号，默认为 ``True``； -- **length** (int，可选) - 指定输出信号的长度，该信号将从逆短时傅里叶变换的结果中截取。 - 默认为 ``None`` (返回不截取的信号)； -- **return_complex** (bool，可选) - 表示输出的重构信号是否为复信号。如果 - ``return_complex`` 设为 ``True``， ``onesided`` 必须设为 ``False``，默认 - 为 ``False``； -- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 + - **x** (Tensor) - 输入数据，是维度为 2D 或者 3D 的 Tensor，数据类型必须为复数（复信号），其 + 形状为 ``[..., fft_size, num_frames]``； + - **n_fft** (int) - 离散傅里叶变换的样本点个数； + - **hop_length** (int，可选) - 对输入分帧时，相邻两帧偏移的样本点个数，默认为 ``None`` + (为 ``n_fft//4``)； + - **win_length** (int，可选) - 信号窗的长度，默认为 ``None`` (为 ``n_fft``)； + - **window** (int，可选) - 维度为 1D 长度为 ``win_length`` 的 Tensor，数据类型可为复数。 + 如果 ``win_length < n_fft``，该 Tensor 将被补长至 ``n_fft``。默认为 ``None`` (长 + 度为 ``win_length`` 幅值为 1 的矩形窗)； + - **center** (bool，可选) - 选择是否将输入信号进行补长，使得第 + :math:`t \times hop\_length` 个样本点在第 :math:`t` 帧的中心，默认为 ``True``； + - **normalized** (bool，可选) - 是否将傅里叶变换的结果乘以值为 :math:`1/sqrt(n)` 的缩放 + 系数； + - **onesided** (bool，可选) - 该参数与 ``paddle.signal.stft`` 中的有区别，此处表示 + 告知接口输入的 ``x`` 是否为满足共轭对称性的短时傅里叶变换 Tensor 的一半。若满足上述条件， + 且设为 ``True``，则 ``paddle.signal.istft`` 将返回一个实信号，默认为 ``True``； + - **length** (int，可选) - 指定输出信号的长度，该信号将从逆短时傅里叶变换的结果中截取。 + 默认为 ``None`` (返回不截取的信号)； + - **return_complex** (bool，可选) - 表示输出的重构信号是否为复信号。如果 + ``return_complex`` 设为 ``True``， ``onesided`` 必须设为 ``False``，默认 + 为 ``False``； + - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 ::::::::: diff --git a/docs/api/paddle/signal/stft_cn.rst b/docs/api/paddle/signal/stft_cn.rst index 4d09840094d..205f4b034ec 100644 --- a/docs/api/paddle/signal/stft_cn.rst +++ b/docs/api/paddle/signal/stft_cn.rst @@ -21,7 +21,7 @@ stft - :math:`t`：第 :math:`t` 帧输入信号； - :math:`f`：傅里叶变换频域的自变量，如果 ``onesided=False`` , :math:`f` 取值范围是 :math:`0 \leq f < n\_fft` , - 如果 `onesided=True`，取值范围是 + 如果 ``onesided=True``，取值范围是 :math:`0 \leq f < \lfloor n\_fft / 2 \rfloor + 1`； - :math:`N`: ``n_fft`` 参数的值； - :math:`H`: ``hop_length`` 参数的值。 diff --git a/docs/api/paddle/sinh_cn.rst b/docs/api/paddle/sinh_cn.rst index 649db1b3ad6..4f4f5ae749b 100644 --- a/docs/api/paddle/sinh_cn.rst +++ b/docs/api/paddle/sinh_cn.rst @@ -10,7 +10,7 @@ sinh 双曲正弦函数。 -输入范围是 `(-inf, inf)`，输出范围是 `(-inf, inf)`。 +输入范围是 ``(-inf, inf)``，输出范围是 ``(-inf, inf)``。 .. math:: diff --git a/docs/api/paddle/sparse/Overview_cn.rst b/docs/api/paddle/sparse/Overview_cn.rst index 3e0d89b6617..9206982c899 100644 --- a/docs/api/paddle/sparse/Overview_cn.rst +++ b/docs/api/paddle/sparse/Overview_cn.rst @@ -59,7 +59,7 @@ paddle.sparse 目录包含飞桨框架支持稀疏数据存储和计算相关的 " :ref:`paddle.sparse.reshape ` ", "改变一个 SparseTensor 的形状" " :ref:`paddle.sparse.coalesce` ", "对 SparseCooTensor 进行排序并合并" " :ref:`paddle.sparse.transpose ` ", "在不改变数据的情况下改变 ``x`` 的维度顺序, 支持 COO 格式的多维 SparseTensor 以及 COO 格式的 2 维和 3 维 SparseTensor" - " :ref:`paddle.sparse.mask_as` ", "稀疏张量的掩码逻辑，使用稀疏张量 `mask` 的索引过滤输入的稠密张量 `x`" + " :ref:`paddle.sparse.mask_as` ", "稀疏张量的掩码逻辑，使用稀疏张量 ``mask`` 的索引过滤输入的稠密张量 ``x``" .. _about_sparse_nn: diff --git a/docs/api/paddle/sparse/abs_cn.rst b/docs/api/paddle/sparse/abs_cn.rst index e328a3c4d51..5b1bf38f7cf 100644 --- a/docs/api/paddle/sparse/abs_cn.rst +++ b/docs/api/paddle/sparse/abs_cn.rst @@ -6,7 +6,7 @@ abs .. py:function:: paddle.sparse.abs(x, name=None) -逐元素计算输入 :attr:`x` 的绝对值，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素计算输入 :attr:`x` 的绝对值，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/asin_cn.rst b/docs/api/paddle/sparse/asin_cn.rst index 89d89bdfe20..b6c6ebc3f3c 100644 --- a/docs/api/paddle/sparse/asin_cn.rst +++ b/docs/api/paddle/sparse/asin_cn.rst @@ -6,7 +6,7 @@ asin .. py:function:: paddle.sparse.asin(x, name=None) -逐元素计算输入 :attr:`x` 的反正弦，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素计算输入 :attr:`x` 的反正弦，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/asinh_cn.rst b/docs/api/paddle/sparse/asinh_cn.rst index cf731ec4b7f..c0af01f8a82 100644 --- a/docs/api/paddle/sparse/asinh_cn.rst +++ b/docs/api/paddle/sparse/asinh_cn.rst @@ -6,7 +6,7 @@ asinh .. py:function:: paddle.sparse.asinh(x, name=None) -逐元素计算输入 :attr:`x` 的反双曲正弦，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素计算输入 :attr:`x` 的反双曲正弦，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/atan_cn.rst b/docs/api/paddle/sparse/atan_cn.rst index 9531da44230..67723abce08 100644 --- a/docs/api/paddle/sparse/atan_cn.rst +++ b/docs/api/paddle/sparse/atan_cn.rst @@ -6,7 +6,7 @@ atan .. py:function:: paddle.sparse.atan(x, name=None) -逐元素计算输入 :attr:`x` 的反正切，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素计算输入 :attr:`x` 的反正切，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/atanh_cn.rst b/docs/api/paddle/sparse/atanh_cn.rst index 066ee004da6..3a2a88e5fb5 100644 --- a/docs/api/paddle/sparse/atanh_cn.rst +++ b/docs/api/paddle/sparse/atanh_cn.rst @@ -6,7 +6,7 @@ atanh .. py:function:: paddle.sparse.atanh(x, name=None) -逐元素计算输入 :attr:`x` 的反双曲正切，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素计算输入 :attr:`x` 的反双曲正切，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/deg2rad_cn.rst b/docs/api/paddle/sparse/deg2rad_cn.rst index f34825a612d..6310353c88b 100644 --- a/docs/api/paddle/sparse/deg2rad_cn.rst +++ b/docs/api/paddle/sparse/deg2rad_cn.rst @@ -6,7 +6,7 @@ deg2rad .. py:function:: paddle.sparse.deg2rad(x, name=None) -逐元素将输入 :attr:`x` 从度转换为弧度，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素将输入 :attr:`x` 从度转换为弧度，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/log1p_cn.rst b/docs/api/paddle/sparse/log1p_cn.rst index 82e8c5293a9..8ef05b7bf86 100644 --- a/docs/api/paddle/sparse/log1p_cn.rst +++ b/docs/api/paddle/sparse/log1p_cn.rst @@ -5,7 +5,7 @@ log1p .. py:function:: paddle.sparse.log1p(x, name=None) -逐元素计算 :attr:`x+1` 的自然对数，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素计算 :attr:`x+1` 的自然对数，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/neg_cn.rst b/docs/api/paddle/sparse/neg_cn.rst index 400b7931fdf..cdc446898a6 100644 --- a/docs/api/paddle/sparse/neg_cn.rst +++ b/docs/api/paddle/sparse/neg_cn.rst @@ -6,7 +6,7 @@ neg .. py:function:: paddle.sparse.neg(x, name=None) -逐元素计算 :attr:`x` 的相反数，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素计算 :attr:`x` 的相反数，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/nn/LeakyReLU_cn.rst b/docs/api/paddle/sparse/nn/LeakyReLU_cn.rst index e0f055c27e0..3bb4cc07751 100644 --- a/docs/api/paddle/sparse/nn/LeakyReLU_cn.rst +++ b/docs/api/paddle/sparse/nn/LeakyReLU_cn.rst @@ -4,7 +4,7 @@ LeakyReLU ------------------------------- .. py:class:: paddle.sparse.nn.LeakyReLU(negative_slope=0.01, name=None) -稀疏 LeakyReLU 激活层，创建一个可调用对象以计算输入 `x` 的 `LeakReLU` 。 +稀疏 LeakyReLU 激活层，创建一个可调用对象以计算输入 ``x`` 的 ``LeakReLU`` 。 .. math:: LeakyReLU(x)= diff --git a/docs/api/paddle/sparse/nn/ReLU6_cn.rst b/docs/api/paddle/sparse/nn/ReLU6_cn.rst index 8912550fd77..a447a8a5bc7 100644 --- a/docs/api/paddle/sparse/nn/ReLU6_cn.rst +++ b/docs/api/paddle/sparse/nn/ReLU6_cn.rst @@ -4,7 +4,7 @@ ReLU6 ------------------------------- .. py:class:: paddle.sparse.nn.ReLU6(name=None) -稀疏 ReLU6 激活层，创建一个可调用对象以计算输入 `x` 的 `ReLU6` 。 +稀疏 ReLU6 激活层，创建一个可调用对象以计算输入 ``x`` 的 ``ReLU6`` 。 .. math:: ReLU6(x) = min(max(0,x), 6) diff --git a/docs/api/paddle/sparse/nn/ReLU_cn.rst b/docs/api/paddle/sparse/nn/ReLU_cn.rst index cd47ef259ac..c45fa7e8926 100644 --- a/docs/api/paddle/sparse/nn/ReLU_cn.rst +++ b/docs/api/paddle/sparse/nn/ReLU_cn.rst @@ -4,7 +4,7 @@ ReLU ------------------------------- .. py:class:: paddle.sparse.nn.ReLU(name=None) -稀疏 ReLU 激活层，创建一个可调用对象以计算输入 `x` 的 `ReLU` 。 +稀疏 ReLU 激活层，创建一个可调用对象以计算输入 ``x`` 的 ``ReLU`` 。 .. math:: ReLU(x) = max(x, 0) diff --git a/docs/api/paddle/sparse/nn/functional/leaky_relu_cn.rst b/docs/api/paddle/sparse/nn/functional/leaky_relu_cn.rst index 331ef21ed0c..24430f81d7c 100644 --- a/docs/api/paddle/sparse/nn/functional/leaky_relu_cn.rst +++ b/docs/api/paddle/sparse/nn/functional/leaky_relu_cn.rst @@ -4,7 +4,7 @@ leaky_relu ------------------------------- .. py:function:: paddle.sparse.nn.functional.leaky_relu(x, negative_slope=0.01, name=None) -稀疏 leaky_relu 激活函数，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +稀疏 leaky_relu 激活函数，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 .. math:: leaky_relu(x)= diff --git a/docs/api/paddle/sparse/nn/functional/relu6_cn.rst b/docs/api/paddle/sparse/nn/functional/relu6_cn.rst index e612638612c..faadc8675e4 100644 --- a/docs/api/paddle/sparse/nn/functional/relu6_cn.rst +++ b/docs/api/paddle/sparse/nn/functional/relu6_cn.rst @@ -4,7 +4,7 @@ relu6 ------------------------------- .. py:function:: paddle.sparse.nn.functional.relu6(x, name=None) -稀疏 relu6 激活函数，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +稀疏 relu6 激活函数，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 .. math:: relu6(x) = min(max(0, x), 6) diff --git a/docs/api/paddle/sparse/nn/functional/relu_cn.rst b/docs/api/paddle/sparse/nn/functional/relu_cn.rst index 99393c62514..309e52d225e 100644 --- a/docs/api/paddle/sparse/nn/functional/relu_cn.rst +++ b/docs/api/paddle/sparse/nn/functional/relu_cn.rst @@ -4,7 +4,7 @@ relu ------------------------------- .. py:function:: paddle.sparse.nn.functional.relu(x, name=None) -稀疏 relu 激活函数，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +稀疏 relu 激活函数，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 .. math:: relu(x) = max(x, 0) diff --git a/docs/api/paddle/sparse/rad2deg_cn.rst b/docs/api/paddle/sparse/rad2deg_cn.rst index 64eee2721f1..ec8d53303be 100644 --- a/docs/api/paddle/sparse/rad2deg_cn.rst +++ b/docs/api/paddle/sparse/rad2deg_cn.rst @@ -6,7 +6,7 @@ rad2deg .. py:function:: paddle.sparse.rad2deg(x, name=None) -逐元素将输入 :attr:`x` 从弧度转换为度，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素将输入 :attr:`x` 从弧度转换为度，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/sin_cn.rst b/docs/api/paddle/sparse/sin_cn.rst index 6cf81831c7b..07c1f7e4150 100644 --- a/docs/api/paddle/sparse/sin_cn.rst +++ b/docs/api/paddle/sparse/sin_cn.rst @@ -5,7 +5,7 @@ sin .. py:function:: paddle.sparse.sin(x, name=None) -逐元素计算 :attr:`x` 的正弦，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素计算 :attr:`x` 的正弦，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/sinh_cn.rst b/docs/api/paddle/sparse/sinh_cn.rst index b8e6a8eeb75..5264c3c6788 100644 --- a/docs/api/paddle/sparse/sinh_cn.rst +++ b/docs/api/paddle/sparse/sinh_cn.rst @@ -5,7 +5,7 @@ sinh .. py:function:: paddle.sparse.sinh(x, name=None) -逐元素计算 :attr:`x` 的双曲正弦，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素计算 :attr:`x` 的双曲正弦，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/sparse/sqrt_cn.rst b/docs/api/paddle/sparse/sqrt_cn.rst index 1cbf40a44be..94f81cf6b91 100644 --- a/docs/api/paddle/sparse/sqrt_cn.rst +++ b/docs/api/paddle/sparse/sqrt_cn.rst @@ -5,7 +5,7 @@ sqrt .. py:function:: paddle.sparse.sqrt(x, name=None) -逐元素计算 :attr:`x` 的算术平方根，要求 输入 :attr:`x` 为 `SparseCooTensor` 或 `SparseCsrTensor` 。 +逐元素计算 :attr:`x` 的算术平方根，要求 输入 :attr:`x` 为 ``SparseCooTensor`` 或 ``SparseCsrTensor`` 。 数学公式： diff --git a/docs/api/paddle/static/CompiledProgram_cn.rst b/docs/api/paddle/static/CompiledProgram_cn.rst index 80f1b3bdcfc..dfc144f78c8 100644 --- a/docs/api/paddle/static/CompiledProgram_cn.rst +++ b/docs/api/paddle/static/CompiledProgram_cn.rst @@ -7,7 +7,7 @@ CompiledProgram .. py:class:: paddle.static.CompiledProgram(program_or_graph, build_strategy=None) -CompiledProgram 根据 `build_strategy` 的配置将输入的 Program 或 Graph 进行转换和优化，例如：计算图中算子融合、计算图执行过程中开启内存/显存优化等，关于 build_strategy 更多信息。请参阅 :ref:`cn_api_paddle_static_BuildStrategy`。 +CompiledProgram 根据 ``build_strategy`` 的配置将输入的 Program 或 Graph 进行转换和优化，例如：计算图中算子融合、计算图执行过程中开启内存/显存优化等，关于 build_strategy 更多信息。请参阅 :ref:`cn_api_paddle_static_BuildStrategy`。 参数 ::::::::: diff --git a/docs/api/paddle/static/nn/group_norm_cn.rst b/docs/api/paddle/static/nn/group_norm_cn.rst index 00852f17be5..28666ef82ef 100755 --- a/docs/api/paddle/static/nn/group_norm_cn.rst +++ b/docs/api/paddle/static/nn/group_norm_cn.rst @@ -23,7 +23,7 @@ group_norm 返回 ::::::::: -Tensor，数据类型和格式与 `input` 一致。 +Tensor，数据类型和格式与 ``input`` 一致。 代码示例 ::::::::: diff --git a/docs/api/paddle/t__cn.rst b/docs/api/paddle/t__cn.rst index f70db61f801..22501f1e871 100644 --- a/docs/api/paddle/t__cn.rst +++ b/docs/api/paddle/t__cn.rst @@ -5,7 +5,7 @@ t\_ .. py:function:: paddle.t_(input, name=None) -Inplace 版本的 :ref:`cn_api_paddle_t` API，对输入 `input` 采用 Inplace 策略。 +Inplace 版本的 :ref:`cn_api_paddle_t` API，对输入 ``input`` 采用 Inplace 策略。 更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 diff --git a/docs/api/paddle/tril_cn.rst b/docs/api/paddle/tril_cn.rst index dd5371ccfaa..6a278296562 100644 --- a/docs/api/paddle/tril_cn.rst +++ b/docs/api/paddle/tril_cn.rst @@ -24,7 +24,7 @@ tril 返回 ::::::::: -Tensor，数据类型与输入 `input` 数据类型一致。 +Tensor，数据类型与输入 ``input`` 数据类型一致。 代码示例 diff --git a/docs/api/paddle/true_divide_cn.rst b/docs/api/paddle/true_divide_cn.rst index 7c9fb8dbaa8..983952e6897 100644 --- a/docs/api/paddle/true_divide_cn.rst +++ b/docs/api/paddle/true_divide_cn.rst @@ -5,4 +5,4 @@ true_divide .. py:function:: paddle.true_divide(input, other, *, out=None) -别名函数，功能与 :ref:`cn_api_paddle_divide` （设置 `rounding_mode=None` 时）完全相同，详情请参考 :ref:`cn_api_paddle_divide` 。 +别名函数，功能与 :ref:`cn_api_paddle_divide` （设置 ``rounding_mode=None`` 时）完全相同，详情请参考 :ref:`cn_api_paddle_divide` 。 diff --git a/docs/api_guides/low_level/optimizer.rst b/docs/api_guides/low_level/optimizer.rst index 2e63df78e6f..585db96a2ba 100644 --- a/docs/api_guides/low_level/optimizer.rst +++ b/docs/api_guides/low_level/optimizer.rst @@ -28,9 +28,7 @@ API Reference 请参考 :ref:`cn_api_paddle_optimizer_SGD` 3. Momentum ------------------------- :code:`Momentum` 优化器在 :code:`SGD` 基础上引入动量，减少了随机梯度下降过程中存在的噪声问题。 -用户在使用时可以将 :code:`use_nesterov` 参数设置为 False 或 True ，分别对应传统 `Momentum(论文 4.1 节) -`_ 算法和 `Nesterov accelerated gradient(论文 4.2 节) -`_ 算法。 +用户在使用时可以将 :code:`use_nesterov` 参数设置为 False 或 True ，分别对应传统 `Momentum(论文 4.1 节) `_ 算法和 `Nesterov accelerated gradient(论文 4.2 节) `_ 算法。 API Reference 请参考 :ref:`cn_api_paddle_optimizer_Momentum` diff --git a/docs/api_guides/low_level/optimizer_en.rst b/docs/api_guides/low_level/optimizer_en.rst index a004612ce98..5485ba73e74 100755 --- a/docs/api_guides/low_level/optimizer_en.rst +++ b/docs/api_guides/low_level/optimizer_en.rst @@ -28,9 +28,7 @@ API Reference: :ref:`api_paddle_optimizer_SGD` 3. Momentum ------------------------ :code:`Momentum` optimizer adds momentum on the basis of :code:`SGD` , reducing noise problem in the process of random gradient descent. -You can set :code:`use_nesterov` as False or True, respectively corresponding to traditional `Momentum(Section 4.1 in thesis) -`_ algorithm and `Nesterov accelerated gradient(Section 4.2 in thesis) -`_ algorithm. +You can set :code:`use_nesterov` as False or True, respectively corresponding to traditional `Momentum(Section 4.1 in thesis) `_ algorithm and `Nesterov accelerated gradient(Section 4.2 in thesis) `_ algorithm. API Reference: :ref:`api_paddle_optimizer_Momentum` diff --git a/docs/api_guides/low_level/parameter.rst b/docs/api_guides/low_level/parameter.rst index daab4993399..2a665d29f46 100644 --- a/docs/api_guides/low_level/parameter.rst +++ b/docs/api_guides/low_level/parameter.rst @@ -5,7 +5,7 @@ ######### .. note:: - `paddle.fluid.*` 已废弃，请使用 Paddle 最新版本的 API。 + ``paddle.fluid.*`` 已废弃，请使用 Paddle 最新版本的 API。 模型参数通常为模型中的 weight 和 bias，在 Paddle 动态图下对应 :code:`EagerParamBase` 类。模型参数是可学习的变量，拥有梯度并且可优化。在 Paddle 中可以通过 :ref:`cn_api_paddle_create_parameter` 来创建自定义参数。 @@ -139,7 +139,7 @@ Paddle 通过设置 :code:`ParamAttr` 的 :code:`regularizer` 属性为单个 pa Paddle 通过设置 :code:`ParamAttr` 的 :code:`do_model_average` 属性为单个 parameter 设置是否进行平均优化。 -默认值为 `True` 。 +默认值为 ``True`` 。 .. code-block:: python @@ -163,7 +163,7 @@ Clipping Paddle 通过设置 :code:`ParamAttr` 的 :code:`need_clip` 属性为单个 parameter 设置是否进行梯度裁剪。 -默认值为 `True` 。 +默认值为 ``True`` 。 .. code-block:: python @@ -178,21 +178,21 @@ Paddle 通过设置 :code:`ParamAttr` 的 :code:`need_clip` 属性为单个 para 1. GradientClipByGlobalNorm --------------------------- -将一个 Tensor 列表 `t_list` 中所有 Tensor 的 L2 范数之和，限定在 :code:`clip_norm` 范围内。 +将一个 Tensor 列表 ``t_list`` 中所有 Tensor 的 L2 范数之和，限定在 :code:`clip_norm` 范围内。 API 请参考：:ref:`cn_api_paddle_nn_ClipGradByGlobalNorm` 2. GradientClipByNorm --------------------- -将输入的多维 Tensor `X` 的 L2 范数限制在 :code:`clip_norm` 范围之内。 +将输入的多维 Tensor ``X`` 的 L2 范数限制在 :code:`clip_norm` 范围之内。 API 请参考：:ref:`cn_api_paddle_nn_ClipGradByNorm` 3. GradientClipByValue ---------------------- -将输入的多维 Tensor `X` 的值限制在 [min, max] 范围之内。 +将输入的多维 Tensor ``X`` 的值限制在 [min, max] 范围之内。 API 请参考：:ref:`cn_api_paddle_nn_ClipGradByValue` diff --git a/docs/api_guides/low_level/parameter_en.rst b/docs/api_guides/low_level/parameter_en.rst index 75c83afd745..dac95e92fde 100644 --- a/docs/api_guides/low_level/parameter_en.rst +++ b/docs/api_guides/low_level/parameter_en.rst @@ -5,7 +5,7 @@ Model Parameters ################## .. note:: - The `paddle.fluid.*` APIs are deprecated. Please use the latest Paddle API versions instead. + The ``paddle.fluid.*`` APIs are deprecated. Please use the latest Paddle API versions instead. Model parameters are usually weights and bias in the model. In Paddle's dynamic graph mode, they correspond to the :code:`EagerParamBase` class. Model parameters are learnable variables that have gradients and can be optimized. In Paddle, custom parameters can be created using :ref:`api_paddle_create_parameter` . @@ -137,7 +137,7 @@ Model Averaging Paddle determines whether to average a single parameter by setting attributes of :code:`do_model_average` in :code:`ParamAttr` . -- Default value: `True` . +- Default value: ``True`` . .. code-block:: python @@ -161,7 +161,7 @@ Clipping Paddle determines whether gradient clipping is applied to a single parameter by setting attributes of :code:`need_clip` in :code:`ParamAttr` . -- Default value: `True` . +- Default value: ``True`` . .. code-block:: python @@ -176,21 +176,21 @@ The following is the clipping method supported by Paddle: 1. GradientClipByGlobalNorm --------------------------- -Limits the sum of the L2 norms of all Tensors in a Tensor list `t_list` to the :code:`clip_norm` range. +Limits the sum of the L2 norms of all Tensors in a Tensor list ``t_list`` to the :code:`clip_norm` range. API reference: :ref:`api_paddle_nn_ClipGradByGlobalNorm` 2. GradientClipByNorm --------------------- -Limits the L2 norm of a multi-dimensional input Tensor `X` to the :code:`clip_norm` range. +Limits the L2 norm of a multi-dimensional input Tensor ``X`` to the :code:`clip_norm` range. API reference: :ref:`api_paddle_nn_ClipGradByNorm` 3. GradientClipByValue ---------------------- -Limits the values of a multi-dimensional input Tensor `X` to the range [min, max]. +Limits the values of a multi-dimensional input Tensor ``X`` to the range [min, max]. API reference: :ref:`api_paddle_nn_ClipGradByValue` diff --git a/docs/guides/06_distributed_training/cluster_quick_start_fl_ps_cn.rst b/docs/guides/06_distributed_training/cluster_quick_start_fl_ps_cn.rst index 574628802d8..d1b623282ed 100755 --- a/docs/guides/06_distributed_training/cluster_quick_start_fl_ps_cn.rst +++ b/docs/guides/06_distributed_training/cluster_quick_start_fl_ps_cn.rst @@ -81,7 +81,7 @@ FL-PS 训练主要包括如下几个部分： 1.2.2 配置文件 """""""""""" -所有的配置参数均写在文件 `config_fl.yaml` 里： +所有的配置参数均写在文件 ``config_fl.yaml`` 里： .. code-block:: python @@ -231,12 +231,12 @@ FL-PS 训练主要包括如下几个部分： 1.3.2 Coordinator 模块 """""""""""" -用户可以基于文件 `coordinator.py https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/distributed/ps/coordinator.py`_ 中定义的相关基类进行继承开发，用户自定义的各种 Client 选择算法均可以用 python 代码实现，从类 `ClientSelectorBase` 继承。 +用户可以基于文件 `coordinator.py https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/distributed/ps/coordinator.py`_ 中定义的相关基类进行继承开发，用户自定义的各种 Client 选择算法均可以用 python 代码实现，从类 ``ClientSelectorBase`` 继承。 1.3.3 构造自定义异构数据集 """""""""""" -参考脚本 `gen_heter_data.py` 写法。 +参考脚本 ``gen_heter_data.py`` 写法。 备注：本教程主要介绍了横向联邦 PS 的使用方法，关于纵向联邦 PS 的使用，请参考 `test_fl_ps.py https://github.com/PaddlePaddle/Paddle/blob/develop/test/ps/test_fl_ps.py`_ ，使用 1.3.1 节的编译命令，再执行下述命令即可