§
    ’©ºj¯P  ã                   óÀ  — 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 	 	 	 	 d*d
ededededeed                  ded         dedededefd„Z	 	 	 	 	 d+dedededed         dee         dededefd„Z	 	 	 	 	 	 d,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	 	 	 	 	 	 d-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	 	 	 	 	 	 	 	 	 d.deded'ed(         ded!ee         d$ee         deed"                  deed                  dee         dee         dededefd)„ZdS )/é    )Ú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Úaverage)ÚbinaryÚmicroÚmacroÚweightedÚnoneÚmultidim_average)r   Ú
samplewiseÚ
multilabelÚtop_kÚzero_divisionÚreturnc	           	      ó6  — |dk    rt          |||z   |¦  «        S |dk    rP|                     |dk    rdnd¬¦  «        }|                     |dk    rdnd¬¦  «        }t          |||z   |¦  «        S t          |||z   |¦  «        }	t          |	||| |||¬¦  «        S )z.Reduction logic for negative predictive value.r   r   r   r   r   )Údim)r$   )r   Úsumr   )
r   r   r   r   r   r!   r#   r$   r%   Úscores
             ú�/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/functional/classification/negative_predictive_value.pyÚ!_negative_predictive_value_reducer,   %   s½   € ð �(ÒÐÝ˜B  R¡¨Ñ7Ô7Ð7Ø�'ÒÐØ�VŠVÐ-°Ò9Ð9˜˜¸qˆVÑAÔAˆØ�VŠVÐ-°Ò9Ð9˜˜¸qˆVÑAÔAˆÝ˜B  R¡¨Ñ7Ô7Ð7Ý˜˜R "™W mÑ4Ô4€EÝ& u¨g°zÀ2ÀrÈ2ÐUZÐ[Ñ[Ô[Ð[ó    ç      à?NTÚpredsÚtargetÚ	thresholdÚignore_indexÚvalidate_argsc           	      óÎ   — |r#t          |||¦  «         t          | |||¦  «         t          | |||¦  «        \  } }t          | ||¦  «        \  }}}	}
t	          |||	|
d||¬¦  «        S )ak  Compute `Negative Predictive Value`_ for binary tasks.

    .. math:: \text{Negative Predictive Value} = \frac{\text{TN}}{\text{TN} + \text{FP}}

    Where :math:`\text{TN}` and :math:`\text{FP}` represent the number of true negatives and false positives
    respectively. The metric is only proper defined when :math:`\text{TN} + \text{FP} \neq 0`. If this case is
    encountered a score of 0 is returned.

    Accepts the following input tensors:

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

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

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

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

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

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

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

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

    r   )r   r!   r%   )r   r   r   r	   r,   )r/   r0   r1   r!   r2   r3   r%   r   r   r   r   s              r+   Ú binary_negative_predictive_valuer5   ;   s�   € ðJ ð ]Ý*¨9Ð6FÈÑUÔUÐUÝ-¨e°VÐ=MÈ|Ñ\Ô\Ð\Ý.¨u°f¸iÈÑVÔV�M€Eˆ6Ý/°°vÐ?OÑPÔP�N€BˆˆB�Ý,Ø
