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)Ú_perplexity_computeÚ_perplexity_update)ÚMetric)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEúPerplexity.plotc                       s®   e Zd ZU dZdZdZdZeed< eed< 	dde	e
 deeef d	df‡ fd
d„Zdede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 )Ú
PerplexityaS  Perplexity measures how well a language model predicts a text sample.

    It's calculated as the average number of bits per word a model needs to represent the sample.

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

    - ``preds`` (:class:`~torch.Tensor`): Logits or a unnormalized score assigned to each token in a sequence with shape
      [batch_size, seq_len, vocab_size], which is the output of a language model. Scores will be normalized internally
      using softmax.
    - ``target`` (:class:`~torch.Tensor`): Ground truth values with a shape [batch_size, seq_len]

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

    - ``perp`` (:class:`~torch.Tensor`): A tensor with the perplexity score

    Args:
        ignore_index: Integer specifying a target class to ignore.
            If given, this class index does not contribute to the returned score.
        kwargs:
            Additional keyword arguments, see :ref:`Metric kwargs` for more info.

    Examples:
        >>> from torch import rand, randint
        >>> from torchmetrics.text import Perplexity
        >>> preds = rand(2, 8, 5)
        >>> target = randint(5, (2, 8))
        >>> target[0, 6:] = -100
        >>> perp = Perplexity(ignore_index=-100)
        >>> perp(preds, target)
        tensor(5.8540)

    TFÚtotal_log_probsÚcountNÚignore_indexÚkwargsÚreturnc                    sd   t ƒ jdi |¤Ž |d urt|tƒstd|› �ƒ‚|| _| jdtdƒdd� | jdtdƒdd� d S )NzIArgument `ignore_index` expected to either be `None` or an `int` but got r   g        Úsum)ÚdefaultÚdist_reduce_fxr   © )ÚsuperÚ__init__Ú
isinstanceÚintÚ
ValueErrorr   Ú	add_stater   )Úselfr   r   ©Ú	__class__r   úo/var/www/html/academy/tools/voices/clone/cosy-venv/lib/python3.10/site-packages/torchmetrics/text/perplexity.pyr   E   s   zPerplexity.__init__ÚpredsÚtargetc                 C   s2   t ||| jƒ\}}|  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"   ÚupdateQ   s   zPerplexity.updatec                 C   s   t | j| jƒS )zCompute the Perplexity.)r   r   r   )r   r   r   r"   ÚcomputeW   s   zPerplexity.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
            >>> import torch
            >>> from torchmetrics.text import Perplexity
            >>> metric = Perplexity()
            >>> metric.update(torch.rand(2, 8, 5), torch.randint(5, (2, 8)))
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

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

        )Ú_plot)r   r'   r(   r   r   r"   Úplot[   s   (r   )N)NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__Úis_differentiableÚhigher_is_betterÚfull_state_updater   Ú__annotations__r   r   ÚdictÚstrr   r   r%   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.perplexityr   r	   Útorchmetrics.metricr
   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r   r   r   r"   Ú<module>   s   