o
    ªôj  ã                   @   s†   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s9dgZG d	d
„ d
eƒZdS )é    )ÚSequence)ÚAnyÚOptionalÚUnion)ÚTensorÚtensor)Ú_wip_computeÚ_wip_update)ÚMetric)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEúWordInfoPreserved.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	< eed
< eed< eed< deddf‡ fdd„Zdeeee f deeee f dd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 )Ú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                    sR   t ƒ jdi |¤Ž | jdtdƒdd� | jdtdƒdd� | jdtdƒdd� d S )Nr   r   Úsum)Údist_reduce_fxr   r   © )ÚsuperÚ__init__Ú	add_stater   )Úselfr   ©Ú	__class__r   úh/var/www/html/academy/tools/voices/clone/cosy-venv/lib/python3.10/site-packages/torchmetrics/text/wip.pyr   M   s   zWordInfoPreserved.__init__ÚpredsÚtargetc                 C   s>   t ||ƒ\}}}|  j|7  _|  j|7  _|  j|7  _dS )z*Update state with predictions and targets.N)r	   r   r   r   )r!   r%   r&   r   r   r   r   r   r$   ÚupdateV   s   zWordInfoPreserved.updatec                 C   s   t | j| j| jƒS )z)Calculate the Word Information Preserved.)r   r   r   r   )r!   r   r   r$   Úcompute]   s   zWordInfoPreserved.computeÚvalÚaxc                 C   s   |   ||¡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*   r   r   r$   Úplota   s   *r   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   Úfloatr   r   r   r   r   ÚstrÚlistr'   r(   r   r   r   r   r,   Ú__classcell__r   r   r"   r$   r      s2   
 &þý.	ÿÿÿþ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   r$   Ú<module>   s   