Skip to content

[Docathon][Fix Doc Format No.28-30] fix 3 API docs #7501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

[Docathon][Fix Doc Format No.28-30] fix 3 API docs #7501

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f48e322
[Docathon][Fix Doc Format No.28-30] fix 3 API docs
123wjr Sep 29, 2025
60492b5
[Docathon][Fix Doc Format No.30] fix API docs
123wjr Sep 29, 2025
4e812e0
[Docathon][Fix Doc Format No.30] fix API docs
123wjr Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/paddle/incubate/ModelAverage_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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。

**代码示例**

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/io/DistributedBatchSampler_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 数据的读取顺序将会相同。

**参数**

Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/nn/RNNTLoss_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ 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 <https://github.com/b-flo/warp-transducer.git>`_ 的实现。
也可以叫做 softmax with RNNT，因为 warp-transducer 库中插入了 softmax 激活函数来对输入的值进行归一化。

参数
:::::::::
- **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。

形状
Expand Down