Skip to content

Commit 89ba9f4

Browse files
[Docs] Fix invalid single-backticks usage in guides docs (Batch 4) (#7872)
Co-authored-by: ooo oo <106524776+ooooo-create@users.noreply.github.com>
1 parent bfedb9f commit 89ba9f4

9 files changed

Lines changed: 18 additions & 18 deletions

File tree

docs/guides/advanced/gradient_clip_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464

6565
部分参数裁剪需要设置参数的 :ref:`paddle.ParamAttr <cn_api_paddle_ParamAttr>` ,其中的 ``need_clip`` 默认为 True,表示需要裁剪,如果设置为 False,则不会裁剪。
6666

67-
例如:仅裁剪 `linear` 中 `weight` 的梯度,则需要在创建 `linear` 层时设置 `bias_attr` 如下:
67+
例如:仅裁剪 ``linear`` 中 ``weight`` 的梯度,则需要在创建 ``linear`` 层时设置 ``bias_attr`` 如下:
6868

6969
.. code:: ipython3
7070
@@ -113,7 +113,7 @@
113113

114114
部分参数裁剪的设置方式与上面一致,也是通过设置参数的 :ref:`paddle.ParamAttr <cn_api_paddle_ParamAttr>` ,其中的 ``need_clip`` 默认为 True,表示需要裁剪,如果设置为 False,则不会裁剪。
115115

116-
例如:仅裁剪 `linear` 中 `bias` 的梯度,则需要在创建 `linear` 层时设置 `weight_attr` 如下:
116+
例如:仅裁剪 ``linear`` 中 ``bias`` 的梯度,则需要在创建 ``linear`` 层时设置 ``weight_attr`` 如下:
117117

118118
.. code:: ipython3
119119

docs/guides/advanced/gradient_clip_en.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ You can also clip gradients of a part of parameters as follow:
3232

3333
**b. Clip a part of gradients**
3434

35-
You can clip a part of gradients by setting `need_clip` of ref:`cn_api_fluid_ParamAttr` . `need_clip` is `True` by default, which represents that its gradient will be clipped. Otherwise, its gradient will not be clipped.
35+
You can clip a part of gradients by setting ``need_clip`` of :ref:`cn_api_fluid_ParamAttr` . ``need_clip`` is ``True`` by default, which represents that its gradient will be clipped. Otherwise, its gradient will not be clipped.
3636

3737
For example:
38-
If only clip the gradient of `weight` in `linear`, you should set `bias_attr` as follow:
38+
If only clip the gradient of ``weight`` in ``linear``, you should set ``bias_attr`` as follow:
3939

4040
.. code:: ipython3
4141
@@ -80,10 +80,10 @@ You can also clip gradients of a part of parameters as follow:
8080

8181
**b. Clip a part of gradients**
8282

83-
You can clip a part of gradients by setting `need_clip` of ref:`cn_api_fluid_ParamAttr` . `need_clip` is `True` by default, which represents that its gradient will be clipped. Otherwise, its gradient will not be clipped.
83+
You can clip a part of gradients by setting ``need_clip`` of :ref:`cn_api_fluid_ParamAttr` . ``need_clip`` is ``True`` by default, which represents that its gradient will be clipped. Otherwise, its gradient will not be clipped.
8484

8585
For example:
86-
If only clip the gradient of `bias` in `linear`, you should set `weight_attr` as follow:
86+
If only clip the gradient of ``bias`` in ``linear``, you should set ``weight_attr`` as follow:
8787

8888
.. code:: ipython3
8989
@@ -131,4 +131,4 @@ You can also clip gradients of a part of parameters as follow:
131131

132132
**b. Clip a part of gradients**
133133

134-
You can clip a part of gradients by setting `need_clip` of ref:`cn_api_fluid_ParamAttr` . `need_clip` is `True` by default, which represents that its gradient will be clipped. Otherwise, its gradient will not be clipped. Refer to the sample code above.
134+
You can clip a part of gradients by setting ``need_clip`` of :ref:`cn_api_fluid_ParamAttr` . ``need_clip`` is ``True`` by default, which represents that its gradient will be clipped. Otherwise, its gradient will not be clipped. Refer to the sample code above.

docs/guides/beginner/index_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
当完成了快速上手的任务后,下面这些模块会阐述如何用飞桨框架 2.0,实现深度学习过程中的每一步。具体包括:
1010

11-
- `Tensor 介绍 <./tensor_cn.html>`_ : 介绍飞桨基本数据类型 `Tensor` 的概念与常见用法。
11+
- `Tensor 介绍 <./tensor_cn.html>`_ : 介绍飞桨基本数据类型 ``Tensor`` 的概念与常见用法。
1212
- `数据集定义与加载 <./data_load_cn.html>`_ : 飞桨框架数据加载的方式,主要为\ ``paddle.io.Dataset + paddle.io.DataLoader``\ ,以及飞桨内置数据集的介绍。
1313
- `数据预处理 <./data_preprocessing_cn.html>`_ : 飞桨框架数据预处理的方法,主要是\ ``paddle.vision.transform.*``\
1414
- `模型组网 <./model_cn.html>`_ : 飞桨框架组网 API 的介绍,主要是\ ``paddle.nn.*``\ ,然后是飞桨框架组网方式的介绍,即 Sequential 的组网与 SubClass 的组网。

docs/guides/flags/debug_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ FLAGS_cpu_deterministic
2222
*******************************************
2323
(始于 0.15.0)
2424

25-
该 flag 用于调试。它表示是否在 CPU 侧确定计算结果。 在某些情况下,不同求和次序的结果可能不同,例如,`a+b+c+d` 的结果可能与 `c+a+b+d` 的结果不同。
25+
该 flag 用于调试。它表示是否在 CPU 侧确定计算结果。 在某些情况下,不同求和次序的结果可能不同,例如,``a+b+c+d`` 的结果可能与 ``c+a+b+d`` 的结果不同。
2626

2727
取值范围
2828
---------------

docs/guides/flags/debug_en.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ FLAGS_cpu_deterministic
2121
*******************************************
2222
(since 0.15.0)
2323

24-
This Flag is used for debugging. It indicates whether to make the result of computation deterministic in CPU side. In some case, the result of the different order of summing maybe different,for example, the result of `a+b+c+d` may be different with the result of `c+a+b+d`.
24+
This Flag is used for debugging. It indicates whether to make the result of computation deterministic in CPU side. In some case, the result of the different order of summing maybe different,for example, the result of ``a+b+c+d`` may be different with the result of ``c+a+b+d``.
2525

2626
Values accepted
2727
---------------

docs/guides/flags/npu_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ FLAGS_npu_precision_mode
88
*******************************************
99
(develop)
1010

11-
FLAGS_npu_precision_mode 用于配置昇腾 NPU 芯片算子精度模式。仅在编译选项选择`WITH_ASCEND_CL = ON`时有效。
11+
FLAGS_npu_precision_mode 用于配置昇腾 NPU 芯片算子精度模式。仅在编译选项选择 ``WITH_ASCEND_CL = ON`` 时有效。
1212

1313
取值范围
1414
---------------

docs/guides/flags/npu_en.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ FLAGS_npu_precision_mode
88
*******************************************
99
(develop)
1010

11-
FLAGS_npu_precision_mode is used to set the operator precision mode of Ascend Devices. Only valid when compiled `WITH_ASCEND_CL = ON`.
11+
FLAGS_npu_precision_mode is used to set the operator precision mode of Ascend Devices. Only valid when compiled ``WITH_ASCEND_CL = ON``.
1212

1313
Values accepted
1414
---------------

docs/guides/flags/others_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,22 +57,22 @@ FLAGS_sync_nccl_allreduce
5757
*******************************************
5858
(始于 1.3)
5959

60-
如果 FLAGS_sync_nccl_allreduce 为 True,则会在 allreduce_op_handle 中调用 `cudaStreamSynchronize(nccl_stream)` ,这种模式在某些情况下可以获得更好的性能。
60+
如果 FLAGS_sync_nccl_allreduce 为 True,则会在 allreduce_op_handle 中调用 ``cudaStreamSynchronize(nccl_stream)`` ,这种模式在某些情况下可以获得更好的性能。
6161

6262
取值范围
6363
---------------
6464
Bool 型,缺省值为 True。
6565

6666
示例
6767
-------
68-
FLAGS_sync_nccl_allreduce=True - 在 allreduce_op_handle 中调用 `cudaStreamSynchronize(nccl_stream)` 。
68+
FLAGS_sync_nccl_allreduce=True - 在 allreduce_op_handle 中调用 ``cudaStreamSynchronize(nccl_stream)`` 。
6969

7070

7171
FLAGS_tracer_profile_fname
7272
*******************************************
7373
(始于 1.4.0)
7474

75-
FLAGS_tracer_profile_fname 表示由 gperftools 生成的命令式跟踪器的分析器文件名。仅在编译选项选择`WITH_PROFILER = ON`时有效。如果禁用则设为 empty。
75+
FLAGS_tracer_profile_fname 表示由 gperftools 生成的命令式跟踪器的分析器文件名。仅在编译选项选择 ``WITH_PROFILER = ON`` 时有效。如果禁用则设为 empty。
7676

7777
取值范围
7878
---------------

docs/guides/flags/others_en.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,22 +57,22 @@ FLAGS_sync_nccl_allreduce
5757
*******************************************
5858
(since 1.3)
5959

60-
If the FLAGS_sync_nccl_allreduce is true, there will call `cudaStreamSynchronize(nccl_stream)` in allreduce_op_handle, this mode can get better performance in some scenarios.
60+
If the FLAGS_sync_nccl_allreduce is true, there will call ``cudaStreamSynchronize(nccl_stream)`` in allreduce_op_handle, this mode can get better performance in some scenarios.
6161

6262
Values accepted
6363
---------------
6464
Bool. The default value is True.
6565

6666
Example
6767
-------
68-
FLAGS_sync_nccl_allreduce=True will call `cudaStreamSynchronize(nccl_stream)` in allreduce_op_handle.
68+
FLAGS_sync_nccl_allreduce=True will call ``cudaStreamSynchronize(nccl_stream)`` in allreduce_op_handle.
6969

7070

7171
FLAGS_tracer_profile_fname
7272
*******************************************
7373
(since 1.4.0)
7474

75-
FLAGS_tracer_profile_fname indicates the profiler filename for imperative tracer, which generated by gperftools. Only valid when compiled `WITH_PROFILER=ON`. Empty if disabled.
75+
FLAGS_tracer_profile_fname indicates the profiler filename for imperative tracer, which generated by gperftools. Only valid when compiled ``WITH_PROFILER=ON``. Empty if disabled.
7676

7777
Values accepted
7878
---------------

0 commit comments

Comments
 (0)