§
    ’©ºjÔÓ  ã                   ó–  — d dl mZ d dlmZmZmZ d dlmZ d dlm	Z	 d dl
mZ d dlmZmZmZ d dlmZmZmZmZ d dlmZ d d	lmZ d d
lmZ d dlmZmZ esg d¢Z G d„ de¦  «        Z G d„ de¦  «        Z  G d„ de¦  «        Z! G d„ de¦  «        Z" G d„ de ¦  «        Z# G d„ de!¦  «        Z$ G d„ de¦  «        Z% G d„ de¦  «        Z&dS )é    )ÚSequence)ÚAnyÚOptionalÚUnion)ÚTensor)ÚLiteral)Ú_ClassificationTaskWrapper)ÚBinaryStatScoresÚMulticlassStatScoresÚMultilabelStatScores)Ú"_binary_fbeta_score_arg_validationÚ_fbeta_reduceÚ&_multiclass_fbeta_score_arg_validationÚ&_multilabel_fbeta_score_arg_validation)ÚMetric)ÚClassificationTask)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPE)zBinaryFBetaScore.plotzMulticlassFBetaScore.plotzMultilabelFBetaScore.plotzBinaryF1Score.plotzMulticlassF1Score.plotzMultilabelF1Score.plotc                   ó  ‡ — e Zd ZU dZdZeed<   dZee         ed<   dZ	eed<   dZ
eed<   d	Zeed
<   	 	 	 	 	 ddededed         dee         dedededdfˆ fd„Zdefd„Z	 ddeeeee         f                  dee         defd„Zˆ xZS )ÚBinaryFBetaScoreag  Compute `F-score`_ metric for binary tasks.

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

    The metric is only proper defined when :math:`\text{TP} + \text{FP} \neq 0 \wedge \text{TP} + \text{FN} \neq 0`
    where :math:`\text{TP}`, :math:`\text{FP}` and :math:`\text{FN}` represent the number of true positives, false
    positives and false negatives respectively. If this case is encountered a score of `zero_division`
    (0 or 1, default is 0) is returned.

    As input to ``forward`` and ``update`` the metric accepts the following input:

    - ``preds`` (:class:`~torch.Tensor`): An int tensor or float tensor of shape ``(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`` (:class:`~torch.Tensor`): An int tensor of shape ``(N, ...)``.

    As output to ``forward`` and ``compute`` the metric returns the following output:

    - ``bfbs`` (:class:`~torch.Tensor`): A tensor whose returned shape depends on the ``multidim_average`` argument:

        - If ``multidim_average`` is set to ``global`` the output will be a scalar tensor
        - If ``multidim_average`` is set to ``samplewise`` the output will be a tensor of shape ``(N,)`` consisting of
          a scalar value per sample.

    If ``multidim_average`` is set to ``samplewise`` we expect at least one additional dimension ``...`` to be present,
    which the reduction will then be applied over instead of the sample dimension ``N``.

    Args:
        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`.

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.classification import BinaryFBetaScore
        >>> target = tensor([0, 1, 0, 1, 0, 1])
        >>> preds = tensor([0, 0, 1, 1, 0, 1])
        >>> metric = BinaryFBetaScore(beta=2.0)
        >>> metric(preds, target)
        tensor(0.6667)

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

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

    FÚis_differentiableTÚhigher_is_betterÚfull_state_updateç        Úplot_lower_boundç      ð?Úplot_upper_boundç      à?ÚglobalNr   ÚbetaÚ	thresholdÚmultidim_average©r    Ú
samplewiseÚignore_indexÚvalidate_argsÚzero_divisionÚkwargsÚreturnc                 ó˜   •—  t          ¦   «         j        d|||ddœ|¤Ž |rt          |||||¦  «         || _        || _        || _        d S )NF)r"   r#   r&   r'   © )ÚsuperÚ__init__r   r'   r(   r!   )	Úselfr!   r"   r#   r&   r'   r(   r)   Ú	__class__s	           €úr/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/classification/f_beta.pyr.   zBinaryFBetaScore.__init__}   s   ø€ ð 	�‰ŒÔð 	
ØØ-Ø%Øð		
ð 	
ð
 ð	
ð 	
ð 	
ð ð 	oÝ.¨t°YÐ@PÐR^Ð`mÑnÔnÐnØ*ˆÔØ*ˆÔØˆŒ	ˆ	ˆ	ó    c           
      ó€   — |                       ¦   «         \  }}}}t          ||||| j        d| j        | j        ¬¦  «        S )úCompute metric.Úbinary©Úaverager#   r(   )Ú_final_stater   r!   r#   r(   ©r/   ÚtpÚfpÚtnÚfns        r1   ÚcomputezBinaryFBetaScore.compute”   sR   € à×*Ò*Ñ,Ô,‰ˆˆB��BÝØØØØØŒIØØ!Ô2ØÔ,ð	
