



"""simple docstring"""






import copy

from ...configuration_utils import PretrainedConfig
from ...utils import add_start_docstrings


_lowercase			:			Tuple										=						r"\n    [`RagConfig`] stores the configuration of a *RagModel*. Configuration objects inherit from [`PretrainedConfig`] and\n    can be used to control the model outputs. Read the documentation from [`PretrainedConfig`] for more information.\n\n    Args:\n        title_sep (`str`, *optional*, defaults to  `\" / \"`):\n            Separator inserted between the title and the text of the retrieved document when calling [`RagRetriever`].\n        doc_sep (`str`, *optional*, defaults to  `\" // \"`):\n            Separator inserted between the text of the retrieved document and the original input when calling\n            [`RagRetriever`].\n        n_docs (`int`, *optional*, defaults to 5):\n            Number of documents to retrieve.\n        max_combined_length (`int`, *optional*, defaults to 300):\n            Max length of contextualized input returned by [`~RagRetriever.__call__`].\n        retrieval_vector_size (`int`, *optional*, defaults to 768):\n            Dimensionality of the document embeddings indexed by [`RagRetriever`].\n        retrieval_batch_size (`int`, *optional*, defaults to 8):\n            Retrieval batch size, defined as the number of queries issues concurrently to the faiss index encapsulated\n            [`RagRetriever`].\n        dataset (`str`, *optional*, defaults to `\"wiki_dpr\"`):\n            A dataset identifier of the indexed dataset in HuggingFace Datasets (list all available datasets and ids\n            using `datasets.list_datasets()`).\n        dataset_split (`str`, *optional*, defaults to `\"train\"`)\n            Which split of the `dataset` to load.\n        index_name (`str`, *optional*, defaults to `\"compressed\"`)\n            The index name of the index associated with the `dataset`. One can choose between `\"legacy\"`, `\"exact\"` and\n            `\"compressed\"`.\n        index_path (`str`, *optional*)\n            The path to the serialized faiss index on disk.\n        passages_path (`str`, *optional*):\n            A path to text passages compatible with the faiss index. Required if using\n            [`~models.rag.retrieval_rag.LegacyIndex`]\n        use_dummy_dataset (`bool`, *optional*, defaults to `False`)\n            Whether to load a \"dummy\" variant of the dataset specified by `dataset`.\n        label_smoothing (`float`, *optional*, defaults to 0.0):\n            Only relevant if `return_loss` is set to `True`. Controls the `epsilon` parameter value for label smoothing\n            in the loss calculation. If set to 0, no label smoothing is performed.\n        do_marginalize (`bool`, *optional*, defaults to `False`):\n            If `True`, the logits are marginalized over all documents by making use of\n            `torch.nn.functional.log_softmax`.\n        reduce_loss (`bool`, *optional*, defaults to `False`):\n            Whether or not to reduce the NLL loss using the `torch.Tensor.sum` operation.\n        do_deduplication (`bool`, *optional*, defaults to `True`):\n            Whether or not to deduplicate the generations from different context documents for a given input. Has to be\n            set to `False` if used while training with distributed backend.\n        exclude_bos_score (`bool`, *optional*, defaults to `False`):\n            Whether or not to disregard the BOS token when computing the loss.\n        output_retrieved(`bool`, *optional*, defaults to `False`):\n            If set to `True`, `retrieved_doc_embeds`, `retrieved_doc_ids`, `context_input_ids` and\n            `context_attention_mask` are returned. See returned tensors for more detail.\n        use_cache (`bool`, *optional*, defaults to `True`):\n            Whether or not the model should return the last key/values attentions (not used by all models).\n        forced_eos_token_id (`int`, *optional*):\n            The id of the token to force as the last generated token when `max_length` is reached. Usually set to\n            `eos_token_id`.\n"

