Skip to content

Commit e94c823

Browse files
authored
Merge branch 'develop' into fix/inline-backticks-api-batch-develop-hotfix
2 parents 8ff2833 + b11d603 commit e94c823

24 files changed

Lines changed: 38 additions & 38 deletions

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

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

66
.. py:class:: paddle.amp.debugging.DebugMode()
77
8-
`DebugMode` 用于标识 `TensorCheckerConfig` 的状态。每个 `DebugMode` 的含义如下:
8+
``DebugMode`` 用于标识 ``TensorCheckerConfig`` 的状态。每个 ``DebugMode`` 的含义如下:
99

1010
- **DebugMode.CHECK_NAN_INF_AND_ABORT** - 打印或保存带有 NaN/Inf 的 Tensor 关键信息并中断程序。
1111

docs/api/paddle/compat/max_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ max
2323
.. py:function:: paddle.compat.max(x, out=None)
2424
2525
26-
对整个 input tensor 求最大值,见 `paddle.amax` :ref:`cn_api_paddle_amax`
26+
对整个 input tensor 求最大值,见 ``paddle.amax`` :ref:`cn_api_paddle_amax`
2727

2828
.. note::
2929

@@ -47,7 +47,7 @@ max
4747
4848
.. note::
4949

50-
对输入有多个最大值的情况下,`paddle.compat.max` 将只返回梯度值给 ``indices`` 中选择的位置。``out`` 返回方法与静态图联合使用是被禁止的行为,静态图下将报错。
50+
对输入有多个最大值的情况下,``paddle.compat.max`` 将只返回梯度值给 ``indices`` 中选择的位置。``out`` 返回方法与静态图联合使用是被禁止的行为,静态图下将报错。
5151

5252
参数
5353
:::::::::
@@ -67,7 +67,7 @@ MinMaxRetType(Tensor, Tensor),此处的 ``MinMaxRetType`` 是一个具名元
6767
.. py:function:: paddle.compat.max(x, other, out=None)
6868
6969
70-
与 ``other`` Tensor 计算逐元素最大值。见 `paddle.maximum` :ref:`cn_api_paddle_maximum`
70+
与 ``other`` Tensor 计算逐元素最大值。见 ``paddle.maximum`` :ref:`cn_api_paddle_maximum`
7171

7272
.. note::
7373

docs/api/paddle/compat/min_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ min
2323
.. py:function:: paddle.compat.min(x, out=None)
2424
2525
26-
对整个 input tensor 求最小值,见 `paddle.amin` :ref:`cn_api_paddle_amin`
26+
对整个 input tensor 求最小值,见 ``paddle.amin`` :ref:`cn_api_paddle_amin`
2727

2828
.. note::
2929

@@ -47,7 +47,7 @@ min
4747
4848
.. note::
4949

50-
对输入有多个最小值的情况下,`paddle.compat.min` 将只返回梯度值给 ``indices`` 中选择的位置。``out`` 返回方法与静态图联合使用是被禁止的行为,静态图下将报错。
50+
对输入有多个最小值的情况下,``paddle.compat.min`` 将只返回梯度值给 ``indices`` 中选择的位置。``out`` 返回方法与静态图联合使用是被禁止的行为,静态图下将报错。
5151

5252
参数
5353
:::::::::
@@ -67,7 +67,7 @@ MinMaxRetType(Tensor, Tensor),此处的 ``MinMaxRetType`` 是一个具名元
6767
.. py:function:: paddle.compat.min(x, other, out=None)
6868
6969
70-
与 ``other`` Tensor 计算逐元素最小值。见 `paddle.minimum` :ref:`cn_api_paddle_minimum`
70+
与 ``other`` Tensor 计算逐元素最小值。见 ``paddle.minimum`` :ref:`cn_api_paddle_minimum`
7171

7272
.. note::
7373

docs/api/paddle/distributed/shard_optimizer_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ shard_optimizer
55

66
.. py:function:: paddle.distributed.shard_optimizer(optimizer, shard_fn=None)
77
8-
将单卡视角的优化器转变为分布式视角。可以通过指定 `shard_fn` 来定制化优化器状态的切分方式,否则会将参数的分布式信息传递给对应的优化器状态。
8+
将单卡视角的优化器转变为分布式视角。可以通过指定 ``shard_fn`` 来定制化优化器状态的切分方式,否则会将参数的分布式信息传递给对应的优化器状态。
99

10-
`shard_fn` 的函数签名为:def shard_fn(accumulator_name, param, accumulator) -> sharded_accumulator。
10+
``shard_fn`` 的函数签名为:def shard_fn(accumulator_name, param, accumulator) -> sharded_accumulator。
1111

1212

1313
参数
@@ -18,7 +18,7 @@ shard_optimizer
1818

1919
返回
2020
:::::::::
21-
Optimizer:一个具有分布式视角的 `Optimizer` 对象。
21+
Optimizer:一个具有分布式视角的 ``Optimizer`` 对象。
2222

2323

2424
代码示例

docs/api/paddle/distributed/to_distributed_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ to_distributed
2626

