§
    ’©ºj0”  ã                   ó¾  — 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 	 	 	 d3d	ed
ededededeed                  ded         dededefd„Z	 	 	 	 d4dededed         dee         deddfd„Z	 	 	 	 	 d5dededededed         dee         dededefd„Z	 	 	 	 	 d6ded"ed#edeed$                  ded         dee         deddfd%„Z	 	 	 	 	 	 d7ded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	 	 	 	 	 d8ded'ededeed$                  ded         dee         deddfd(„Z 	 	 	 	 	 	 d9ded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!	 	 	 	 	 d5dedededed         dee         dededefd*„Z"	 	 	 	 	 	 d7d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#	 	 	 	 	 	 d9d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$	 	 	 	 	 	 	 	 	 	 d:deded/ed0         de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d1„Z%	 	 	 	 	 	 	 	 	 d;deded/ed0         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d2„Z&dS )<é    )Ú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ÚtpÚfpÚtnÚfnÚbetaÚaverage)ÚbinaryÚmicroÚmacroÚweightedÚnoneÚmultidim_average)r   Ú
samplewiseÚ
multilabelÚzero_divisionÚreturnc	                 óä  — |dz  }	|dk    r&t          d|	z   | z  d|	z   | z  |	|z  z   |z   |¦  «        S |dk    r€|                      |dk    rdnd¬¦  «        } |                     |dk    rdnd¬¦  «        }|                     |dk    rdnd¬¦  «        }t          d|	z   | z  d|	z   | z  |	|z  z   |z   |¦  «        S t          d|	z   | z  d|	z   | z  |	|z  z   |z   |¦  «        }
t          |
||| ||¦  «        S )Né   r   é   r   r   r   )Údim)r   Úsumr   )r   r   r   r   r   r   r!   r#   r$   Úbeta2Úfbeta_scores              ú}/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/functional/classification/f_beta.pyÚ_fbeta_reducer.   %   s;  € ð �!‰G€EØ�(ÒÐÝ˜Q ™Y¨"Ñ,¨q°5©y¸BÑ.>ÀÈÁÑ.KÈbÑ.PÐR_Ñ`Ô`Ð`Ø�'ÒÐØ�VŠVÐ-°Ò9Ð9˜˜¸qˆVÑAÔAˆØ�VŠVÐ-°Ò9Ð9˜˜¸qˆVÑAÔAˆØ�VŠVÐ-°Ò9Ð9˜˜¸qˆVÑAÔAˆÝ˜Q ™Y¨"Ñ,¨q°5©y¸BÑ.>ÀÈÁÑ.KÈbÑ.PÐR_Ñ`Ô`Ð`å  E¡	¨RÑ/°!°e±)¸rÑ1AÀEÈBÁJÑ1NÐQSÑ1SÐUbÑcÔc€KÝ& {°G¸ZÈÈRÐQSÑTÔTÐTó    ç      à?NÚ	thresholdÚignore_indexc                 ó†   — t          | t          ¦  «        r| dk    st          d| › d�¦  «        ‚t          ||||¦  «         d S ©Nr   z>Expected argument `beta` to be a float larger than 0, but got ú.)Ú
isinstanceÚfloatÚ
ValueErrorr   )r   r1   r!   r2   r$   s        r-   Ú"_binary_fbeta_score_arg_validationr9   =   sV   € õ �t�UÑ#Ô#ð c¨¨qª¨ÝÐaÐZ^ÐaÐaÐaÑbÔbÐbÝ& yÐ2BÀLÐR_Ñ`Ô`Ð`Ð`Ð`r/   TÚpredsÚtargetÚvalidate_argsc           
      óÔ   — |r%t          |||||¦  «         t          | |||¦  «         t          | |||¦  «        \  } }t          | ||¦  «        \  }}	}
}t	          ||	|
||d||¬¦  «        S )aö  Compute `F-score`_ metric for binary tasks.

    .. math::
        F_{\beta} = (1 + \beta^2) * \frac{\text{precision} * \text{recall}}
        {(\beta^2 * \text{precision}) + \text{recall}}

    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
        beta: Weighting between precision and recall in calculation. Setting to 1 corresponds to equal weight
        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 \wedge \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_fbeta_score
        >>> target = tensor([0, 1, 0, 1, 0, 1])
        >>> preds = tensor([0, 0, 1, 1, 0, 1])
        >>> binary_fbeta_score(preds, target, beta=2.0)
        tensor(0.6667)

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

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import binary_fbeta_score
        >>> 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_fbeta_score(preds, target, beta=2.0, multidim_average='samplewise')
        tensor([0.5882, 0.0000])

    r   ©r   r!   r$   )r9   r   r   r	   r.   )r:   r;   r   r1   r!   r2   r<   r$   r   r   r   r   s               r-   Úbinary_fbeta_scorer?   I   s–   € ðL ð ]Ý*¨4°Ð<LÈlÐ\iÑjÔjÐjÝ-¨e°VÐ=MÈ|Ñ\Ô\Ð\Ý.¨u°f¸iÈÑVÔV�M€Eˆ6Ý/°°vÐ?OÑPÔP�N€BˆˆB�ÝØ
