Skip to content

[API Compatibility No.191] Update poisson_nll_loss docs for target/eps alias support -part #7824

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
Aidenwu0209 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

[API Compatibility No.191] Update poisson_nll_loss docs for target/eps alias support -part #7824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/api/paddle/nn/functional/poisson_nll_loss_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ poisson_nll_loss
参数
:::::::::
- **input** (Tensor) - 输入 :attr:`Tensor`，对应泊松分布的期望，其形状为 :math:`[N, *]`，其中 :math:`*` 表示任何数量的额外维度。数据类型为 float16，bfloat16，float32 或 float64。
- **label** (Tensor) - 标签 :attr:`Tensor`， 形状、数据类型和 :attr:`input` 相同。
- **label** (Tensor) - 标签 :attr:`Tensor`， 形状、数据类型和 :attr:`input` 相同。别名：``target``。
- **log_input** (bool，可选) - 输入是否为对数函数映射后结果，如果为 ``True``，则 loss 当中第一项的计算公式为

.. math::
Expand All @@ -30,7 +30,7 @@ poisson_nll_loss

默认值为 ``False``。

- **eps** (float，可选) - 在 :attr:`log_input` 为 ``True`` 时使用的常数小量，使得 loss 计算过程中不会导致对 0 求对数情况的出现。默认值为 1e-8。
- **epsilon** (float，可选) - 在 :attr:`log_input` 为 ``True`` 时使用的常数小量，使得 loss 计算过程中不会导致对 0 求对数情况的出现。默认值为 1e-8。别名：``eps``。
- **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有 ``none``、``mean`` 和 ``sum``。默认为 ``mean``，计算 ``mini-batch`` loss 均值。设置为 ``sum`` 时，计算 ``mini-batch`` loss 的总和。设置为 ``none`` 时，则返回 loss Tensor。默认值下为 ``mean``。
- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

Expand Down
20 changes: 10 additions & 10 deletions ..._pytorch/api_difference/torch_more_args/torch.nn.functional.poisson_nll_loss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ paddle.nn.functional.poisson_nll_loss(input, label, log_input=True, full=False,

### 参数映射

| PyTorch | PaddlePaddle | 备注 |
| ------------ | ------------ | -- |
| input | input | 输入 Tensor。 |
| target | label | 标签 Tensor，仅参数名不一致。 |
| log_input | log_input | 输入是否为对数函数映射后结果。 |
| full | full | 是否在损失计算中包括 Stirling 近似项。 |
| size_average | - | PyTorch 已弃用， Paddle 无此参数，需要转写。 |
| eps | epsilon | 在 log_input 为 True 时使用的常数小量，仅参数名不一致。 |
| reduce | - | PyTorch 已弃用， Paddle 无此参数，需要转写。 |
| reduction | reduction | 指定应用于输出结果的计算方式。 |
| PyTorch | PaddlePaddle | 备注 |
| ------------ | ------------ | ----------------------------------------------------------------------- |
| input | input | 输入 Tensor。 |
| target | label | 标签 Tensor，仅参数名不一致，Paddle 同时支持 `target`。 |
| log_input | log_input | 输入是否为对数函数映射后结果。 |
| full | full | 是否在损失计算中包括 Stirling 近似项。 |
| size_average | - | PyTorch 已弃用， Paddle 无此参数，需要转写。 |
| eps | epsilon | 在 log_input 为 True 时使用的常数小量，仅参数名不一致，Paddle 同时支持 `eps`。 |
| reduce | - | PyTorch 已弃用， Paddle 无此参数，需要转写。 |
| reduction | reduction | 指定应用于输出结果的计算方式。 |

### 转写示例

Expand Down