§
    ’©ºjÐ�  ã                   ó´  — d dl mZ d dlmZ d dlmZ d dlmZmZm	Z	m
Z
mZmZmZmZmZmZmZmZ d dlmZmZ d dlmZ 	 	 	 	 d0d
ed         dededededeed                  ded         dedededefd„Z	 	 	 	 	 d1dedededed         dee         d ededefd!„Z	 	 	 	 	 	 d2deded#edeed$                  deded         dee         d ededefd%„Z	 	 	 	 	 	 d3deded&ededeed$                  ded         dee         d ededefd'„Z	 	 	 	 	 d1dedededed         dee         d ededefd(„Z	 	 	 	 	 	 d2deded#edeed$                  deded         dee         d ededefd)„Z 	 	 	 	 	 	 d3deded&ededeed$                  ded         dee         d ededefd*„Z!	 	 	 	 	 	 	 	 	 d4deded,ed-         ded#ee         d&ee         deed$                  deed                  dee         dee         d ededefd.„Z"	 	 	 	 	 	 	 	 	 d4deded,ed-         ded#ee         d&ee         deed$                  deed                  dee         dee         d ededefd/„Z#dS )5é    )ÚOptional)ÚTensor)ÚLiteral)Ú"_binary_stat_scores_arg_validationÚ_binary_stat_scores_formatÚ%_binary_stat_scores_tensor_validationÚ_binary_stat_scores_updateÚ&_multiclass_stat_scores_arg_validationÚ_multiclass_stat_scores_formatÚ)_multiclass_stat_scores_tensor_validationÚ_multiclass_stat_scores_updateÚ&_multilabel_stat_scores_arg_validationÚ_multilabel_stat_scores_formatÚ)_multilabel_stat_scores_tensor_validationÚ_multilabel_stat_scores_update)Ú_adjust_weights_safe_divideÚ_safe_divide)ÚClassificationTaskÚglobalFé   Ústat)Ú	precisionÚrecallÚtpÚfpÚtnÚfnÚaverage)ÚbinaryÚmicroÚmacroÚweightedÚnoneÚmultidim_average)r   Ú
samplewiseÚ
multilabelÚtop_kÚzero_divisionÚreturnc
           	      ó†  — | dk    r|n|}
|dk    rt          |||
z   |	¦  «        S |dk    rn|                     |dk    rdnd¬¦  «        }|                     |dk    rdnd¬¦  «        }|
                     |dk    rdnd¬¦  «        }