@add_start_docstrings(lowerCAmelCase_       )
class 	__SCREAMING_SNAKE_CASE     (				lowerCAmelCase_       ):


					'''simple docstring'''





					_a             =							'rag'
					_a             =							True



					def __init__(	self							:  Optional[int],  lowerCamelCase							:  Union[str, Any]=None,  lowerCamelCase							:  Union[str, Any]=True,  lowerCamelCase							:  Dict=None,  lowerCamelCase							:  Optional[Any]=None,  lowerCamelCase							:  Any=None,  lowerCamelCase							:  List[Any]=None,  lowerCamelCase							:  Optional[Any]=None,  lowerCamelCase							:  Any=" / ",  lowerCamelCase							:  Union[str, Any]=" // ",  lowerCamelCase							:  List[Any]=5,  lowerCamelCase							:  int=300,  lowerCamelCase							:  Optional[Any]=768,  lowerCamelCase							:  Optional[Any]=8,  lowerCamelCase							:  Tuple="wiki_dpr",  lowerCamelCase							:  Tuple="train",  lowerCamelCase							:  Union[str, Any]="compressed",  lowerCamelCase							:  List[str]=None,  lowerCamelCase							:  Any=None,  lowerCamelCase							:  Union[str, Any]=False,  lowerCamelCase							:  Dict=False,  lowerCamelCase							:  Optional[int]=0.0,  lowerCamelCase							:  Any=True,  lowerCamelCase							:  Dict=False,  lowerCamelCase							:  Tuple=False,  lowerCamelCase							:  List[str]=False,  lowerCamelCase							:  List[Any]=True,  lowerCamelCase							:  Optional[Any]=None,  **lowerCamelCase							:  str,  )-> List[Any]:
								super().__init__(
								    bos_token_id=lowerCamelCase,  pad_token_id=lowerCamelCase,  eos_token_id=lowerCamelCase,  decoder_start_token_id=lowerCamelCase,  forced_eos_token_id=lowerCamelCase,  is_encoder_decoder=lowerCamelCase,  prefix=lowerCamelCase,  vocab_size=lowerCamelCase,  **lowerCamelCase,  )
								assert (
								    "question_encoder" in kwargs and "generator" in kwargs
								), "Config has to be initialized with question_encoder and generator config"
								lowerCamelCase__		:		Tuple		     =kwargs.pop('''question_encoder'''					)
								lowerCamelCase__		:		int		     =question_encoder_config.pop('''model_type'''					)
								lowerCamelCase__		:		Dict		     =kwargs.pop('''generator'''					)
								lowerCamelCase__		:		Tuple		     =decoder_config.pop('''model_type'''					)

								from ..auto.configuration_auto import AutoConfig

								lowerCamelCase__		:		Tuple		     =AutoConfig.for_model(lowerCamelCase,  **lowerCamelCase					)
								lowerCamelCase__		:		Dict		     =AutoConfig.for_model(lowerCamelCase,  **lowerCamelCase					)

								lowerCamelCase__		:		Any		     =reduce_loss
								lowerCamelCase__		:		Tuple		     =label_smoothing
								lowerCamelCase__		:		List[str]		     =exclude_bos_score
								lowerCamelCase__		:		Dict		     =do_marginalize

								lowerCamelCase__		:		Union[str, Any]		     =title_sep
								lowerCamelCase__		:		Dict		     =doc_sep
								lowerCamelCase__		:		List[Any]		     =n_docs
								lowerCamelCase__		:		List[str]		     =max_combined_length

								lowerCamelCase__		:		List[Any]		     =dataset
								lowerCamelCase__		:		int		     =dataset_split
								lowerCamelCase__		:		List[Any]		     =index_name

								lowerCamelCase__		:		int		     =retrieval_vector_size
								lowerCamelCase__		:		Dict		     =retrieval_batch_size
								lowerCamelCase__		:		str		     =passages_path
								lowerCamelCase__		:		Any		     =index_path
								lowerCamelCase__		:		List[Any]		     =use_dummy_dataset

								lowerCamelCase__		:		Optional[int]		     =output_retrieved

								lowerCamelCase__		:		List[str]		     =do_deduplication

								lowerCamelCase__		:		Tuple		     =use_cache

								if self.forced_eos_token_id is None:
											lowerCamelCase__		:		int		     =getattr(self.generator,  '''forced_eos_token_id''',  lowerCamelCase					)



					@classmethod
					def 		snake_case	(	cls							:  List[str],  lowerCamelCase							:  PretrainedConfig,  lowerCamelCase							:  PretrainedConfig,  **lowerCamelCase							:  int					)-> PretrainedConfig:
								return cls(question_encoder=question_encoder_config.to_dict(),  generator=generator_config.to_dict(),  **lowerCamelCase					)




					def 		snake_case	(	self							:  Optional[int]					)-> int:
								lowerCamelCase__		:		Union[str, Any]		     =copy.deepcopy(self.__dict__					)
								lowerCamelCase__		:		Optional[int]		     =self.question_encoder.to_dict()
								lowerCamelCase__		:		Tuple		     =self.generator.to_dict()
								lowerCamelCase__		:		Optional[Any]		     =self.__class__.model_type
								return output









"""simple docstring"""






from typing import List

import jiwer
import jiwer.transforms as tr
from packaging import version

import datasets
from datasets.config import PY_VERSION


if PY_VERSION < version.parse("3.8"):
		import importlib_metadata
else:
		import importlib.metadata as importlib_metadata


_lowercase			:			List[str]										=						""


