



import unittest

from parameterized import parameterized

from transformers import AutoTokenizer, GPTNeoXConfig, is_torch_available, set_seed
from transformers.testing_utils import require_torch, slow, torch_device

from ...generation.test_utils import GenerationTesterMixin
from ...test_configuration_common import ConfigTester
from ...test_modeling_common import ModelTesterMixin, ids_tensor, random_attention_mask
from ...test_pipeline_mixin import PipelineTesterMixin


if is_torch_available():
  import torch

  from transformers import (
      GPTNeoXForCausalLM,
      GPTNeoXForQuestionAnswering,
      GPTNeoXForSequenceClassification,
      GPTNeoXForTokenClassification,
      GPTNeoXModel,
  )



class  __lowerCAmelCase     :




 def __init__(						self	,				__UpperCAmelCase	,				__UpperCAmelCase=13	,				__UpperCAmelCase=7	,				__UpperCAmelCase=True	,				__UpperCAmelCase=True	,				__UpperCAmelCase=True	,				__UpperCAmelCase=True	,				__UpperCAmelCase=99	,				__UpperCAmelCase=64	,				__UpperCAmelCase=5	,				__UpperCAmelCase=4	,				__UpperCAmelCase=37	,				__UpperCAmelCase="gelu"	,				__UpperCAmelCase=0.1	,				__UpperCAmelCase=0.1	,				__UpperCAmelCase=512	,				__UpperCAmelCase=16	,				__UpperCAmelCase=2	,				__UpperCAmelCase=0.02	,				__UpperCAmelCase=3	,				__UpperCAmelCase=4	,				__UpperCAmelCase=None	,				):



    '''simple docstring'''
    __lowerCamelCase													=    parent
    __lowerCamelCase													=    batch_size
    __lowerCamelCase													=    seq_length
    __lowerCamelCase													=    is_training
    __lowerCamelCase													=    use_input_mask
    __lowerCamelCase													=    use_token_type_ids
    __lowerCamelCase													=    use_labels
    __lowerCamelCase													=    vocab_size
    __lowerCamelCase													=    hidden_size
    __lowerCamelCase													=    num_hidden_layers
    __lowerCamelCase													=    num_attention_heads
    __lowerCamelCase													=    intermediate_size
    __lowerCamelCase													=    hidden_act
    __lowerCamelCase													=    hidden_dropout_prob
    __lowerCamelCase													=    attention_probs_dropout_prob
    __lowerCamelCase													=    max_position_embeddings
    __lowerCamelCase													=    type_vocab_size
    __lowerCamelCase													=    type_sequence_label_size
    __lowerCamelCase													=    initializer_range
    __lowerCamelCase													=    num_labels
    __lowerCamelCase													=    num_choices
    __lowerCamelCase													=    scope
    __lowerCamelCase													=    vocab_size - 1




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    ids_tensor([self.batch_size, self.seq_length]	,				self.vocab_size				)

    __lowerCamelCase													=    None
    if self.use_input_mask:
       __lowerCamelCase													=    random_attention_mask([self.batch_size, self.seq_length]				)

    __lowerCamelCase													=    None
    if self.use_labels:
       __lowerCamelCase													=    ids_tensor([self.batch_size, self.seq_length]	,				self.num_labels				)

    __lowerCamelCase													=    self.get_config()

    return config, input_ids, input_mask, token_labels




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    return GPTNeoXConfig(
        vocab_size=self.vocab_size	,				hidden_size=self.hidden_size	,				num_hidden_layers=self.num_hidden_layers	,				num_attention_heads=self.num_attention_heads	,				intermediate_size=self.intermediate_size	,				hidden_act=self.hidden_act	,				hidden_dropout_prob=self.hidden_dropout_prob	,				attention_probs_dropout_prob=self.attention_probs_dropout_prob	,				max_position_embeddings=self.max_position_embeddings	,				type_vocab_size=self.type_vocab_size	,				is_decoder=__UpperCAmelCase	,				initializer_range=self.initializer_range	,				pad_token_id=self.pad_token_id	,				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    self.prepare_config_and_inputs()

    __lowerCamelCase													=    True

    return config, input_ids, input_mask, token_labels




 def        lowerCamelCase      (						self	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				):



    '''simple docstring'''
    __lowerCamelCase													=    GPTNeoXModel(config=__UpperCAmelCase				)
    model.to(__UpperCAmelCase				)
    model.eval()
    __lowerCamelCase													=    model(__UpperCAmelCase	,				attention_mask=__UpperCAmelCase				)
    __lowerCamelCase													=    model(__UpperCAmelCase				)
    self.parent.assertEqual(result.last_hidden_state.shape	,				(self.batch_size, self.seq_length, self.hidden_size)				)




 def        lowerCamelCase      (						self	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				):



    '''simple docstring'''
    __lowerCamelCase													=    True
    __lowerCamelCase													=    GPTNeoXModel(__UpperCAmelCase				)
    model.to(__UpperCAmelCase				)
    model.eval()
    __lowerCamelCase													=    model(__UpperCAmelCase	,				attention_mask=__UpperCAmelCase				)
    self.parent.assertEqual(result.last_hidden_state.shape	,				(self.batch_size, self.seq_length, self.hidden_size)				)




 def        lowerCamelCase      (						self	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				):



    '''simple docstring'''
    __lowerCamelCase													=    GPTNeoXForCausalLM(config=__UpperCAmelCase				)
    model.to(__UpperCAmelCase				)
    model.eval()
    __lowerCamelCase													=    model(__UpperCAmelCase	,				attention_mask=__UpperCAmelCase	,				labels=__UpperCAmelCase				)
    self.parent.assertEqual(result.logits.shape	,				(self.batch_size, self.seq_length, self.vocab_size)				)




 def        lowerCamelCase      (						self	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				):



    '''simple docstring'''
    __lowerCamelCase													=    self.num_labels
    __lowerCamelCase													=    GPTNeoXForQuestionAnswering(__UpperCAmelCase				)
    model.to(__UpperCAmelCase				)
    model.eval()
    __lowerCamelCase													=    model(__UpperCAmelCase	,				attention_mask=__UpperCAmelCase				)
    self.parent.assertEqual(result.start_logits.shape	,				(self.batch_size, self.seq_length)				)
    self.parent.assertEqual(result.end_logits.shape	,				(self.batch_size, self.seq_length)				)




 def        lowerCamelCase      (						self	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				):



    '''simple docstring'''
    __lowerCamelCase													=    self.num_labels
    __lowerCamelCase													=    GPTNeoXForSequenceClassification(__UpperCAmelCase				)
    model.to(__UpperCAmelCase				)
    model.eval()
    __lowerCamelCase													=    ids_tensor([self.batch_size]	,				self.type_sequence_label_size				)
    __lowerCamelCase													=    model(__UpperCAmelCase	,				attention_mask=__UpperCAmelCase	,				labels=__UpperCAmelCase				)
    self.parent.assertEqual(result.logits.shape	,				(self.batch_size, self.num_labels)				)




 def        lowerCamelCase      (						self	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				):



    '''simple docstring'''
    __lowerCamelCase													=    self.num_labels
    __lowerCamelCase													=    GPTNeoXForTokenClassification(__UpperCAmelCase				)
    model.to(__UpperCAmelCase				)
    model.eval()
    __lowerCamelCase													=    model(__UpperCAmelCase	,				attention_mask=__UpperCAmelCase	,				labels=__UpperCAmelCase				)
    self.parent.assertEqual(result.logits.shape	,				(self.batch_size, self.seq_length, self.num_labels)				)




 def        lowerCamelCase      (						self	,				__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				):



    '''simple docstring'''
    __lowerCamelCase													=    True
    __lowerCamelCase													=    GPTNeoXForCausalLM(config=__UpperCAmelCase				)
    model.to(__UpperCAmelCase				)
    model.eval()

    # first forward pass
    __lowerCamelCase													=    model(__UpperCAmelCase	,				attention_mask=__UpperCAmelCase	,				use_cache=__UpperCAmelCase				)
    __lowerCamelCase													=    outputs.past_key_values

    # create hypothetical multiple next token and extent to next_input_ids
    __lowerCamelCase													=    ids_tensor((self.batch_size, 3)	,				config.vocab_size				)
    __lowerCamelCase													=    ids_tensor((self.batch_size, 3)	,				vocab_size=2				)

    # append to next input_ids and
    __lowerCamelCase													=    torch.cat([input_ids, next_tokens]	,				dim=-1				)
    __lowerCamelCase													=    torch.cat([input_mask, next_mask]	,				dim=-1				)

    __lowerCamelCase													=    model(__UpperCAmelCase	,				attention_mask=__UpperCAmelCase	,				output_hidden_states=__UpperCAmelCase				)
    __lowerCamelCase													=    output_from_no_past['''hidden_states'''][0]
    __lowerCamelCase													=    model(
        __UpperCAmelCase	,				attention_mask=__UpperCAmelCase	,				past_key_values=__UpperCAmelCase	,				output_hidden_states=__UpperCAmelCase	,				)['''hidden_states'''][0]

    # select random slice
    __lowerCamelCase													=    ids_tensor((1,)	,				output_from_past.shape[-1]				).item()
    __lowerCamelCase													=    output_from_no_past[:, -3:, random_slice_idx].detach()
    __lowerCamelCase													=    output_from_past[:, :, random_slice_idx].detach()

    self.parent.assertTrue(output_from_past_slice.shape[1] == next_tokens.shape[1]				)

    # test that outputs are equal for slice
    self.parent.assertTrue(torch.allclose(__UpperCAmelCase	,				__UpperCAmelCase	,				atol=1E-3				)				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.prepare_config_and_inputs()
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    config_and_inputs
    __lowerCamelCase													=    {'''input_ids''': input_ids, '''attention_mask''': input_mask}
    return config, inputs_dict



@require_torch
class  __lowerCAmelCase     (	lowerCAmelCase__  ,	lowerCAmelCase__  ,	lowerCAmelCase__  ,	unittest.TestCase   ):
 lowerCAmelCase__       					=  (
     (
         GPTNeoXModel,
         GPTNeoXForCausalLM,
         GPTNeoXForQuestionAnswering,
         GPTNeoXForSequenceClassification,
         GPTNeoXForTokenClassification,
     )
     if is_torch_available()
     else ()
 )
 lowerCAmelCase__       					=  (GPTNeoXForCausalLM,) if is_torch_available() else ()
 lowerCAmelCase__       					=  (
     {
         """feature-extraction""": GPTNeoXModel,
         """question-answering""": GPTNeoXForQuestionAnswering,
         """text-classification""": GPTNeoXForSequenceClassification,
         """text-generation""": GPTNeoXForCausalLM,
         """token-classification""": GPTNeoXForTokenClassification,
         """zero-shot""": GPTNeoXForSequenceClassification,
     }
     if is_torch_available()
     else {}
 )
 lowerCAmelCase__       					=  False
 lowerCAmelCase__       					=  False
 lowerCAmelCase__       					=  False
 lowerCAmelCase__       					=  False




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    GPTNeoXModelTester(self				)
    __lowerCamelCase													=    ConfigTester(self	,				config_class=__UpperCAmelCase	,				hidden_size=64	,				num_attention_heads=8				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    self.config_tester.run_common_tests()




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    self.model_tester.prepare_config_and_inputs()
    self.model_tester.create_and_check_model(__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    self.model_tester.prepare_config_and_inputs_for_decoder()
    self.model_tester.create_and_check_model_as_decoder(__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    # This regression test was failing with PyTorch < 1.3
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    self.model_tester.prepare_config_and_inputs_for_decoder()

    __lowerCamelCase													=    None

    self.model_tester.create_and_check_model_as_decoder(__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    self.model_tester.prepare_config_and_inputs()
    self.model_tester.create_and_check_decoder_model_past_large_inputs(__UpperCAmelCase	,				__UpperCAmelCase	,				__UpperCAmelCase				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.model_tester.prepare_config_and_inputs()
    self.model_tester.create_and_check_for_causal_lm(*__UpperCAmelCase				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.model_tester.prepare_config_and_inputs()
    self.model_tester.create_and_check_for_question_answering(*__UpperCAmelCase				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.model_tester.prepare_config_and_inputs()
    self.model_tester.create_and_check_for_sequence_classification(*__UpperCAmelCase				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.model_tester.prepare_config_and_inputs()
    self.model_tester.create_and_check_for_token_classification(*__UpperCAmelCase				)




 @unittest.skip(reason='''Feed forward chunking is not implemented'''				)
 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    pass




 @parameterized.expand([('''linear''',), ('''dynamic''',)]				)
 def        lowerCamelCase      (						self	,				__UpperCAmelCase				):



    '''simple docstring'''
    __lowerCamelCase							,__lowerCamelCase													=    self.model_tester.prepare_config_and_inputs_for_common()
    __lowerCamelCase													=    ids_tensor([1, 10]	,				config.vocab_size				)
    __lowerCamelCase													=    ids_tensor([1, int(config.max_position_embeddings * 1.5				)]	,				config.vocab_size				)

    set_seed(42				)  # Fixed seed at init time so the two models get the same random weights
    __lowerCamelCase													=    GPTNeoXModel(__UpperCAmelCase				)
    original_model.to(__UpperCAmelCase				)
    original_model.eval()
    __lowerCamelCase													=    original_model(__UpperCAmelCase				).last_hidden_state
    __lowerCamelCase													=    original_model(__UpperCAmelCase				).last_hidden_state

    set_seed(42				)  # Fixed seed at init time so the two models get the same random weights
    __lowerCamelCase													=    {'''type''': scaling_type, '''factor''': 10.0}
    __lowerCamelCase													=    GPTNeoXModel(__UpperCAmelCase				)
    scaled_model.to(__UpperCAmelCase				)
    scaled_model.eval()
    __lowerCamelCase													=    scaled_model(__UpperCAmelCase				).last_hidden_state
    __lowerCamelCase													=    scaled_model(__UpperCAmelCase				).last_hidden_state

    # Dynamic scaling does not change the RoPE embeddings until it receives an input longer than the original
    # maximum sequence length, so the outputs for the short input should match.
    if scaling_type == "dynamic":
       self.assertTrue(torch.allclose(__UpperCAmelCase	,				__UpperCAmelCase	,				atol=1E-5				)				)
    else:
       self.assertFalse(torch.allclose(__UpperCAmelCase	,				__UpperCAmelCase	,				atol=1E-5				)				)

    # The output should be different for long inputs
    self.assertFalse(torch.allclose(__UpperCAmelCase	,				__UpperCAmelCase	,				atol=1E-5				)				)



@require_torch
class  __lowerCAmelCase     (	unittest.TestCase   ):




 @slow
 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    AutoTokenizer.from_pretrained('''EleutherAI/pythia-410m-deduped'''				)
    for checkpointing in [True, False]:
       __lowerCamelCase													=    GPTNeoXForCausalLM.from_pretrained('''EleutherAI/pythia-410m-deduped'''				)

       if checkpointing:
          model.gradient_checkpointing_enable()
       else:
          model.gradient_checkpointing_disable()
       model.to(__UpperCAmelCase				)

       __lowerCamelCase													=    tokenizer('''My favorite food is'''	,				return_tensors='''pt'''				).to(__UpperCAmelCase				)
       # The hub repo. is updated on 2023-04-04, resulting in poor outputs.
       # See: https://github.com/huggingface/transformers/pull/24193
       __lowerCamelCase													=    '''My favorite food is a good old-fashioned, old-fashioned, old-fashioned.\n\nI\'m not sure'''

       __lowerCamelCase													=    model.generate(**__UpperCAmelCase	,				do_sample=__UpperCAmelCase	,				max_new_tokens=20				)
       __lowerCamelCase													=    tokenizer.batch_decode(__UpperCAmelCase				)[0]

       self.assertEqual(__UpperCAmelCase	,				__UpperCAmelCase				)











import json
import os
import pickle
import shutil
import tempfile
from unittest import TestCase
from unittest.mock import patch

import numpy as np
from datasets import Dataset

from transformers import is_faiss_available
from transformers.models.bart.configuration_bart import BartConfig
from transformers.models.bart.tokenization_bart import BartTokenizer
from transformers.models.bert.tokenization_bert import VOCAB_FILES_NAMES as DPR_VOCAB_FILES_NAMES
from transformers.models.dpr.configuration_dpr import DPRConfig
from transformers.models.dpr.tokenization_dpr import DPRContextEncoderTokenizer, DPRQuestionEncoderTokenizer
from transformers.models.rag.configuration_rag import RagConfig
from transformers.models.rag.retrieval_rag import CustomHFIndex, RagRetriever
from transformers.models.roberta.tokenization_roberta import VOCAB_FILES_NAMES as BART_VOCAB_FILES_NAMES
from transformers.testing_utils import require_faiss, require_sentencepiece, require_tokenizers, require_torch


if is_faiss_available():
  import faiss



@require_faiss
class  __lowerCAmelCase     (	lowerCAmelCase__   ):




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    tempfile.mkdtemp()
    __lowerCamelCase													=    8

    # DPR tok
    __lowerCamelCase													=    [
        '''[UNK]''',
        '''[CLS]''',
        '''[SEP]''',
        '''[PAD]''',
        '''[MASK]''',
        '''want''',
        '''##want''',
        '''##ed''',
        '''wa''',
        '''un''',
        '''runn''',
        '''##ing''',
        ''',''',
        '''low''',
        '''lowest''',
    ]
    __lowerCamelCase													=    os.path.join(self.tmpdirname	,				'''dpr_tokenizer'''				)
    os.makedirs(__UpperCAmelCase	,				exist_ok=__UpperCAmelCase				)
    __lowerCamelCase													=    os.path.join(__UpperCAmelCase	,				DPR_VOCAB_FILES_NAMES['''vocab_file''']				)
    with open(self.vocab_file	,				'''w'''	,				encoding='''utf-8'''				) as vocab_writer:
       vocab_writer.write(''''''.join([x + '''\n''' for x in vocab_tokens]				)				)

    # BART tok
    __lowerCamelCase													=    [
        '''l''',
        '''o''',
        '''w''',
        '''e''',
        '''r''',
        '''s''',
        '''t''',
        '''i''',
        '''d''',
        '''n''',
        '''\u0120''',
        '''\u0120l''',
        '''\u0120n''',
        '''\u0120lo''',
        '''\u0120low''',
        '''er''',
        '''\u0120lowest''',
        '''\u0120newer''',
        '''\u0120wider''',
        '''<unk>''',
    ]
    __lowerCamelCase													=    dict(zip(__UpperCAmelCase	,				range(len(__UpperCAmelCase				)				)				)				)
    __lowerCamelCase													=    ['''#version: 0.2''', '''\u0120 l''', '''\u0120l o''', '''\u0120lo w''', '''e r''', '''''']
    __lowerCamelCase													=    {'''unk_token''': '''<unk>'''}

    __lowerCamelCase													=    os.path.join(self.tmpdirname	,				'''bart_tokenizer'''				)
    os.makedirs(__UpperCAmelCase	,				exist_ok=__UpperCAmelCase				)
    __lowerCamelCase													=    os.path.join(__UpperCAmelCase	,				BART_VOCAB_FILES_NAMES['''vocab_file''']				)
    __lowerCamelCase													=    os.path.join(__UpperCAmelCase	,				BART_VOCAB_FILES_NAMES['''merges_file''']				)
    with open(self.vocab_file	,				'''w'''	,				encoding='''utf-8'''				) as fp:
       fp.write(json.dumps(__UpperCAmelCase				) + '''\n'''				)
    with open(self.merges_file	,				'''w'''	,				encoding='''utf-8'''				) as fp:
       fp.write('''\n'''.join(__UpperCAmelCase				)				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    return DPRQuestionEncoderTokenizer.from_pretrained(os.path.join(self.tmpdirname	,				'''dpr_tokenizer'''				)				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    return DPRContextEncoderTokenizer.from_pretrained(os.path.join(self.tmpdirname	,				'''dpr_tokenizer'''				)				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    return BartTokenizer.from_pretrained(os.path.join(self.tmpdirname	,				'''bart_tokenizer'''				)				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    shutil.rmtree(self.tmpdirname				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    Dataset.from_dict(
        {
            '''id''': ['''0''', '''1'''],
            '''text''': ['''foo''', '''bar'''],
            '''title''': ['''Foo''', '''Bar'''],
            '''embeddings''': [np.ones(self.retrieval_vector_size				), 2 * np.ones(self.retrieval_vector_size				)],
        }				)
    dataset.add_faiss_index('''embeddings'''	,				string_factory='''Flat'''	,				metric_type=faiss.METRIC_INNER_PRODUCT				)
    return dataset




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.get_dummy_dataset()
    __lowerCamelCase													=    RagConfig(
        retrieval_vector_size=self.retrieval_vector_size	,				question_encoder=DPRConfig().to_dict()	,				generator=BartConfig().to_dict()	,				)
    with patch('''transformers.models.rag.retrieval_rag.load_dataset'''				) as mock_load_dataset:
       __lowerCamelCase													=    dataset
       __lowerCamelCase													=    RagRetriever(
           __UpperCAmelCase	,				question_encoder_tokenizer=self.get_dpr_tokenizer()	,				generator_tokenizer=self.get_bart_tokenizer()	,				)
    return retriever




 def        lowerCamelCase      (						self	,				__UpperCAmelCase				):



    '''simple docstring'''
    __lowerCamelCase													=    self.get_dummy_dataset()
    __lowerCamelCase													=    RagConfig(
        retrieval_vector_size=self.retrieval_vector_size	,				question_encoder=DPRConfig().to_dict()	,				generator=BartConfig().to_dict()	,				index_name='''custom'''	,				)
    if from_disk:
       __lowerCamelCase													=    os.path.join(self.tmpdirname	,				'''dataset'''				)
       __lowerCamelCase													=    os.path.join(self.tmpdirname	,				'''index.faiss'''				)
       dataset.get_index('''embeddings'''				).save(os.path.join(self.tmpdirname	,				'''index.faiss'''				)				)
       dataset.drop_index('''embeddings'''				)
       dataset.save_to_disk(os.path.join(self.tmpdirname	,				'''dataset'''				)				)
       del dataset
       __lowerCamelCase													=    RagRetriever(
           __UpperCAmelCase	,				question_encoder_tokenizer=self.get_dpr_tokenizer()	,				generator_tokenizer=self.get_bart_tokenizer()	,				)
    else:
       __lowerCamelCase													=    RagRetriever(
           __UpperCAmelCase	,				question_encoder_tokenizer=self.get_dpr_tokenizer()	,				generator_tokenizer=self.get_bart_tokenizer()	,				index=CustomHFIndex(config.retrieval_vector_size	,				__UpperCAmelCase				)	,				)
    return retriever




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    Dataset.from_dict(
        {
            '''id''': ['''0''', '''1'''],
            '''text''': ['''foo''', '''bar'''],
            '''title''': ['''Foo''', '''Bar'''],
            '''embeddings''': [np.ones(self.retrieval_vector_size + 1				), 2 * np.ones(self.retrieval_vector_size + 1				)],
        }				)
    dataset.add_faiss_index('''embeddings'''	,				string_factory='''Flat'''	,				metric_type=faiss.METRIC_INNER_PRODUCT				)

    __lowerCamelCase													=    os.path.join(self.tmpdirname	,				'''hf_bert_base.hnswSQ8_correct_phi_128.c_index'''				)
    dataset.save_faiss_index('''embeddings'''	,				index_file_name + '''.index.dpr'''				)
    pickle.dump(dataset['''id''']	,				open(index_file_name + '''.index_meta.dpr'''	,				'''wb'''				)				)

    __lowerCamelCase													=    os.path.join(self.tmpdirname	,				'''psgs_w100.tsv.pkl'''				)
    __lowerCamelCase													=    {sample['''id''']: [sample['''text'''], sample['''title''']] for sample in dataset}
    pickle.dump(__UpperCAmelCase	,				open(__UpperCAmelCase	,				'''wb'''				)				)

    __lowerCamelCase													=    RagConfig(
        retrieval_vector_size=self.retrieval_vector_size	,				question_encoder=DPRConfig().to_dict()	,				generator=BartConfig().to_dict()	,				index_name='''legacy'''	,				index_path=self.tmpdirname	,				)
    __lowerCamelCase													=    RagRetriever(
        __UpperCAmelCase	,				question_encoder_tokenizer=self.get_dpr_tokenizer()	,				generator_tokenizer=self.get_bart_tokenizer()				)
    return retriever




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    1
    __lowerCamelCase													=    self.get_dummy_canonical_hf_index_retriever()
    __lowerCamelCase													=    np.array(
        [np.ones(self.retrieval_vector_size				), -np.ones(self.retrieval_vector_size				)]	,				dtype=np.floataa				)
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    retriever.retrieve(__UpperCAmelCase	,				n_docs=__UpperCAmelCase				)
    self.assertEqual(retrieved_doc_embeds.shape	,				(2, n_docs, self.retrieval_vector_size)				)
    self.assertEqual(len(__UpperCAmelCase				)	,				2				)
    self.assertEqual(sorted(doc_dicts[0]				)	,				['''embeddings''', '''id''', '''text''', '''title''']				)
    self.assertEqual(len(doc_dicts[0]['''id''']				)	,				__UpperCAmelCase				)
    self.assertEqual(doc_dicts[0]['''id'''][0]	,				'''1'''				)  # max inner product is reached with second doc
    self.assertEqual(doc_dicts[1]['''id'''][0]	,				'''0'''				)  # max inner product is reached with first doc
    self.assertListEqual(doc_ids.tolist()	,				[[1], [0]]				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.get_dummy_canonical_hf_index_retriever()
    with tempfile.TemporaryDirectory() as tmp_dirname:
       with patch('''transformers.models.rag.retrieval_rag.load_dataset'''				) as mock_load_dataset:
          __lowerCamelCase													=    self.get_dummy_dataset()
          retriever.save_pretrained(__UpperCAmelCase				)
          __lowerCamelCase													=    RagRetriever.from_pretrained(__UpperCAmelCase				)
          self.assertIsInstance(__UpperCAmelCase	,				__UpperCAmelCase				)
          __lowerCamelCase													=    np.array(
              [np.ones(self.retrieval_vector_size				), -np.ones(self.retrieval_vector_size				)]	,				dtype=np.floataa				)
          __lowerCamelCase													=    retriever.retrieve(__UpperCAmelCase	,				n_docs=1				)
          self.assertTrue(out is not None				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    1
    __lowerCamelCase													=    self.get_dummy_custom_hf_index_retriever(from_disk=__UpperCAmelCase				)
    __lowerCamelCase													=    np.array(
        [np.ones(self.retrieval_vector_size				), -np.ones(self.retrieval_vector_size				)]	,				dtype=np.floataa				)
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    retriever.retrieve(__UpperCAmelCase	,				n_docs=__UpperCAmelCase				)
    self.assertEqual(retrieved_doc_embeds.shape	,				(2, n_docs, self.retrieval_vector_size)				)
    self.assertEqual(len(__UpperCAmelCase				)	,				2				)
    self.assertEqual(sorted(doc_dicts[0]				)	,				['''embeddings''', '''id''', '''text''', '''title''']				)
    self.assertEqual(len(doc_dicts[0]['''id''']				)	,				__UpperCAmelCase				)
    self.assertEqual(doc_dicts[0]['''id'''][0]	,				'''1'''				)  # max inner product is reached with second doc
    self.assertEqual(doc_dicts[1]['''id'''][0]	,				'''0'''				)  # max inner product is reached with first doc
    self.assertListEqual(doc_ids.tolist()	,				[[1], [0]]				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.get_dummy_custom_hf_index_retriever(from_disk=__UpperCAmelCase				)
    with tempfile.TemporaryDirectory() as tmp_dirname:
       retriever.save_pretrained(__UpperCAmelCase				)
       __lowerCamelCase													=    RagRetriever.from_pretrained(__UpperCAmelCase				)
       self.assertIsInstance(__UpperCAmelCase	,				__UpperCAmelCase				)
       __lowerCamelCase													=    np.array(
           [np.ones(self.retrieval_vector_size				), -np.ones(self.retrieval_vector_size				)]	,				dtype=np.floataa				)
       __lowerCamelCase													=    retriever.retrieve(__UpperCAmelCase	,				n_docs=1				)
       self.assertTrue(out is not None				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    1
    __lowerCamelCase													=    self.get_dummy_custom_hf_index_retriever(from_disk=__UpperCAmelCase				)
    __lowerCamelCase													=    np.array(
        [np.ones(self.retrieval_vector_size				), -np.ones(self.retrieval_vector_size				)]	,				dtype=np.floataa				)
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    retriever.retrieve(__UpperCAmelCase	,				n_docs=__UpperCAmelCase				)
    self.assertEqual(retrieved_doc_embeds.shape	,				(2, n_docs, self.retrieval_vector_size)				)
    self.assertEqual(len(__UpperCAmelCase				)	,				2				)
    self.assertEqual(sorted(doc_dicts[0]				)	,				['''embeddings''', '''id''', '''text''', '''title''']				)
    self.assertEqual(len(doc_dicts[0]['''id''']				)	,				__UpperCAmelCase				)
    self.assertEqual(doc_dicts[0]['''id'''][0]	,				'''1'''				)  # max inner product is reached with second doc
    self.assertEqual(doc_dicts[1]['''id'''][0]	,				'''0'''				)  # max inner product is reached with first doc
    self.assertListEqual(doc_ids.tolist()	,				[[1], [0]]				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.get_dummy_custom_hf_index_retriever(from_disk=__UpperCAmelCase				)
    with tempfile.TemporaryDirectory() as tmp_dirname:
       retriever.save_pretrained(__UpperCAmelCase				)
       __lowerCamelCase													=    RagRetriever.from_pretrained(__UpperCAmelCase				)
       self.assertIsInstance(__UpperCAmelCase	,				__UpperCAmelCase				)
       __lowerCamelCase													=    np.array(
           [np.ones(self.retrieval_vector_size				), -np.ones(self.retrieval_vector_size				)]	,				dtype=np.floataa				)
       __lowerCamelCase													=    retriever.retrieve(__UpperCAmelCase	,				n_docs=1				)
       self.assertTrue(out is not None				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    1
    __lowerCamelCase													=    self.get_dummy_legacy_index_retriever()
    __lowerCamelCase													=    np.array(
        [np.ones(self.retrieval_vector_size				), -np.ones(self.retrieval_vector_size				)]	,				dtype=np.floataa				)
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    retriever.retrieve(__UpperCAmelCase	,				n_docs=__UpperCAmelCase				)
    self.assertEqual(retrieved_doc_embeds.shape	,				(2, n_docs, self.retrieval_vector_size)				)
    self.assertEqual(len(__UpperCAmelCase				)	,				2				)
    self.assertEqual(sorted(doc_dicts[0]				)	,				['''text''', '''title''']				)
    self.assertEqual(len(doc_dicts[0]['''text''']				)	,				__UpperCAmelCase				)
    self.assertEqual(doc_dicts[0]['''text'''][0]	,				'''bar'''				)  # max inner product is reached with second doc
    self.assertEqual(doc_dicts[1]['''text'''][0]	,				'''foo'''				)  # max inner product is reached with first doc
    self.assertListEqual(doc_ids.tolist()	,				[[1], [0]]				)




 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.get_dummy_legacy_index_retriever()
    with tempfile.TemporaryDirectory() as tmp_dirname:
       retriever.save_pretrained(__UpperCAmelCase				)
       __lowerCamelCase													=    RagRetriever.from_pretrained(__UpperCAmelCase				)
       self.assertIsInstance(__UpperCAmelCase	,				__UpperCAmelCase				)
       __lowerCamelCase													=    np.array(
           [np.ones(self.retrieval_vector_size				), -np.ones(self.retrieval_vector_size				)]	,				dtype=np.floataa				)
       __lowerCamelCase													=    retriever.retrieve(__UpperCAmelCase	,				n_docs=1				)
       self.assertTrue(out is not None				)




 @require_torch
 @require_tokenizers
 @require_sentencepiece
 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    import torch

    __lowerCamelCase													=    1
    __lowerCamelCase													=    self.get_dummy_canonical_hf_index_retriever()
    __lowerCamelCase													=    [[5, 7], [10, 11]]
    __lowerCamelCase													=    np.array(
        [np.ones(self.retrieval_vector_size				), -np.ones(self.retrieval_vector_size				)]	,				dtype=np.floataa				)
    __lowerCamelCase													=    retriever(__UpperCAmelCase	,				__UpperCAmelCase	,				prefix=retriever.config.generator.prefix	,				n_docs=__UpperCAmelCase				)
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    (
        out['''context_input_ids'''],
        out['''context_attention_mask'''],
        out['''retrieved_doc_embeds'''],
    )
    self.assertEqual(retrieved_doc_embeds.shape	,				(2, n_docs, self.retrieval_vector_size)				)
    self.assertIsInstance(__UpperCAmelCase	,				__UpperCAmelCase				)
    self.assertIsInstance(__UpperCAmelCase	,				__UpperCAmelCase				)
    self.assertIsInstance(__UpperCAmelCase	,				np.ndarray				)

    __lowerCamelCase													=    retriever(
        __UpperCAmelCase	,				__UpperCAmelCase	,				prefix=retriever.config.generator.prefix	,				n_docs=__UpperCAmelCase	,				return_tensors='''pt'''	,				)
    __lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase							,__lowerCamelCase													=    (  # noqa: F841
        out['''context_input_ids'''],
        out['''context_attention_mask'''],
        out['''retrieved_doc_embeds'''],
        out['''doc_ids'''],
    )
    self.assertEqual(retrieved_doc_embeds.shape	,				(2, n_docs, self.retrieval_vector_size)				)
    self.assertIsInstance(__UpperCAmelCase	,				torch.Tensor				)
    self.assertIsInstance(__UpperCAmelCase	,				torch.Tensor				)
    self.assertIsInstance(__UpperCAmelCase	,				torch.Tensor				)




 @require_torch
 @require_tokenizers
 @require_sentencepiece
 def        lowerCamelCase      (						self				):



    '''simple docstring'''
    __lowerCamelCase													=    self.get_dpr_ctx_encoder_tokenizer()
    __lowerCamelCase													=    1
    __lowerCamelCase													=    self.get_dummy_custom_hf_index_retriever(from_disk=__UpperCAmelCase				)
    retriever.set_ctx_encoder_tokenizer(__UpperCAmelCase				)

    __lowerCamelCase													=    [[5, 7], [10, 11]]
    __lowerCamelCase													=    np.array(
        [np.ones(self.retrieval_vector_size				), -np.ones(self.retrieval_vector_size				)]	,				dtype=np.floataa				)
    __lowerCamelCase													=    retriever(__UpperCAmelCase	,				__UpperCAmelCase	,				prefix=retriever.config.generator.prefix	,				n_docs=__UpperCAmelCase				)

    self.assertEqual(
        len(__UpperCAmelCase				)	,				6				)  # check whether the retriever output consist of 6 attributes including tokenized docs
    self.assertEqual(
        all(k in out for k in ('''tokenized_doc_ids''', '''tokenized_doc_attention_mask''')				)	,				__UpperCAmelCase				)  # check for doc token related keys in dictionary.






