Skip to content

Commit 180bb70

Browse files
authored
[Docs] Fix invalid api_label references (#7739)
1 parent c544822 commit 180bb70

7 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/api/paddle/device/Overview_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ paddle.device 目录下包含 cuda 目录和 xpu 目录, cuda 目录中存放
4646
" :ref:`is_available <cn_api_paddle_device_is_available>` ", "检查设备是否可用"
4747
" :ref:`get_rng_state <cn_api_paddle_device_get_rng_state>` ", "获取随机数生成器状态"
4848
" :ref:`set_rng_state <cn_api_paddle_device_set_rng_state>` ", "设置随机数生成器状态"
49-
" :ref:`device <_cn_api_paddle_device_device>` ", "临时使用设备"
49+
" :ref:`device <cn_api_paddle_device_device>` ", "临时使用设备"
5050
" :ref:`get_device_name <cn_api_paddle_device_get_device_name>` ", "返回指定设备的名称"
51-
" :ref:`manual_seed <_cn_api_paddle_device_manual_seed>` ", "设置当前设备的随机数种子"
51+
" :ref:`manual_seed <cn_api_paddle_device_manual_seed>` ", "设置当前设备的随机数种子"
5252
.. _cn_device_compile:
5353

5454
编译环境检测

docs/api/paddle/linalg/Overview_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ paddle.linalg 目录下包含飞桨框架支持的线性代数相关 API。具
6464
" :ref:`paddle.linalg.cholesky <cn_api_paddle_linalg_cholesky>` ", "计算一个实数对称正定矩阵的 Cholesky 分解"
6565
" :ref:`paddle.linalg.cholesky_inverse <cn_api_paddle_linalg_cholesky_inverse>` ", "使用 Cholesky 因子 `U` 计算对称正定矩阵的逆矩阵"
6666
" :ref:`paddle.linalg.svd <cn_api_paddle_linalg_svd>` ", "计算矩阵的奇异值分解"
67-
" :ref:`paddle.linalg.svdvals <_cn_api_paddle_linalg_svdvals>` ", "计算矩阵的奇异值"
67+
" :ref:`paddle.linalg.svdvals <cn_api_paddle_linalg_svdvals>` ", "计算矩阵的奇异值"
6868
" :ref:`paddle.linalg.svd_lowrank <cn_api_paddle_linalg_svd_lowrank>` ", "对低秩矩阵进行奇异值分解"
6969
" :ref:`paddle.linalg.pca_lowrank <cn_api_paddle_linalg_pca_lowrank>` ", "对矩阵进行线性主成分分析"
7070
" :ref:`paddle.linalg.qr <cn_api_paddle_linalg_qr>` ", "计算矩阵的正交三角分解(也称 QR 分解)"

docs/api/paddle/linalg/eigvals_cn.rst

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

99

1010
.. note::
11-
该 API 的反向实现尚未完成,若你的代码需要对其进行反向传播,请使用 ref:`cn_api_paddle_linalg_eig`。
11+
该 API 的反向实现尚未完成,若你的代码需要对其进行反向传播,请使用 :ref:`cn_api_paddle_linalg_eig`。
1212

1313

1414
参数

docs/api/paddle/linalg/matrix_norm_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ matrix_norm
88
99
1010
11-
将计算给定 Tensor 的矩阵范数。具体用法请参见 :ref:`norm <_cn_api_paddle_linalg_norm>`。
11+
将计算给定 Tensor 的矩阵范数。具体用法请参见 :ref:`norm <cn_api_paddle_linalg_norm>`。
1212

1313

1414
参数

docs/api/paddle/linalg/vector_norm_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ vector_norm
88
99
1010
11-
将计算给定 Tensor 的向量范数。具体用法请参见 :ref:`norm <_cn_api_paddle_linalg_norm>`。
11+
将计算给定 Tensor 的向量范数。具体用法请参见 :ref:`norm <cn_api_paddle_linalg_norm>`。
1212

1313

1414
参数

docs/api_guides/low_level/layers/sparse_update.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
稀疏更新
55
#####
66

7-
`paddle.nn.functional.embedding <cn_api_paddle_nn_functional_embedding>` 层在单机训练和分布式训练时,均可以支持“稀疏更新”,即梯度以 sparse tensor 结构存储,只保存梯度不为 0 的行。
7+
:ref:`paddle.nn.functional.embedding <cn_api_paddle_nn_functional_embedding>` 层在单机训练和分布式训练时,均可以支持“稀疏更新”,即梯度以 sparse tensor 结构存储,只保存梯度不为 0 的行。
88
在分布式训练中,对于较大的 embedding 层,开启稀疏更新有助于减少通信数据量,提升训练速度。
99

1010
在 paddle 内部,我们用 lookup_table 来实现 embedding。下边这张图说明了 embedding 在正向和反向计算的过程:
@@ -14,4 +14,4 @@
1414
.. image:: ../../../design/dist_train/src/lookup_table_training.png
1515
:scale: 50 %
1616

17-
API 详细使用方法参考 `paddle.nn.functional.embedding <cn_api_paddle_nn_functional_embedding>`
17+
API 详细使用方法参考 :ref:`paddle.nn.functional.embedding <cn_api_paddle_nn_functional_embedding>`

docs/api_guides/low_level/layers/sparse_update_en.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Sparse update
55
###############
66

7-
`paddle.nn.functional.embedding <cn_api_paddle_nn_functional_embedding>` layer supports "sparse updates" in both single-node and distributed training, which means gradients are stored in a sparse tensor structure where only rows with non-zero gradients are saved.
7+
:ref:`paddle.nn.functional.embedding <cn_api_paddle_nn_functional_embedding>` layer supports "sparse updates" in both single-node and distributed training, which means gradients are stored in a sparse tensor structure where only rows with non-zero gradients are saved.
88
In distributed training, for larger embedding layers, sparse updates reduce the amount of communication data and speed up training.
99

1010
In paddle, we use lookup_table to implement embedding. The figure below illustrates the process of embedding in the forward and backward calculations:
@@ -17,4 +17,4 @@ As shown in the figure: two rows in a Tensor are not 0. In the process of forwar
1717
Example
1818
--------------------------
1919

20-
API reference `paddle.nn.functional.embedding <cn_api_paddle_nn_functional_embedding>` .
20+
API reference :ref:`paddle.nn.functional.embedding <cn_api_paddle_nn_functional_embedding>` .

0 commit comments

Comments
 (0)