ñ 	
ô 	
ð 		
r2   ÚvalÚaxc                 ó.   — |                       ||¦  «        S )aI  Plot a single or multiple values from the metric.

        Args:
            val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results.
                If no value is provided, will automatically call `metric.compute` and plot that result.
            ax: An matplotlib axis object. If provided will add plot to that axis

        Returns:
            Figure object and Axes object

        Raises:
            ModuleNotFoundError:
                If `matplotlib` is not installed

        .. plot::
            :scale: 75

            >>> from torch import rand, randint
            >>> # Example plotting a single value
            >>> from torchmetrics.classification import BinaryFBetaScore
            >>> metric = BinaryFBetaScore(beta=2.0)
            >>> metric.update(rand(10), randint(2,(10,)))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> from torch import rand, randint
            >>> # Example plotting multiple values
            >>> from torchmetrics.classification import BinaryFBetaScore
            >>> metric = BinaryFBetaScore(beta=2.0)
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(rand(10), randint(2,(10,))))
            >>> fig_, ax_ = metric.plot(values)

        ©Ú_plot©r/   r?   r@   s      r1   ÚplotzBinaryFBetaScore.plot¢   ó   € ðP �zŠz˜#˜rÑ"Ô"Ð"r2   ©r   r    NTr   ©NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   r   Úfloatr   r   Úintr   r.   r   r>   r   r   r   r   rE   Ú__classcell__©r0   s   @r1   r   r   ,   s‚  ø€ € € € € € ðHð HðT $Ð�tÐ#Ð#Ñ#Ø'+Ð�h˜t”nÐ+Ð+Ñ+Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�eÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!ð
 Ø<DØ&*Ø"Ø ðð àðð ðð "Ð"8Ô9ð	ð
 ˜s”mðð ðð ðð ðð 
ðð ð ð ð ð ð.
˜ð 
ð 
ð 
ð 
ð _cð(#ð (#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð(#ØIQÐRZÔI[ð(#à	ð(#ð (#ð (#ð (#ð (#ð (#ð (#ð (#r2   r   c                   óD  ‡ — e Zd ZU dZdZeed<   dZee         ed<   dZ	eed<   dZ
eed<   d	Zeed
<   dZeed<   	 	 	 	 	 	 d#dedededeed                  ded         dee         dedededdfˆ fd„Zdefd„Z	 d$d eeeee         f                  d!ee         defd"„Zˆ xZS )%ÚMulticlassFBetaScoreaP  Compute `F-score`_ metric for multiclass tasks.

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

    The metric is only proper defined when :math:`\text{TP} + \text{FP} \neq 0 \wedge \text{TP} + \text{FN} \neq 0`
    where :math:`\text{TP}`, :math:`\text{FP}` and :math:`\text{FN}` represent the number of true positives, false
    positives and false negatives respectively. If this case is encountered for any class, the metric for that class
    will be set to `zero_division` (0 or 1, default is 0) and the overall metric may therefore be affected in turn.

    As input to ``forward`` and ``update`` the metric accepts the following input:

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

    As output to ``forward`` and ``compute`` the metric returns the following output:

    - ``mcfbs`` (:class:`~torch.Tensor`): A tensor whose 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)``

    If ``multidim_average`` is set to ``samplewise`` we expect at least one additional dimension ``...`` to be present,
    which the reduction will then be applied over instead of the sample dimension ``N``.

    Args:
        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`.

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.classification import MulticlassFBetaScore
        >>> target = tensor([2, 1, 0, 0])
        >>> preds = tensor([2, 1, 0, 1])
        >>> metric = MulticlassFBetaScore(beta=2.0, num_classes=3)
        >>> metric(preds, target)
        tensor(0.7963)
        >>> mcfbs = MulticlassFBetaScore(beta=2.0, num_classes=3, average=None)
        >>> mcfbs(preds, target)
        tensor([0.5556, 0.8333, 1.0000])

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

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

    Fr   Tr   r   r   r   r   r   ÚClassÚplot_legend_nameé   Úmacror    Nr   r!   Únum_classesÚtop_kr7   ©ÚmicrorX   ÚweightedÚnoner#   r$   r&   r'   r(   r)   r*   c	           
      ó    •—  t          ¦   «         j        d|||||ddœ|	¤Ž |rt          |||||||¦  «         || _        || _        || _        d S )NF)rY   rZ   r7   r#   r&   r'   r,   )r-   r.   r   r'   r(   r!   )r/   r!   rY   rZ   r7   r#   r&   r'   r(   r)   r0   s             €r1   r.   zMulticlassFBetaScore.__init__=  s�   ø€ ð 	�‰ŒÔð 	
Ø#ØØØ-Ø%Øð	
ð 	
ð ð	
ð 	
ð 	
ð ð 	Ý2Ø�k 5¨'Ð3CÀ\ÐS`ñô ð ð +ˆÔØ*ˆÔØˆŒ	ˆ	ˆ	r2   c           
      óŠ   — |                       ¦   «         \  }}}}t          ||||| j        | j        | j        | j        ¬¦  «        S )r4   r6   ©r8   r   r!   r7   r#   r(   r9   s        r1   r>   zMulticlassFBetaScore.computeZ  sT   € à×*Ò*Ñ,Ô,‰ˆˆB��BÝØØØØØŒIØ”LØ!Ô2ØÔ,ð	