ˆB��B Ð;KÐ[hðñ ô ð r-   r   Únum_classes)r   r   r   r    c	           
      óÜ   — |r&t          |||||¦  «         t          | ||||¦  «         t          | ||¦  «        \  } }t          | ||||||¦  «        \  }	}
}}t	          |	|
||||||¬¦  «        S )a5  Compute `Negative Predictive Value`_ for multiclass tasks.

    .. math:: \text{Negative Predictive Value} = \frac{\text{TN}}{\text{TN} + \text{FP}}

    Where :math:`\text{TN}` and :math:`\text{FP}` represent the number of true negatives and false positives
    respectively. The metric is only proper defined when :math:`\text{TN} + \text{FP} \neq 0`. If this case is
    encountered a score of 0 is returned.

    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``: Calculate statistics for each label and compute a weighted average using their support
            - ``"none"`` or ``None``: Calculate statistics for each label and apply no reduction

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

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

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

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

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

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

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

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

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

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

    Example (multidim tensors):
        >>> from torchmetrics.functional.classification import multiclass_negative_predictive_value
        >>> 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_negative_predictive_value(preds, target, num_classes=3, multidim_average='samplewise')
        tensor([0.7833, 0.6556])
        >>> multiclass_negative_predictive_value(
        ...     preds, target, num_classes=3, multidim_average='samplewise', average=None
        ... )
        tensor([[1.0000, 0.6000, 0.7500],
                [0.8000, 0.5000, 0.6667]])

    )r   r!   r$   r%   )r
   r   r   r   r,   )r/   r0   r6   r   r$   r!   r2   r3   r%   r   r   r   r   s                r+   Ú$multiclass_negative_predictive_valuer8   Š   s§   € ðL ð nÝ.¨{¸EÀ7ÐL\Ð^jÑkÔkÐkÝ1°%¸ÀÐN^Ð`lÑmÔmÐmÝ2°5¸&À%ÑHÔH�M€Eˆ6Ý3Øˆv�{ E¨7Ð4DÀlñô �N€BˆˆB�õ -Ø
ˆB��B Ð:JÐRWÐgtðñ ô ð r-   Ú
num_labelsc	           
      óØ   — |r&t          |||||¦  «         t          | ||||¦  «         t          | ||||¦  «        \  } }t          | ||¦  «        \  }	}
}}t	          |	|
||||d|¬¦  «        S )aî  Compute `Negative Predictive Value`_ for multilabel tasks.

    .. math:: \text{Negative Predictive Value} = \frac{\text{TN}}{\text{TN} + \text{FP}}

    Where :math:`\text{TN}` and :math:`\text{FP}` represent the number of true negatives and false positives
    respectively. The metric is only proper defined when :math:`\text{TN} + \text{FP} \neq 0`. If this case is
    encountered a score of 0 is returned.

    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``: Calculate statistics for each label and compute a weighted average using their support
            - ``"none"`` or ``None``: Calculate statistics for each label and apply no reduction

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

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

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

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

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

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

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

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

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

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

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

    T)r   r!   r#   r%   )r   r   r   r   r,   )r/   r0   r9   r1   r   r!   r2   r3   r%   r   r   r   r   s                r+   Ú$multilabel_negative_predictive_valuer;   ü   s�   € ðD ð mÝ.¨z¸9ÀgÐO_ÐamÑnÔnÐnÝ1°%¸ÀÐM]Ð_kÑlÔlÐlÝ2°5¸&À*ÈiÐYeÑfÔf�M€Eˆ6Ý3°E¸6ÐCSÑTÔT�N€BˆˆB�Ý,Ø
ˆB��B Ð:JÐW[Ðkxðñ ô ð r-   r   Útask)r   Ú
multiclassr#   c                 óz  — t          j        |¦  «        }|€J ‚|t           j        k    rt          | ||||	|
|¦  «        S |t           j        k    r�t          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          | ||||||	|
|¦	  «	        S |t           j
        k    rLt          |t          ¦  «        s t          dt          |¦  «        › d�¦  «        ‚t          | ||||||	|
|¦	  «	        S t          d|› �¦  «        ‚)aL  Compute `Negative Predictive Value`_.

    .. math:: \text{Negative Predictive Value} = \frac{\text{TN}}{\text{TN} + \text{FP}}

    Where :math:`\text{TN}` and :math:`\text{FP}` represent the number of true negatives and false positives
    respectively. The metric is only proper defined when :math:`\text{TN} + \text{FP} \neq 0`. If this case is
    encountered a score of 0 is returned.

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

    LegacyExample:
        >>> from torch import tensor
        >>> preds  = tensor([2, 0, 2, 1])
        >>> target = tensor([1, 1, 2, 0])
        >>> negative_predictive_value(preds, target, task="multiclass", average='macro', num_classes=3)
        tensor(0.6667)
        >>> negative_predictive_value(preds, target, task="multiclass", average='micro', num_classes=3)
        tensor(0.6250)

    Nz+`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Not handled value: )r   Úfrom_strÚBINARYr5   Ú
MULTICLASSÚ
isinstanceÚintÚ
ValueErrorÚtyper8   Ú
MULTILABELr;   )r/   r0   r<   r1   r6   r9   r   r!   r$   r2   r3   r%   s               r+   Únegative_predictive_valuerG   h  s|  € õN Ô& tÑ,Ô,€DØÐ'Ð'Ð'ØÕ!Ô(Ò(Ð(Ý/Ø�6˜9Ð&6¸ÀmÐUbñ
ô 
ð 	
ð Õ!Ô,Ò,Ð,Ý˜+¥sÑ+Ô+ð 	mÝÐkÍ4ÐP[ÑK\ÔK\ÐkÐkÐkÑlÔlÐlÝ˜%¥Ñ%Ô%ð 	aÝÐ_ÅTÈ%Á[Ä[Ð_Ð_Ð_Ñ`Ô`Ð`Ý3Ø�6˜;¨°Ð8HÈ,ÐXeÐgtñ
ô 
ð 	
ð Õ!Ô,Ò,Ð,Ý˜*¥cÑ*Ô*ð 	kÝÐiÍ$ÈzÑJZÔJZÐiÐiÐiÑjÔjÐjÝ3Ø�6˜: y°'Ð;KÈ\Ð[hÐjwñ
ô 
ð 	
õ Ð1¨4Ð1Ð1Ñ
2Ô
2Ð2r-   )r   Fr   r   )r.   r   NTr   )r   r   r   NTr   )r.   r   r   NTr   )	r.   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   ÚboolrC   Úfloatr,   r5   r8   r;   rG   © r-   r+   ú<module>rQ      s|  ðð Ð Ð Ð Ð Ð à Ð Ð Ð Ð Ð Ø %Ð %Ð %Ð %Ð %Ð %ðð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð ð UÐ TÐ TÐ TÐ TÐ TÐ TÐ TØ ;Ð ;Ð ;Ð ;Ð ;Ð ;ð 9AØØØð\ð \Øð\àð\ð 	ð\ð 	ð	\ð
 �gÐLÔMÔNð\ð Ð4Ô5ð\ð ð\ð ð\ð ð\ð ð\ð \ð \ð \ð2 Ø8@Ø"&ØØðLð LØðLàðLð ðLð Ð4Ô5ð	Lð
 ˜3”-ðLð ðLð ðLð ðLð Lð Lð Lðf HOØØ8@Ø"&ØØðoð oØðoàðoð ðoð �gÐBÔCÔDð	oð
 ðoð Ð4Ô5ðoð ˜3”-ðoð ðoð ðoð ðoð oð oð oðl Ø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ØØ"&ØØð;3ð ;3Øð;3àð;3ð Ð6Ô
7ð;3ð ð	;3ð
 ˜#”ð;3ð ˜”ð;3ð �gÐBÔCÔDð;3ð ˜wÐ'=Ô>Ô?ð;3ð �CŒ=ð;3ð ˜3”-ð;3ð ð;3ð ð;3ð ð;3ð ;3ð ;3ð ;3ð ;3ð ;3r-   