From f48e32293c1ebe6b7da8a61c12aae0241403f4e6 Mon Sep 17 00:00:00 2001 From: John Jerry Date: Mon, 29 Sep 2025 11:36:42 +0800 Subject: [PATCH 1/3] [Docathon][Fix Doc Format No.28-30] fix 3 API docs --- docs/api/paddle/incubate/ModelAverage_cn.rst | 2 +- docs/api/paddle/io/DistributedBatchSampler_cn.rst | 2 +- docs/api/paddle/nn/RNNTLoss_cn.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/paddle/incubate/ModelAverage_cn.rst b/docs/api/paddle/incubate/ModelAverage_cn.rst index e7a9ba4c475..00f3ce85328 100644 --- a/docs/api/paddle/incubate/ModelAverage_cn.rst +++ b/docs/api/paddle/incubate/ModelAverage_cn.rst @@ -75,7 +75,7 @@ apply(executor=None, need_restore=True) **参数** - **executor** (Executor) - 静态图模式下当前网络的执行器；动态图模式下默认值为 None。 - - **need_restore** (bool) - 恢复标志变量；设为 True 时，执行完成后会将网络的 ``Parameters``恢复为网络默认的值，设为 False 将不会恢复。默认值为 True。 + - **need_restore** (bool) - 恢复标志变量；设为 True 时，执行完成后会将网络的 ``Parameters`` 恢复为网络默认的值，设为 False 将不会恢复。默认值为 True。 **代码示例** diff --git a/docs/api/paddle/io/DistributedBatchSampler_cn.rst b/docs/api/paddle/io/DistributedBatchSampler_cn.rst index 23040c839ab..799e65fb4c4 100644 --- a/docs/api/paddle/io/DistributedBatchSampler_cn.rst +++ b/docs/api/paddle/io/DistributedBatchSampler_cn.rst @@ -37,7 +37,7 @@ COPY-FROM: paddle.io.DistributedBatchSampler set_epoch(epoch) ''''''''' -设置 epoch 数。当设置``shuffle=True``时，此 epoch 被用作随机种子。默认情况下，用户可以不用此接口设置，每个 epoch 时，所有的进程(workers)使用不同的顺序。如果每个 epoch 设置相同的数字，每个 epoch 数据的读取顺序将会相同。 +设置 epoch 数。当设置 ``shuffle=True`` 时，此 epoch 被用作随机种子。默认情况下，用户可以不用此接口设置，每个 epoch 时，所有的进程(workers)使用不同的顺序。如果每个 epoch 设置相同的数字，每个 epoch 数据的读取顺序将会相同。 **参数** diff --git a/docs/api/paddle/nn/RNNTLoss_cn.rst b/docs/api/paddle/nn/RNNTLoss_cn.rst index 88c30ed1e83..3bbba18f5b7 100644 --- a/docs/api/paddle/nn/RNNTLoss_cn.rst +++ b/docs/api/paddle/nn/RNNTLoss_cn.rst @@ -12,7 +12,7 @@ RNNTLoss ::::::::: - **blank** (int，可选) - 空格标记的 ID 值，其取值范围为 [0, num_classes + 1)。数据类型支持 int32。默认值为 0。 - **fastemit_lambda** (float，默认 0.001) - FastEmit 的正则化参数(https://arxiv.org/pdf/2010.11148.pdf)。 - - **reduction** (str，可选) - 表示如何平均损失，候选是 ``'none'``|``'mean'``|``'sum'`` 。如果是 ``'mean'`` ，输出将是损失的总和并除以 batch_size;如果是 ``'sum'``，返回损失的总和;如果为 ``'none'``，则不应用 reduction。默认是 ``'mean'``。 + - **reduction** (str，可选) - 表示如何平均损失，候选是 ``'none'`` | ``'mean'`` | ``'sum'`` 。如果是 ``'mean'`` ，输出将是损失的总和并除以 batch_size;如果是 ``'sum'``，返回损失的总和;如果为 ``'none'``，则不应用 reduction。默认是 ``'mean'``。 - **name** (str，可选) - 操作名称，默认为 None。 形状 From 60492b539b3a6ee52e4e7b26adeb8a6e30e20113 Mon Sep 17 00:00:00 2001 From: John Jerry Date: Mon, 29 Sep 2025 19:02:01 +0800 Subject: [PATCH 2/3] [Docathon][Fix Doc Format No.30] fix API docs --- docs/api/paddle/nn/RNNTLoss_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/nn/RNNTLoss_cn.rst b/docs/api/paddle/nn/RNNTLoss_cn.rst index 3bbba18f5b7..a5b2c8f3f51 100644 --- a/docs/api/paddle/nn/RNNTLoss_cn.rst +++ b/docs/api/paddle/nn/RNNTLoss_cn.rst @@ -5,7 +5,7 @@ RNNTLoss .. py:class:: paddle.nn.RNNTLoss(blank=0, fastemit_lambda=0.001, reduction='mean', name=None) -计算 RNNT loss。该接口的底层调用了第三方 [warp-transducer](https://github.com/b-flo/warp-transducer.git) 的实现。 +计算 RNNT loss。该接口的底层调用了第三方 `warp-transducer `_ 的实现。 也可以叫做 softmax with RNNT，因为 warp-transducer 库中插入了 softmax 激活函数来对输入的值进行归一化。 参数 From 4e812e017e89c6d30da09c556a256918fbd2d695 Mon Sep 17 00:00:00 2001 From: John Jerry Date: Fri, 3 Oct 2025 22:30:14 +0800 Subject: [PATCH 3/3] [Docathon][Fix Doc Format No.30] fix API docs --- docs/api/paddle/nn/RNNTLoss_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/nn/RNNTLoss_cn.rst b/docs/api/paddle/nn/RNNTLoss_cn.rst index a5b2c8f3f51..cccc43184c7 100644 --- a/docs/api/paddle/nn/RNNTLoss_cn.rst +++ b/docs/api/paddle/nn/RNNTLoss_cn.rst @@ -5,7 +5,7 @@ RNNTLoss .. py:class:: paddle.nn.RNNTLoss(blank=0, fastemit_lambda=0.001, reduction='mean', name=None) -计算 RNNT loss。该接口的底层调用了第三方 `warp-transducer `_ 的实现。 +计算 RNNT loss。该接口的底层调用了第三方 `warp-transducer `_ 的实现。 也可以叫做 softmax with RNNT，因为 warp-transducer 库中插入了 softmax 激活函数来对输入的值进行归一化。 参数