U &ce5@sdZddlZddlZddlmZddlmZmZddlm Z ddl m Z e e Zdd iZdd d d d dddiZdddddddZGddde ZdS)z, Tokenization classes for XLM-RoBERTa model.N)copyfile)ListOptional)PreTrainedTokenizer)SPIECE_UNDERLINE vocab_filezsentencepiece.bpe.modelz\https://s3.amazonaws.com/models.huggingface.co/bert/xlm-roberta-base-sentencepiece.bpe.modelz]https://s3.amazonaws.com/models.huggingface.co/bert/xlm-roberta-large-sentencepiece.bpe.modelzuhttps://s3.amazonaws.com/models.huggingface.co/bert/xlm-roberta-large-finetuned-conll02-dutch-sentencepiece.bpe.modelzwhttps://s3.amazonaws.com/models.huggingface.co/bert/xlm-roberta-large-finetuned-conll02-spanish-sentencepiece.bpe.modelzwhttps://s3.amazonaws.com/models.huggingface.co/bert/xlm-roberta-large-finetuned-conll03-english-sentencepiece.bpe.modelzvhttps://s3.amazonaws.com/models.huggingface.co/bert/xlm-roberta-large-finetuned-conll03-german-sentencepiece.bpe.model)zxlm-roberta-basezxlm-roberta-largez)xlm-roberta-large-finetuned-conll02-dutchz+xlm-roberta-large-finetuned-conll02-spanishz+xlm-roberta-large-finetuned-conll03-englishz*xlm-roberta-large-finetuned-conll03-germanicseZdZdZeZeZeZ dgZ d&fdd Z d d Z d d Z d'eeeeeeedddZd(eeeeeeeedddZd)eeeeeeedddZeddZddZddZddZd d!Zd"d#Zd$d%ZZS)*XLMRobertaTokenizera! Adapted from RobertaTokenizer and XLNetTokenizer SentencePiece based tokenizer. Peculiarities: - requires `SentencePiece `_ This tokenizer inherits from :class:`~transformers.PreTrainedTokenizer` which contains most of the methods. Users should refer to the superclass for more information regarding methods. Args: vocab_file (:obj:`str`): Path to the vocabulary file. bos_token (:obj:`string`, `optional`, defaults to ""): The beginning of sequence token that was used during pre-training. Can be used a sequence classifier token. .. note:: When building a sequence using special tokens, this is not the token that is used for the beginning of sequence. The token used is the :obj:`cls_token`. eos_token (:obj:`string`, `optional`, defaults to ""): The end of sequence token. .. note:: When building a sequence using special tokens, this is not the token that is used for the end of sequence. The token used is the :obj:`sep_token`. sep_token (:obj:`string`, `optional`, defaults to ""): The separator token, which is used when building a sequence from multiple sequences, e.g. two sequences for sequence classification or for a text and a question for question answering. It is also used as the last token of a sequence built with special tokens. cls_token (:obj:`string`, `optional`, defaults to ""): The classifier token which is used when doing sequence classification (classification of the whole sequence instead of per-token classification). It is the first token of the sequence when built with special tokens. unk_token (:obj:`string`, `optional`, defaults to ""): The unknown token. A token that is not in the vocabulary cannot be converted to an ID and is set to be this token instead. pad_token (:obj:`string`, `optional`, defaults to ""): The token used for padding, for example when batching sequences of different lengths. mask_token (:obj:`string`, `optional`, defaults to ""): The token used for masking values. This is the token used when training this model with masked language modeling. This is the token which the model will try to predict. additional_special_tokens (:obj:`List[str]`, `optional`, defaults to :obj:`["NOTUSED", "NOTUSED"]`): Additional special tokens used by the tokenizer. Attributes: sp_model (:obj:`SentencePieceProcessor`): The `SentencePiece` processor that is used for every conversion (string, tokens and IDs). Zattention_maskc stjf|||||||d| z ddl} Wn tk rNtdYnX| |_|jt |||_ ddddd|_ d|_ t |j|j |j d<d d |j D|_dS) N) bos_token eos_token unk_token sep_token cls_token pad_token mask_tokenr~You need to install SentencePiece to use XLMRobertaTokenizer: https://github.com/google/sentencepiecepip install sentencepiecer)r r r r rcSsi|]\}}||qSr).0kvrrI/tmp/pip-unpacked-wheel-ymerj3tt/transformers/tokenization_xlm_roberta.py sz0XLMRobertaTokenizer.__init__..)super__init__ sentencepiece ImportErrorloggerwarningSentencePieceProcessorsp_modelLoadstrrfairseq_tokens_to_idsfairseq_offsetlenitemsfairseq_ids_to_tokens) selfrrrrrrrrkwargsspm __class__rrr ls2     zXLMRobertaTokenizer.__init__cCs|j}d|d<|S)Nr&)__dict__copy)r.staterrr __getstate__s z XLMRobertaTokenizer.__getstate__cCsP||_z ddl}Wn tk r2tdYnX||_|j|jdS)Nrr) r3r!r"r#r$r%r&r'r)r.dr0rrr __setstate__s  z XLMRobertaTokenizer.__setstate__N) token_ids_0 token_ids_1returncCsD|dkr|jg||jgS|jg}|jg}||||||S)a Build model inputs from a sequence or a pair of sequence for sequence classification tasks by concatenating and adding special tokens. A XLM-R sequence has the following format: - single sequence: `` X `` - pair of sequences: `` A B `` Args: token_ids_0 (:obj:`List[int]`): List of IDs to which the special tokens will be added token_ids_1 (:obj:`List[int]`, `optional`, defaults to :obj:`None`): Optional second list of IDs for sequence pairs. Returns: :obj:`List[int]`: list of `input IDs <../glossary.html#input-ids>`__ with the appropriate special tokens. N) cls_token_id sep_token_id)r.r9r:clsseprrr build_inputs_with_special_tokenss z4XLMRobertaTokenizer.build_inputs_with_special_tokensF)r9r:already_has_special_tokensr;cs||r*|dk rtdttfdd|S|dkrLdgdgt|dgSdgdgt|ddgdgt|dgS)a  Retrieves sequence ids from a token list that has no special tokens added. This method is called when adding special tokens using the tokenizer ``prepare_for_model`` or ``encode_plus`` methods. Args: token_ids_0 (:obj:`List[int]`): List of ids. token_ids_1 (:obj:`List[int]`, `optional`, defaults to :obj:`None`): Optional second list of IDs for sequence pairs. already_has_special_tokens (:obj:`bool`, `optional`, defaults to :obj:`False`): Set to True if the token list is already formatted with special tokens for the model Returns: :obj:`List[int]`: A list of integers in the range [0, 1]: 1 for a special token, 0 for a sequence token. Nz~You should not supply a second sequence if the provided sequence of ids is already formated with special tokens for the model.cs|jjfkrdSdS)Nrr)r=r<)xr.rrz=XLMRobertaTokenizer.get_special_tokens_mask..rr) ValueErrorlistmapr+)r.r9r:rArrCrget_special_tokens_masksz+XLMRobertaTokenizer.get_special_tokens_maskcCsP|jg}|jg}|dkr.t|||dgSt||||||dgS)a Creates a mask from the two sequences passed to be used in a sequence-pair classification task. XLM-R does not make use of token type ids, therefore a list of zeros is returned. Args: token_ids_0 (:obj:`List[int]`): List of ids. token_ids_1 (:obj:`List[int]`, `optional`, defaults to :obj:`None`): Optional second list of IDs for sequence pairs. Returns: :obj:`List[int]`: List of zeros. Nr)r=r<r+)r.r9r:r?r>rrr$create_token_type_ids_from_sequencess z8XLMRobertaTokenizer.create_token_type_ids_from_sequencescCst|j|jdS)Nr)r+r&r*rCrrr vocab_sizeszXLMRobertaTokenizer.vocab_sizecs(fddtjD}|j|S)Ncsi|]}||qSr)Zconvert_ids_to_tokens)rirCrrr sz1XLMRobertaTokenizer.get_vocab..)rangerKupdateZadded_tokens_encoder)r.ZvocabrrCr get_vocabs zXLMRobertaTokenizer.get_vocabcCs |j|S)N)r&ZEncodeAsPieces)r.textrrr _tokenize szXLMRobertaTokenizer._tokenizecCs4||jkr|j|S|j|}|r.||jS|jS)z2 Converts a token (str) in an id using the vocab. )r)r&Z PieceToIdr*Z unk_token_id)r.tokenZspm_idrrr_convert_token_to_ids   z(XLMRobertaTokenizer._convert_token_to_idcCs&||jkr|j|S|j||jS)z=Converts an index (integer) in a token (str) using the vocab.)r-r&Z IdToPiecer*)r.indexrrr_convert_id_to_tokens  z(XLMRobertaTokenizer._convert_id_to_tokencCsd|td}|S)zIConverts a sequence of tokens (strings for sub-words) in a single string. )joinreplacerstrip)r.tokensZ out_stringrrrconvert_tokens_to_stringsz,XLMRobertaTokenizer.convert_tokens_to_stringcCs^tj|s td|dStj|td}tj|j tj|krXt |j ||fS)a2 Save the sentencepiece vocabulary (copy original file) and special tokens file to a directory. Args: save_directory (:obj:`str`): The directory in which to save the vocabulary. Returns: :obj:`Tuple(str)`: Paths to the files saved. z*Vocabulary path ({}) should be a directoryNr) ospathisdirr#errorformatrXVOCAB_FILES_NAMESabspathrr)r.Zsave_directoryZout_vocab_filerrrsave_vocabulary$s  z#XLMRobertaTokenizer.save_vocabulary)r r r r r r r)N)NF)N)__name__ __module__ __qualname____doc__rbZvocab_files_namesPRETRAINED_VOCAB_FILES_MAPZpretrained_vocab_files_map&PRETRAINED_POSITIONAL_EMBEDDINGS_SIZESZmax_model_input_sizesZmodel_input_namesr r6r8rintrr@boolrIrJpropertyrKrOrQrSrUr\rd __classcell__rrr1rr 4sV23        r )rhloggingr]shutilrtypingrrZtokenization_utilsrZtokenization_xlnetr getLoggerrer#rbrirjr rrrrs2