o
    ©ôj²  ã                   @   s–   d dl mZ d dlmZmZmZ d dlZd dlmZ d dlm	Z	 d dl
mZmZmZmZmZ d dlmZ d dlmZmZ esAd	gZG d
d„ de	ƒZdS )é    )ÚSequence)ÚAnyÚOptionalÚUnionN)ÚTensor)ÚMetric)Ú
PREDS_TYPEÚTARGETS_TYPEÚ_squad_computeÚ_squad_input_checkÚ_squad_update)Ú_MATPLOTLIB_AVAILABLE)Ú_AX_TYPEÚ_PLOT_OUT_TYPEú
SQuAD.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deddfdd„Zdeeef fdd„Z	ddeeeee f  dee defdd„Z‡  ZS )ÚSQuADaÆ  Calculate `SQuAD Metric`_ which is a metric for evaluating question answering models.

    This metric corresponds to the scoring script for version 1 of the Stanford Question Answering Dataset (SQuAD).

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

    -  ``preds`` (:class:`~Dict`): A Dictionary or List of Dictionary-s that map ``id`` and ``prediction_text`` to
       the respective values

       Example ``prediction``:

                .. code-block:: python

                    {"prediction_text": "TorchMetrics is awesome", "id": "123"}


    - ``target`` (:class:`~Dict`): A Dictionary or List of Dictionary-s that contain the ``answers`` and ``id`` in
      the SQuAD Format.

        Example ``target``:

        .. code-block:: python

            {
                'answers': [{'answer_start': [1], 'text': ['This is a test answer']}],
                'id': '1',
            }

        Reference SQuAD Format:

        .. code-block:: python

            {
                'answers': {'answer_start': [1], 'text': ['This is a test text']},
                'context': 'This is a test context.',
                'id': '1',
                'question': 'Is this a test?',
                'title': 'train test'
            }

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

    -  ``squad`` (:class:`~Dict`): A dictionary containing the F1 score (key: "f1"),
        and Exact match score (key: "exact_match") for the batch.

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

    Example:
        >>> from torchmetrics.text import SQuAD
        >>> preds = [{"prediction_text": "1976", "id": "56e10a3be3433e1400422b22"}]
        >>> target = [{"answers": {"answer_start": [97], "text": ["1976"]}, "id": "56e10a3be3433e1400422b22"}]
        >>> squad = SQuAD()
        >>> squad(preds, target)
        {'exact_match': tensor(100.), 'f1': tensor(100.)}

    FÚis_differentiableTÚhigher_is_betterÚfull_state_updateg        Úplot_lower_boundg      Y@Úplot_upper_boundÚf1_scoreÚexact_matchÚtotalÚkwargsÚreturnNc                    sj   t ƒ jdi |¤Ž | jdtjdtjd�dd� | jdtjdtjd�dd� | jdtjdtjd�dd� d S )	Nr   r   )ÚdtypeÚsum)ÚnameÚdefaultÚdist_reduce_fxr   r   © )ÚsuperÚ__init__Ú	add_stateÚtorchÚtensorÚfloatÚint)Úselfr   ©Ú	__class__r!   új/var/www/html/academy/tools/voices/clone/cosy-venv/lib/python3.10/site-packages/torchmetrics/text/squad.pyr#   h   s    zSQuAD.__init__ÚpredsÚtargetc                 C   sL   t ||ƒ\}}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.   Ú
preds_dictÚtarget_dictr   r   r   r!   r!   r,   Úupdater   s
   zSQuAD.updatec                 C   s   t | j| j| jƒS )z5Aggregate the F1 Score and Exact match for the batch.)r
   r   r   r   )r)   r!   r!   r,   Úcomputez   s   zSQuAD.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 SQuAD
            >>> metric = SQuAD()
            >>> preds = [{"prediction_text": "1976", "id": "56e10a3be3433e1400422b22"}]
            >>> target = [{"answers": {"answer_start": [97], "text": ["1976"]}, "id": "56e10a3be3433e1400422b22"}]
            >>> metric.update(preds, target)
            >>> fig_, ax_ = metric.plot()

        .. plot::
            :scale: 75

            >>> # Example plotting multiple values
            >>> from torchmetrics.text import SQuAD
            >>> metric = SQuAD()
            >>> preds = [{"prediction_text": "1976", "id": "56e10a3be3433e1400422b22"}]
            >>> target = [{"answers": {"answer_start": [97], "text": ["1976"]}, "id": "56e10a3be3433e1400422b22"}]
            >>> values = [ ]
            >>> for _ in range(10):
            ...     values.append(metric(preds, target))
            >>> fig_, ax_ = metric.plot(values)

        )Ú_plot)r)   r3   r4   r!   r!   r,   Úplot~   s   *r   )NN)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   ÚboolÚ__annotations__r   r   r   r'   r   r   r   r#   r   r	   r1   ÚdictÚstrr2   r   r   r   r   r   r6   Ú__classcell__r!   r!   r*   r,   r   #   s2   
 :þý
ÿÿÿþr   )Úcollections.abcr   Útypingr   r   r   r%   r   Útorchmetricsr   Ú"torchmetrics.functional.text.squadr   r	   r
   r   r   Útorchmetrics.utilities.importsr   Útorchmetrics.utilities.plotr   r   Ú__doctest_skip__r   r!   r!   r!   r,   Ú<module>   s   