ˆB��B˜ hÐAQÐanðñ ô ð r/   r(   r   Únum_classesÚtop_k)r   r   r   r    c                 óŠ   — t          | t          ¦  «        r| dk    st          d| › d�¦  «        ‚t          ||||||¦  «         d S r4   )r6   r7   r8   r
   )r   r@   rA   r   r!   r2   r$   s          r-   Ú&_multiclass_fbeta_score_arg_validationrC   ™   s[   € õ �t�UÑ#Ô#ð c¨¨qª¨ÝÐaÐZ^ÐaÐaÐaÑbÔbÐbÝ*¨;¸¸wÐHXÐZfÐhuÑvÔvÐvÐvÐvr/   c
           
      óà   — |r(t          |||||||	¦  «         t          | ||||¦  «         t          | ||¦  «        \  } }t          | ||||||¦  «        \  }
}}}t	          |
|||||||	¬¦  «        S )a—  Compute `F-score`_ metric for multiclass tasks.

    .. math::
        F_{\beta} = (1 + \beta^2) * \frac{\text{precision} * \text{recall}}
        {(\beta^2 * \text{precision}) + \text{recall}}

    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
        beta: Weighting between precision and recall in calculation. Setting to 1 corresponds to equal weight
        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 \wedge \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_fbeta_score
        >>> target = tensor([2, 1, 0, 0])
        >>> preds = tensor([2, 1, 0, 1])
        >>> multiclass_fbeta_score(preds, target, beta=2.0, num_classes=3)
        tensor(0.7963)
        >>> multiclass_fbeta_score(preds, target, beta=2.0, num_classes=3, average=None)
        tensor([0.5556, 0.8333, 1.0000])

    Example (preds is float tensor):
        >>> from torchmetrics.functional.classification import multiclass_fbeta_score
        >>> 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_fbeta_score(preds, target, beta=2.0, num_classes=3)
        tensor(0.7963)
        >>> multiclass_fbeta_score(preds, target, beta=2.0, num_classes=3, average=None)
        tensor([0.5556, 0.8333, 1.0000])

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import multiclass_fbeta_score
        >>> 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_fbeta_score(preds, target, beta=2.0, num_classes=3, multidim_average='samplewise')
        tensor([0.4697, 0.2706])
        >>> multiclass_fbeta_score(preds, target, beta=2.0, num_classes=3, multidim_average='samplewise', average=None)
        tensor([[0.9091, 0.0000, 0.5000],
                [0.0000, 0.3571, 0.4545]])

    r>   )rC   r   r   r   r.   )r:   r;   r   r@   r   rA   r!   r2   r<   r$   r   r   r   r   s                 r-   Úmulticlass_fbeta_scorerE   §   s²   € ðH ð nÝ.Ø�+˜u gÐ/?ÀÈ}ñ	
