o
    .wi                     @   s   d dl mZ d dlmZmZmZ d dlZd dlmZmZ d dl	m
Z
 d dlmZmZmZ d dlmZ d dlmZmZ es?d	gZG d
d de
ZdS )    )Sequence)AnyOptionalUnionN)Tensortensor)Metric)_bleu_score_compute_bleu_score_update_tokenize_fn)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPEBLEUScore.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< eed< 			d"dededeee
  deddf
 fddZdee dee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 )$	BLEUScorea  Calculate `BLEU score`_ of machine translated text with one or more references.

    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 ``update`` the metric returns the following output:

    - ``bleu`` (:class:`~torch.Tensor`): A tensor with the BLEU Score

    Args:
        n_gram: Gram value ranged from 1 to 4
        smooth: Whether or not to apply smoothing, see `Machine Translation Evolution`_
        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 a length of a list of weights is not ``None`` and not equal to ``n_gram``.

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

    Fis_differentiableThigher_is_betterfull_state_update        plot_lower_bound      ?plot_upper_bound	preds_len
target_len	numeratordenominator   Nn_gramsmoothweightskwargsreturnc                    s   t  jdi | || _|| _|d ur%t||kr%tdt| d| |d ur+|nd| g| | _| jdtddd | jdtddd | jd	t	
| jdd | jd
t	
| jdd d S )Nz5List of weights has different weights than `n_gram`: z != r   r   r   sum)dist_reduce_fxr   r   r    )super__init__r   r   len
ValueErrorr   	add_stater   torchzeros)selfr   r   r   r    	__class__r$   S/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/torchmetrics/text/bleu.pyr&   N   s   zBLEUScore.__init__predstargetc              	   C   s,   t ||| j| j| j| j| jt\| _| _dS )z*Update state with predictions and targets.N)r
   r   r   r   r   r   r   )r,   r0   r1   r$   r$   r/   updatea   s   zBLEUScore.updatec                 C   s"   t | j| j| j| j| j| j| jS )zCalculate BLEU score.)r	   r   r   r   r   r   r   r   )r,   r$   r$   r/   computen   s   zBLEUScore.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 BLEUScore
            >>> metric = BLEUScore()
            >>> 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 BLEUScore
            >>> metric = BLEUScore()
            >>> 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)

        )_plot)r,   r4   r5   r$   r$   r/   plott   s   *r   )r   FN)NN)__name__
__module____qualname____doc__r   bool__annotations__r   r   r   floatr   r   intr   r   r   r&   strr2   r3   r   r   r   r7   __classcell__r$   r$   r-   r/   r   "   sF   
  
"r   )collections.abcr   typingr   r   r   r*   r   r   torchmetricsr   !torchmetrics.functional.text.bleur	   r
   r   torchmetrics.utilities.importsr   torchmetrics.utilities.plotr   r   __doctest_skip__r   r$   r$   r$   r/   <module>   s   