t          |||
z   |	¦  «        S t          |||
z   |	¦  «        }t          |||||||¬¦  «        S )	Nr   r   r    r   r   r   )Údim)r'   )r   Úsumr   )r   r   r   r   r   r   r$   r&   r'   r(   Údifferent_statÚscores               ú‡/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/functional/classification/precision_recall.pyÚ_precision_recall_reducer0   %   sù   € ð   ;Ò.Ð.�R�R°B€NØ�(ÒÐÝ˜B  ^Ñ 3°]ÑCÔCÐCØ�'ÒÐØ�VŠVÐ-°Ò9Ð9˜˜¸qˆVÑAÔAˆØ�VŠVÐ-°Ò9Ð9˜˜¸qˆVÑAÔAˆØ'×+Ò+Ð5EÈÒ5QÐ5Q°°ÐWXÐ+ÑYÔYˆÝ˜B  ^Ñ 3°]ÑCÔCÐCå˜˜R .Ñ0°-Ñ@Ô@€EÝ& u¨g°zÀ2ÀrÈ2ÐUZÐ[Ñ[Ô[Ð[ó    ç      à?NTÚpredsÚtargetÚ	thresholdÚignore_indexÚvalidate_argsc           
      óÐ   — |r#t          |||¦  «         t          | |||¦  «         t          | |||¦  «        \  } }t          | ||¦  «        \  }}}	}
t	          d|||	|
d||¬¦  «        S )ae  Compute `Precision`_ for binary tasks.

    .. math:: \text{Precision} = \frac{\text{TP}}{\text{TP} + \text{FP}}

    Where :math:`\text{TP}` and :math:`\text{FP}` represent the number of true positives and
    false positives respecitively.

    Accepts the following input tensors:

    - ``preds`` (int or float tensor): ``(N, ...)``. If preds is a floating point tensor with values outside
      [0,1] range we consider the input to be logits and will auto apply sigmoid per element. Additionally,
      we convert to int tensor with thresholding using the value in ``threshold``.
    - ``target`` (int tensor): ``(N, ...)``

    Args:
        preds: Tensor with predictions
        target: Tensor with true labels
        threshold: Threshold for transforming probability to binary {0,1} predictions
        multidim_average:
            Defines how additionally dimensions ``...`` should be handled. Should be one of the following:

            - ``global``: Additional dimensions are flatted along the batch dimension
            - ``samplewise``: Statistic will be calculated independently for each sample on the ``N`` axis.
              The statistics in this case are calculated over the additional dimensions.

        ignore_index:
            Specifies a target value that is ignored and does not contribute to the metric calculation
        validate_args: bool indicating if input arguments and tensors should be validated for correctness.
            Set to ``False`` for faster computations.
        zero_division: Should be `0` or `1`. The value returned when :math:`\text{TP} + \text{FP} = 0`.

    Returns:
        If ``multidim_average`` is set to ``global``, the metric returns a scalar value. If ``multidim_average``
        is set to ``samplewise``, the metric returns ``(N,)`` vector consisting of a scalar value per sample.

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.functional.classification import binary_precision
        >>> target = tensor([0, 1, 0, 1, 0, 1])
        >>> preds = tensor([0, 0, 1, 1, 0, 1])
        >>> binary_precision(preds, target)
        tensor(0.6667)

    Example (preds is float tensor):
        >>> from torchmetrics.functional.classification import binary_precision
        >>> target = tensor([0, 1, 0, 1, 0, 1])
        >>> preds = tensor([0.11, 0.22, 0.84, 0.73, 0.33, 0.92])
        >>> binary_precision(preds, target)
        tensor(0.6667)

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import binary_precision
        >>> target = tensor([[[0, 1], [1, 0], [0, 1]], [[1, 1], [0, 0], [1, 0]]])
        >>> preds = tensor([[[0.59, 0.91], [0.91, 0.99], [0.63, 0.04]],
        ...                 [[0.38, 0.04], [0.86, 0.780], [0.45, 0.37]]])
        >>> binary_precision(preds, target, multidim_average='samplewise')
        tensor([0.4000, 0.0000])

    r   r   ©r   r$   r(   ©r   r   r   r	   r0   ©r3   r4   r5   r$   r6   r7   r(   r   r   r   r   s              r/   Úbinary_precisionr<   >   s‘   € ðH ð ]Ý*¨9Ð6FÈÑUÔUÐUÝ-¨e°VÐ=MÈ|Ñ\Ô\Ð\Ý.¨u°f¸iÈÑVÔV�M€Eˆ6Ý/°°vÐ?OÑPÔP�N€BˆˆB�Ý#Ø�R˜˜R ¨XÐHXÐhuðñ ô ð r1   r!   Únum_classes)r    r!   r"   r#   c	                 óÞ   — |r&t          |||||¦  «         t          | ||||¦  «         t          | ||¦  «        \  } }t          | ||||||¦  «        \  }	}
}}t	          d|	|
||||||¬¦	  «	        S )aã  Compute `Precision`_ for multiclass tasks.

    .. math:: \text{Precision} = \frac{\text{TP}}{\text{TP} + \text{FP}}

    Where :math:`\text{TP}` and :math:`\text{FP}` represent the number of true positives and
    false positives respecitively.

    Accepts the following input tensors:

    - ``preds``: ``(N, ...)`` (int tensor) or ``(N, C, ..)`` (float tensor). If preds is a floating point
      we apply ``torch.argmax`` along the ``C`` dimension to automatically convert probabilities/logits into
      an int tensor.
    - ``target`` (int tensor): ``(N, ...)``

    Args:
        preds: Tensor with predictions
        target: Tensor with true labels
        num_classes: Integer specifying the number of classes
        average:
            Defines the reduction that is applied over labels. Should be one of the following:

            - ``micro``: Sum statistics over all labels
            - ``macro``: Calculate statistics for each label and average them
            - ``weighted``: calculates statistics for each label and computes weighted average using their support
            - ``"none"`` or ``None``: calculates statistic for each label and applies no reduction

        top_k:
            Number of highest probability or logit score predictions considered to find the correct label.
            Only works when ``preds`` contain probabilities/logits.
        multidim_average:
            Defines how additionally dimensions ``...`` should be handled. Should be one of the following:

            - ``global``: Additional dimensions are flatted along the batch dimension
            - ``samplewise``: Statistic will be calculated independently for each sample on the ``N`` axis.
              The statistics in this case are calculated over the additional dimensions.

        ignore_index:
            Specifies a target value that is ignored and does not contribute to the metric calculation
        validate_args: bool indicating if input arguments and tensors should be validated for correctness.
            Set to ``False`` for faster computations.
        zero_division: Should be `0` or `1`. The value returned when :math:`\text{TP} + \text{FP} = 0`.

    Returns:
        The returned shape depends on the ``average`` and ``multidim_average`` arguments:

        - If ``multidim_average`` is set to ``global``:

          - If ``average='micro'/'macro'/'weighted'``, the output will be a scalar tensor
          - If ``average=None/'none'``, the shape will be ``(C,)``

        - If ``multidim_average`` is set to ``samplewise``:

          - If ``average='micro'/'macro'/'weighted'``, the shape will be ``(N,)``
          - If ``average=None/'none'``, the shape will be ``(N, C)``

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.functional.classification import multiclass_precision
        >>> target = tensor([2, 1, 0, 0])
        >>> preds = tensor([2, 1, 0, 1])
        >>> multiclass_precision(preds, target, num_classes=3)
        tensor(0.8333)
        >>> multiclass_precision(preds, target, num_classes=3, average=None)
        tensor([1.0000, 0.5000, 1.0000])

    Example (preds is float tensor):
        >>> from torchmetrics.functional.classification import multiclass_precision
        >>> target = tensor([2, 1, 0, 0])
        >>> preds = tensor([[0.16, 0.26, 0.58],
        ...                 [0.22, 0.61, 0.17],
        ...                 [0.71, 0.09, 0.20],
        ...                 [0.05, 0.82, 0.13]])
        >>> multiclass_precision(preds, target, num_classes=3)
        tensor(0.8333)
        >>> multiclass_precision(preds, target, num_classes=3, average=None)
        tensor([1.0000, 0.5000, 1.0000])

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import multiclass_precision
        >>> target = tensor([[[0, 1], [2, 1], [0, 2]], [[1, 1], [2, 0], [1, 2]]])
        >>> preds = tensor([[[0, 2], [2, 0], [0, 1]], [[2, 2], [2, 1], [1, 0]]])
        >>> multiclass_precision(preds, target, num_classes=3, multidim_average='samplewise')
        tensor([0.3889, 0.2778])
        >>> multiclass_precision(preds, target, num_classes=3, multidim_average='samplewise', average=None)
        tensor([[0.6667, 0.0000, 0.5000],
                [0.0000, 0.5000, 0.3333]])

    r   ©r   r$   r'   r(   ©r
   r   r   r   r0   ©r3   r4   r=   r   r'   r$   r6   r7   r(   r   r   r   r   s                r/   Úmulticlass_precisionrB   Œ   s®   € ðF ð nÝ.¨{¸EÀ7ÐL\Ð^jÑkÔkÐkÝ1°%¸ÀÐN^Ð`lÑmÔmÐmÝ2°5¸&À%ÑHÔH�M€Eˆ6Ý3Øˆv�{ E¨7Ð4DÀlñô �N€BˆˆB�õ $ØØ
Ø
Ø
Ø
ØØ)ØØ#ð
ñ 
ô 
ð 
r1   Ú
num_labelsc	                 óÚ   — |r&t          |||||¦  «         t          | ||||¦  «         t          | ||||¦  «        \  } }t          | ||¦  «        \  }	}
}}t	          d|	|
||||d|¬¦	  «	        S )aœ  Compute `Precision`_ for multilabel tasks.

    .. math:: \text{Precision} = \frac{\text{TP}}{\text{TP} + \text{FP}}

    Where :math:`\text{TP}` and :math:`\text{FP}` represent the number of true positives and
    false positives respecitively.

    Accepts the following input tensors:

    - ``preds`` (int or float tensor): ``(N, C, ...)``. If preds is a floating point tensor with values outside
      [0,1] range we consider the input to be logits and will auto apply sigmoid per element. Additionally,
      we convert to int tensor with thresholding using the value in ``threshold``.
    - ``target`` (int tensor): ``(N, C, ...)``

    Args:
        preds: Tensor with predictions
        target: Tensor with true labels
        num_labels: Integer specifying the number of labels
        threshold: Threshold for transforming probability to binary (0,1) predictions
        average:
            Defines the reduction that is applied over labels. Should be one of the following:

            - ``micro``: Sum statistics over all labels
            - ``macro``: Calculate statistics for each label and average them
            - ``weighted``: calculates statistics for each label and computes weighted average using their support
            - ``"none"`` or ``None``: calculates statistic for each label and applies no reduction

        multidim_average:
            Defines how additionally dimensions ``...`` should be handled. Should be one of the following:

            - ``global``: Additional dimensions are flatted along the batch dimension
            - ``samplewise``: Statistic will be calculated independently for each sample on the ``N`` axis.
              The statistics in this case are calculated over the additional dimensions.

        ignore_index:
            Specifies a target value that is ignored and does not contribute to the metric calculation
        validate_args: bool indicating if input arguments and tensors should be validated for correctness.
            Set to ``False`` for faster computations.
        zero_division: Should be `0` or `1`. The value returned when :math:`\text{TP} + \text{FP} = 0`.

    Returns:
        The returned shape depends on the ``average`` and ``multidim_average`` arguments:

        - If ``multidim_average`` is set to ``global``:

          - If ``average='micro'/'macro'/'weighted'``, the output will be a scalar tensor
          - If ``average=None/'none'``, the shape will be ``(C,)``

        - If ``multidim_average`` is set to ``samplewise``:

          - If ``average='micro'/'macro'/'weighted'``, the shape will be ``(N,)``
          - If ``average=None/'none'``, the shape will be ``(N, C)``

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.functional.classification import multilabel_precision
        >>> target = tensor([[0, 1, 0], [1, 0, 1]])
        >>> preds = tensor([[0, 0, 1], [1, 0, 1]])
        >>> multilabel_precision(preds, target, num_labels=3)
        tensor(0.5000)
        >>> multilabel_precision(preds, target, num_labels=3, average=None)
        tensor([1.0000, 0.0000, 0.5000])

    Example (preds is float tensor):
        >>> from torchmetrics.functional.classification import multilabel_precision
        >>> target = tensor([[0, 1, 0], [1, 0, 1]])
        >>> preds = tensor([[0.11, 0.22, 0.84], [0.73, 0.33, 0.92]])
        >>> multilabel_precision(preds, target, num_labels=3)
        tensor(0.5000)
        >>> multilabel_precision(preds, target, num_labels=3, average=None)
        tensor([1.0000, 0.0000, 0.5000])

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import multilabel_precision
        >>> target = tensor([[[0, 1], [1, 0], [0, 1]], [[1, 1], [0, 0], [1, 0]]])
        >>> preds = tensor([[[0.59, 0.91], [0.91, 0.99], [0.63, 0.04]],
        ...                 [[0.38, 0.04], [0.86, 0.780], [0.45, 0.37]]])
        >>> multilabel_precision(preds, target, num_labels=3, multidim_average='samplewise')
        tensor([0.3333, 0.0000])
        >>> multilabel_precision(preds, target, num_labels=3, multidim_average='samplewise', average=None)
        tensor([[0.5000, 0.5000, 0.0000],
                [0.0000, 0.0000, 0.0000]])

    r   T©r   r$   r&   r(   ©r   r   r   r   r0   ©r3   r4   rC   r5   r   r$   r6   r7   r(   r   r   r   r   s                r/   Úmultilabel_precisionrH     s¤   € ð~ ð mÝ.¨z¸9ÀgÐO_ÐamÑnÔnÐnÝ1°%¸ÀÐM]Ð_kÑlÔlÐlÝ2°5¸&À*ÈiÐYeÑfÔf�M€Eˆ6Ý3°E¸6ÐCSÑTÔT�N€BˆˆB�Ý#ØØ
Ø
Ø
Ø
ØØ)ØØ#ð
ñ 
ô 
ð 
r1   c           
      óÐ   — |r#t          |||¦  «         t          | |||¦  «         t          | |||¦  «        \  } }t          | ||¦  «        \  }}}	}
