o
    ÁôjHP  ã                   @   sð   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 d dlmZ d d	lmZ d d
lmZ d dlmZmZ esVg d¢ZG dd„ deƒZG dd„ deƒZG dd„ deƒZ G dd„ deƒZ!dS )é    )ÚSequence)ÚAnyÚOptionalÚUnion)ÚTensor)ÚLiteral)Ú_ClassificationTaskWrapper)ÚBinaryConfusionMatrixÚMulticlassConfusionMatrixÚMultilabelConfusionMatrix)Ú_jaccard_index_reduceÚ(_multiclass_jaccard_index_arg_validationÚ(_multilabel_jaccard_index_arg_validation)ÚMetric)ÚClassificationTask)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPE)úBinaryJaccardIndex.plotúMulticlassJaccardIndex.plotúMultilabelJaccardIndex.plotc                       sÂ   e Zd ZU dZdZ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e dede
deddf‡ fdd„Zdefdd„Z	ddeeeee f  dee defdd„Z‡  ZS )ÚBinaryJaccardIndexa?	  Calculate the Jaccard index for binary tasks.

    The `Jaccard index`_ (also known as the intersection over union or jaccard similarity coefficient) is an statistic
    that can be used to determine the similarity and diversity of a sample set. It is defined as the size of the
    intersection divided by the union of the sample sets:

    .. math:: J(A,B) = \frac{|A\cap B|}{|A\cup B|}

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

    - ``preds`` (:class:`~torch.Tensor`): A 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, ...)``.

    .. tip::
       Additional dimension ``...`` will be flattened into the batch dimension.

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

    - ``bji`` (:class:`~torch.Tensor`): A tensor containing the Binary Jaccard Index.

    Args:
        threshold: Threshold for transforming probability to binary (0,1) predictions
        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:
            Value to replace when there is a division by zero. Should be `0` or `1`.
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

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

    Example (preds is float tensor):
        >>> from torchmetrics.classification import BinaryJaccardIndex
        >>> target = tensor([1, 1, 0, 0])
        >>> preds = tensor([0.35, 0.85, 0.48, 0.01])
        >>> metric = BinaryJaccardIndex()
        >>> metric(preds, target)
        tensor(0.5000)

    FÚis_differentiableTÚhigher_is_betterÚfull_state_updateç        Úplot_lower_boundç      ð?Úplot_upper_boundç      à?Nr   Ú	thresholdÚignore_indexÚvalidate_argsÚzero_divisionÚkwargsÚreturnc                    s&   t ƒ jd||d |dœ|¤Ž || _d S )N)r    r!   Ú	normalizer"   © )ÚsuperÚ__init__r#   )Úselfr    r!   r"   r#   r$   ©Ú	__class__r'   úv/var/www/html/academy/tools/voices/clone/cosy-venv/lib/python3.10/site-packages/torchmetrics/classification/jaccard.pyr)   b   s   ÿÿ
