文档反馈

问题文档片段

问题文档片段包含公式时，显示为空格。

提交类型

issue

有点复杂...

找人问问吧。

请选择提交类型

问题类型

规范和低错类

- 规范和低错类：

- 错别字或拼写错误，标点符号使用错误、公式错误或显示异常。

- 链接错误、空单元格、格式错误。

- 英文中包含中文字符。

- 界面和描述不一致，但不影响操作。

- 表述不通顺，但不影响理解。

- 版本号不匹配：如软件包名称、界面版本号。

易用性

- 易用性：

- 关键步骤错误或缺失，无法指导用户完成任务。

- 缺少主要功能描述、关键词解释、必要前提条件、注意事项等。

- 描述内容存在歧义指代不明、上下文矛盾。

- 逻辑不清晰，该分类、分项、分步骤的没有给出。

正确性

- 正确性：

- 技术原理、功能、支持平台、参数类型、异常报错等描述和软件实现不一致。

- 原理图、架构图等存在错误。

- 命令、命令参数等错误。

- 代码片段错误。

- 命令无法完成对应功能。

- 界面错误，无法指导操作。

- 代码样例运行报错、运行结果不符。

风险提示

- 风险提示：

- 对重要数据或系统存在风险的操作，缺少安全提示。

内容合规

- 内容合规：

- 违反法律法规，涉及政治、领土主权等敏感词。

- 内容侵权。

请选择问题类型

问题描述

点击输入详细问题描述，以帮助我们快速定位问题。

提交

文档反馈

mindspore.nn.KLDivLoss

class mindspore.nn.KLDivLoss(reduction='mean')

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

对于相同shape的Tensor $x$ 和 $target$ ，KLDivLoss的计算公式如下：

$$L(x,target)=target\cdot (\log target-x)$$

输出

$$\begin{array}{r}\ell (x,target)=\{\begin{array}{ll}L(x,target),& \text{if reduction}=\text{'none';}\\ \mathrm{mean}(L(x,target)),& \text{if reduction}=\text{'mean';}\\ \mathrm{sum}(L(x,target))/x.\mathrm{shape}[0],& \text{if reduction}=\text{'batchmean';}\\ \mathrm{sum}(L(x,target)),& \text{if reduction}=\text{'sum'.}\end{array}\end{array}$$

其中 $x$ 代表 logits ； $target$ 代表 labels ； $\ell (x,target)$ 为 output 。

说明

• 目前Ascend平台不支持数据类型float64。

• 仅当 reduction 设置为"batchmean"时输出才与Kullback-Leibler散度的数学定义一致。

参数：

• reduction (str) - 指定输出结果的计算方式。默认值： 'mean'。

  • 在Ascend平台上， reduction 的可选值为 'batchmean' 、 'none' 或 'sum'。

  • 在GPU平台上， reduction 的可选值为 "mean" 、 "none" 或 "sum" 。

  • 在CPU平台上， reduction 的可选值为 "mean" 、 "batchmean" 、 "none" 或 "sum" 。

输入：

• logits (Tensor) - 数据类型支持float16、float32或float64。

• labels (Tensor) - 标签Tensor，与 logits 的shape和数据类型相同。

输出：

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

异常：

• TypeError - reduction 不是str。

• TypeError - logits 或 labels 不是Tensor。

• TypeError - logits 或 labels 的数据类型不是支持的类型。

• ValueError - logits 和 labels 的shape不一致。

• RuntimeError - logits 或 labels 是标量并且 reduction 是"batchmean"。

支持平台：

Ascend GPU CPU

样例：

>>> import mindspore as ms
>>> import mindspore.nn as nn
>>> import numpy as np
>>> logits = ms.Tensor(np.array([0.2, 0.7, 0.1]), ms.float32)
>>> labels = ms.Tensor(np.array([0., 1., 0.]), ms.float32)
>>> loss = nn.KLDivLoss(reduction='mean')
>>> output = loss(logits, labels)
>>> print(output)
-0.23333333