ô 	
ð 	
õ 	2°%¸ÀÐN^Ð`lÑmÔmÐmÝ2°5¸&À%ÑHÔH�M€Eˆ6Ý3Øˆv�{ E¨7Ð4DÀlñô �N€BˆˆB�õ Ø
ˆB��B˜ gÐ@PÐ`mðñ ô ð r/   Ú
num_labelsc                 óŠ   — t          | t          ¦  «        r| dk    st          d| › d�¦  «        ‚t          ||||||¦  «         d S r4   )r6   r7   r8   r   )r   rF   r1   r   r!   r2   r$   s          r-   Ú&_multilabel_fbeta_score_arg_validationrH     sd   € õ �t�UÑ#Ô#ð c¨¨qª¨ÝÐaÐZ^ÐaÐaÐaÑbÔbÐbÝ*Ø�I˜wÐ(8¸,Èñô ð ð ð r/   c
                 óÞ   — |r(t          |||||||	¦  «         t          | ||||¦  «         t          | ||||¦  «        \  } }t          | ||¦  «        \  }
}}}t	          |
||||||d|	¬¦	  «	        S )aQ  Compute `F-score`_ metric for multilabel tasks.

    .. math::
        F_{\beta} = (1 + \beta^2) * \frac{\text{precision} * \text{recall}}
        {(\beta^2 * \text{precision}) + \text{recall}}

    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
        beta: Weighting between precision and recall in calculation. Setting to 1 corresponds to equal weight
        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 \wedge \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_fbeta_score
        >>> target = tensor([[0, 1, 0], [1, 0, 1]])
        >>> preds = tensor([[0, 0, 1], [1, 0, 1]])
        >>> multilabel_fbeta_score(preds, target, beta=2.0, num_labels=3)
        tensor(0.6111)
        >>> multilabel_fbeta_score(preds, target, beta=2.0, num_labels=3, average=None)
        tensor([1.0000, 0.0000, 0.8333])

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

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import multilabel_fbeta_score
        >>> 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_fbeta_score(preds, target, num_labels=3, beta=2.0, multidim_average='samplewise')
        tensor([0.5556, 0.0000])
        >>> multilabel_fbeta_score(preds, target, num_labels=3, beta=2.0, multidim_average='samplewise', average=None)
        tensor([[0.8333, 0.8333, 0.0000],
                [0.0000, 0.0000, 0.0000]])

    T)r   r!   r#   r$   )rH   r   r   r   r.   )r:   r;   r   rF   r1   r   r!   r2   r<   r$   r   r   r   r   s                 r-   Úmultilabel_fbeta_scorerJ   )  s±   € ðB ð mÝ.Ø�*˜i¨Ð2BÀLÐR_ñ	
ô 	
ð 	
õ 	2°%¸ÀÐM]Ð_kÑlÔlÐlÝ2°5¸&À*ÈiÐYeÑfÔf�M€Eˆ6Ý3°E¸6ÐCSÑTÔT�N€BˆˆB�ÝØ
Ø
Ø
Ø
ØØØ)ØØ#ð
ñ 
ô 
ð 
r/   c           
      ó0   — t          | |d|||||¬¦  «        S )a*  Compute F-1 score for binary tasks.

    .. math::
        F_{1} = 2\frac{\text{precision} * \text{recall}}{(\text{precision}) + \text{recall}}

    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 \wedge \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_f1_score
        >>> target = tensor([0, 1, 0, 1, 0, 1])
        >>> preds = tensor([0, 0, 1, 1, 0, 1])
        >>> binary_f1_score(preds, target)
        tensor(0.6667)

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

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import binary_f1_score
        >>> 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_f1_score(preds, target, multidim_average='samplewise')
        tensor([0.5000, 0.0000])

    ç      ð?)r:   r;   r   r1   r!   r2   r<   r$   )r?   )r:   r;   r1   r!   r2   r<   r$   s          r-   Úbinary_f1_scorerM   ž  s4   € õF ØØØØØ)Ø!Ø#Ø#ð	ñ 	ô 	ð 	r/   c	                 ó4   — t          | |d|||||||¬¦
  «
        S )a¤  Compute F-1 score for multiclass tasks.

    .. math::
        F_{1} = 2\frac{\text{precision} * \text{recall}}{(\text{precision}) + \text{recall}}

    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 \wedge \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_f1_score
        >>> target = tensor([2, 1, 0, 0])
        >>> preds = tensor([2, 1, 0, 1])
        >>> multiclass_f1_score(preds, target, num_classes=3)
        tensor(0.7778)
        >>> multiclass_f1_score(preds, target, num_classes=3, average=None)
        tensor([0.6667, 0.6667, 1.0000])

    Example (preds is float tensor):
        >>> from torchmetrics.functional.classification import multiclass_f1_score
        >>> 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_f1_score(preds, target, num_classes=3)
        tensor(0.7778)
        >>> multiclass_f1_score(preds, target, num_classes=3, average=None)
        tensor([0.6667, 0.6667, 1.0000])

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import multiclass_f1_score
        >>> 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_f1_score(preds, target, num_classes=3, multidim_average='samplewise')
        tensor([0.4333, 0.2667])
        >>> multiclass_f1_score(preds, target, num_classes=3, multidim_average='samplewise', average=None)
        tensor([[0.8000, 0.0000, 0.5000],
                [0.0000, 0.4000, 0.4000]])

    rL   )
