a
h 1 @ s d Z ddlZddlmZ ddlmZmZ ddlZddl m
Z
ddl m Z ddl
mZ e eZd Zd
d iZed d
G dd de
ZdgZdS )zTokenization classes for . N)copyfile)AnyOptional )PreTrainedTokenizer)logging)requiresu ▁
vocab_filezsentencepiece.bpe.model)
sentencepiece)backendsc s e Zd ZdZeZddgZd)eee e
f dd fd
d
Z d d
Z dd Z
d*ee eee ee dddZd+ee eee eee d fdd
Zd,ee eee ee dddZedd Zdd Ze ee d d d Zd d! Zd"d# Zd$d% Zd-e ee ee d&d'd(Z Z S ).
XGLMTokenizera
Adapted from [`RobertaTokenizer`] and [`XLNetTokenizer`]. Based on
[SentencePiece](https://github.com/google/sentencepiece).
This tokenizer inherits from [`PreTrainedTokenizer`] which contains most of the main methods. Users should refer to
this superclass for more information regarding those methods.
Args:
vocab_file (`str`):
Path to the vocabulary file.
bos_token (`str`, *optional*, defaults to `""`):
The beginning of sequence token that was used during pretraining. Can be used a sequence classifier token.
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 `cls_token`.
eos_token (`str`, *optional*, defaults to `""`):
The end of sequence token.
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 `sep_token`.
sep_token (`str`, *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 (`str`, *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 (`str`, *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 (`str`, *optional*, defaults to `""`):
The token used for padding, for example when batching sequences of different lengths.
sp_model_kwargs (`dict`, *optional*):
Will be passed to the `SentencePieceProcessor.__init__()` method. The [Python wrapper for
SentencePiece](https://github.com/google/sentencepiece/tree/master/python) can be used, among other things,
to set:
- `enable_sampling`: Enable subword regularization.
- `nbest_size`: Sampling parameters for unigram. Invalid for BPE-Dropout.
- `nbest_size = {0,1}`: No sampling is performed.
- `nbest_size > 1`: samples from the nbest_size results.
- `nbest_size < 0`: assuming that nbest_size is infinite and samples from the all hypothesis (lattice)
using forward-filtering-and-backward-sampling algorithm.
- `alpha`: Smoothing parameter for unigram sampling, and dropout probability of merge operations for
BPE-dropout.
Attributes:
sp_model (`SentencePieceProcessor`):
The *SentencePiece* processor that is used for every conversion (string, tokens and IDs).
Z input_idsZattention_mask X `
- pair of sequences: ` A B `
Args:
token_ids_0 (`list[int]`):
List of IDs to which the special tokens will be added.
token_ids_1 (`list[int]`, *optional*):
Optional second list of IDs for sequence pairs.
Returns:
`list[int]`: List of [input IDs](../glossary#input-ids) with the appropriate special tokens.
N) sep_token_idr# rH rI sepr r r build_inputs_with_special_tokens s z.XGLMTokenizer.build_inputs_with_special_tokensF)rH rI already_has_special_tokensr c s\ |rt j||ddS |du r2dgdgt| S dgdgt| ddg dgt| S )a
Retrieve 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` method.
Args:
token_ids_0 (`list[int]`):
List of IDs.
token_ids_1 (`list[int]`, *optional*):
Optional second list of IDs for sequence pairs.
already_has_special_tokens (`bool`, *optional*, defaults to `False`):
Whether or not the token list is already formatted with special tokens for the model.
Returns:
`list[int]`: A list of integers in the range [0, 1]: 1 for a special token, 0 for a sequence token.
T)rH rI rN Nr r )r; get_special_tokens_maskr7 )r# rH rI rN r= r r rO s z%XGLMTokenizer.get_special_tokens_maskc C s@ | j g}|du r"t|| dg S t|| | | | dg S )a
Create a mask from the two sequences passed to be used in a sequence-pair classification task. XLM-RoBERTa does
not make use of token type ids, therefore a list of zeros is returned.
Args:
token_ids_0 (`list[int]`):
List of IDs.
token_ids_1 (`list[int]`, *optional*):
Optional second list of IDs for sequence pairs.
Returns:
`list[int]`: List of zeros.
Nr )rJ r7 rK r r r $create_token_type_ids_from_sequences s z2XGLMTokenizer.create_token_type_ids_from_sequencesc C s t | j| j | j S )N)r7 r3 r" r. r# r r r
vocab_size s zXGLMTokenizer.vocab_sizec s( fddt jD }| j |S )Nc s i | ]} ||qS r )Zconvert_ids_to_tokensr rQ r r r% r z+XGLMTokenizer.get_vocab..)r/ rR r8 Zadded_tokens_encoder)r# Zvocabr rQ r get_vocab s zXGLMTokenizer.get_vocab)textr c C s | j j|tdS )N)Zout_type)r3 encoder5 )r# rT r r r _tokenize s zXGLMTokenizer._tokenizec C s4 || j v r| j | S | j|}|r.|| j S | jS )z0Converts a token (str) in an id using the vocab.)r6 r3 Z PieceToIdr" Z unk_token_id)r# tokenZspm_idr r r _convert_token_to_id s
z"XGLMTokenizer._convert_token_to_idc C s& || j v r| j | S | j|| j S )z=Converts an index (integer) in a token (str) using the vocab.)r: r3 Z IdToPiecer" )r# indexr r r _convert_id_to_token s
z"XGLMTokenizer._convert_id_to_tokenc C s d |td }|S )zIConverts a sequence of tokens (strings for sub-words) in a single string. )joinreplaceSPIECE_UNDERLINEstrip)r# tokensZ
out_stringr r r convert_tokens_to_string s z&XGLMTokenizer.convert_tokens_to_string)save_directoryfilename_prefixr c C s t j|s"td| d d S t j||r6|d ndtd }t j| jt j|krzt j | jrzt
| j| nLt j | jst |d$}| j
}|| W d n1 s0 Y |fS )NzVocabulary path (z) should be a directory-r[ r wb)ospathisdirloggererrorr] VOCAB_FILES_NAMESabspathr isfiler openr3 rB write)r# rc rd Zout_vocab_filefiZcontent_spiece_modelr r r save_vocabulary s (
(z XGLMTokenizer.save_vocabulary)r
r r r
r r N)N)NF)N)N) __name__
__module__ __qualname____doc__rl Zvocab_files_namesZmodel_input_namesr dictr5 r r< rD rG listintrM boolrO rP propertyrR rS rV rX rZ rb tuplerr
__classcell__r r r= r r # sN ? 8
r )rv rg shutilr typingr r r
r1 Ztokenization_utilsr utilsr Zutils.import_utilsr Z
get_loggerrs rj r_ rl r __all__r r r r s