o .wi@sddlmZddlmZmZmZddlmZmZddl m Z m Z ddl m Z ddlmZddlmZmZes9dgZGd d d e Zd S) )Sequence)AnyOptionalUnion)Tensortensor) _wip_compute _wip_update)Metric)_MATPLOTLIB_AVAILABLE)_AX_TYPE_PLOT_OUT_TYPEWordInfoPreserved.plotcseZdZUdZdZeed<dZeed<dZeed<dZ e ed<dZ e ed <e ed <e ed <e ed <d e ddffdd ZdeeeefdeeeefddfddZde fddZ ddeee ee fdeedefddZZS)WordInfoPreservedaWord 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) Fis_differentiablehigher_is_betterfull_state_updateplot_lower_boundg?plot_upper_bounderrors preds_total target_totalkwargsreturnNc sRtjdi||jdtddd|jdtddd|jdtddddS)Nrrsum)dist_reduce_fxrr)super__init__ add_stater)selfr __class__rR/home/ubuntu/sommelier/.venv/lib/python3.10/site-packages/torchmetrics/text/wip.pyrMszWordInfoPreserved.__init__predstargetcCs>t||\}}}|j|7_|j|7_|j|7_dS)z*Update state with predictions and targets.N)r rrr)r!r%r&rrrrrr$updateVszWordInfoPreserved.updatecCst|j|j|jS)z)Calculate the Word Information Preserved.)rrrr)r!rrr$compute]szWordInfoPreserved.computevalaxcCs |||S)aPlot 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*rrr$plotas *r)NN)__name__ __module__ __qualname____doc__rbool__annotations__rrrfloatrrrrrstrlistr'r(rrr r r, __classcell__rrr"r$rs2  &    . rN)collections.abcrtypingrrrtorchrr torchmetrics.functional.text.wiprr torchmetrics.metricr torchmetrics.utilities.importsr torchmetrics.utilities.plotr r __doctest_skip__rrrrr$s