t	          d|||	|
d||¬¦  «        S )aM  Compute `Recall`_ for binary tasks.

    .. math:: \text{Recall} = \frac{\text{TP}}{\text{TP} + \text{FN}}

    Where :math:`\text{TP}` and :math:`\text{FN}` represent the number of true positives and
    false negatives respecitively.

    Accepts the following input tensors:

    - ``preds`` (int or float tensor): ``(N, ...)``. If preds is a floating point tensor with values outside
      [0,1] range we consider the input to be logits and will auto apply sigmoid per element. Additionally,
      we convert to int tensor with thresholding using the value in ``threshold``.
    - ``target`` (int tensor): ``(N, ...)``

    Args:
        preds: Tensor with predictions
        target: Tensor with true labels
        threshold: Threshold for transforming probability to binary {0,1} predictions
        multidim_average:
            Defines how additionally dimensions ``...`` should be handled. Should be one of the following:

            - ``global``: Additional dimensions are flatted along the batch dimension
            - ``samplewise``: Statistic will be calculated independently for each sample on the ``N`` axis.
              The statistics in this case are calculated over the additional dimensions.

        ignore_index:
            Specifies a target value that is ignored and does not contribute to the metric calculation
        validate_args: bool indicating if input arguments and tensors should be validated for correctness.
            Set to ``False`` for faster computations.
        zero_division: Should be `0` or `1`. The value returned when :math:`\text{TP} + \text{FN} = 0`.

    Returns:
        If ``multidim_average`` is set to ``global``, the metric returns a scalar value. If ``multidim_average``
        is set to ``samplewise``, the metric returns ``(N,)`` vector consisting of a scalar value per sample.

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.functional.classification import binary_recall
        >>> target = tensor([0, 1, 0, 1, 0, 1])
        >>> preds = tensor([0, 0, 1, 1, 0, 1])
        >>> binary_recall(preds, target)
        tensor(0.6667)

    Example (preds is float tensor):
        >>> from torchmetrics.functional.classification import binary_recall
        >>> target = tensor([0, 1, 0, 1, 0, 1])
        >>> preds = tensor([0.11, 0.22, 0.84, 0.73, 0.33, 0.92])
        >>> binary_recall(preds, target)
        tensor(0.6667)

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import binary_recall
        >>> target = tensor([[[0, 1], [1, 0], [0, 1]], [[1, 1], [0, 0], [1, 0]]])
        >>> preds = tensor([[[0.59, 0.91], [0.91, 0.99], [0.63, 0.04]],
        ...                 [[0.38, 0.04], [0.86, 0.780], [0.45, 0.37]]])
        >>> binary_recall(preds, target, multidim_average='samplewise')
        tensor([0.6667, 0.0000])

    r   r   r9   r:   r;   s              r/   Úbinary_recallrJ   t  s‘   € ðH ð ]Ý*¨9Ð6FÈÑUÔUÐUÝ-¨e°VÐ=MÈ|Ñ\Ô\Ð\Ý.¨u°f¸iÈÑVÔV�M€Eˆ6Ý/°°vÐ?OÑPÔP�N€BˆˆB�Ý#Ø�"�b˜"˜b¨(ÐEUÐerðñ ô ð r1   c	                 óÞ   — |r&t          |||||¦  «         t          | ||||¦  «         t          | ||¦  «        \  } }t          | ||||||¦  «        \  }	}
}}t	          d|	|
||||||¬¦	  «	        S )aÂ  Compute `Recall`_ for multiclass tasks.

    .. math:: \text{Recall} = \frac{\text{TP}}{\text{TP} + \text{FN}}

    Where :math:`\text{TP}` and :math:`\text{FN}` represent the number of true positives and
    false negatives respecitively.

    Accepts the following input tensors:

    - ``preds``: ``(N, ...)`` (int tensor) or ``(N, C, ..)`` (float tensor). If preds is a floating point
      we apply ``torch.argmax`` along the ``C`` dimension to automatically convert probabilities/logits into
      an int tensor.
    - ``target`` (int tensor): ``(N, ...)``

    Args:
        preds: Tensor with predictions
        target: Tensor with true labels
        num_classes: Integer specifying the number of classes
        average:
            Defines the reduction that is applied over labels. Should be one of the following:

            - ``micro``: Sum statistics over all labels
            - ``macro``: Calculate statistics for each label and average them
            - ``weighted``: calculates statistics for each label and computes weighted average using their support
            - ``"none"`` or ``None``: calculates statistic for each label and applies no reduction

        top_k:
            Number of highest probability or logit score predictions considered to find the correct label.
            Only works when ``preds`` contain probabilities/logits.
        multidim_average:
            Defines how additionally dimensions ``...`` should be handled. Should be one of the following:

            - ``global``: Additional dimensions are flatted along the batch dimension
            - ``samplewise``: Statistic will be calculated independently for each sample on the ``N`` axis.
              The statistics in this case are calculated over the additional dimensions.

        ignore_index:
            Specifies a target value that is ignored and does not contribute to the metric calculation
        validate_args: bool indicating if input arguments and tensors should be validated for correctness.
            Set to ``False`` for faster computations.
        zero_division: Should be `0` or `1`. The value returned when :math:`\text{TP} + \text{FN} = 0`.

    Returns:
        The returned shape depends on the ``average`` and ``multidim_average`` arguments:

        - If ``multidim_average`` is set to ``global``:

          - If ``average='micro'/'macro'/'weighted'``, the output will be a scalar tensor
          - If ``average=None/'none'``, the shape will be ``(C,)``

        - If ``multidim_average`` is set to ``samplewise``:

          - If ``average='micro'/'macro'/'weighted'``, the shape will be ``(N,)``
          - If ``average=None/'none'``, the shape will be ``(N, C)``

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.functional.classification import multiclass_recall
        >>> target = tensor([2, 1, 0, 0])
        >>> preds = tensor([2, 1, 0, 1])
        >>> multiclass_recall(preds, target, num_classes=3)
        tensor(0.8333)
        >>> multiclass_recall(preds, target, num_classes=3, average=None)
        tensor([0.5000, 1.0000, 1.0000])

    Example (preds is float tensor):
        >>> from torchmetrics.functional.classification import multiclass_recall
        >>> target = tensor([2, 1, 0, 0])
        >>> preds = tensor([[0.16, 0.26, 0.58],
        ...                 [0.22, 0.61, 0.17],
        ...                 [0.71, 0.09, 0.20],
        ...                 [0.05, 0.82, 0.13]])
        >>> multiclass_recall(preds, target, num_classes=3)
        tensor(0.8333)
        >>> multiclass_recall(preds, target, num_classes=3, average=None)
        tensor([0.5000, 1.0000, 1.0000])

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import multiclass_recall
        >>> target = tensor([[[0, 1], [2, 1], [0, 2]], [[1, 1], [2, 0], [1, 2]]])
        >>> preds = tensor([[[0, 2], [2, 0], [0, 1]], [[2, 2], [2, 1], [1, 0]]])
        >>> multiclass_recall(preds, target, num_classes=3, multidim_average='samplewise')
        tensor([0.5000, 0.2778])
        >>> multiclass_recall(preds, target, num_classes=3, multidim_average='samplewise', average=None)
        tensor([[1.0000, 0.0000, 0.5000],
                [0.0000, 0.3333, 0.5000]])

    r   r?   r@   rA   s                r/   Úmulticlass_recallrL   Â  s®   € ðF ð nÝ.¨{¸EÀ7ÐL\Ð^jÑkÔkÐkÝ1°%¸ÀÐN^Ð`lÑmÔmÐmÝ2°5¸&À%ÑHÔH�M€Eˆ6Ý3Øˆv�{ E¨7Ð4DÀlñô �N€BˆˆB�õ $ØØ
Ø
Ø
Ø
ØØ)ØØ#ð
ñ 
ô 
ð 
r1   c	                 óÚ   — |r&t          |||||¦  «         t          | ||||¦  «         t          | ||||¦  «        \  } }t          | ||¦  «        \  }	}
}}t	          d|	|
||||d|¬¦	  «	        S )aK  Compute `Recall`_ for multilabel tasks.

    .. math:: \text{Recall} = \frac{\text{TP}}{\text{TP} + \text{FN}}

    Where :math:`\text{TP}` and :math:`\text{FN}` represent the number of true positives and
    false negatives respecitively.

    Accepts the following input tensors:

    - ``preds`` (int or float tensor): ``(N, C, ...)``. If preds is a floating point tensor with values outside
      [0,1] range we consider the input to be logits and will auto apply sigmoid per element. Additionally,
      we convert to int tensor with thresholding using the value in ``threshold``.
    - ``target`` (int tensor): ``(N, C, ...)``

    Args:
        preds: Tensor with predictions
        target: Tensor with true labels
        num_labels: Integer specifying the number of labels
        threshold: Threshold for transforming probability to binary (0,1) predictions
        average:
            Defines the reduction that is applied over labels. Should be one of the following:

            - ``micro``: Sum statistics over all labels
            - ``macro``: Calculate statistics for each label and average them
            - ``weighted``: calculates statistics for each label and computes weighted average using their support
            - ``"none"`` or ``None``: calculates statistic for each label and applies no reduction

        multidim_average:
            Defines how additionally dimensions ``...`` should be handled. Should be one of the following:

            - ``global``: Additional dimensions are flatted along the batch dimension
            - ``samplewise``: Statistic will be calculated independently for each sample on the ``N`` axis.
              The statistics in this case are calculated over the additional dimensions.

        ignore_index:
            Specifies a target value that is ignored and does not contribute to the metric calculation
        validate_args: bool indicating if input arguments and tensors should be validated for correctness.
            Set to ``False`` for faster computations.
        zero_division: Should be `0` or `1`. The value returned when :math:`\text{TP} + \text{FN} = 0`.

    Returns:
        The returned shape depends on the ``average`` and ``multidim_average`` arguments:

        - If ``multidim_average`` is set to ``global``:

          - If ``average='micro'/'macro'/'weighted'``, the output will be a scalar tensor
          - If ``average=None/'none'``, the shape will be ``(C,)``

        - If ``multidim_average`` is set to ``samplewise``:

          - If ``average='micro'/'macro'/'weighted'``, the shape will be ``(N,)``
          - If ``average=None/'none'``, the shape will be ``(N, C)``

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.functional.classification import multilabel_recall
        >>> target = tensor([[0, 1, 0], [1, 0, 1]])
        >>> preds = tensor([[0, 0, 1], [1, 0, 1]])
        >>> multilabel_recall(preds, target, num_labels=3)
        tensor(0.6667)
        >>> multilabel_recall(preds, target, num_labels=3, average=None)
        tensor([1., 0., 1.])

    Example (preds is float tensor):
        >>> from torchmetrics.functional.classification import multilabel_recall
        >>> target = tensor([[0, 1, 0], [1, 0, 1]])
        >>> preds = tensor([[0.11, 0.22, 0.84], [0.73, 0.33, 0.92]])
        >>> multilabel_recall(preds, target, num_labels=3)
        tensor(0.6667)
        >>> multilabel_recall(preds, target, num_labels=3, average=None)
        tensor([1., 0., 1.])

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import multilabel_recall
        >>> target = tensor([[[0, 1], [1, 0], [0, 1]], [[1, 1], [0, 0], [1, 0]]])
        >>> preds = tensor([[[0.59, 0.91], [0.91, 0.99], [0.63, 0.04]],
        ...                 [[0.38, 0.04], [0.86, 0.780], [0.45, 0.37]]])
        >>> multilabel_recall(preds, target, num_labels=3, multidim_average='samplewise')
        tensor([0.6667, 0.0000])
        >>> multilabel_recall(preds, target, num_labels=3, multidim_average='samplewise', average=None)
        tensor([[1., 1., 0.],
                [0., 0., 0.]])

    r   TrE   rF   rG   s                r/   Úmultilabel_recallrN   9  s¤   € ð~ ð mÝ.¨z¸9ÀgÐO_ÐamÑnÔnÐnÝ1°%¸ÀÐM]Ð_kÑlÔlÐlÝ2°5¸&À*ÈiÐYeÑfÔf�M€Eˆ6Ý3°E¸6ÐCSÑTÔT�N€BˆˆB�Ý#ØØ
Ø
Ø
Ø
ØØ)ØØ#ð
ñ 
ô 
ð 
r1   r    Útask)r   Ú
multiclassr&   c                 óR  — |€J ‚|t           j        k    rt          | ||||	|
|¦  «        S |t           j        k    r�t	          |t
          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t	          |t
          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          | ||||||	|
|¦	  «	        S |t           j	        k    rLt	          |t
          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          | ||||||	|
|¦	  «	        S t          d|› �¦  «        ‚)aW  Compute `Precision`_.

    .. math:: \text{Precision} = \frac{\text{TP}}{\text{TP} + \text{FP}}

    Where :math:`\text{TP}` and :math:`\text{FP}` represent the number of true positives and
    false positives respecitively.

    This function is a simple wrapper to get the task specific versions of this metric, which is done by setting the
    ``task`` argument to either ``'binary'``, ``'multiclass'`` or ``'multilabel'``. See the documentation of
    :func:`~torchmetrics.functional.classification.binary_precision`,
    :func:`~torchmetrics.functional.classification.multiclass_precision` and
    :func:`~torchmetrics.functional.classification.multilabel_precision` for the specific details of
    each argument influence and examples.

    Legacy Example:
        >>> from torch import tensor
        >>> preds  = tensor([2, 0, 2, 1])
        >>> target = tensor([1, 1, 2, 0])
        >>> precision(preds, target, task="multiclass", average='macro', num_classes=3)
        tensor(0.1667)
        >>> precision(preds, target, task="multiclass", average='micro', num_classes=3)
        tensor(0.2500)

    Nú+`num_classes` is expected to be `int` but `ú was passed.`ú%`top_k` is expected to be `int` but `ú*`num_labels` is expected to be `int` but `z[Expected argument `task` to either be `'binary'`, `'multiclass'` or `'multilabel'` but got )r   ÚBINARYr<   Ú
MULTICLASSÚ
isinstanceÚintÚ
ValueErrorÚtyperB   Ú
MULTILABELrH   ©r3   r4   rO   r5   r=   rC   r   r$   r'   r6   r7   r(   s               r/   r   r   ª  sk  € ðL Ð'Ð'Ð'ØÕ!Ô(Ò(Ð(Ý  v¨yÐ:JÈLÐZgÐivÑwÔwÐwØÕ!Ô,Ò,Ð,Ý˜+¥sÑ+Ô+ð 	mÝÐkÍ4ÐP[ÑK\ÔK\ÐkÐkÐkÑlÔlÐlÝ˜%¥Ñ%Ô%ð 	aÝÐ_ÅTÈ%Á[Ä[Ð_Ð_Ð_Ñ`Ô`Ð`Ý#Ø�6˜;¨°Ð8HÈ,ÐXeÐgtñ
ô 
ð 	
ð Õ!Ô,Ò,Ð,Ý˜*¥cÑ*Ô*ð 	kÝÐiÍ$ÈzÑJZÔJZÐiÐiÐiÑjÔjÐjÝ#Ø�6˜: y°'Ð;KÈ\Ð[hÐjwñ
ô 
ð 	
õ ØlÐfjÐlÐlñô ð r1   c                 óz  — t          j        |¦  «        }|€J ‚|t           j        k    rt          | ||||	|
|¦  «        S |t           j        k    r�t          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          | ||||||	|
|¦	  «	        S |t           j
        k    rLt          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          | ||||||	|
