diff --git a/docs/api/paddle/nn/CTCLoss_cn.rst b/docs/api/paddle/nn/CTCLoss_cn.rst index cfe38bb9d77..560016243b6 100644 --- a/docs/api/paddle/nn/CTCLoss_cn.rst +++ b/docs/api/paddle/nn/CTCLoss_cn.rst @@ -3,7 +3,7 @@ CTCLoss ------------------------------- -.. py:class:: paddle.nn.CTCLoss(blank=0, reduction='mean') +.. py:class:: paddle.nn.CTCLoss(blank=0, reduction='mean', zero_infinity=False) 计算 CTC loss。该接口的底层调用了第三方 baidu-research::warp-ctc 的实现。 也可以叫做 softmax with CTC，因为 Warp-CTC 库中插入了 softmax 激活函数来对输入的值进行归一化。 @@ -12,6 +12,7 @@ CTCLoss ::::::::: - **blank** (int，可选) - 空格标记的 ID 值，其取值范围为 [0, num_classes + 1)。数据类型支持 int32。默认值为 0。 - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。设置为 ``'mean'`` 时，对 loss 值除以 label_lengths，并返回所得商的均值；设置为 ``'sum'`` 时，返回 loss 值的总和；设置为 ``'none'`` 时，则直接返回输出的 loss 值。默认值为 ``'mean'``。 + - **zero_infinity** (bool，可选) - 如果为 ``true``，则将 ``loss`` 中无限的值设置为 ``0``。默认值为 False。 形状 ::::::::: diff --git a/docs/api/paddle/nn/functional/ctc_loss_cn.rst b/docs/api/paddle/nn/functional/ctc_loss_cn.rst index 4fa60483883..44d47054561 100644 --- a/docs/api/paddle/nn/functional/ctc_loss_cn.rst +++ b/docs/api/paddle/nn/functional/ctc_loss_cn.rst @@ -3,7 +3,7 @@ ctc_loss ------------------------------- -.. py:function:: paddle.nn.functional.ctc_loss(log_probs, labels, input_lengths, label_lengths, blank=0, reduction='mean') +.. 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) 计算 CTC loss。该接口的底层调用了第三方 baidu-research::warp-ctc 的实现。 也可以叫做 softmax with CTC，因为 Warp-CTC 库中插入了 softmax 激活函数来对输入的值进行归一化。 @@ -17,6 +17,7 @@ ctc_loss - **blank** (int，可选) - 空格标记的 ID 值，其取值范围为 [0, num_classes + 1)。数据类型支持 int32。默认值为 0。 - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。设置为 ``'mean'`` 时，对 loss 值除以 label_lengths，并返回所得商的均值；设置为 ``'sum'`` 时，返回 loss 值的总和；设置为 ``'none'`` 时，则直接返回输出的 loss 值。默认值为 ``'mean'``。 - **norm_by_times** (bool，可选) - 是否根据序列长度对梯度进行正则化。数据类型支持 bool。默认值为 False。 + - **zero_infinity** (bool，可选) - 如果为 ``true``，则将 ``loss`` 中无限的值设置为 ``0``。默认值为 False。 返回 ::::::::: diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.CTCLoss.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.CTCLoss.md deleted file mode 100644 index 6f10e2691b9..00000000000 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.CTCLoss.md +++ /dev/null @@ -1,23 +0,0 @@ -## [ torch 参数更多 ]torch.nn.CTCLoss -### [torch.nn.CTCLoss](https://pytorch.org/docs/stable/generated/torch.nn.CTCLoss.html#torch.nn.CTCLoss) -```python -torch.nn.CTCLoss(blank=0, - reduction='mean', - zero_infinity=False) -``` - -### [paddle.nn.CTCLoss](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/nn/CTCLoss_cn.html#ctcloss) -```python -paddle.nn.CTCLoss(blank=0, - reduction='mean') -``` - -其中，torch 的 log_softmax+ctc_loss 相当于 paddle 的 ctc_loss，是一个二对一的情况，暂时无法转写，且 PyTorch 相比 Paddle 支持更多其他参数，具体如下： - -### 参数映射 - -| PyTorch | PaddlePaddle | 备注 | -| ------------- | ------------ | ------------------------------------------------------------ | -| blank | blank | 空格标记的 ID 值。 | -| reduction | reduction | 表示应用于输出结果的计算方式。 | -| zero_infinity | - | 是否将无穷大损失及其梯度置 0，Paddle 无此参数，暂无转写方式。 | diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.functional.ctc_loss.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.functional.ctc_loss.md deleted file mode 100644 index f8d1b705da2..00000000000 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.functional.ctc_loss.md +++ /dev/null @@ -1,24 +0,0 @@ -## [ torch 参数更多 ]torch.nn.functional.ctc_loss -### [torch.nn.functional.ctc_loss](https://pytorch.org/docs/stable/generated/torch.nn.functional.ctc_loss.html#torch.nn.functional.ctc_loss) -```python -torch.nn.functional.ctc_loss(log_probs, targets, input_lengths, target_lengths, blank=0, reduction='mean', zero_infinity=False) -``` - -### [paddle.nn.functional.ctc_loss](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/nn/functional/ctc_loss_cn.html) -```python -paddle.nn.functional.ctc_loss(log_probs, labels, input_lengths, label_lengths, blank=0, reduction='mean') -``` - -其中 torch 的 log_softmax+ctc_loss 相当于 paddle 的 ctc_loss，是一个二对一的情况，暂时无法转写。PyTorch 相比 Paddle 支持更多其他参数，具体如下： - -### 参数映射 - -| PyTorch | PaddlePaddle | 备注 | -| -------------- | ------------- | ------------------------------------------------------------------ | -| log_probs | log_probs | 经过 padding 的概率序列。 | -| targets | labels | 经过 padding 的标签序列，仅参数名不一致。 | -| input_lengths | input_lengths | 表示输入 log_probs 数据中每个序列的长度。 | -| target_lengths | label_lengths | 表示 label 中每个序列的长度，仅参数名不一致。 | -| blank | blank | 空格标记的 ID 值。 | -| reduction | reduction | 指定应用于输出结果的计算方式。 | -| zero_infinity | - | 是否设置 infinity 及关联梯度 为 0，Paddle 无此参数，暂无转写方式。 |