Skip to content

Commit 3cf64e3

Browse files
azticeSigureMoCopilot
authored
[docs] Update ctc_loss function parameters in documentation (#7597)
* Update ctc_loss function parameters in documentation Added parameters 'norm_by_times' and 'zero_infinity' to ctc_loss function documentation. * Fix formatting of 'zero_infinity' in ctc_loss_cn.rst Correct formatting of the 'zero_infinity' parameter description in the CTC loss documentation. * Update CTCLoss_cn.rst with zero_infinity parameter Add description for zero_infinity parameter in CTCLoss. * Revise CTCLoss parameter mapping in documentation Updated the parameter mapping for PyTorch and PaddlePaddle in the CTCLoss documentation, including the addition of the 'zero_infinity' parameter for PaddlePaddle. * Delete docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.CTCLoss.md * Add zero_infinity parameter to CTCLoss class * Remove 'zero_infinity' parameter from CTCLoss docs Removed the 'zero_infinity' parameter description from CTCLoss documentation. * Delete docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.functional.ctc_loss.md * Update docs/api/paddle/nn/functional/ctc_loss_cn.rst Co-authored-by: Nyakku Shigure <[email protected]> * Update CTCLoss_cn.rst * Update CTCLoss_cn.rst * Update ctc_loss_cn.rst * Update ctc_loss_cn.rst * Update CTCLoss_cn.rst * Update ctc_loss_cn.rst * Update CTCLoss_cn.rst * Update ctc_loss_cn.rst * Update docs/api/paddle/nn/functional/ctc_loss_cn.rst Co-authored-by: Copilot <[email protected]> * Update docs/api/paddle/nn/CTCLoss_cn.rst Co-authored-by: Copilot <[email protected]> * Update docs/api/paddle/nn/functional/ctc_loss_cn.rst * Update docs/api/paddle/nn/CTCLoss_cn.rst --------- Co-authored-by: Nyakku Shigure <[email protected]> Co-authored-by: Copilot <[email protected]>
1 parent dbf79a8 commit 3cf64e3

File tree

4 files changed

+4
-49
lines changed

4 files changed

+4
-49
lines changed

docs/api/paddle/nn/CTCLoss_cn.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
CTCLoss
44
-------------------------------
55

6-
.. py:class:: paddle.nn.CTCLoss(blank=0, reduction='mean')
6+
.. py:class:: paddle.nn.CTCLoss(blank=0, reduction='mean', zero_infinity=False)
77
88
计算 CTC loss。该接口的底层调用了第三方 baidu-research::warp-ctc 的实现。
99
也可以叫做 softmax with CTC,因为 Warp-CTC 库中插入了 softmax 激活函数来对输入的值进行归一化。
@@ -12,6 +12,7 @@ CTCLoss
1212
:::::::::
1313
- **blank** (int,可选) - 空格标记的 ID 值,其取值范围为 [0, num_classes + 1)。数据类型支持 int32。默认值为 0。
1414
- **reduction** (str,可选) - 指定应用于输出结果的计算方式,可选值有:``'none'``, ``'mean'``, ``'sum'``。设置为 ``'mean'`` 时,对 loss 值除以 label_lengths,并返回所得商的均值;设置为 ``'sum'`` 时,返回 loss 值的总和;设置为 ``'none'`` 时,则直接返回输出的 loss 值。默认值为 ``'mean'``。
15+
- **zero_infinity** (bool,可选) - 如果为 ``true``,则将 ``loss`` 中无限的值设置为 ``0``。默认值为 False。
1516

1617
形状
1718
:::::::::

docs/api/paddle/nn/functional/ctc_loss_cn.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
ctc_loss
44
-------------------------------
55

6-
.. py:function:: paddle.nn.functional.ctc_loss(log_probs, labels, input_lengths, label_lengths, blank=0, reduction='mean')
6+
.. py:function:: paddle.nn.functional.ctc_loss(log_probs, labels, input_lengths, label_lengths, blank=0, reduction='mean', norm_by_times=False, zero_infinity=False)
77
88
计算 CTC loss。该接口的底层调用了第三方 baidu-research::warp-ctc 的实现。
99
也可以叫做 softmax with CTC,因为 Warp-CTC 库中插入了 softmax 激活函数来对输入的值进行归一化。
@@ -17,6 +17,7 @@ ctc_loss
1717
- **blank** (int,可选) - 空格标记的 ID 值,其取值范围为 [0, num_classes + 1)。数据类型支持 int32。默认值为 0。
1818
- **reduction** (str,可选) - 指定应用于输出结果的计算方式,可选值有:``'none'``, ``'mean'``, ``'sum'``。设置为 ``'mean'`` 时,对 loss 值除以 label_lengths,并返回所得商的均值;设置为 ``'sum'`` 时,返回 loss 值的总和;设置为 ``'none'`` 时,则直接返回输出的 loss 值。默认值为 ``'mean'``。
1919
- **norm_by_times** (bool,可选) - 是否根据序列长度对梯度进行正则化。数据类型支持 bool。默认值为 False。
20+
- **zero_infinity** (bool,可选) - 如果为 ``true``,则将 ``loss`` 中无限的值设置为 ``0``。默认值为 False。
2021

2122
返回
2223
:::::::::

docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.CTCLoss.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.functional.ctc_loss.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)