[Docs] Fix invalid single-backticks usage in guides docs (Batch 4)#7872
Merged
ooooo-create merged 3 commits intoPaddlePaddle:developfrom Mar 13, 2026
Merged
Conversation
|
感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7872.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
📚 本次 PR 文档预览链接（点击展开）
|
cutetocute
changed the title
ooooo-create
approved these changes
Mar 13, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
该 PR 延续批量修复 RST 文档中单反引号误用的问题（将 inline literal/变量名从 ... 改为 ...），覆盖 flags 指南、入门索引与梯度裁剪高级指南，并尝试修正一个错误的交叉引用写法。
Changes:
- 将多处错误使用的单反引号 inline literal 替换为双反引号
...（中英 guides）。 - 修复
gradient_clip_en.rst中ref:形式的交叉引用为:ref:形式。 - 对部分示例/描述文本同步做了 inline literal 标注更新。
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/guides/flags/others_en.rst | 修正 inline literal 的反引号用法（并触及相关句子行）。 |
| docs/guides/flags/others_cn.rst | 修正 inline literal 的反引号用法（并触及相关句子行）。 |
| docs/guides/flags/npu_en.rst | 修正编译选项 inline literal 的反引号用法。 |
| docs/guides/flags/npu_cn.rst | 修正编译选项 inline literal 的反引号用法。 |
| docs/guides/flags/debug_en.rst | 修正表达式 inline literal 的反引号用法。 |
| docs/guides/flags/debug_cn.rst | 修正表达式 inline literal 的反引号用法。 |
| docs/guides/beginner/index_cn.rst | 修正 Tensor inline literal 的反引号用法。 |
| docs/guides/advanced/gradient_clip_en.rst | 修正 inline literal，并将错误的 ref: 改为 :ref:（引入引用有效性风险点）。 |
| docs/guides/advanced/gradient_clip_cn.rst | 修正 inline literal 的反引号用法。 |
You can also share your feedback on Copilot code review. Take the survey.
| (始于 0.15.0) | ||
|
|
||
| 该 flag 用于调试。它表示是否在 CPU 侧确定计算结果。 在某些情况下，不同求和次序的结果可能不同，例如，`a+b+c+d` 的结果可能与 `c+a+b+d` 的结果不同。 | ||
| 该 flag 用于调试。它表示是否在 CPU 侧确定计算结果。 在某些情况下，不同求和次序的结果可能不同，例如，``a+b+c+d`` 的结果可能与 ``c+a+b+d`` 的结果不同。 |
| (since 1.4.0) | ||
|
|
||
| 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. | ||
| 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. |
| (始于 1.4.0) | ||
|
|
||
| FLAGS_tracer_profile_fname 表示由 gperftools 生成的命令式跟踪器的分析器文件名。仅在编译选项选择`WITH_PROFILER = ON`时有效。如果禁用则设为 empty。 | ||
| FLAGS_tracer_profile_fname 表示由 gperftools 生成的命令式跟踪器的分析器文件名。仅在编译选项选择 ``WITH_PROFILER = ON`` 时有效。如果禁用则设为 empty。 |
| (since 1.3) | ||
|
|
||
| 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. | ||
| 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. |
| (始于 1.3) | ||
|
|
||
| 如果 FLAGS_sync_nccl_allreduce 为 True，则会在 allreduce_op_handle 中调用 `cudaStreamSynchronize（nccl_stream）` ，这种模式在某些情况下可以获得更好的性能。 | ||
| 如果 FLAGS_sync_nccl_allreduce 为 True，则会在 allreduce_op_handle 中调用 ``cudaStreamSynchronize（nccl_stream）`` ，这种模式在某些情况下可以获得更好的性能。 |
| 示例 | ||
| ------- | ||
| FLAGS_sync_nccl_allreduce=True - 在 allreduce_op_handle 中调用 `cudaStreamSynchronize(nccl_stream)` 。 | ||
| FLAGS_sync_nccl_allreduce=True - 在 allreduce_op_handle 中调用 ``cudaStreamSynchronize(nccl_stream)`` 。 |
| **b. Clip a part of gradients** | ||
|
|
||
| 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. | ||
| 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. |
| **b. Clip a part of gradients** | ||
|
|
||
| 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. | ||
| 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. |
| **b. Clip a part of gradients** | ||
|
|
||
| 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. | ||
| 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. |
| (since 0.15.0) | ||
|
|
||
| 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`. | ||
| 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``. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR types
Typos
PR changes
Docs
Description
This PR continues to resolve the abuse of single backticks in RST documents as tracked in StatefulDust#40 .
The previous single-backticks used incorrectly for inline literals or variable names have been properly replaced with double backticks.
This batch focuses on tutorial guides like
docs/guides/advanced/*,docs/guides/beginner/*, anddocs/guides/flags/*, avoiding intersections with other pending PRs. Among them it also fixes a malformed cross-referenceref:cn_api_fluid_ParamAttrto properly use:ref:.