mindspore/docs/api/api_python/nn/mindspore.nn.Loss.rst

mindspore.nn.Loss
=================

.. py:class:: mindspore.nn.Loss

    计算loss的平均值。如果每 :math:`n` 次迭代调用一次 `update` 方法，则评估结果为：

    .. math::
        loss = \frac{\sum_{k=1}^{n}loss_k}{n}

    **样例：**

    >>> import numpy as np
    >>> from mindspore import nn, Tensor
    >>>
    >>> x = Tensor(np.array(0.2), mindspore.float32)
    >>> loss = nn.Loss()
    >>> loss.clear()
    >>> loss.update(x)
    >>> result = loss.eval()

    .. py:method:: clear()

        内部评估结果清零。

    .. py:method:: eval()

        计算loss的平均值。

        **返回：**

        Float，loss的平均值。

        **异常：**

        RuntimeError：样本总数为0。

    .. py:method:: update(*inputs)

        更新内部评估结果。

        **参数：**

        - **inputs** - 输入只包含一个元素，且该元素为loss。loss的维度必须为0或1。

        **异常：**

        - **ValueError** - `inputs` 的长度不为1。
        - **ValueError** - `inputs` 的维度不为0或1。