mindspore.ops.binary_cross_entropy

mindspore.ops.binary_cross_entropy(logits, labels, weight=None, reduction='mean')

计算预测值 logits 和 目标值 labels 之间的二值交叉熵损失。

将 logits 设置为 \(x\) ， labels 设置为 \(y\) ，输出设置为 \(\ell(x, y)\) ，第n个batch二值交叉熵的权重为 \(w_n\)。则，

\[L = \{l_1,\dots,l_N\}^\top, \quad l_n = - w_n \left[ y_n \cdot \log x_n + (1 - y_n) \cdot \log (1 - x_n) \right]\]

其中，\(L\) 表示所有batch_size的loss值，\(l\) 表示一个batch_size的loss值，n表示在1-N范围内的一个batch_size。

\[\begin{split}\ell(x, y) = \begin{cases} L, & \text{if reduction} = \text{'none';}\\ \operatorname{mean}(L), & \text{if reduction} = \text{'mean';}\\ \operatorname{sum}(L), & \text{if reduction} = \text{'sum'.} \end{cases}\end{split}\]

警告

• x 的值必须要在0-1范围内。

• y 的值必须是 0 或者 1 。

参数：

• logits (Tensor) - 输入预测值，任意维度的Tensor。其数据类型为float16或float32。

• labels (Tensor) - 输入目标值，shape与 logits 相同。数据类型为float16或float32。

• weight (Tensor, 可选) - 指定每个批次二值交叉熵的权重。支持广播，使其shape与 logits 的shape保持一致。数据类型必须为float16或float32。默认值：None。

• reduction (str) - 指定用于输出结果的计算方式。取值为 ‘mean’ 、 ‘sum’ 或 ‘none’ ，不区分大小写。如果 ‘none’ ，则不执行 reduction 。默认值：’mean’ 。

返回：

Tensor或Scalar，如果 reduction 为 ‘none’ ，则为shape和数据类型与输入 logits 相同的Tensor。否则，输出为Scalar。

异常：

• TypeError - 输入 logits ， labels ， weight 不为Tensor。

• TypeError - 输入 logits ， labels ， weight 的数据类型既不是float16也不是float32。

• ValueError - reduction 不为 ‘none’ 、 ‘mean’ 或 ‘sum’ 。

• ValueError - labels 的shape大小与 logits 或者 weight 不相同。

支持平台：

Ascend GPU CPU

样例：

>>> logits = Tensor(np.array([0.2, 0.7, 0.1]), mindspore.float32)
>>> labels = Tensor(np.array([0., 1., 0.]), mindspore.float32)
>>> weight = Tensor(np.array([1, 2, 2]), mindspore.float32)
>>> output = ops.binary_cross_entropy(logits, labels, weight)
>>> print(output)
0.38240486