|¦	  «	        S t          d|› �¦  «        ‚)aB  Compute `Recall`_.

    .. math:: \text{Recall} = \frac{\text{TP}}{\text{TP} + \text{FN}}

    Where :math:`\text{TP}` and :math:`\text{FN}` represent the number of true positives and
    false negatives respecitively.

    This function is a simple wrapper to get the task specific versions of this metric, which is done by setting the
    ``task`` argument to either ``'binary'``, ``'multiclass'`` or ``'multilabel'``. See the documentation of
    :func:`~torchmetrics.functional.classification.binary_recall`,
    :func:`~torchmetrics.functional.classification.multiclass_recall` and
    :func:`~torchmetrics.functional.classification.multilabel_recall` for the specific details of
    each argument influence and examples.

    Legacy Example:
        >>> from torch import tensor
        >>> preds  = tensor([2, 0, 2, 1])
        >>> target = tensor([1, 1, 2, 0])
        >>> recall(preds, target, task="multiclass", average='macro', num_classes=3)
        tensor(0.3333)
        >>> recall(preds, target, task="multiclass", average='micro', num_classes=3)
        tensor(0.2500)

    NrR   rS   rT   rU   zNot handled value: )r   Úfrom_strrV   rJ   rW   rX   rY   rZ   r[   rL   r\   rN   r]   s               r/   r   r   æ  st  € õL Ô& tÑ,Ô,€DØÐ'Ð'Ð'ØÕ!Ô(Ò(Ð(Ý˜U F¨IÐ7GÈÐWdÐfsÑtÔtÐtØÕ!Ô,Ò,Ð,Ý˜+¥sÑ+Ô+ð 	mÝÐkÍ4ÐP[ÑK\ÔK\ÐkÐkÐkÑlÔlÐlÝ˜%¥Ñ%Ô%ð 	aÝÐ_ÅTÈ%Á[Ä[Ð_Ð_Ð_Ñ`Ô`Ð`Ý Ø�6˜;¨°Ð8HÈ,ÐXeÐgtñ