ñ 	
ô 	
ð 		
r2   r?   r@   c                 ó.   — |                       ||¦  «        S )a°  Plot a single or multiple values from the metric.

        Args:
            val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results.
                If no value is provided, will automatically call `metric.compute` and plot that result.
            ax: An matplotlib axis object. If provided will add plot to that axis

        Returns:
            Figure object and Axes object

        Raises:
            ModuleNotFoundError:
                If `matplotlib` is not installed

        .. plot::
            :scale: 75

            >>> from torch import randint
            >>> # Example plotting a single value per class
            >>> from torchmetrics.classification import MulticlassFBetaScore
            >>> metric = MulticlassFBetaScore(num_classes=3, beta=2.0, average=None)
            >>> metric.update(randint(3, (20,)), randint(3, (20,)))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> from torch import randint
            >>> # Example plotting a multiple values per class
            >>> from torchmetrics.classification import MulticlassFBetaScore
            >>> metric = MulticlassFBetaScore(num_classes=3, beta=2.0, average=None)
            >>> values = []
            >>> for _ in range(20):
            ...     values.append(metric(randint(3, (20,)), randint(3, (20,))))
            >>> fig_, ax_ = metric.plot(values)

        rB   rD   s      r1   rE   zMulticlassFBetaScore.ploth  rF   r2   ©rW   rX   r    NTr   rH   ©rI   rJ   rK   rL   r   rM   rN   r   r   r   r   rO   r   rV   ÚstrrP   r   r   r.   r   r>   r   r   r   r   rE   rQ   rR   s   @r1   rT   rT   Í   sµ  ø€ € € € € € ðfð fðP $Ð�tÐ#Ð#Ñ#Ø'+Ð�h˜t”nÐ+Ð+Ñ+Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�eÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!Ø#Ð�cÐ#Ð#Ñ#ð ØKRØ<DØ&*Ø"Ø ðð àðð ðð ð	ð
 ˜'Ð"FÔGÔHðð "Ð"8Ô9ðð ˜s”mðð ðð ðð ðð 
