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

mindspore.nn.Metric
====================

.. py:class:: mindspore.nn.Metric

    ���ڼ�������ָ��Ļ��ࡣ

    �ڼ�������ָ��ʱ��Ҫ���� `clear` �� `update` �� `eval` �����������ڼ̳и����Զ�������ָ��ʱ��Ҳ��Ҫʵ�����������������У�`update` ���ڼ����м���̵��ڲ������`eval` ���ڼ����������������`clear` ���������м�����
    ����ֱ��ʹ�ø��࣬��ʹ�������� :class:`mindspore.nn.MAE` �� :class:`mindspore.nn.Recall` �ȡ�

    .. py:method:: clear()
        :abstract:

        ����������ڲ������������Ϊ��

        .. note::
            �������඼������д�˽ӿڡ�

    .. py:method:: eval()
        :abstract:

        �����˼������������������Ϊ��

        .. note::
            �������඼������д�˽ӿڡ�
        
    .. py:method:: indexes
        :property:

        ��ȡ��ǰ�� `indexes` ֵ��Ĭ��ΪNone������ `set_indexes` ���޸� `indexes` ֵ��

    .. py:method:: set_indexes(indexes)

        �ýӿ��������� `update` �����롣

        ����(label0, label1, logits)��Ϊ `update` �����룬�� `indexes` ����Ϊ[2, 1]��������ʹ��(logits, label1)��Ϊ `update` ����ʵ���롣

        .. note::
            �ڼ̳и����Զ�����������ʱ����Ҫ��װ���� `mindspore.nn.rearrange_inputs` ���� `update` �������������õ� `indexes` ֵ����Ч��
            

        **������**

        **indexes** (List(int)) - logits�ͱ�ǩ��Ŀ��˳��

        **�����**

        :class:`Metric` ����ʵ��������

        **������**

        >>> 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]]))
        >>> y = Tensor(np.array([1, 0, 1]))
        >>> y2 = Tensor(np.array([0, 0, 1]))
        >>> metric = nn.Accuracy('classification').set_indexes([0, 2])
        >>> metric.clear()
        >>> # indexesΪ[0, 2]��ʹ��x��ΪԤ��ֵ��y2��Ϊ��ʵ��ǩ
        >>> metric.update(x, y, y2)
        >>> accuracy = metric.eval()
        >>> print(accuracy)
        0.3333333333333333
        
    .. py:method:: update(*inputs)
        :abstract:

        �����˸����ڲ������������Ϊ��

        .. note::
            �������඼������д�˽ӿڡ�

        **������**

        **inputs** - �ɱ䳤����������б���ͨ����Ԥ��ֵ�Ͷ�Ӧ����ʵ��ǩ��