mindspore.ops.kl_div

mindspore.ops.kl_div(logits, labels, reduction='mean')[源代码]

计算输入 logits 和 labels 的KL散度。

对于相同shape的Tensor $x$ 和 $t a r g e t$ ，kl_div的计算公式如下：

L (x, t a r g e t) = t a r g e t \cdot (\log t a r g e t - x)

可得

\begin{array}{r} ℓ (x, t a r g e t) = {\begin{cases} L (x, t a r g e t), & if reduction ='none'; \\ mean (L (x, t a r g e t)), & if reduction ='mean'; \\ sum (L (x, t a r g e t)) / x . shape [0], & if reduction ='batchmean'; \\ sum (L (x, t a r g e t)), & if reduction ='sum'. \end{cases} \end{array}

其中 $x$ 代表 logits 。 $t a r g e t$ 代表 labels 。 $ℓ (x, t a r g e t)$ 为 output 。

说明

目前Ascend平台不支持数据类型float64。
仅当 reduction 设置为 "batchmean" 时输出才与Kullback-Leibler散度的数学定义一致。

参数：

logits (Tensor) - 数据类型支持float16、float32或float64。
labels (Tensor) - 标签Tensor，与 logits 的shape和数据类型相同。
reduction (str) - 指定输出结果的计算方式，可选值为 'mean' 、 'batchmean' 、 'none' 或 'sum' 。默认值： 'mean' 。
- 'none'：不应用规约方法。
- 'mean'：计算输出元素的加权平均值。
- 'sum'：计算输出元素的总和。
- 'batchmean'：计算输出元素的总和除以batch值。

返回：

Tensor或标量。如果 reduction 为 'none' ，则输出为Tensor且与 logits 的shape相同。否则为标量。

异常：

TypeError - reduction 不是str。
TypeError - logits 或 labels 不是Tensor。
TypeError - logits 或 labels 的数据类型不是支持的类型。

支持平台：

Ascend GPU CPU

样例：

>>> import mindspore
>>> import numpy as np
>>> from mindspore import Tensor, ops
>>> logits = Tensor(np.array([0.2, 0.7, 0.1]), mindspore.float32)
>>> labels = Tensor(np.array([0., 1., 0.]), mindspore.float32)
>>> output = mindspore.ops.kl_div(logits, labels, 'mean')
>>> print(output)
-0.23333333