if version.parse(importlib_metadata.version("jiwer")) < version.parse("2.3.0"):

		class 	__SCREAMING_SNAKE_CASE     (				tr.AbstractTransform       ):


							'''simple docstring'''





							def __init__(	self							:  List[Any],  lowerCamelCase							:  str = " "					)-> List[str]:
										lowerCamelCase__		:		List[str]		     =sentence_delimiter



							def 		snake_case	(	self							:  Any,  lowerCamelCase							:  str					)-> Optional[Any]:
										return list(lowerCamelCase					)




							def 		snake_case	(	self							:  Optional[Any],  lowerCamelCase							:  List[str]					)-> Tuple:
										lowerCamelCase__		:		Optional[int]		     =[]
										for sent_idx, sentence in enumerate(lowerCamelCase					):
													chars.extend(self.process_string(lowerCamelCase					)					)
													if self.sentence_delimiter is not None and self.sentence_delimiter != "" and sent_idx < len(lowerCamelCase					) - 1:
																chars.append(self.sentence_delimiter					)
										return chars





		_lowercase			:			Optional[int]										=						tr.Compose(
		    [tr.RemoveMultipleSpaces(), tr.Strip(), SentencesToListOfCharacters(SENTENCE_DELIMITER)]
		)
else:
		_lowercase			:			List[str]										=						tr.Compose(
		    [
		        tr.RemoveMultipleSpaces(),
		        tr.Strip(),
		        tr.ReduceToSingleSentence(SENTENCE_DELIMITER),
		        tr.ReduceToListOfListOfChars(),
		    ]
		)


_lowercase			:			Dict										=						"\\n@inproceedings{inproceedings,\n    author = {Morris, Andrew and Maier, Viktoria and Green, Phil},\n    year = {2004},\n    month = {01},\n    pages = {},\n    title = {From WER and RIL to MER and WIL: improved evaluation measures for connected speech recognition.}\n}\n"

_lowercase			:			List[Any]										=						"\\nCharacter error rate (CER) is a common metric of the performance of an automatic speech recognition system.\n\nCER is similar to Word Error Rate (WER), but operates on character instead of word. Please refer to docs of WER for further information.\n\nCharacter error rate can be computed as:\n\nCER = (S + D + I) / N = (S + D + I) / (S + D + C)\n\nwhere\n\nS is the number of substitutions,\nD is the number of deletions,\nI is the number of insertions,\nC is the number of correct characters,\nN is the number of characters in the reference (N=S+D+C).\n\nCER's output is not always a number between 0 and 1, in particular when there is a high number of insertions. This value is often associated to the percentage of characters that were incorrectly predicted. The lower the value, the better the\nperformance of the ASR system with a CER of 0 being a perfect score.\n"

_lowercase			:			Dict										=						"\nComputes CER score of transcribed segments against references.\nArgs:\n    references: list of references for each speech input.\n    predictions: list of transcribtions to score.\n    concatenate_texts: Whether or not to concatenate sentences before evaluation, set to True for more accurate result.\nReturns:\n    (float): the character error rate\n\nExamples:\n\n    >>> predictions = [\"this is the prediction\", \"there is an other sample\"]\n    >>> references = [\"this is the reference\", \"there is another one\"]\n    >>> cer = datasets.load_metric(\"cer\")\n    >>> cer_score = cer.compute(predictions=predictions, references=references)\n    >>> print(cer_score)\n    0.34146341463414637\n"

@datasets.utils.file_utils.add_start_docstrings(_DESCRIPTION		,       _KWARGS_DESCRIPTION       )
class 	__SCREAMING_SNAKE_CASE     (				datasets.Metric       ):


					'''simple docstring'''





					def 		snake_case	(	self							:  Dict					)-> Optional[Any]:
								return datasets.MetricInfo(
								    description=_DESCRIPTION,  citation=_CITATION,  inputs_description=_KWARGS_DESCRIPTION,  features=datasets.Features(
								        {
								            '''predictions''': datasets.Value('''string''',  id='''sequence'''					),
								            '''references''': datasets.Value('''string''',  id='''sequence'''					),
								        }					),  codebase_urls=['''https://github.com/jitsi/jiwer/'''],  reference_urls=[
								        '''https://en.wikipedia.org/wiki/Word_error_rate''',
								        '''https://sites.google.com/site/textdigitisation/qualitymeasures/computingerrorrates''',
								    ],  )




					def 		snake_case	(	self							:  Optional[Any],  lowerCamelCase							:  Union[str, Any],  lowerCamelCase							:  List[str],  lowerCamelCase							:  Dict=False					)-> List[Any]:
								if concatenate_texts:
											return jiwer.compute_measures(
											    lowerCamelCase,  lowerCamelCase,  truth_transform=lowerCamelCase,  hypothesis_transform=lowerCamelCase,  )["wer"]

								lowerCamelCase__		:		Optional[Any]		     =0
								lowerCamelCase__		:		Union[str, Any]		     =0
								for prediction, reference in zip(lowerCamelCase,  lowerCamelCase					):
											lowerCamelCase__		:		int		     =jiwer.compute_measures(
											    lowerCamelCase,  lowerCamelCase,  truth_transform=lowerCamelCase,  hypothesis_transform=lowerCamelCase,  )
											incorrect += measures["substitutions"] + measures["deletions"] + measures["insertions"]
											total += measures["substitutions"] + measures["deletions"] + measures["hits"]

								return incorrect / total