r:   r;   r   r@   r   rA   r!   r2   r<   r$   )rE   )	r:   r;   r@   r   rA   r!   r2   r<   r$   s	            r-   Úmulticlass_f1_scorerO   í  s:   € õB "ØØØØØØØ)Ø!Ø#Ø#ðñ ô ð r/   c	                 ó4   — t          | |d|||||||¬¦
  «
        S )a^  Compute F-1 score for multilabel tasks.

    .. math::
        F_{1} = 2\frac{\text{precision} * \text{recall}}{(\text{precision}) + \text{recall}}

    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 \wedge \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_f1_score
        >>> target = tensor([[0, 1, 0], [1, 0, 1]])
        >>> preds = tensor([[0, 0, 1], [1, 0, 1]])
        >>> multilabel_f1_score(preds, target, num_labels=3)
        tensor(0.5556)
        >>> multilabel_f1_score(preds, target, num_labels=3, average=None)
        tensor([1.0000, 0.0000, 0.6667])

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

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import multilabel_f1_score
        >>> 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_f1_score(preds, target, num_labels=3, multidim_average='samplewise')
        tensor([0.4444, 0.0000])
        >>> multilabel_f1_score(preds, target, num_labels=3, multidim_average='samplewise', average=None)
        tensor([[0.6667, 0.6667, 0.0000],
                [0.0000, 0.0000, 0.0000]])

    rL   )
r:   r;   r   rF   r1   r   r!   r2   r<   r$   )rJ   )	r:   r;   rF   r1   r   r!   r2   r<   r$   s	            r-   Úmultilabel_f1_scorerQ   \  s:   € õ| "ØØØØØØØ)Ø!Ø#Ø#ðñ ô ð r/   rL   r   Útask)r   Ú
multiclassr#   c                 ó‚  — 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    rMt          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          | |||||||
||¦
  «
        S t          d|› d�¦  «        ‚)aÀ  Compute `F-score`_ metric.

    .. math::
        F_{\beta} = (1 + \beta^2) * \frac{\text{precision} * \text{recall}}
        {(\beta^2 * \text{precision}) + \text{recall}}

    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_fbeta_score`,
    :func:`~torchmetrics.functional.classification.multiclass_fbeta_score` and
    :func:`~torchmetrics.functional.classification.multilabel_fbeta_score` for the specific
    details of each argument influence and examples.

    Legacy Example:
        >>> from torch import tensor
        >>> target = tensor([0, 1, 2, 0, 1, 2])
        >>> preds = tensor([0, 2, 1, 0, 0, 1])
        >>> fbeta_score(preds, target, task="multiclass", num_classes=3, beta=0.5)
        tensor(0.3333)

    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 `úUnsupported task `ú	` passed.)r   Úfrom_strÚBINARYr?   Ú
