mindspore2022/docs/api/api_python/nn/mindspore.nn.MSE.rst

mindspore.nn.MSE
================

.. py:class:: mindspore.nn.MSE

    测量均方差（MSE）。

    创建用于计算输入 :math:`x` 和目标 :math:`y` 中的每个元素的均方差（L2范数平方）的标准。

    .. math::
        \text{MSE}(x,\ y) = \frac{\sum_{i=1}^n(y_i - x_i)^2}{n}

    其中， :math:`n` 为batch size。

    **样例：**

    >>> import numpy as np
    >>> from mindspore import nn, Tensor
    >>>
    >>> x = Tensor(np.array([0.1, 0.2, 0.6, 0.9]), mindspore.float32)
    >>> y = Tensor(np.array([0.1, 0.25, 0.5, 0.9]), mindspore.float32)
    >>> error = nn.MSE()
    >>> error.clear()
    >>> error.update(x, y)
    >>> result = error.eval()

    .. py:method:: clear()

        清除内部评估结果。

    .. py:method:: eval()

        计算均方差（MSE）。

        **返回：**

        numpy.float64，计算结果。

        **异常：**

        - **RuntimeError** - 样本数为0。

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

        使用预测值 :math:`y_{pred}` 和真实值 :math:`y` 更新局部变量。。

        **参数：**

        - **inputs** - 输入 `y_pred` 和 `y` 用于计算MSE，其中 `y_pred` 和 `y` shape都为N-D，它们的shape相同。

        **异常：**

        - **ValueError** - `inputs` 的数量不等于2。