zBinaryJaccardIndex.__init__c                 C   s   t | jd| jd�S )úCompute metric.Úbinary©Úaverager#   )r   Úconfmatr#   ©r*   r'   r'   r-   Úcomputeo   s   zBinaryJaccardIndex.computeÚvalÚaxc                 C   ó   |   ||¡S )aA  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

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

        .. plot::
            :scale: 75

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

        ©Ú_plot©r*   r5   r6   r'   r'   r-   Úplots   ó   (r   )r   NTr   ©NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   Úfloatr   r   Úintr   r)   r   r4   r   r   r   r   r;   Ú__classcell__r'   r'   r+   r-   r   (   sB   
 3ûþýüûúùÿÿÿþr   c                       sÚ   e Zd ZU dZdZeed< dZ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ed  dee dede
deddf‡ fdd„Zdefdd„Z	d!deeeee f  dee defdd„Z‡  ZS )"ÚMulticlassJaccardIndexa~  Calculate the Jaccard index for multiclass tasks.

    The `Jaccard index`_ (also known as the intersection over union or jaccard similarity coefficient) is an statistic
    that can be used to determine the similarity and diversity of a sample set. It is defined as the size of the
    intersection divided by the union of the sample sets:

    .. math:: J(A,B) = \frac{|A\cap B|}{|A\cup B|}

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

    - ``preds`` (:class:`~torch.Tensor`): A 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, ...)``.

    .. tip::
       Additional dimension ``...`` will be flattened into the batch dimension.

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

    - ``mcji`` (:class:`~torch.Tensor`): A tensor containing the Multi-class Jaccard Index.

    Args:
        num_classes: Integer specifying the number of classes
        ignore_index:
            Specifies a target value that is ignored and does not contribute to the metric calculation
        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

        validate_args: bool indicating if input arguments and tensors should be validated for correctness.
            Set to ``False`` for faster computations.
        zero_division:
            Value to replace when there is a division by zero. Should be `0` or `1`.
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Example (pred is integer tensor):
        >>> from torch import tensor
        >>> from torchmetrics.classification import MulticlassJaccardIndex
        >>> target = tensor([2, 1, 0, 0])
        >>> preds = tensor([2, 1, 0, 1])
        >>> metric = MulticlassJaccardIndex(num_classes=3)
        >>> metric(preds, target)
        tensor(0.6667)

    Example (pred is float tensor):
        >>> from torchmetrics.classification import MulticlassJaccardIndex
        >>> 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 = MulticlassJaccardIndex(num_classes=3)
        >>> metric(preds, target)
        tensor(0.6667)

    Fr   Tr   r   r   r   r   r   ÚClassÚplot_legend_nameÚmacroNr   Únum_classesr1   ©ÚmicrorJ   ÚweightedÚnoner!   r"   r#   r$   r%   c                    sB   t ƒ jd||d ddœ|¤Ž |rt|||ƒ || _|| _|| _d S )NF)rK   r!   r&   r"   r'   )r(   r)   r   r"   r1   r#   )r*   rK   r1   r!   r"   r#   r$   r+   r'   r-   r)   ä   s   	ÿÿ
zMulticlassJaccardIndex.__init__c                 C   s   t | j| j| j| jd�S )r.   )r1   r!   r#   )r   r2   r1   r!   r#   r3   r'   r'   r-   r4   ö   s   ÿzMulticlassJaccardIndex.computer5   r6   c                 C   r7   )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

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

        .. plot::
            :scale: 75

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

        r8   r:   r'   r'   r-   r;   ü   r<   r   )rJ   NTr   r=   ©r>   r?   r@   rA   r   rB   rC   r   r   r   rD   r   rI   ÚstrrE   r   r   r   r)   r   r4   r   r   r   r   r;   rF   r'   r'   r+   r-   rG   ž   sH   
 >úþ
ýüûúùøÿÿÿþrG   c                       sà   e Zd ZU dZdZeed< dZ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e dede
deddf‡ fdd„Zdefdd„Z	d#deeeee f  dee defd d!„Z‡  ZS )$ÚMultilabelJaccardIndexa»  Calculate the Jaccard index for multilabel tasks.

    The `Jaccard index`_ (also known as the intersection over union or jaccard similarity coefficient) is an statistic
    that can be used to determine the similarity and diversity of a sample set. It is defined as the size of the
    intersection divided by the union of the sample sets:

    .. math:: J(A,B) = \frac{|A\cap B|}{|A\cup B|}

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

    - ``preds`` (:class:`~torch.Tensor`): A int tensor 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, ...)``

    .. tip::
       Additional dimension ``...`` will be flattened into the batch dimension.

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

    - ``mlji`` (:class:`~torch.Tensor`): A tensor containing the Multi-label Jaccard Index loss.

    Args:
        num_classes: Integer specifying the number of labels
        threshold: Threshold for transforming probability to binary (0,1) predictions
        ignore_index:
            Specifies a target value that is ignored and does not contribute to the metric calculation
        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

        validate_args: bool indicating if input arguments and tensors should be validated for correctness.
            Set to ``False`` for faster computations.
        zero_division:
            Value to replace when there is a division by zero. Should be `0` or `1`.
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Example (preds is int tensor):
        >>> from torch import tensor
        >>> from torchmetrics.classification import MultilabelJaccardIndex
        >>> target = tensor([[0, 1, 0], [1, 0, 1]])
        >>> preds = tensor([[0, 0, 1], [1, 0, 1]])
        >>> metric = MultilabelJaccardIndex(num_labels=3)
        >>> metric(preds, target)
        tensor(0.5000)

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

    Fr   Tr   r   r   r   r   r   ÚLabelrI   r   rJ   Nr   Ú