MULTICLASSr6   Úintr8   ÚtyperE   Ú
MULTILABELrJ   )r:   r;   rR   r   r1   r@   rF   r   r!   rA   r2   r<   r$   s                r-   r,   r,   È  s‘  € õH Ô& tÑ,Ô,€DØÐ'Ð'Ð'ØÕ!Ô(Ò(Ð(Ý!Ø�6˜4 Ð,<¸lÈMÐ[hñ
ô 
ð 	
ð Õ!Ô,Ò,Ð,Ý˜+¥sÑ+Ô+ð 	mÝÐkÍ4ÐP[ÑK\ÔK\ÐkÐkÐkÑlÔlÐlÝ˜%¥Ñ%Ô%ð 	aÝÐ_ÅTÈ%Á[Ä[Ð_Ð_Ð_Ñ`Ô`Ð`Ý%ØØØØØØØØØØñ
ô 
ð 	
ð Õ!Ô,Ò,Ð,Ý˜*¥cÑ*Ô*ð 	kÝÐiÍ$ÈzÑJZÔJZÐiÐiÐiÑjÔjÐjÝ%ØØØØØØØØØØñ
ô 
ð 	
õ Ð9¨$Ð9Ð9Ð9Ñ
:Ô
:Ð:r/   c                 ó|  — 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|› d�¦  «        ‚)a|  Compute F-1 score.

    .. math::
        F_{1} = 2\frac{\text{precision} * \text{recall}}{(\text{precision}) + \text{recall}}

    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_f1_score`,
    :func:`~torchmetrics.functional.classification.multiclass_f1_score` and
    :func:`~torchmetrics.functional.classification.multilabel_f1_score` for the specific
    details of each argument influence and examples.

    Legacy Example:
        >>> from torch import tensor
        >>> target = tensor([0, 1, 2, 0, 1, 2])
        >>> preds = tensor([0, 2, 1, 0, 0, 1])
        >>> f1_score(preds, target, task="multiclass", num_classes=3)
        tensor(0.3333)

    NrU   rV   rW   rX   rY   rZ   )r   r[   r\   rM   r]   r6   r^   r8   r_   rO   r`   rQ   )r:   r;   rR   r1   r@   rF   r   r!   rA   r2   r<   r$   s               r-   Úf1_scorerb     sw  € õD Ô& tÑ,Ô,€DØÐ'Ð'Ð'ØÕ!Ô(Ò(Ð(Ý˜u f¨iÐ9IÈ<ÐYfÐhuÑvÔvÐvØÕ!Ô,Ò,Ð,Ý˜+¥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ñ
ô 
ð 	
õ Ð9¨$Ð9Ð9Ð9Ñ
:Ô
:Ð:r/   )r   Fr   )r0   r   Nr   )r0   r   NTr   )r(   r   r   Nr   )r   r(   r   NTr   )r0   r   r   Nr   )r0   r   r   NTr   )
rL   r0   NNr   r   r(   NTr   )	r0   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   r7   Úboolr.   r^   r9   r?   rC   rE   rH   rJ   rM   rO   rQ   r,   rb   © r/   r-   ú<module>rk      s&	  ðð Ð Ð Ð Ð Ð à Ð Ð Ð Ð Ð Ø %Ð %Ð %Ð %Ð %Ð %ðð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð UÐ TÐ TÐ TÐ TÐ TÐ TÐ TØ ;Ð ;Ð ;Ð ;Ð ;Ð ;ð 9AØØðUð UØðUàðUð 	ðUð 	ð	Uð
 ðUð �gÐLÔMÔNðUð Ð4Ô5ðUð ðUð ðUð ðUð Uð Uð Uð4 Ø8@Ø"&Øð	að 	aØ
ð	aàð	að Ð4Ô5ð	að ˜3”-ð		að
 ð	að 
ð	að 	að 	að 	að  Ø8@Ø"&ØØðMð MØðMàðMð ðMð ð	Mð
 Ð4Ô5ðMð ˜3”-ðMð ðMð ðMð ðMð Mð Mð Mðf ØGNØ8@Ø"&Øðwð wØ
ðwàðwð ðwð �gÐBÔCÔDð	wð
 Ð4Ô5ðwð ˜3”-ðwð ðwð 
ðwð wð wð wð& HOØØ8@Ø"&ØØðoð oØðoàðoð ðoð ð	oð
 �gÐBÔCÔDðoð ðoð Ð4Ô5ðoð ˜3”-ðoð ðoð ðoð ðoð oð oð oðj ØGNØ8@Ø"&Øðð Ø
ðàðð ðð �gÐBÔCÔDð	ð
 Ð4Ô5ðð ˜3”-ðð ðð 
ðð ð ð ð* ØGNØ8@Ø"&ØØðrð rØðràðrð ðrð ð	rð
 ðrð �gÐBÔCÔDðrð Ð4Ô5ðrð ˜3”-ðrð ðrð ðrð ðrð rð rð rðp Ø8@Ø"&ØØðLð LØðLàðLð ðLð Ð4Ô5ð	Lð
 ˜3”-ðLð ðLð ðLð ðLð Lð Lð Lðf HOØØ8@Ø"&ØØðlð lØðlàðlð ðlð �gÐBÔCÔDð	lð
 ðlð Ð4Ô5ðlð ˜3”-ðlð ðlð ðlð ðlð lð lð lðf ØGNØ8@Ø"&ØØðið iØðiàðið ðið ð	ið
 �gÐBÔCÔDðið Ð4Ô5ðið ˜3”-ðið ðið ðið ðið ið ið ið` ØØ!%Ø $ØGNØBJØØ"&ØØðJ;ð J;ØðJ;àðJ;ð Ð6Ô
7ðJ;ð ð	J;ð
 ðJ;ð ˜#”ðJ;ð ˜”ðJ;ð �gÐBÔCÔDðJ;ð ˜wÐ'=Ô>Ô?ðJ;ð �CŒ=ðJ;ð ˜3”-ðJ;ð ðJ;ð ðJ;ð ðJ;ð J;ð J;ð J;ðb Ø!%Ø $ØGNØBJØØ"&ØØð4;ð 4;Øð4;àð4;ð Ð6Ô
7ð4;ð ð	4;ð
 ˜#”ð4;ð ˜”ð4;ð �gÐBÔCÔDð4;ð ˜wÐ'=Ô>Ô?ð4;ð �CŒ=ð4;ð ˜3”-ð4;ð ð4;ð ð4;ð ð4;ð 4;ð 4;ð 4;ð 4;ð 4;r/   