ô 
ð 	
ð Õ!Ô,Ò,Ð,Ý˜*¥cÑ*Ô*ð 	kÝÐiÍ$ÈzÑJZÔJZÐiÐiÐiÑjÔjÐjÝ Ø�6˜: y°'Ð;KÈ\Ð[hÐjwñ
ô 
ð 	
õ Ð1¨4Ð1Ð1Ñ
2Ô
2Ð2r1   )r   Fr   r   )r2   r   NTr   )r!   r   r   NTr   )r2   r!   r   NTr   )	r2   NNr    r   r   NTr   )$Útypingr   Útorchr   Útyping_extensionsr   Ú2torchmetrics.functional.classification.stat_scoresr   r   r   r	   r
   r   r   r   r   r   r   r   Útorchmetrics.utilities.computer   r   Útorchmetrics.utilities.enumsr   ÚboolrY   Úfloatr0   r<   rB   rH   rJ   rL   rN   r   r   © r1   r/   ú<module>ri      sb  ðð Ð Ð Ð Ð Ð à Ð Ð Ð Ð Ð Ø %Ð %Ð %Ð %Ð %Ð %ðð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð UÐ TÐ TÐ TÐ TÐ TÐ TÐ TØ ;Ð ;Ð ;Ð ;Ð ;Ð ;ð 9AØØØð\ð \Ø
