Skip to content

Commit bfedb9f

Browse files
authored
[Docs] Fix invalid single-backticks usage in API docs (Batch 3) (#7871)
1 parent 093dc0d commit bfedb9f

98 files changed

Lines changed: 142 additions & 146 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/api/paddle/Overview_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ tensor 元素操作相关原位(inplace)版本
579579
:widths: 10, 30
580580

581581
" :ref:`paddle.cast_ <cn_api_paddle_cast_>` ", "Inplace 版本的 cast API,对输入 x 采用 Inplace 策略"
582-
" :ref:`paddle.index_add_ <cn_api_paddle_index_add_>` ", "Inplace 版本的 :ref:`cn_api_paddle_index_add` API,对输入 `x` 采用 Inplace 策略"
582+
" :ref:`paddle.index_add_ <cn_api_paddle_index_add_>` ", "Inplace 版本的 :ref:`cn_api_paddle_index_add` API,对输入 ``x`` 采用 Inplace 策略"
583583
" :ref:`paddle.index_put_ <cn_api_paddle_index_put_>` ", "依据索引 ``indices`` ,将指定位置的 ``x`` 重新赋值为 ``value`` "
584584
" :ref:`paddle.reshape_ <cn_api_paddle_reshape_>` ", "Inplace 版本的 reshape API,对输入 x 采用 Inplace 策略"
585585
" :ref:`paddle.scatter_ <cn_api_paddle_scatter_>` ", "Inplace 版本的 scatter API,对输入 x 采用 Inplace 策略 "

docs/api/paddle/addmm__cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ addmm\_
44
-------------------------------
55

66
.. py:function:: paddle.addmm_(input, x, y, beta=1.0, alpha=1.0, name=None)
7-
Inplace 版本的 :ref:`cn_api_paddle_addmm` API,对输入 `input` 采用 Inplace 策略。
7+
Inplace 版本的 :ref:`cn_api_paddle_addmm` API,对输入 ``input`` 采用 Inplace 策略。
88

99
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
1010

docs/api/paddle/amp/debugging/compare_accuracy_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ compare_accuracy
44
-------------------------------
55
.. py:function:: paddle.amp.debugging.compare_accuracy(dump_path, another_dump_path, output_filename, loss_scale=1, dump_all_tensors=False)
66
7-
`compare_accuracy` 是一个精度比对的工具,可以用来比较 float16 和 float32 的 log 数据。
7+
``compare_accuracy`` 是一个精度比对的工具,可以用来比较 float16 和 float32 的 log 数据。
88

99
参数
1010
:::::::::

docs/api/paddle/as_tensor_cn.rst

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

66
.. py:function:: paddle.as_tensor(data, dtype=None, device=None, requires_grad=False, pin_memory=False)
77
8-
`paddle.tensor` 的别名,详细参考 :ref:`cn_api_paddle_tensor`。
8+
``paddle.tensor`` 的别名,详细参考 :ref:`cn_api_paddle_tensor`。

docs/api/paddle/baddbmm__cn.rst

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

66
.. py:function:: paddle.baddbmm_(input, x, y, beta=1.0, alpha=1.0, out_dtype=None, name=None)
77
8-
Inplace 版本的 :ref:`cn_api_paddle_baddbmm` API,对输入 `input` 采用 Inplace 策略。
8+
Inplace 版本的 :ref:`cn_api_paddle_baddbmm` API,对输入 ``input`` 采用 Inplace 策略。
99
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。
1010

1111
.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

docs/api/paddle/binomial_cn.rst

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

66
.. py:function:: paddle.binomial(count, prob, name=None)
77
8-
以输入参数 ``count`` 和 ``prob`` 分别为二项分布的 `n` 和 `p` 参数,生成一个二项分布的随机数 Tensor ,支持 Tensor 形状广播。输出 Tensor 的 dtype 为 ``int64`` 。
8+
以输入参数 ``count`` 和 ``prob`` 分别为二项分布的 ``n`` 和 ``p`` 参数,生成一个二项分布的随机数 Tensor ,支持 Tensor 形状广播。输出 Tensor 的 dtype 为 ``int64`` 。
99

1010
.. math::
1111

docs/api/paddle/cos_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ cos
1010
1111
余弦函数。
1212

13-
输入范围是 `(-inf, inf)`,输出范围是 `[-1,1]`。
13+
输入范围是 ``(-inf, inf)``,输出范围是 ``[-1,1]``。
1414

1515
.. math::
1616

docs/api/paddle/cosh_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ cosh
1010
1111
双曲余弦函数。
1212

13-
输入范围是 `(-inf, inf)`,输出范围是 `[1,inf]`。
13+
输入范围是 ``(-inf, inf)``,输出范围是 ``[1,inf]``。
1414

1515
.. math::
1616

docs/api/paddle/device/Overview_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
paddle.device
44
============================
55

6-
`paddle.device` 模块提供了一系列与设备相关的 API,用于管理和配置计算设备。具体如下:
6+
``paddle.device`` 模块提供了一系列与设备相关的 API,用于管理和配置计算设备。具体如下:
77

88
- :ref:`设备设置与属性获取 <cn_device_setting>`
99
- :ref:`编译环境检测 <cn_device_compile>`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ COPY-FROM: paddle.distributed.fleet.UtilBase.get_file_shard
7878

7979
print_on_rank(message, rank_id)
8080
'''''''''''''''''''''''''''''''''
81-
在编号为 `rank_id` 的节点上打印指定信息。
81+
在编号为 ``rank_id`` 的节点上打印指定信息。
8282

8383
**参数**
8484

0 commit comments

Comments
 (0)