kl_div

paddle.nn.functional. kl_div ( input, label, reduction='mean', log_target=False, name=None ) [源代码]

计算输入(Input)和输入(Label)之间的 Kullback-Leibler 散度损失。注意其中输入(Input)应为对数概率值，输入(Label)应为概率值。

kL 发散损失计算如下：

若 log_target 为 False:

\[l(input, label) = label * (log(label) - input)\]

若 log_target 为 True:

\[l(input, label) = exp(label) * (label - input)\]

当 reduction 为 none 时，输出损失与输入（x）形状相同，各点的损失单独计算，不会对结果做 reduction 。

当 reduction 为 mean 时，输出损失的形状为[]，输出为所有损失的平均值。

当 reduction 为 sum 时，输出损失的形状为[]，输出为所有损失的总和。

当 reduction 为 batchmean 时，输出损失为[N]的形状，N 为批大小，输出为所有损失的总和除以批量大小。

参数

  • input (Tensor) - KL 散度损失算子的输入 Tensor。维度为[N, *]的多维 Tensor，其中 N 是批大小，*表示任何数量的附加维度，数据类型为 float32 或 float64。

  • label (Tensor) - KL 散度损失算子的 Tensor。与输入 input 的维度和数据类型一致的多维 Tensor。

  • reduction (str，可选) - 要应用于输出的 reduction 类型，可用类型为‘none’ | ‘batchmean’ | ‘mean’ | ‘sum’，‘none’表示无 reduction，‘batchmean’ 表示输出的总和除以批大小，‘mean’ 表示所有输出的平均值，‘sum’表示输出的总和。

  • log_target (bool，可选) - 表示输入的 label 变量是否属于 log 空间。默认值为 False，表示不属于。

  • name (str，可选) - 具体用法请参见 Name，一般无需设置，默认值为 None。

返回

Tensor KL 散度损失。

代码示例

>>> import paddle
>>> import paddle.nn.functional as F
>>> paddle.seed(2023)

>>> shape = (5, 20)

>>> # input(x) should be a distribution in the log space
>>> x = F.log_softmax(paddle.randn(shape), axis=1).astype('float32')

>>> target = paddle.uniform(shape, min=-10, max=10).astype('float32')

>>> # 'batchmean' reduction, loss shape will be [], who is 0-D Tensor
>>> pred_loss = F.kl_div(x, target, reduction='batchmean')
>>> print(pred_loss.shape)
[]

>>> # 'mean' reduction, loss shape will be [], who is 0-D Tensor
>>> pred_loss = F.kl_div(x, target, reduction='mean')
>>> print(pred_loss.shape)
[]

>>> # 'sum' reduction, loss shape will be [], who is 0-D Tensor
>>> pred_loss = F.kl_div(x, target, reduction='sum')
>>> print(pred_loss.shape)
[]

>>> # 'none' reduction, loss shape is same with input shape
>>> pred_loss = F.kl_div(x, target, reduction='none')
>>> print(pred_loss.shape)
[5, 20]

>>> # if label is in the log space, set log_target = True
>>> target = paddle.uniform(shape, min=0, max=10).astype('float32')
>>> log_target = paddle.log(target)
>>> pred_loss_1 = F.kl_div(x, target, reduction='none')
>>> pred_loss_2 = F.kl_div(x, log_target, reduction='none', log_target=True)
>>> print(paddle.allclose(pred_loss_1, pred_loss_2))
Tensor(shape=[], dtype=bool, place=Place(cpu), stop_gradient=True,
True)

使用本API的教程文档