Ð'Ô
(ð\àð\ð 	ð\ð 	ð	\ð
 	ð\ð �gÐLÔMÔNð\ð Ð4Ô5ð\ð ð\ð ð\ð ð\ð ð\ð \ð \ð \ð8 Ø8@Ø"&ØØðKð KØðKàðKð ðKð Ð4Ô5ð	Kð
 ˜3”-ðKð ðKð ðKð ðKð Kð Kð Kðd HOØØ8@Ø"&ØØðtð tØðtàðtð ðtð �gÐBÔCÔDð	tð
 ðtð Ð4Ô5ðtð ˜3”-ðtð ðtð ðtð ðtð tð tð tðv ØGNØ8@Ø"&ØØðnð nØðnàðnð ðnð ð	nð
 �gÐBÔCÔDðnð Ð4Ô5ðnð ˜3”-ðnð ðnð ðnð ðnð nð nð nðh Ø8@Ø"&ØØðKð KØðKàðKð ðKð Ð4Ô5ð	Kð
 ˜3”-ðKð ðKð ðKð ðKð Kð Kð Kðd HOØØ8@Ø"&ØØðtð tØðtàðtð ðtð �gÐBÔCÔDð	tð
 ðtð Ð4Ô5ðtð ˜3”-ðtð ðtð ðtð ðtð tð tð tðv ØGNØ8@Ø"&ØØðnð nØðnàðnð ðnð ð	nð
 �gÐBÔCÔDðnð Ð4Ô5ðnð ˜3”-ðnð ðnð ðnð ðnð nð nð nðj Ø!%Ø $ØGNØBJØØ"&ØØð9ð 9Øð9àð9ð Ð6Ô
7ð9ð ð	9ð
 ˜#”ð9ð ˜”ð9ð �gÐBÔCÔDð9ð ˜wÐ'=Ô>Ô?ð9ð �CŒ=ð9ð ˜3”-ð9ð ð9ð ð9ð ð9ð 9ð 9ð 9ð@ Ø!%Ø $ØGNØBJØØ"&ØØð83ð 83Øð83àð83ð Ð6Ô
7ð83ð ð	83ð
 ˜#”ð83ð ˜”ð83ð �gÐBÔCÔDð83ð ˜wÐ'=Ô>Ô?ð83ð �CŒ=ð83ð ˜3”-ð83ð ð83ð ð83ð ð83ð 83ð 83ð 83ð 83ð 83r1   