a
    d                     @   s   d dl mZ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 d dlmZ d dlmZmZ d dlmZmZ es~d	gZd
ZG dd deZdS )    )AnyOptionalSequenceUnion)Tensor)Literal)_bleu_score_update)_SacreBLEUTokenizer)	BLEUScore)_MATPLOTLIB_AVAILABLE_REGEX_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPESacreBLEUScore.plotnone13azhintlcharc                	       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eeed eeee
  edd fddZee eee  ddddZdeeeee f  ee edddZ  ZS )SacreBLEUScorea  Calculate `BLEU score`_ of machine translated text with one or more references.

    This implementation follows the behaviour of `SacreBLEU`_. The SacreBLEU implementation differs from the NLTK BLEU
    implementation in tokenization techniques.

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

    - ``preds`` (:class:`~Sequence`): An iterable of machine translated corpus
    - ``target`` (:class:`~Sequence`): An iterable of iterables of reference corpus

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

    - ``sacre_bleu`` (:class:`~torch.Tensor`): A tensor with the SacreBLEU Score

    Args:
        n_gram: Gram value ranged from 1 to 4
        smooth: Whether to apply smoothing, see `SacreBLEU`_
        tokenize: Tokenization technique to be used.
            Supported tokenization: ``['none', '13a', 'zh', 'intl', 'char']``
        lowercase:  If ``True``, BLEU score over lowercased text is calculated.
        kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.
        weights:
            Weights used for unigrams, bigrams, etc. to calculate BLEU score.
            If not provided, uniform weights are used.

    Raises:
        ValueError:
            If ``tokenize`` not one of 'none', '13a', 'zh', 'intl' or 'char'
        ValueError:
            If ``tokenize`` is set to 'intl' and `regex` is not installed
        ValueError:
            If a length of a list of weights is not ``None`` and not equal to ``n_gram``.


    Example:
        >>> from torchmetrics.text import SacreBLEUScore
        >>> preds = ['the cat is on the mat']
        >>> target = [['there is a cat on the mat', 'a cat is on the mat']]
        >>> sacre_bleu = SacreBLEUScore()
        >>> sacre_bleu(preds, target)
        tensor(0.7598)

    Additional References:

        - Automatic Evaluation of Machine Translation Quality Using Longest Common Subsequence
          and Skip-Bigram Statistics by Chin-Yew Lin and Franz Josef Och `Machine Translation Evolution`_

    Fis_differentiableThigher_is_betterfull_state_updateg        plot_lower_boundg      ?plot_upper_bound   r   Nr   )n_gramsmoothtokenize	lowercaseweightskwargsreturnc                    s\   t  jf |||d| |tvr8tdt d| d|dkrLtsLtdt||| _d S )N)r   r   r!   z*Argument `tokenize` expected to be one of z	 but got .r   zv`'intl'` tokenization requires that `regex` is installed. Use `pip install regex` or `pip install torchmetrics[text]`.)super__init__AVAILABLE_TOKENIZERS
ValueErrorr   ModuleNotFoundErrorr	   	tokenizer)selfr   r   r   r    r!   r"   	__class__ e/var/www/html/stable-diffusion-webui/venv/lib/python3.9/site-packages/torchmetrics/text/sacre_bleu.pyr&   ^   s    	zSacreBLEUScore.__init__)predstargetr#   c              	   C   s.   t ||| j| j| j| j| j| j\| _| _dS )z*Update state with predictions and targets.N)r   	numeratordenominatorZ	preds_lenZ
target_lenr   r*   )r+   r0   r1   r.   r.   r/   updater   s    zSacreBLEUScore.update)valaxr#   c                 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 SacreBLEUScore
            >>> metric = SacreBLEUScore()
            >>> preds = ['the cat is on the mat']
            >>> target = [['there is a cat on the mat', 'a cat is on the mat']]
            >>> metric.update(preds, target)
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> # Example plotting multiple values
            >>> from torchmetrics.text import SacreBLEUScore
            >>> metric = SacreBLEUScore()
            >>> preds = ['the cat is on the mat']
            >>> target = [['there is a cat on the mat', 'a cat is on the mat']]
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(preds, target))
            >>> fig_, ax_ = metric.plot(values)

        )Z_plot)r+   r5   r6   r.   r.   r/   plot   s    *r   )r   Fr   FN)NN)__name__
__module____qualname____doc__r   bool__annotations__r   r   r   floatr   intr   r   r   r   r&   strr4   r   r   r   r   r7   __classcell__r.   r.   r,   r/   r   &   s4   
1     
 r   N)typingr   r   r   r   Ztorchr   Ztyping_extensionsr   Z!torchmetrics.functional.text.bleur   Z'torchmetrics.functional.text.sacre_bleur	   Ztorchmetrics.text.bleur
   Ztorchmetrics.utilities.importsr   r   Ztorchmetrics.utilities.plotr   r   Z__doctest_skip__r'   r   r.   r.   r.   r/   <module>   s   