ðð ð ð ð ð ð:
˜ð 
ð 
ð 
ð 
ð _cð(#ð (#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð(#ØIQÐRZÔI[ð(#à	ð(#ð (#ð (#ð (#ð (#ð (#ð (#ð (#r2   rT   c                   óD  ‡ — e Zd ZU dZdZeed<   dZee         ed<   dZ	eed<   dZ
eed<   d	Zeed
<   dZeed<   	 	 	 	 	 	 d#dedededeed                  ded         dee         dedededdfˆ fd„Zdefd„Z	 d$d eeeee         f                  d!ee         defd"„Zˆ xZS )%ÚMultilabelFBetaScorea  Compute `F-score`_ metric for multilabel tasks.

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

    The metric is only proper defined when :math:`\text{TP} + \text{FP} \neq 0 \wedge \text{TP} + \text{FN} \neq 0`
    where :math:`\text{TP}`, :math:`\text{FP}` and :math:`\text{FN}` represent the number of true positives, false
    positives and false negatives respectively. If this case is encountered for any label, the metric for that label
    will be set to `zero_division` (0 or 1, default is 0) and the overall metric may therefore be affected in turn.

    As input to ``forward`` and ``update`` the metric accepts the following input:

    - ``preds`` (:class:`~torch.Tensor`): An int or float tensor of shape ``(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`` (:class:`~torch.Tensor`): An int tensor of shape ``(N, C, ...)``.

    As output to ``forward`` and ``compute`` the metric returns the following output:

    - ``mlfbs`` (:class:`~torch.Tensor`): A tensor whose 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)``

    If ``multidim_average`` is set to ``samplewise`` we expect at least one additional dimension ``...`` to be present,
    which the reduction will then be applied over instead of the sample dimension ``N``.

    Args:
        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`.

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.classification import MultilabelFBetaScore
        >>> target = tensor([[0, 1, 0], [1, 0, 1]])
        >>> preds = tensor([[0, 0, 1], [1, 0, 1]])
        >>> metric = MultilabelFBetaScore(beta=2.0, num_labels=3)
        >>> metric(preds, target)
        tensor(0.6111)
        >>> mlfbs = MultilabelFBetaScore(beta=2.0, num_labels=3, average=None)
        >>> mlfbs(preds, target)
        tensor([1.0000, 0.0000, 0.8333])

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

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

    Fr   Tr   r   r   r   r   r   ÚLabelrV   r   rX   r    Nr   r!   Ú
num_labelsr"   r7   r[   r#   r$   r&   r'   r(   r)   r*   c	           
      ó    •—  t          ¦   «         j        d|||||ddœ|	¤Ž |rt          |||||||¦  «         || _        || _        || _        d S )NF)ri   r"   r7   r#   r&   r'   r,   )r-   r.   r   r'   r(   r!   )r/   r!   ri   r"   r7   r#   r&   r'   r(   r)   r0   s             €r1   r.   zMultilabelFBetaScore.__init__ÿ  s�   ø€ ð 	�‰ŒÔð 	
Ø!ØØØ-Ø%Øð	
ð 	
ð ð	
ð 	
ð 	
ð ð 	Ý2Ø�j )¨WÐ6FÈÐVcñô ð ð +ˆÔØ*ˆÔØˆŒ	ˆ	ˆ	r2   c                 óŒ   — |                       ¦   «         \  }}}}t          ||||| j        | j        | j        d| j        ¬¦	  «	        S )r4   T)r7   r#   Ú
multilabelr(   ra   r9   s        r1   r>   zMultilabelFBetaScore.compute  sW   € à×*Ò*Ñ,Ô,‰ˆˆB��BÝØØØØØŒIØ”LØ!Ô2ØØÔ,ð

ñ 

ô 

ð 
	
r2   r?   r@   c                 ó.   — |                       ||¦  «        S )aŠ  Plot a single or multiple values from the metric.

        Args:
            val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results.
                If no value is provided, will automatically call `metric.compute` and plot that result.
            ax: An matplotlib axis object. If provided will add plot to that axis

        Returns:
            Figure and Axes object

        Raises:
            ModuleNotFoundError:
                If `matplotlib` is not installed

        .. plot::
            :scale: 75

            >>> from torch import rand, randint
            >>> # Example plotting a single value
            >>> from torchmetrics.classification import MultilabelFBetaScore
            >>> metric = MultilabelFBetaScore(num_labels=3, beta=2.0)
            >>> metric.update(randint(2, (20, 3)), randint(2, (20, 3)))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> from torch import rand, randint
            >>> # Example plotting multiple values
            >>> from torchmetrics.classification import MultilabelFBetaScore
            >>> metric = MultilabelFBetaScore(num_labels=3, beta=2.0)
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(randint(2, (20, 3)), randint(2, (20, 3))))
            >>> fig_, ax_ = metric.plot(values)

        rB   rD   s      r1   rE   zMultilabelFBetaScore.plot+  rF   r2   ©r   rX   r    NTr   rH   rd   rR   s   @r1   rg   rg   “  sµ  ø€ € € € € € ðbð bðH $Ð�tÐ#Ð#Ñ#Ø'+Ð�h˜t”nÐ+Ð+Ñ+Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�eÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!Ø#Ð�cÐ#Ð#Ñ#ð ØKRØ<DØ&*Ø"Ø ðð àðð ðð ð	ð
 ˜'Ð"FÔGÔHðð "Ð"8Ô9ðð ˜s”mðð ðð ðð ðð 
ðð ð ð ð ð ð:
˜ð 
ð 
ð 
ð 
ð  _cð(#ð (#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð(#ØIQÐRZÔI[ð(#à	ð(#ð (#ð (#ð (#ð (#ð (#ð (#ð (#r2   rg   c                   ó  ‡ — e Zd ZU dZdZeed<   dZee         ed<   dZ	eed<   dZ
eed<   d	Zeed
<   	 	 	 	 	 ddeded         dee         dedededdfˆ fd„Z	 ddeeeee         f                  dee         defd„Zˆ xZS )ÚBinaryF1ScoreaŽ  Compute F-1 score for binary tasks.

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

    The metric is only proper defined when :math:`\text{TP} + \text{FP} \neq 0 \wedge \text{TP} + \text{FN} \neq 0`
    where :math:`\text{TP}`, :math:`\text{FP}` and :math:`\text{FN}` represent the number of true positives, false
    positives and false negatives respectively. If this case is encountered a score of `zero_division`
    (0 or 1, default is 0) is returned.

    As input to ``forward`` and ``update`` the metric accepts the following input:

    - ``preds`` (:class:`~torch.Tensor`): An int or float tensor of shape ``(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`` (:class:`~torch.Tensor`): An int tensor of shape ``(N, ...)``

    As output to ``forward`` and ``compute`` the metric returns the following output:

    - ``bf1s`` (:class:`~torch.Tensor`): A tensor whose returned shape depends on the ``multidim_average`` argument:

        - 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.

    If ``multidim_average`` is set to ``samplewise`` we expect at least one additional dimension ``...`` to be present,
    which the reduction will then be applied over instead of the sample dimension ``N``.

    Args:
        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`.

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

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

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

    Fr   Tr   r   r   r   r   r   r   r    Nr   r"   r#   r$   r&   r'   r(   r)   r*   c           
      óH   •—  t          ¦   «         j        dd|||||dœ|¤Ž d S )Nr   )r!   r"   r#   r&   r'   r(   r,   ©r-   r.   )r/   r"   r#   r&   r'   r(   r)   r0   s          €r1   r.   zBinaryF1Score.__init__¥  sP   ø€ ð 	�‰ŒÔð 	