2727
返回
2828
:::::::::
29-
Model:一个具有分布式信息的 `paddle.nn.Layer` 对象,根据自动选择的最优分布式策略,可能包含分布式化的权重参数。
29+
Model:一个具有分布式信息的 ``paddle.nn.Layer`` 对象,根据自动选择的最优分布式策略,可能包含分布式化的权重参数。
3030

31-
Optimizer:一个 `Optimizer` 对象,根据自动选择的最优分布式策略,可能包含分布式化的优化器状态。
31+
Optimizer:一个 ``Optimizer`` 对象,根据自动选择的最优分布式策略,可能包含分布式化的优化器状态。
3232

33-
DataLoader:一个 `ShardDataloader` 对象。能够给后续的分布式训练提供输入数据。
33+
DataLoader:一个 ``ShardDataloader`` 对象。能够给后续的分布式训练提供输入数据。
3434

3535

3636
代码示例

docs/api/paddle/hypot_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ hypot
66
.. py:function:: paddle.hypot(x, y, name=None, *, out=None)
77
88
9-
`hypot` 函数对于给定直角三角形直角边 `x`, `y` 实现斜边长度求解的计算;
9+
``hypot`` 函数对于给定直角三角形直角边 ``x``, ``y`` 实现斜边长度求解的计算;
1010

1111
.. math::
1212
out= \sqrt{x^2 + y^2}

docs/api/paddle/linalg/cholesky_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ cholesky
88
99
1010
11-
计算一个对称正定矩阵或一批对称正定矩阵的 Cholesky 分解。如果 `upper` 是 `True`,
11+
计算一个对称正定矩阵或一批对称正定矩阵的 Cholesky 分解。如果 ``upper`` 是 ``True``,
1212
则分解形式为 :math:`A = U ^ {T} U`,返回的矩阵 U 是上三角矩阵。
1313
否则,分解形式为 :math:`A = LL ^ {T}`,并返回矩阵 :math:`L` 是下三角矩阵。
1414

@@ -21,7 +21,7 @@ cholesky
2121

2222
返回
2323
::::::::::::
24-
Tensor,与 `x` 具有相同形状和数据类型。它代表了 Cholesky 分解生成的三角矩阵。
24+
Tensor,与 ``x`` 具有相同形状和数据类型。它代表了 Cholesky 分解生成的三角矩阵。
2525

2626
代码示例
2727
::::::::::::

docs/api/paddle/masked_fill_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ masked_fill
99
1010
返回一个 1-D 的 Tensor,Tensor 的值是根据 ``mask`` 信息,将 ``value`` 中的值填充到 ``x`` 中 ``mask`` 对应为 ``True`` 的位置,``mask`` 的数据类型是 bool。
1111

12-
下图展示了一个例子:假设我们有一个所有元素值为 1 的 3x3 矩阵 `x` 和一个相同尺寸的掩码矩阵 `Mask`,`Value` 值为 3。
12+
下图展示了一个例子:假设我们有一个所有元素值为 1 的 3x3 矩阵 ``x`` 和一个相同尺寸的掩码矩阵 ``Mask``,``Value`` 值为 3。
1313

1414
.. image:: ../../images/api_legend/masked_fill.png
1515
:width: 700

docs/api/paddle/msort_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ msort
55

66
.. py:function:: paddle.msort(input: Tensor, *, out: Tensor | None = None)
77
8-
沿输入 `Tensor` 的第 0 轴(`axis=0`)按升序对元素进行排序。
8+
沿输入 ``Tensor`` 的第 0 轴(``axis=0``)按升序对元素进行排序。
99

10-
该函数等价于 `paddle.sort(x, axis=0)`。
10+
该函数等价于 ``paddle.sort(x, axis=0)``。
1111

1212
参数
1313
::::::::::::

docs/api/paddle/optimizer/lr/PiecewiseDecay_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ PiecewiseDecay
66
.. py:class:: paddle.optimizer.lr.PiecewiseDecay(boundaries, values, last_epoch=-1, verbose=False)
77
88
9-
该接口提供分段设置学习率的策略。`boundaries` 表示学习率变化的边界步数,对应 epoch 的值,`values` 表示学习率变化的值。
9+
该接口提供分段设置学习率的策略。``boundaries`` 表示学习率变化的边界步数,对应 epoch 的值,``values`` 表示学习率变化的值。
1010

1111
过程可以描述如下:
1212

@@ -43,7 +43,7 @@ COPY-FROM: paddle.optimizer.lr.PiecewiseDecay
4343
step(epoch=None)
4444
'''''''''
4545

46-
step 函数需要在优化器的 `optimizer.step()` 函数之后调用,调用之后将会根据 epoch 数来更新学习率,更新之后的学习率将会在优化器下一轮更新参数时使用。
46+
step 函数需要在优化器的 ``optimizer.step()`` 函数之后调用,调用之后将会根据 epoch 数来更新学习率,更新之后的学习率将会在优化器下一轮更新参数时使用。
4747

4848
**参数**
4949

0 commit comments

Comments
 (0)