class_docstr: Compute extended edit distance score (`ExtendedEditDistance`_) for strings or list of strings.
  
  The metric utilises the Levenshtein distance and extends it by adding a jump operation.
  
  As input to ``forward`` and ``update`` the metric accepts the following input:
  
  - ``preds`` (:class:`~Sequence`): An iterable of hypothesis corpus
  - ``target`` (:class:`~Sequence`): An iterable of iterables of reference corpus
  
  As output of ``forward`` and ``compute`` the metric returns the following output:
  
  - ``eed`` (:class:`~torch.Tensor`): A tensor with the extended edit distance score
  
  Args:
      language: Language used in sentences. Only supports English (en) and Japanese (ja) for now.
      return_sentence_level_score: An indication of whether sentence-level EED score is to be returned
      alpha: optimal jump penalty, penalty for jumps between characters
      rho: coverage cost, penalty for repetition of characters
      deletion: penalty for deletion of character
      insertion: penalty for insertion or substitution of character
      kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.
  
  Example:
      >>> from torchmetrics.text import ExtendedEditDistance
      >>> preds = ["this is the prediction", "here is an other sample"]
      >>> target = ["this is the reference", "here is another one"]
      >>> eed = ExtendedEditDistance()
      >>> eed(preds=preds, target=target)
      tensor(0.3078)
class_docstr_tok: ["Compute","extended","edit","distance","score","(","`","ExtendedEditDistance","`","_",")","for","strings","or","list","of","strings",".","The","metric","utilises","the","Levenshtein","distance","and","extends","it","by","adding","a","jump","operation",".","As","input","to","``","forward","``","and","``","update","``","the","metric","accepts","the","following","input",":","-","``","preds","``","(",":","class",":","`","~Sequence","`",")",":","An","iterable","of","hypothesis","corpus","-","``","target","``","(",":","class",":","`","~Sequence","`",")",":","An","iterable","of","iterables","of","reference","corpus","As","output","of","``","forward","``","and","``","compute","``","the","metric","returns","the","following","output",":","-","``","eed","``","(",":","class",":","`","~torch.Tensor","`",")",":","A","tensor","with","the","extended","edit","distance","score","Args",":","language",":","Language","used","in","sentences",".","Only","supports","English","(","en",")","and","Japanese","(","ja",")","for","now",".","return_sentence_level_score",":","An","indication","of","whether","sentence-level","EED","score","is","to","be","returned","alpha",":","optimal","jump","penalty",",","penalty","for","jumps","between","characters","rho",":","coverage","cost",",","penalty","for","repetition","of","characters","deletion",":","penalty","for","deletion","of","character","insertion",":","penalty","for","insertion","or","substitution","of","character","kwargs",":","Additional","keyword","arguments",",","see",":","ref",":","`","Metric","kwargs","`","for","more","info",".","Example",":",">",">",">","from","torchmetrics.text","import","ExtendedEditDistance",">",">",">","preds","=","[","``","this","is","the","prediction","''",",","``","here","is","an","other","sample","''","]",">",">",">","target","=","[","``","this","is","the","reference","''",",","``","here","is","another","one","''","]",">",">",">","eed","=","ExtendedEditDistance","(",")",">",">",">","eed","(","preds=preds",",","target=target",")","tensor","(","0.3078",")"]
docstr: 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 ExtendedEditDistance
      >>> metric = ExtendedEditDistance()
      >>> 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 ExtendedEditDistance
      >>> metric = ExtendedEditDistance()
      >>> 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)
docstr_tok: ["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","ExtendedEditDistance",">",">",">","metric","=","ExtendedEditDistance","(",")",">",">",">","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","ExtendedEditDistance",">",">",">","metric","=","ExtendedEditDistance","(",")",">",">",">","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",")"]
code: def plot(
      self,
      val: Optional[Union[Tensor, Sequence[Tensor]]] = None,
      ax: Optional[_AX_TYPE] = None,
  ) -> _PLOT_OUT_TYPE:
      """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 ExtendedEditDistance
          >>> metric = ExtendedEditDistance()
          >>> 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 ExtendedEditDistance
          >>> metric = ExtendedEditDistance()
          >>> 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)
  
      """
      return self._plot(val, ax)
  
file_path: torchmetrics/src/torchmetrics/text/eed.py
imports: from typing import Any, List, Optional, Sequence, Tuple, Union
  from torch import Tensor, stack
  from typing_extensions import Literal
  from torchmetrics.functional.text.eed import _eed_compute, _eed_update
  from torchmetrics.metric import Metric
  from torchmetrics.utilities.imports import _MATPLOTLIB_AVAILABLE
  from torchmetrics.utilities.plot import _AX_TYPE, _PLOT_OUT_TYPE
label_desc: Use image node_id 4 for calling the ExtendedEditDistance obj's underlying member method code with example usage: obj.plot(val, ax) and returns: self