ØØØ-Ø%Ø'Ø'ð	
ð 	
ð ð	
ð 	
ð 	
ð 	
ð 	
r2   r?   r@   c                 ó.   — |                       ||¦  «        S )a-  Plot a single or multiple values from the metric.

        Args:
            val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results.
                If no value is provided, will automatically call `metric.compute` and plot that result.
            ax: An matplotlib axis object. If provided will add plot to that axis

        Returns:
            Figure object and Axes object

        Raises:
            ModuleNotFoundError:
                If `matplotlib` is not installed

        .. plot::
            :scale: 75

            >>> from torch import rand, randint
            >>> # Example plotting a single value
            >>> from torchmetrics.classification import BinaryF1Score
            >>> metric = BinaryF1Score()
            >>> metric.update(rand(10), randint(2,(10,)))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> from torch import rand, randint
            >>> # Example plotting multiple values
            >>> from torchmetrics.classification import BinaryF1Score
            >>> metric = BinaryF1Score()
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(rand(10), randint(2,(10,))))
            >>> fig_, ax_ = metric.plot(values)

        rB   rD   s      r1   rE   zBinaryF1Score.plot¸  rF   r2   rG   rH   )rI   rJ   rK   rL   r   rM   rN   r   r   r   r   rO   r   r   rP   r   r.   r   r   r   r   r   rE   rQ   rR   s   @r1   rp   rp   V  s]  ø€ € € € € € ðFð FðP $Ð�tÐ#Ð#Ñ#Ø'+Ð�h˜t”nÐ+Ð+Ñ+Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�eÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!ð Ø<DØ&*Ø"Ø ð
ð 
àð
ð "Ð"8Ô9ð
ð ˜s”mð	
ð
 ð
