Skip to content

Commit 835a173

Browse files
authored
[Docs] Use math role in dist formula descriptions (#7855)
1 parent 39d09d9 commit 835a173

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

docs/api/paddle/dist_cn.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,44 @@ dist
55

66
.. py:function:: paddle.dist(x, y, p=2, name=None)
77
8-
计算 `(x-y)` 的 p 范数(p-norm),需要注意这不是严格意义上的范数,仅作为距离的度量。输入 `x` 和 `y` 的形状(shape)必须是可广播的(broadcastable)。其含义如下,详情请参考 `Tensor 的广播机制 <../../guides/beginner/tensor_cn.html#id7>`_ :
8+
计算 :math:`(x-y)` 的 :math:`p` 范数(p-norm),需要注意这不是严格意义上的范数,仅作为距离的度量。输入 :math:`x` 和 :math:`y` 的形状(shape)必须是可广播的(broadcastable)。其含义如下,详情请参考 `Tensor 的广播机制 <../../guides/beginner/tensor_cn.html#id7>`_ :
99

1010
- 每个输入都至少有 1 维
1111
- 对两个输入的维度从后向前匹配,两个输入每一维的大小需要满足 3 个条件中的任意一个:相等、其中一个为 1 或者其中一个不存在。
1212

13-
定义 `z = x - y` ,`x` 和 `y` 的形状是可广播的,那么 `z` 的形状可按照下列步骤得到:
13+
定义 :math:`z=x-y`,:math:`x` 和 :math:`y` 的形状是可广播的,那么 :math:`z` 的形状可按照下列步骤得到:
1414

15-
(1) 如果 `x` 和 `y` 的维数不同,先对维数较少的这个输入的维度往前补 1。
15+
(1) 如果 :math:`x` 和 :math:`y` 的维数不同,先对维数较少的这个输入的维度往前补 1。
1616

17-
例如,`x` 的形状为[8, 1, 6, 1],`y` 的形状为[7, 1, 5],对 `y` 的维度补 1,
17+
例如,:math:`x` 的形状为 [8, 1, 6, 1],:math:`y` 的形状为 [7, 1, 5],对 :math:`y` 的维度补 1,
1818

1919
x (4-D Tensor): 8 x 1 x 6 x 1
2020

2121
y (4-D Tensor): 1 x 7 x 1 x 5
2222

2323

24-
(2) 确定输出 `z` 每一维度的大小:从两个输入的维度中选取最大值。
24+
(2) 确定输出 :math:`z` 每一维度的大小:从两个输入的维度中选取最大值。
2525

2626
z (4-D Tensor): 8 x 7 x 6 x 5
2727

28-
若两个输入的维数相同,则输出的大小可直接用步骤 2 确定。以下是 `p` 取不同值时,范数的计算公式:
28+
若两个输入的维数相同,则输出的大小可直接用步骤 2 确定。以下是 :math:`p` 取不同值时,范数的计算公式:
2929

30-
当 `p = 0`,定义 $0^0 = 0$,则 z 的零范数是 `z` 中非零元素的个数。
30+
:math:`p = 0`,定义 :math:`0^0 = 0`,则 :math:`z` 的零范数是 :math:`z` 中非零元素的个数。
3131

3232
.. math::
3333
||z||_{0}=\lim_{p \rightarrow 0}\sum_{i=1}^{m}|z_i|^{p}
3434
35-
当 `p = inf` ,`z` 的无穷范数是 `z` 所有元素中的绝对值最大值。
35+
:math:`p = \infty` 时,:math:`z` 的无穷范数是 :math:`z` 所有元素中的绝对值最大值。
3636

3737
.. math::
3838
||z||_\infty=\max_i |z_i|
3939
40-
当 `p = -inf` ,`z` 的负无穷范数是 `z` 所有元素中的绝对值最小值。
40+
:math:`p = -\infty` 时,:math:`z` 的负无穷范数是 :math:`z` 所有元素中的绝对值最小值。
4141

4242
.. math::
4343
||z||_{-\infty}=\min_i |z_i|
4444
45-
其他情况下,`z` 的 `p` 范数使用以下公式计算:
45+
其他情况下,:math:`z` 的 :math:`p` 范数使用以下公式计算:
4646

4747
.. math::
4848
||z||_{p}=(\sum_{i=1}^{m}|z_i|^p)^{\frac{1}{p}}
@@ -59,7 +59,7 @@ z (4-D Tensor): 8 x 7 x 6 x 5
5959

6060
返回
6161
::::::::::::
62-
Tensor,`(x-y)` 的 `p` 范数。
62+
Tensor,:math:`(x-y)` 的 :math:`p` 范数。
6363

6464
代码示例
6565
::::::::::::

0 commit comments

Comments
 (0)