num_labelsr    r1   rL   r!   r"   r#   r$   r%   c                    sF   t ƒ jd|||d ddœ|¤Ž |rt||||ƒ || _|| _|| _d S )NF)rT   r    r!   r&   r"   r'   )r(   r)   r   r"   r1   r#   )r*   rT   r    r1   r!   r"   r#   r$   r+   r'   r-   r)   k  s   
ûú
zMultilabelJaccardIndex.__init__c                 C   s   t | j| j| jd�S )r.   r0   )r   r2   r1   r#   r3   r'   r'   r-   r4   ƒ  s   zMultilabelJaccardIndex.computer5   r6   c                 C   r7   )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

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

        .. plot::
            :scale: 75

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

        r8   r:   r'   r'   r-   r;   ‡  r<   r   )r   rJ   NTr   r=   rP   r'   r'   r+   r-   rR   '  sN   
 <ùþý
üûúùø	÷ÿÿÿþrR   c                   @   sl   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e	de
defdd„ZdS )ÚJaccardIndexaÍ  Calculate the Jaccard index for multilabel tasks.

    The `Jaccard index`_ (also known as the intersection over union or jaccard similarity coefficient) is an statistic
    that can be used to determine the similarity and diversity of a sample set. It is defined as the size of the
    intersection divided by the union of the sample sets:

    .. math:: J(A,B) = \frac{|A\cap B|}{|A\cup B|}

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

    Legacy Example:
        >>> from torch import randint, tensor
        >>> target = randint(0, 2, (10, 25, 25))
        >>> pred = tensor(target)
        >>> pred[2:5, 7:13, 9:15] = 1 - pred[2:5, 7:13, 9:15]
        >>> jaccard = JaccardIndex(task="multiclass", num_classes=2)
        >>> jaccard(pred, target)
        tensor(0.9660)

    r   NrJ   TÚclsÚtask)r/   Ú
multiclassÚ
multilabelr    rK   rT   r1   rL   r!   r"   r$   r%   c           	      K   sº   t  |¡}| ||dœ¡ |t jkrt|fi |¤ŽS |t jkr7t|tƒs.tdt	|ƒ› d�ƒ‚t
||fi |¤ŽS |t jkrUt|tƒsKtdt	|ƒ› d�ƒ‚t|||fi |¤ŽS td|› d�ƒ‚)zInitialize task metric.)r!   r"   z+`num_classes` is expected to be `int` but `z was passed.`z*`num_labels` is expected to be `int` but `zTask z not supported!)r   Úfrom_strÚupdateÚBINARYr   Ú
MULTICLASSÚ
isinstancerE   Ú
ValueErrorÚtyperG   Ú
MULTILABELrR   )	rV   rW   r    rK   rT   r1   r!   r"   r$   r'   r'   r-   Ú__new__Í  s   





zJaccardIndex.__new__)r   NNrJ   NT)r>   r?   r@   rA   r`   r   rD   r   rE   rB   r   r   rb   r'   r'   r'   r-   rU   ²  s:    øÿþýüû
úùø	÷
örU   N)"Úcollections.abcr   Útypingr   r   r   Útorchr   Útyping_extensionsr   Ú torchmetrics.classification.baser   Ú,torchmetrics.classification.confusion_matrixr	   r
   r   Ú.torchmetrics.functional.classification.jaccardr   r   r   Útorchmetrics.metricr   Útorchmetrics.utilities.enumsr   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   rG   rR   rU   r'   r'   r'   r-   Ú<module>   s&   v 
 