ð ð
ð ð
ð 
ð
ð 
ð 
ð 
ð 
ð 
ð( _cð(#ð (#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð(#ØIQÐRZÔI[ð(#à	ð(#ð (#ð (#ð (#ð (#ð (#ð (#ð (#r2   rp   c                   ó4  ‡ — e Zd ZU dZdZeed<   dZee         ed<   dZ	eed<   dZ
eed<   d	Zeed
<   dZeed<   	 	 	 	 	 	 d!dededeed                  ded         dee         dedededdfˆ fd„Z	 d"deeeee         f                  dee         defd „Zˆ xZS )#ÚMulticlassF1Scorea«  Compute F-1 score for multiclass tasks.

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

    The metric is only proper defined when :math:`\text{TP} + \text{FP} \neq 0 \wedge \text{TP} + \text{FN} \neq 0`
    where :math:`\text{TP}`, :math:`\text{FP}` and :math:`\text{FN}` represent the number of true positives, false
    positives and false negatives respectively.  If this case is encountered for any class, the metric for that class
    will be set to `zero_division` (0 or 1, default is 0) and the overall metric may therefore be affected in turn.

    As input to ``forward`` and ``update`` the metric accepts the following input:

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

    As output to ``forward`` and ``compute`` the metric returns the following output:

    - ``mcf1s`` (:class:`~torch.Tensor`): A tensor whose 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)``

    If ``multidim_average`` is set to ``samplewise`` we expect at least one additional dimension ``...`` to be present,
    which the reduction will then be applied over instead of the sample dimension ``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`.

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.classification import MulticlassF1Score
        >>> target = tensor([2, 1, 0, 0])
        >>> preds = tensor([2, 1, 0, 1])
        >>> metric = MulticlassF1Score(num_classes=3)
        >>> metric(preds, target)
        tensor(0.7778)
        >>> mcf1s = MulticlassF1Score(num_classes=3, average=None)
        >>> mcf1s(preds, target)
        tensor([0.6667, 0.6667, 1.0000])

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

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

    Fr   Tr   r   r   r   r   r   rU   rV   rW   rX   r    Nr   rY   rZ   r7   r[   r#   r$   r&   r'   r(   r)   r*   c                 óL   •—  t          ¦   «         j        dd|||||||dœ|¤Ž d S )Nr   )r!   rY   rZ   r7   r#   r&   r'   r(   r,   rr   )
r/   rY   rZ   r7   r#   r&   r'   r(   r)   r0   s
            €r1   r.   zMulticlassF1Score.__init__R  sV   ø€ ð 	�‰ŒÔð 
	
ØØ#ØØØ-Ø%Ø'Ø'ð
	
ð 
	
ð ð
	
ð 
	
ð 
	
ð 
	
ð 
	
r2   r?   r@   c                 ó.   — |                       ||¦  «        S )a�  Plot a single or multiple values from the metric.

        Args:
            val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results.
                If no value is provided, will automatically call `metric.compute` and plot that result.
            ax: An matplotlib axis object. If provided will add plot to that axis

        Returns:
            Figure object and Axes object

        Raises:
            ModuleNotFoundError:
                If `matplotlib` is not installed

        .. plot::
            :scale: 75

            >>> from torch import randint
            >>> # Example plotting a single value per class
            >>> from torchmetrics.classification import MulticlassF1Score
            >>> metric = MulticlassF1Score(num_classes=3, average=None)
            >>> metric.update(randint(3, (20,)), randint(3, (20,)))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> from torch import randint
            >>> # Example plotting a multiple values per class
            >>> from torchmetrics.classification import MulticlassF1Score
            >>> metric = MulticlassF1Score(num_classes=3, average=None)
            >>> values = []
            >>> for _ in range(20):
            ...     values.append(metric(randint(3, (20,)), randint(3, (20,))))
            >>> fig_, ax_ = metric.plot(values)

        rB   rD   s      r1   rE   zMulticlassF1Score.ploti  rF   r2   rc   rH   ©rI   rJ   rK   rL   r   rM   rN   r   r   r   r   rO   r   rV   re   rP   r   r   r.   r   r   r   r   r   rE   rQ   rR   s   @r1   ru   ru   ã  s�  ø€ € € € € € ðeð eðN $Ð�tÐ#Ð#Ñ#Ø'+Ð�h˜t”nÐ+Ð+Ñ+Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�eÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!Ø#Ð�cÐ#Ð#Ñ#ð
 ØKRØ<DØ&*Ø"Ø ð
ð 
àð
ð ð
ð ˜'Ð"FÔGÔHð	
ð
 "Ð"8Ô9ð
ð ˜s”mð
ð ð
ð ð
ð ð
ð 
ð
ð 
ð 
ð 
ð 
ð 
ð0 _cð(#ð (#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð(#ØIQÐRZÔI[ð(#à	ð(#ð (#ð (#ð (#ð (#ð (#ð (#ð (#r2   ru   c                   ó4  ‡ — e Zd ZU dZdZeed<   dZee         ed<   dZ	eed<   dZ
eed<   d	Zeed
<   dZeed<   	 	 	 	 	 	 d!dededeed                  ded         dee         dedededdfˆ fd„Z	 d"deeeee         f                  dee         defd „Zˆ xZS )#ÚMultilabelF1Scorea  Compute F-1 score for multilabel tasks.

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

    The metric is only proper defined when :math:`\text{TP} + \text{FP} \neq 0 \wedge \text{TP} + \text{FN} \neq 0`
    where :math:`\text{TP}`, :math:`\text{FP}` and :math:`\text{FN}` represent the number of true positives, false
    positives and false negatives respectively. If this case is encountered for any label, the metric for that label
    will be set to `zero_division` (0 or 1, default is 0) and the overall metric may therefore be affected in turn.

    As input to ``forward`` and ``update`` the metric accepts the following input:

    - ``preds`` (:class:`~torch.Tensor`): An int or float tensor of shape ``(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`` (:class:`~torch.Tensor`): An int tensor of shape ``(N, C, ...)``.

    As output to ``forward`` and ``compute`` the metric returns the following output:

    - ``mlf1s`` (:class:`~torch.Tensor`): A tensor whose 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)```

    If ``multidim_average`` is set to ``samplewise`` we expect at least one additional dimension ``...`` to be present,
    which the reduction will then be applied over instead of the sample dimension ``N``.

    Args:
        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`.

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.classification import MultilabelF1Score
        >>> target = tensor([[0, 1, 0], [1, 0, 1]])
        >>> preds = tensor([[0, 0, 1], [1, 0, 1]])
        >>> metric = MultilabelF1Score(num_labels=3)
        >>> metric(preds, target)
        tensor(0.5556)
        >>> mlf1s = MultilabelF1Score(num_labels=3, average=None)
        >>> mlf1s(preds, target)
        tensor([1.0000, 0.0000, 0.6667])

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

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

    Fr   Tr   r   r   r   r   r   rh   rV   r   rX   r    Nr   ri   r"   r7   r[   r#   r$   r&   r'   r(   r)   r*   c                 óL   •—  t          ¦   «         j        dd|||||||dœ|¤Ž d S )Nr   )r!   ri   r"   r7   r#   r&   r'   r(   r,   rr   )
r/   ri   r"   r7   r#   r&   r'   r(   r)   r0   s
            €r1   r.   zMultilabelF1Score.__init__ÿ  sV   ø€ ð 	�‰ŒÔð 
	
ØØ!ØØØ-Ø%Ø'Ø'ð
	
ð 
	
ð ð
	
ð 
	
ð 
	
ð 
	
ð 
	
r2   r?   r@   c                 ó.   — |                       ||¦  «        S )aj  Plot a single or multiple values from the metric.

        Args:
            val: Either a single result from calling `metric.forward` or `metric.compute` or a list of these results.
                If no value is provided, will automatically call `metric.compute` and plot that result.
            ax: An matplotlib axis object. If provided will add plot to that axis

        Returns:
            Figure and Axes object

        Raises:
            ModuleNotFoundError:
                If `matplotlib` is not installed

        .. plot::
            :scale: 75

            >>> from torch import rand, randint
            >>> # Example plotting a single value
            >>> from torchmetrics.classification import MultilabelF1Score
            >>> metric = MultilabelF1Score(num_labels=3)
            >>> metric.update(randint(2, (20, 3)), randint(2, (20, 3)))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> from torch import rand, randint
            >>> # Example plotting multiple values
            >>> from torchmetrics.classification import MultilabelF1Score
            >>> metric = MultilabelF1Score(num_labels=3)
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(randint(2, (20, 3)), randint(2, (20, 3))))
            >>> fig_, ax_ = metric.plot(values)

        rB   rD   s      r1   rE   zMultilabelF1Score.plot  rF   r2   rn   rH   rx   rR   s   @r1   rz   rz   ”  s�  ø€ € € € € € ðað aðF $Ð�tÐ#Ð#Ñ#Ø'+Ð�h˜t”nÐ+Ð+Ñ+Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�eÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!Ø#Ð�cÐ#Ð#Ñ#ð
 ØKRØ<DØ&*Ø"Ø ð
ð 
àð
ð ð
ð ˜'Ð"FÔGÔHð	
ð
 "Ð"8Ô9ð
ð ˜s”mð
ð ð
ð ð
ð ð
ð 
ð
ð 
ð 
ð 
ð 
ð 
ð0 _cð(#ð (#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð(#ØIQÐRZÔI[ð(#à	ð(#ð (#ð (#ð (#ð (#ð (#ð (#ð (#r2   rz   c                   óà   — e Zd ZdZ	 	 	 	 	 	 	 	 	 	 dd
ed          ded         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
defd„ZdS )Ú
FBetaScorea—  Compute `F-score`_ metric.

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

    The metric is only proper defined when :math:`\text{TP} + \text{FP} \neq 0 \wedge \text{TP} + \text{FN} \neq 0`
    where :math:`\text{TP}`, :math:`\text{FP}` and :math:`\text{FN}` represent the number of true positives, false
    positives and false negatives respectively. If this case is encountered for any class/label, the metric for that
    class/label will be set to `zero_division` (0 or 1, default is 0) and the overall metric may therefore be
    affected in turn.

    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
    :class:`~torchmetrics.classification.BinaryFBetaScore`,
    :class:`~torchmetrics.classification.MulticlassFBetaScore` and
    :class:`~torchmetrics.classification.MultilabelFBetaScore` for the specific details of each argument influence
    and examples.

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

    r   r   Nr\   r    rW   Tr   ÚclsÚtask©r5   Ú
multiclassrl   r!   r"   rY   ri   r7   r[   r#   r$   rZ   r&   r'   r(   r)   r*   c                 ó†  — t          j        |¦  «        }|€J ‚|                     ||	|
|dœ¦  «         |t           j        k    rt	          ||fi |¤ŽS |t           j        k    rzt          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          ||||fi |¤ŽS |t           j        k    rEt          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          ||||fi |¤ŽS t          d|› d�¦  «        ‚©	zInitialize task metric.N)r#   r&   r'   r(   z+`num_classes` is expected to be `int` but `z was passed.`z%`top_k` is expected to be `int` but `z*`num_labels` is expected to be `int` but `zTask z not supported!)r   Úfrom_strÚupdateÚBINARYr   Ú
MULTICLASSÚ
isinstancerP   Ú
ValueErrorÚtyperT   Ú
MULTILABELrg   )r   r€   r!   r"   rY   ri   r7   r#   rZ   r&   r'   r(   r)   s                r1   Ú__new__zFBetaScore.__new___  s…  € õ  "Ô*¨4Ñ0Ô0ˆØÐ+Ð+Ð+Ø�ŠØ 0Ø(Ø*Ø*ð	
ð 
ñ 	ô 	ð 	ð Õ%Ô,Ò,Ð,Ý# D¨)Ð>Ð>°vÐ>Ð>Ð>ØÕ%Ô0Ò0Ð0Ý˜k­3Ñ/Ô/ð qÝ Ð!oÍtÐT_ÑO`ÔO`Ð!oÐ!oÐ!oÑpÔpÐpÝ˜e¥SÑ)Ô)ð eÝ Ð!cÍÈeÉÌÐ!cÐ!cÐ!cÑdÔdÐdÝ'¨¨k¸5À'ÐTÐTÈVÐTÐTÐTØÕ%Ô0Ò0Ð0Ý˜j­#Ñ.Ô.ð oÝ Ð!mÍdÐS]ÑN^ÔN^Ð!mÐ!mÐ!mÑnÔnÐnÝ'¨¨j¸)ÀWÐWÐWÐPVÐWÐWÐWÝÐ6 Ð6Ð6Ð6Ñ7Ô7Ð7r2   )
r   r   NNr\   r    rW   NTr   ©rI   rJ   rK   rL   r‹   r   rO   r   rP   rM   r   r   r�   r,   r2   r1   r~   r~   A  s  € € € € € ðð ð@ ØØ%)Ø$(ØKRØFNØ Ø&*Ø"Ø ð$8ð $8Ø�,Ôð$8àÐ:Ô;ð$8ð ð$8ð ð	$8ð
 ˜c”]ð$8ð ˜S”Mð$8ð ˜'Ð"FÔGÔHð$8ð # 7Ð+AÔ#BÔCð$8ð ˜Œ}ð$8ð ˜s”mð$8ð ð$8ð ð$8ð ð$8ð 
ð$8ð $8ð $8ð $8ð $8ð $8r2   r~   c                   óÚ   — e Zd ZdZ	 	 	 	 	 	 	 	 	 dd	ed          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
defd„ZdS )ÚF1ScoreaH  Compute F-1 score.

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

    The metric is only proper defined when :math:`\text{TP} + \text{FP} \neq 0 \wedge \text{TP} + \text{FN} \neq 0`
    where :math:`\text{TP}`, :math:`\text{FP}` and :math:`\text{FN}` represent the number of true positives, false
    positives and false negatives respectively. If this case is encountered for any class/label, the metric for that
    class/label will be set to `zero_division` (0 or 1, default is 0) and the overall metric may therefore be
    affected in turn.

    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
    :class:`~torchmetrics.classification.BinaryF1Score`, :class:`~torchmetrics.classification.MulticlassF1Score` and
    :class:`~torchmetrics.classification.MultilabelF1Score` 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 = F1Score(task="multiclass", num_classes=3)
        >>> f1(preds, target)
        tensor(0.3333)

    r   Nr\   r    rW   Tr   r   r€   r�   r"   rY   ri   r7   r[   r#   r$   rZ   r&   r'   r(   r)   r*   c                 ó€  — t          j        |¦  «        }|€J ‚|                     |||	|
dœ¦  «         |t           j        k    rt	          |fi |¤ŽS |t           j        k    ryt          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          |||fi |¤ŽS |t           j        k    rDt          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          |||fi |¤ŽS t          d|› d�¦  «        ‚r„   )r   r…   r†   r‡   rp   rˆ   r‰   rP   rŠ   r‹   ru   rŒ   rz   )r   r€   r"   rY   ri   r7   r#   rZ   r&   r'   r(   r)   s               r1   r�   zF1Score.__new__¢  s~  € õ "Ô*¨4Ñ0Ô0ˆØÐ+Ð+Ð+Ø�ŠØ 0Ø(Ø*Ø*ð	
ð 
ñ 	ô 	ð 	ð Õ%Ô,Ò,Ð,Ý  Ð5Ð5¨fÐ5Ð5Ð5ØÕ%Ô0Ò0Ð0Ý˜k­3Ñ/Ô/ð qÝ Ð!oÍtÐT_ÑO`ÔO`Ð!oÐ!oÐ!oÑpÔpÐpÝ˜e¥SÑ)Ô)ð eÝ Ð!cÍÈeÉÌÐ!cÐ!cÐ!cÑdÔdÐdÝ$ [°%¸ÐKÐKÀFÐKÐKÐKØÕ%Ô0Ò0Ð0Ý˜j­#Ñ.Ô.ð oÝ Ð!mÍdÐS]ÑN^ÔN^Ð!mÐ!mÐ!mÑnÔnÐnÝ$ Z°¸GÐNÐNÀvÐNÐNÐNÝÐ6 Ð6Ð6Ð6Ñ7Ô7Ð7r2   )	r   NNr\   r    rW   NTr   rŽ   r,   r2   r1   r�   r�   †  s  € € € € € ðð ð< Ø%)Ø$(ØKRØFNØ Ø&*Ø"Ø ð#8ð #8Ø�)Œ_ð#8àÐ:Ô;ð#8ð ð#8ð ˜c”]ð	#8ð
 ˜S”Mð#8ð ˜'Ð"FÔGÔHð#8ð # 7Ð+AÔ#BÔCð#8ð ˜Œ}ð#8ð ˜s”mð#8ð ð#8ð ð#8ð ð#8ð 
ð#8ð #8ð #8ð #8ð #8ð #8r2   r�   N)'Úcollections.abcr   Útypingr   r   r   Útorchr   Útyping_extensionsr   Ú torchmetrics.classification.baser	   Ú'torchmetrics.classification.stat_scoresr
   r   r   Ú-torchmetrics.functional.classification.f_betar   r   r   r   Útorchmetrics.metricr   Útorchmetrics.utilities.enumsr   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   rT   rg   rp   ru   rz   r~   r�   r,   r2   r1   ú<module>rž      sÒ  ðð %Ð $Ð $Ð $Ð $Ð $Ø 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'à Ð Ð Ð Ð Ð Ø %Ð %Ð %Ð %Ð %Ð %à GÐ GÐ GÐ GÐ GÐ GØ pÐ pÐ pÐ pÐ pÐ pÐ pÐ pÐ pÐ pðð ð ð ð ð ð ð ð ð ð ð ð 'Ð &Ð &Ð &Ð &Ð &Ø ;Ð ;Ð ;Ð ;Ð ;Ð ;Ø @Ð @Ð @Ð @Ð @Ð @Ø @Ð @Ð @Ð @Ð @Ð @Ð @Ð @àð ðð ð Ðð^#ð ^#ð ^#ð ^#ð ^#Ð'ñ ^#ô ^#ð ^#ðBC#ð C#ð C#ð C#ð C#Ð/ñ C#ô C#ð C#ðL@#ð @#ð @#ð @#ð @#Ð/ñ @#ô @#ð @#ðFJ#ð J#ð J#ð J#ð J#Ð$ñ J#ô J#ð J#ðZn#ð n#ð n#ð n#ð n#Ð,ñ n#ô n#ð n#ðbj#ð j#ð j#ð j#ð j#Ð,ñ j#ô j#ð j#ðZB8ð B8ð B8ð B8ð B8Ð+ñ B8ô B8ð B8ðJ?8ð ?8ð ?8ð ?8ð ?8Ð(ñ ?8ô ?8ð ?8ð ?8ð ?8r2   