mindspore2022/docs/api/api_python/nn/metric/mindspore.nn.Accuracy.txt

Class mindspore.nn.Accuracy(eval_type='classification')

    计算'classification'单标签数据分类和'multilabel'多标签数据分类的正确率。

    此类创建两个局部变量，预测正确的样本数和总样本数，用于计算预测值`y_pred`和真实标签`y`的匹配频率。
    此频率最终作为正确率返回：是一个将预测正确的数目除以总数的幂等操作。


    .. math::
        \text{accuracy} =\frac{\text{true_positive} + \text{true_negative}}
        {\text{true_positive} + \text{true_negative} + \text{false_positive} + \text{false_negative}}

    参数：
        eval_type (str)：评估的数据集的类型，支持'classification'和'multilabel'。'classification'为单标签分类场景，'multilabel'为多标签分类场景。

            默认值：'classification'。

    示例：
        >>> import numpy as np
        >>> from mindspore import nn, Tensor
        >>>
        >>> x = Tensor(np.array([[0.2, 0.5], [0.3, 0.1], [0.9, 0.6]]), mindspore.float32)
        >>> y = Tensor(np.array([1, 0, 1]), mindspore.float32)
        >>> metric = nn.Accuracy('classification')
        >>> metric.clear()
        >>> metric.update(x, y)
        >>> accuracy = metric.eval()
        >>> print(accuracy)
        0.6666666666666666


clear()
内部评估结果清零。

eval()

        计算正确率。

        返回：
            Float，计算的结果。

        异常：
            RuntimeError：样本量为0。


update(*inputs)

        更新局部变量。计算预测值y_pred和标签y的匹配频率。
        对于'classification'，如果预测的最大值的索引匹配真实的标签，预测正确；对于'multilabel'，如果预测值与真实标签匹配，预测正确。

        参数：
            inputs：预测值 `y_pred` 和真实标签 `y` ，`y_pred` 和 `y` 支持Tensor、list或numpy.ndarray类型。

                对于'classification'情况，`y_pred`在大多数情况下由范围:math:`[0, 1]`中的浮点数组成，shape为:math:`(N, C)`，其中:math:`N`是样本数，:math:`C`是类别数。
                                              `y` 由整数值组成，如果是one_hot编码格式，shape是:math:`(N,C)`；如果是类别索引，shape是:math:`(N,)`。

                对于'multilabel'情况，`y_pred`和`y`只能是值为0或1的one-hot编码格式，其中值为1的索引表示正类别。`y_pred`和`y`的shape都是:math:`(N,C)`。


        异常：
            ValueError：inputs的数量不等于2。