§
    ’©ºj  ã                   ó”   — d dl mZ d dlmZmZmZ d dlmZmZ d dl	m
Z
mZ d dlmZ d dlmZ d dlmZmZ esdgZ G d	„ d
e¦  «        ZdS )é    )ÚSequence)ÚAnyÚOptionalÚUnion)ÚTensorÚtensor)Ú_wip_computeÚ_wip_update)ÚMetric)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEzWordInfoPreserved.plotc                   ó6  ‡ — 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	<   eed
<   eed<   eed<   deddfˆ fd„Zdeeee         f         deeee         f         dd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 )ÚWordInfoPreserveda  Word Information Preserved (`WIP`_) is a metric of the performance of an automatic speech recognition system.

    This value indicates the percentage of words that were correctly predicted between a set of ground-
    truth sentences and a set of hypothesis sentences. The higher the value, the better the performance of the ASR
    system with a WordInfoPreserved of 1 being a perfect score. Word Information Preserved rate can then be
    computed as:

    .. math::
        wip = \frac{C}{N} * \frac{C}{P}

    where:

        - :math:`C` is the number of correct words,
        - :math:`N` is the number of words in the reference
        - :math:`P` is the number of words in the prediction

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

    - ``preds`` (:class:`~List`): Transcription(s) to score as a string or list of strings
    - ``target`` (:class:`~List`): Reference(s) for each speech input as a string or list of strings

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

    - ``wip`` (:class:`~torch.Tensor`): A tensor with the Word Information Preserved score

    Args:
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Examples:
        >>> from torchmetrics.text import WordInfoPreserved
        >>> preds = ["this is the prediction", "there is an other sample"]
        >>> target = ["this is the reference", "there is another one"]
        >>> wip = WordInfoPreserved()
        >>> wip(preds, target)
        tensor(0.3472)

    FÚis_differentiableÚhigher_is_betterÚfull_state_updateç        Úplot_lower_boundg      ð?Úplot_upper_boundÚerrorsÚpreds_totalÚtarget_totalÚkwargsÚreturnNc                 ó  •—  t          ¦   «         j        di |¤Ž |                      dt          d¦  «        d¬¦  «         |                      dt          d¦  «        d¬¦  «         |                      dt          d¦  «        d¬¦  «         d S )Nr   r   Úsum)Údist_reduce_fxr   r   © )ÚsuperÚ__init__Ú	add_stater   )Úselfr   Ú	__class__s     €úe/root/private/project/pallet_detection_v2/.venv/lib/python3.11/site-packages/torchmetrics/text/wip.pyr!   zWordInfoPreserved.__init__M   s‚   ø€ ð 	�‰ŒÔÐ"Ð"˜6Ð"Ð"Ð"Ø�Š�x¥¨¡¤¸UˆÑCÔCÐCØ�Š�~¥v¨c¡{¤{À5ˆÑIÔIÐIØ�Š�}¥f¨S¡k¤kÀ%ˆÑHÔHÐHÐHÐHó    ÚpredsÚtargetc                 óŽ   — t          ||¦  «        \  }}}| xj        |z  c_        | xj        |z  c_        | xj        |z  c_        dS )z*Update state with predictions and targets.N)r
   r   r   r   )r#   r'   r(   r   r   r   s         r%   ÚupdatezWordInfoPreserved.updateV   sV   € å,7¸¸vÑ,FÔ,FÑ)ˆ�˜kØˆŒ�vÑˆŒØÐÔ˜\Ñ)ÐÔØÐÔ˜KÑ'ÐÔÐÐr&   c                 óB   — t          | j        | j        | j        ¦  «        S )z)Calculate the Word Information Preserved.)r	   r   r   r   )r#   s    r%   ÚcomputezWordInfoPreserved.compute]   s   € å˜DœK¨Ô):¸DÔ<LÑMÔMÐMr&   ÚvalÚaxc                 ó.   — |                       ||¦  «        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

            >>> # Example plotting a single value
            >>> from torchmetrics.text import WordInfoPreserved
            >>> metric = WordInfoPreserved()
            >>> preds = ["this is the prediction", "there is an other sample"]
            >>> target = ["this is the reference", "there is another one"]
            >>> metric.update(preds, target)
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> # Example plotting multiple values
            >>> from torchmetrics.text import WordInfoPreserved
            >>> metric = WordInfoPreserved()
            >>> preds = ["this is the prediction", "there is an other sample"]
            >>> target = ["this is the reference", "there is another one"]
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(preds, target))
            >>> fig_, ax_ = metric.plot(values)

        )Ú_plot)r#   r-   r.   s      r%   ÚplotzWordInfoPreserved.plota   s   € ðT �zŠz˜#˜rÑ"Ô"Ð"r&   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   Úfloatr   r   r   r!   r   ÚstrÚlistr*   r,   r   r   r   r   r1   Ú__classcell__)r$   s   @r%   r   r      s’  ø€ € € € € € ð$ð $ðL $Ð�tÐ#Ð#Ñ#Ø"Ð�dÐ"Ð"Ñ"Ø#Ð�tÐ#Ð#Ñ#Ø!Ð�eÐ!Ð!Ñ!Ø!Ð�eÐ!Ð!Ñ!à€N€N�NØÐÐÑØÐÐÑðIàðIð 
ðIð Ið Ið Ið Ið Ið(˜E # t¨C¤y .Ô1ð (¸5ÀÀdÈ3ÄiÀÔ;Pð (ÐUYð (ð (ð (ð (ðN˜ð Nð Nð Nð Nð
 _cð*#ð *#Ø˜E &¨(°6Ô*:Ð":Ô;Ô<ð*#ØIQÐRZÔI[ð*#à	ð*#ð *#ð *#ð *#ð *#ð *#ð *#ð *#r&   r   N)Úcollections.abcr   Útypingr   r   r   Útorchr   r   Ú torchmetrics.functional.text.wipr	   r
   Útorchmetrics.metricr   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r   r&   r%   ú<module>rD      sò   ðð %Ð $Ð $Ð $Ð $Ð $Ø 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'Ð 'à  Ð  Ð  Ð  Ð  Ð  Ð  Ð  à FÐ FÐ FÐ FÐ FÐ FÐ FÐ FØ &Ð &Ð &Ð &Ð &Ð &Ø @Ð @Ð @Ð @Ð @Ð @Ø @Ð @Ð @Ð @Ð @Ð @Ð @Ð @àð 2Ø0Ð1Ððo#ð o#ð o#ð o#ð o#˜ñ o#ô o#ð o#ð o#ð o#r&   