| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235 |
- # coding=utf-8
- # Copyright 2018 The HuggingFace Inc. team.
- #
- # Licensed under the Apache License, Version 2.0 (the "License");
- # you may not use this file except in compliance with the License.
- # You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing, software
- # distributed under the License is distributed on an "AS IS" BASIS,
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- # See the License for the specific language governing permissions and
- # limitations under the License.
- """Auto Tokenizer class."""
- import importlib
- import json
- import os
- import warnings
- from collections import OrderedDict
- from typing import Any, Optional, Union
- from transformers.utils.import_utils import is_mistral_common_available
- from ...configuration_utils import PretrainedConfig
- from ...dynamic_module_utils import get_class_from_dynamic_module, resolve_trust_remote_code
- from ...modeling_gguf_pytorch_utils import load_gguf_checkpoint
- from ...tokenization_utils import PreTrainedTokenizer
- from ...tokenization_utils_base import TOKENIZER_CONFIG_FILE
- from ...utils import (
- cached_file,
- extract_commit_hash,
- is_g2p_en_available,
- is_sentencepiece_available,
- is_tokenizers_available,
- logging,
- )
- from ..encoder_decoder import EncoderDecoderConfig
- from .auto_factory import _LazyAutoMapping
- from .configuration_auto import (
- CONFIG_MAPPING_NAMES,
- AutoConfig,
- config_class_to_model_type,
- model_type_to_module_name,
- replace_list_option_in_docstrings,
- )
- if is_tokenizers_available():
- from ...tokenization_utils_fast import PreTrainedTokenizerFast
- else:
- PreTrainedTokenizerFast = None
- logger = logging.get_logger(__name__)
- # Explicit rather than inferred generics to significantly improves completion suggestion performance for language servers.
- TOKENIZER_MAPPING_NAMES = OrderedDict[str, tuple[Optional[str], Optional[str]]](
- [
- (
- "aimv2",
- (
- "CLIPTokenizer",
- "CLIPTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "albert",
- (
- "AlbertTokenizer" if is_sentencepiece_available() else None,
- "AlbertTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("align", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("arcee", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("aria", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("aya_vision", (None, "CohereTokenizerFast" if is_tokenizers_available() else None)),
- ("bark", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("bart", ("BartTokenizer", "BartTokenizerFast")),
- (
- "barthez",
- (
- "BarthezTokenizer" if is_sentencepiece_available() else None,
- "BarthezTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("bartpho", ("BartphoTokenizer", None)),
- ("bert", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("bert-generation", ("BertGenerationTokenizer" if is_sentencepiece_available() else None, None)),
- ("bert-japanese", ("BertJapaneseTokenizer", None)),
- ("bertweet", ("BertweetTokenizer", None)),
- (
- "big_bird",
- (
- "BigBirdTokenizer" if is_sentencepiece_available() else None,
- "BigBirdTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("bigbird_pegasus", ("PegasusTokenizer", "PegasusTokenizerFast" if is_tokenizers_available() else None)),
- ("biogpt", ("BioGptTokenizer", None)),
- ("bitnet", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("blenderbot", ("BlenderbotTokenizer", "BlenderbotTokenizerFast")),
- ("blenderbot-small", ("BlenderbotSmallTokenizer", None)),
- ("blip", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("blip-2", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("bloom", (None, "BloomTokenizerFast" if is_tokenizers_available() else None)),
- ("blt", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("bridgetower", ("RobertaTokenizer", "RobertaTokenizerFast" if is_tokenizers_available() else None)),
- ("bros", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("byt5", ("ByT5Tokenizer", None)),
- (
- "camembert",
- (
- "CamembertTokenizer" if is_sentencepiece_available() else None,
- "CamembertTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("canine", ("CanineTokenizer", None)),
- (
- "chameleon",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("chinese_clip", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- (
- "clap",
- (
- "RobertaTokenizer",
- "RobertaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "clip",
- (
- "CLIPTokenizer",
- "CLIPTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "clipseg",
- (
- "CLIPTokenizer",
- "CLIPTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("clvp", ("ClvpTokenizer", None)),
- (
- "code_llama",
- (
- "CodeLlamaTokenizer" if is_sentencepiece_available() else None,
- "CodeLlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("codegen", ("CodeGenTokenizer", "CodeGenTokenizerFast" if is_tokenizers_available() else None)),
- ("cohere", (None, "CohereTokenizerFast" if is_tokenizers_available() else None)),
- ("cohere2", (None, "CohereTokenizerFast" if is_tokenizers_available() else None)),
- ("colpali", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("colqwen2", ("Qwen2Tokenizer", "Qwen2TokenizerFast" if is_tokenizers_available() else None)),
- ("convbert", ("ConvBertTokenizer", "ConvBertTokenizerFast" if is_tokenizers_available() else None)),
- (
- "cpm",
- (
- "CpmTokenizer" if is_sentencepiece_available() else None,
- "CpmTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("cpmant", ("CpmAntTokenizer", None)),
- ("csm", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("ctrl", ("CTRLTokenizer", None)),
- ("data2vec-audio", ("Wav2Vec2CTCTokenizer", None)),
- ("data2vec-text", ("RobertaTokenizer", "RobertaTokenizerFast" if is_tokenizers_available() else None)),
- ("dbrx", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("deberta", ("DebertaTokenizer", "DebertaTokenizerFast" if is_tokenizers_available() else None)),
- (
- "deberta-v2",
- (
- "DebertaV2Tokenizer" if is_sentencepiece_available() else None,
- "DebertaV2TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "deepseek_v2",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "deepseek_v3",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "deepseek_vl",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "deepseek_vl_hybrid",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("dia", ("DiaTokenizer", None)),
- (
- "diffllama",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("distilbert", ("DistilBertTokenizer", "DistilBertTokenizerFast" if is_tokenizers_available() else None)),
- (
- "dpr",
- (
- "DPRQuestionEncoderTokenizer",
- "DPRQuestionEncoderTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("electra", ("ElectraTokenizer", "ElectraTokenizerFast" if is_tokenizers_available() else None)),
- ("emu3", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("ernie", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("ernie4_5", (None, "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("ernie4_5_moe", (None, "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("ernie_m", ("ErnieMTokenizer" if is_sentencepiece_available() else None, None)),
- ("esm", ("EsmTokenizer", None)),
- (
- "exaone4",
- (
- "GPT2Tokenizer" if is_tokenizers_available() else None,
- "GPT2TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("falcon", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("falcon_mamba", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- (
- "fastspeech2_conformer",
- ("FastSpeech2ConformerTokenizer" if is_g2p_en_available() else None, None),
- ),
- ("flaubert", ("FlaubertTokenizer", None)),
- ("flex_olmo", (None, "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("fnet", ("FNetTokenizer", "FNetTokenizerFast" if is_tokenizers_available() else None)),
- ("fsmt", ("FSMTTokenizer", None)),
- ("funnel", ("FunnelTokenizer", "FunnelTokenizerFast" if is_tokenizers_available() else None)),
- (
- "gemma",
- (
- "GemmaTokenizer" if is_sentencepiece_available() else None,
- "GemmaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "gemma2",
- (
- "GemmaTokenizer" if is_sentencepiece_available() else None,
- "GemmaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "gemma3",
- (
- "GemmaTokenizer" if is_sentencepiece_available() else None,
- "GemmaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "gemma3_text",
- (
- "GemmaTokenizer" if is_sentencepiece_available() else None,
- "GemmaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "gemma3n",
- (
- "GemmaTokenizer" if is_sentencepiece_available() else None,
- "GemmaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "gemma3n_text",
- (
- "GemmaTokenizer" if is_sentencepiece_available() else None,
- "GemmaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("git", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("glm", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("glm4", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("glm4_moe", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("glm4v", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("glm4v_moe", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("gpt-sw3", ("GPTSw3Tokenizer" if is_sentencepiece_available() else None, None)),
- ("gpt2", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("gpt_bigcode", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("gpt_neo", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("gpt_neox", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- ("gpt_neox_japanese", ("GPTNeoXJapaneseTokenizer", None)),
- ("gpt_oss", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("gptj", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("gptsan-japanese", ("GPTSanJapaneseTokenizer", None)),
- ("granite", ("GPT2Tokenizer", None)),
- ("granitemoe", ("GPT2Tokenizer", None)),
- ("granitemoehybrid", ("GPT2Tokenizer", None)),
- ("granitemoeshared", ("GPT2Tokenizer", None)),
- ("grounding-dino", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("groupvit", ("CLIPTokenizer", "CLIPTokenizerFast" if is_tokenizers_available() else None)),
- ("helium", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("herbert", ("HerbertTokenizer", "HerbertTokenizerFast" if is_tokenizers_available() else None)),
- ("hubert", ("Wav2Vec2CTCTokenizer", None)),
- ("ibert", ("RobertaTokenizer", "RobertaTokenizerFast" if is_tokenizers_available() else None)),
- ("idefics", (None, "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("idefics2", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("idefics3", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("instructblip", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("instructblipvideo", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("internvl", ("Qwen2Tokenizer", "Qwen2TokenizerFast" if is_tokenizers_available() else None)),
- (
- "jamba",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("janus", (None, "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- (
- "jetmoe",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("jukebox", ("JukeboxTokenizer", None)),
- (
- "kosmos-2",
- (
- "XLMRobertaTokenizer" if is_sentencepiece_available() else None,
- "XLMRobertaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("kosmos-2.5", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("layoutlm", ("LayoutLMTokenizer", "LayoutLMTokenizerFast" if is_tokenizers_available() else None)),
- ("layoutlmv2", ("LayoutLMv2Tokenizer", "LayoutLMv2TokenizerFast" if is_tokenizers_available() else None)),
- ("layoutlmv3", ("LayoutLMv3Tokenizer", "LayoutLMv3TokenizerFast" if is_tokenizers_available() else None)),
- ("layoutxlm", ("LayoutXLMTokenizer", "LayoutXLMTokenizerFast" if is_tokenizers_available() else None)),
- ("led", ("LEDTokenizer", "LEDTokenizerFast" if is_tokenizers_available() else None)),
- ("lilt", ("LayoutLMv3Tokenizer", "LayoutLMv3TokenizerFast" if is_tokenizers_available() else None)),
- (
- "llama",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "llama4",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "llama4_text",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("llava", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("llava_next", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("llava_next_video", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("llava_onevision", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("longformer", ("LongformerTokenizer", "LongformerTokenizerFast" if is_tokenizers_available() else None)),
- (
- "longt5",
- (
- "T5Tokenizer" if is_sentencepiece_available() else None,
- "T5TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("luke", ("LukeTokenizer", None)),
- ("lxmert", ("LxmertTokenizer", "LxmertTokenizerFast" if is_tokenizers_available() else None)),
- ("m2m_100", ("M2M100Tokenizer" if is_sentencepiece_available() else None, None)),
- ("mamba", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- ("mamba2", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- ("marian", ("MarianTokenizer" if is_sentencepiece_available() else None, None)),
- (
- "mbart",
- (
- "MBartTokenizer" if is_sentencepiece_available() else None,
- "MBartTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "mbart50",
- (
- "MBart50Tokenizer" if is_sentencepiece_available() else None,
- "MBart50TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("mega", ("RobertaTokenizer", "RobertaTokenizerFast" if is_tokenizers_available() else None)),
- ("megatron-bert", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- (
- "metaclip_2",
- (
- "XLMRobertaTokenizer",
- "XLMRobertaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("mgp-str", ("MgpstrTokenizer", None)),
- (
- "minimax",
- (
- "GPT2Tokenizer" if is_sentencepiece_available() else None,
- "GPT2TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "ministral",
- (
- "MistralCommonTokenizer"
- if is_mistral_common_available()
- else ("LlamaTokenizer" if is_sentencepiece_available() else None),
- "LlamaTokenizerFast" if is_tokenizers_available() and not is_mistral_common_available() else None,
- ),
- ),
- (
- "mistral",
- (
- "MistralCommonTokenizer"
- if is_mistral_common_available()
- else ("LlamaTokenizer" if is_sentencepiece_available() else None),
- "LlamaTokenizerFast" if is_tokenizers_available() and not is_mistral_common_available() else None,
- ),
- ),
- (
- "mistral3",
- (
- "MistralCommonTokenizer"
- if is_mistral_common_available()
- else ("LlamaTokenizer" if is_sentencepiece_available() else None),
- "LlamaTokenizerFast" if is_tokenizers_available() and not is_mistral_common_available() else None,
- ),
- ),
- (
- "mixtral",
- (
- "MistralCommonTokenizer"
- if is_mistral_common_available()
- else ("LlamaTokenizer" if is_sentencepiece_available() else None),
- "LlamaTokenizerFast" if is_tokenizers_available() and not is_mistral_common_available() else None,
- ),
- ),
- ("mllama", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("mluke", ("MLukeTokenizer" if is_sentencepiece_available() else None, None)),
- ("mm-grounding-dino", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("mobilebert", ("MobileBertTokenizer", "MobileBertTokenizerFast" if is_tokenizers_available() else None)),
- ("modernbert", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("moonshine", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("moshi", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("mpnet", ("MPNetTokenizer", "MPNetTokenizerFast" if is_tokenizers_available() else None)),
- ("mpt", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- ("mra", ("RobertaTokenizer", "RobertaTokenizerFast" if is_tokenizers_available() else None)),
- (
- "mt5",
- (
- "MT5Tokenizer" if is_sentencepiece_available() else None,
- "MT5TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("musicgen", ("T5Tokenizer", "T5TokenizerFast" if is_tokenizers_available() else None)),
- ("musicgen_melody", ("T5Tokenizer", "T5TokenizerFast" if is_tokenizers_available() else None)),
- ("mvp", ("MvpTokenizer", "MvpTokenizerFast" if is_tokenizers_available() else None)),
- ("myt5", ("MyT5Tokenizer", None)),
- ("nemotron", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("nezha", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- (
- "nllb",
- (
- "NllbTokenizer" if is_sentencepiece_available() else None,
- "NllbTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "nllb-moe",
- (
- "NllbTokenizer" if is_sentencepiece_available() else None,
- "NllbTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "nystromformer",
- (
- "AlbertTokenizer" if is_sentencepiece_available() else None,
- "AlbertTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("olmo", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- ("olmo2", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- ("olmo3", (None, "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("olmoe", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- (
- "omdet-turbo",
- ("CLIPTokenizer", "CLIPTokenizerFast" if is_tokenizers_available() else None),
- ),
- ("oneformer", ("CLIPTokenizer", "CLIPTokenizerFast" if is_tokenizers_available() else None)),
- (
- "openai-gpt",
- ("OpenAIGPTTokenizer", "OpenAIGPTTokenizerFast" if is_tokenizers_available() else None),
- ),
- ("opt", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- ("owlv2", ("CLIPTokenizer", "CLIPTokenizerFast" if is_tokenizers_available() else None)),
- ("owlvit", ("CLIPTokenizer", "CLIPTokenizerFast" if is_tokenizers_available() else None)),
- ("paligemma", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("parakeet", ("ParakeetCTCTokenizer", None)),
- (
- "pegasus",
- (
- "PegasusTokenizer" if is_sentencepiece_available() else None,
- "PegasusTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "pegasus_x",
- (
- "PegasusTokenizer" if is_sentencepiece_available() else None,
- "PegasusTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "perceiver",
- (
- "PerceiverTokenizer",
- None,
- ),
- ),
- (
- "persimmon",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("phi", ("CodeGenTokenizer", "CodeGenTokenizerFast" if is_tokenizers_available() else None)),
- ("phi3", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("phimoe", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("phobert", ("PhobertTokenizer", None)),
- ("pix2struct", ("T5Tokenizer", "T5TokenizerFast" if is_tokenizers_available() else None)),
- (
- "pixtral",
- (
- None,
- "MistralCommonTokenizer"
- if is_mistral_common_available()
- else ("PreTrainedTokenizerFast" if is_tokenizers_available() else None),
- ),
- ),
- ("plbart", ("PLBartTokenizer" if is_sentencepiece_available() else None, None)),
- ("prophetnet", ("ProphetNetTokenizer", None)),
- ("qdqbert", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- (
- "qwen2",
- (
- "Qwen2Tokenizer",
- "Qwen2TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("qwen2_5_omni", ("Qwen2Tokenizer", "Qwen2TokenizerFast" if is_tokenizers_available() else None)),
- ("qwen2_5_vl", ("Qwen2Tokenizer", "Qwen2TokenizerFast" if is_tokenizers_available() else None)),
- ("qwen2_audio", ("Qwen2Tokenizer", "Qwen2TokenizerFast" if is_tokenizers_available() else None)),
- (
- "qwen2_moe",
- (
- "Qwen2Tokenizer",
- "Qwen2TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("qwen2_vl", ("Qwen2Tokenizer", "Qwen2TokenizerFast" if is_tokenizers_available() else None)),
- (
- "qwen3",
- (
- "Qwen2Tokenizer",
- "Qwen2TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "qwen3_moe",
- (
- "Qwen2Tokenizer",
- "Qwen2TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "qwen3_next",
- (
- "Qwen2Tokenizer",
- "Qwen2TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("qwen3_omni_moe", ("Qwen2Tokenizer", "Qwen2TokenizerFast" if is_tokenizers_available() else None)),
- ("qwen3_vl", ("Qwen2Tokenizer", "Qwen2TokenizerFast" if is_tokenizers_available() else None)),
- ("qwen3_vl_moe", ("Qwen2Tokenizer", "Qwen2TokenizerFast" if is_tokenizers_available() else None)),
- ("rag", ("RagTokenizer", None)),
- ("realm", ("RealmTokenizer", "RealmTokenizerFast" if is_tokenizers_available() else None)),
- (
- "recurrent_gemma",
- (
- "GemmaTokenizer" if is_sentencepiece_available() else None,
- "GemmaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "reformer",
- (
- "ReformerTokenizer" if is_sentencepiece_available() else None,
- "ReformerTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "rembert",
- (
- "RemBertTokenizer" if is_sentencepiece_available() else None,
- "RemBertTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("retribert", ("RetriBertTokenizer", "RetriBertTokenizerFast" if is_tokenizers_available() else None)),
- ("roberta", ("RobertaTokenizer", "RobertaTokenizerFast" if is_tokenizers_available() else None)),
- (
- "roberta-prelayernorm",
- ("RobertaTokenizer", "RobertaTokenizerFast" if is_tokenizers_available() else None),
- ),
- ("roc_bert", ("RoCBertTokenizer", None)),
- ("roformer", ("RoFormerTokenizer", "RoFormerTokenizerFast" if is_tokenizers_available() else None)),
- ("rwkv", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- (
- "seamless_m4t",
- (
- "SeamlessM4TTokenizer" if is_sentencepiece_available() else None,
- "SeamlessM4TTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "seamless_m4t_v2",
- (
- "SeamlessM4TTokenizer" if is_sentencepiece_available() else None,
- "SeamlessM4TTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "shieldgemma2",
- (
- "GemmaTokenizer" if is_sentencepiece_available() else None,
- "GemmaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("siglip", ("SiglipTokenizer" if is_sentencepiece_available() else None, None)),
- (
- "siglip2",
- (
- "GemmaTokenizer" if is_sentencepiece_available() else None,
- "GemmaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("smollm3", (None, "PreTrainedTokenizerFast" if is_tokenizers_available() else None)),
- ("speech_to_text", ("Speech2TextTokenizer" if is_sentencepiece_available() else None, None)),
- ("speech_to_text_2", ("Speech2Text2Tokenizer", None)),
- ("speecht5", ("SpeechT5Tokenizer" if is_sentencepiece_available() else None, None)),
- ("splinter", ("SplinterTokenizer", "SplinterTokenizerFast")),
- (
- "squeezebert",
- ("SqueezeBertTokenizer", "SqueezeBertTokenizerFast" if is_tokenizers_available() else None),
- ),
- ("stablelm", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- ("starcoder2", ("GPT2Tokenizer", "GPT2TokenizerFast" if is_tokenizers_available() else None)),
- (
- "switch_transformers",
- (
- "T5Tokenizer" if is_sentencepiece_available() else None,
- "T5TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "t5",
- (
- "T5Tokenizer" if is_sentencepiece_available() else None,
- "T5TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "t5gemma",
- (
- "GemmaTokenizer" if is_sentencepiece_available() else None,
- "GemmaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("tapas", ("TapasTokenizer", None)),
- ("tapex", ("TapexTokenizer", None)),
- ("transfo-xl", ("TransfoXLTokenizer", None)),
- ("tvp", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- (
- "udop",
- (
- "UdopTokenizer" if is_sentencepiece_available() else None,
- "UdopTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "umt5",
- (
- "T5Tokenizer" if is_sentencepiece_available() else None,
- "T5TokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("video_llava", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("vilt", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("vipllava", ("LlamaTokenizer", "LlamaTokenizerFast" if is_tokenizers_available() else None)),
- ("visual_bert", ("BertTokenizer", "BertTokenizerFast" if is_tokenizers_available() else None)),
- ("vits", ("VitsTokenizer", None)),
- (
- "voxtral",
- (
- "MistralCommonTokenizer" if is_mistral_common_available() else None,
- "PreTrainedTokenizerFast" if is_tokenizers_available() and not is_mistral_common_available() else None,
- ),
- ),
- ("wav2vec2", ("Wav2Vec2CTCTokenizer", None)),
- ("wav2vec2-bert", ("Wav2Vec2CTCTokenizer", None)),
- ("wav2vec2-conformer", ("Wav2Vec2CTCTokenizer", None)),
- ("wav2vec2_phoneme", ("Wav2Vec2PhonemeCTCTokenizer", None)),
- ("whisper", ("WhisperTokenizer", "WhisperTokenizerFast" if is_tokenizers_available() else None)),
- ("xclip", ("CLIPTokenizer", "CLIPTokenizerFast" if is_tokenizers_available() else None)),
- (
- "xglm",
- (
- "XGLMTokenizer" if is_sentencepiece_available() else None,
- "XGLMTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("xlm", ("XLMTokenizer", None)),
- ("xlm-prophetnet", ("XLMProphetNetTokenizer" if is_sentencepiece_available() else None, None)),
- (
- "xlm-roberta",
- (
- "XLMRobertaTokenizer" if is_sentencepiece_available() else None,
- "XLMRobertaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "xlm-roberta-xl",
- (
- "XLMRobertaTokenizer" if is_sentencepiece_available() else None,
- "XLMRobertaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "xlnet",
- (
- "XLNetTokenizer" if is_sentencepiece_available() else None,
- "XLNetTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ("xlstm", (None, "GPTNeoXTokenizerFast" if is_tokenizers_available() else None)),
- (
- "xmod",
- (
- "XLMRobertaTokenizer" if is_sentencepiece_available() else None,
- "XLMRobertaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "yoso",
- (
- "AlbertTokenizer" if is_sentencepiece_available() else None,
- "AlbertTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "zamba",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- (
- "zamba2",
- (
- "LlamaTokenizer" if is_sentencepiece_available() else None,
- "LlamaTokenizerFast" if is_tokenizers_available() else None,
- ),
- ),
- ]
- )
- TOKENIZER_MAPPING = _LazyAutoMapping(CONFIG_MAPPING_NAMES, TOKENIZER_MAPPING_NAMES)
- CONFIG_TO_TYPE = {v: k for k, v in CONFIG_MAPPING_NAMES.items()}
- def tokenizer_class_from_name(class_name: str) -> Union[type[Any], None]:
- if class_name == "PreTrainedTokenizerFast":
- return PreTrainedTokenizerFast
- for module_name, tokenizers in TOKENIZER_MAPPING_NAMES.items():
- if class_name in tokenizers:
- module_name = model_type_to_module_name(module_name)
- if module_name in ["mistral", "mixtral", "ministral"] and class_name == "MistralCommonTokenizer":
- module = importlib.import_module(".tokenization_mistral_common", "transformers")
- else:
- module = importlib.import_module(f".{module_name}", "transformers.models")
- try:
- return getattr(module, class_name)
- except AttributeError:
- continue
- for tokenizers in TOKENIZER_MAPPING._extra_content.values():
- for tokenizer in tokenizers:
- if getattr(tokenizer, "__name__", None) == class_name:
- return tokenizer
- # We did not fine the class, but maybe it's because a dep is missing. In that case, the class will be in the main
- # init and we return the proper dummy to get an appropriate error message.
- main_module = importlib.import_module("transformers")
- if hasattr(main_module, class_name):
- return getattr(main_module, class_name)
- return None
- def get_tokenizer_config(
- pretrained_model_name_or_path: Union[str, os.PathLike[str]],
- cache_dir: Optional[Union[str, os.PathLike[str]]] = None,
- force_download: bool = False,
- resume_download: Optional[bool] = None,
- proxies: Optional[dict[str, str]] = None,
- token: Optional[Union[bool, str]] = None,
- revision: Optional[str] = None,
- local_files_only: bool = False,
- subfolder: str = "",
- **kwargs,
- ) -> dict[str, Any]:
- """
- Loads the tokenizer configuration from a pretrained model tokenizer configuration.
- Args:
- pretrained_model_name_or_path (`str` or `os.PathLike`):
- This can be either:
- - a string, the *model id* of a pretrained model configuration hosted inside a model repo on
- huggingface.co.
- - a path to a *directory* containing a configuration file saved using the
- [`~PreTrainedTokenizer.save_pretrained`] method, e.g., `./my_model_directory/`.
- cache_dir (`str` or `os.PathLike`, *optional*):
- Path to a directory in which a downloaded pretrained model configuration should be cached if the standard
- cache should not be used.
- force_download (`bool`, *optional*, defaults to `False`):
- Whether or not to force to (re-)download the configuration files and override the cached versions if they
- exist.
- resume_download:
- Deprecated and ignored. All downloads are now resumed by default when possible.
- Will be removed in v5 of Transformers.
- proxies (`dict[str, str]`, *optional*):
- A dictionary of proxy servers to use by protocol or endpoint, e.g., `{'http': 'foo.bar:3128',
- 'http://hostname': 'foo.bar:4012'}.` The proxies are used on each request.
- token (`str` or *bool*, *optional*):
- The token to use as HTTP bearer authorization for remote files. If `True`, will use the token generated
- when running `hf auth login` (stored in `~/.huggingface`).
- revision (`str`, *optional*, defaults to `"main"`):
- The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
- git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any
- identifier allowed by git.
- local_files_only (`bool`, *optional*, defaults to `False`):
- If `True`, will only try to load the tokenizer configuration from local files.
- subfolder (`str`, *optional*, defaults to `""`):
- In case the tokenizer config is located inside a subfolder of the model repo on huggingface.co, you can
- specify the folder name here.
- <Tip>
- Passing `token=True` is required when you want to use a private model.
- </Tip>
- Returns:
- `dict`: The configuration of the tokenizer.
- Examples:
- ```python
- # Download configuration from huggingface.co and cache.
- tokenizer_config = get_tokenizer_config("google-bert/bert-base-uncased")
- # This model does not have a tokenizer config so the result will be an empty dict.
- tokenizer_config = get_tokenizer_config("FacebookAI/xlm-roberta-base")
- # Save a pretrained tokenizer locally and you can reload its config
- from transformers import AutoTokenizer
- tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-cased")
- tokenizer.save_pretrained("tokenizer-test")
- tokenizer_config = get_tokenizer_config("tokenizer-test")
- ```"""
- use_auth_token = kwargs.pop("use_auth_token", None)
- if use_auth_token is not None:
- warnings.warn(
- "The `use_auth_token` argument is deprecated and will be removed in v5 of Transformers. Please use `token` instead.",
- FutureWarning,
- )
- if token is not None:
- raise ValueError("`token` and `use_auth_token` are both specified. Please set only the argument `token`.")
- token = use_auth_token
- commit_hash = kwargs.get("_commit_hash")
- resolved_config_file = cached_file(
- pretrained_model_name_or_path,
- TOKENIZER_CONFIG_FILE,
- cache_dir=cache_dir,
- force_download=force_download,
- resume_download=resume_download,
- proxies=proxies,
- token=token,
- revision=revision,
- local_files_only=local_files_only,
- subfolder=subfolder,
- _raise_exceptions_for_gated_repo=False,
- _raise_exceptions_for_missing_entries=False,
- _raise_exceptions_for_connection_errors=False,
- _commit_hash=commit_hash,
- )
- if resolved_config_file is None:
- logger.info("Could not locate the tokenizer configuration file, will try to use the model config instead.")
- return {}
- commit_hash = extract_commit_hash(resolved_config_file, commit_hash)
- with open(resolved_config_file, encoding="utf-8") as reader:
- result = json.load(reader)
- result["_commit_hash"] = commit_hash
- return result
- class AutoTokenizer:
- r"""
- This is a generic tokenizer class that will be instantiated as one of the tokenizer classes of the library when
- created with the [`AutoTokenizer.from_pretrained`] class method.
- This class cannot be instantiated directly using `__init__()` (throws an error).
- """
- def __init__(self):
- raise OSError(
- "AutoTokenizer is designed to be instantiated "
- "using the `AutoTokenizer.from_pretrained(pretrained_model_name_or_path)` method."
- )
- @classmethod
- @replace_list_option_in_docstrings(TOKENIZER_MAPPING_NAMES)
- def from_pretrained(cls, pretrained_model_name_or_path, *inputs, **kwargs):
- r"""
- Instantiate one of the tokenizer classes of the library from a pretrained model vocabulary.
- The tokenizer class to instantiate is selected based on the `model_type` property of the config object (either
- passed as an argument or loaded from `pretrained_model_name_or_path` if possible), or when it's missing, by
- falling back to using pattern matching on `pretrained_model_name_or_path`:
- List options
- Params:
- pretrained_model_name_or_path (`str` or `os.PathLike`):
- Can be either:
- - A string, the *model id* of a predefined tokenizer hosted inside a model repo on huggingface.co.
- - A path to a *directory* containing vocabulary files required by the tokenizer, for instance saved
- using the [`~PreTrainedTokenizer.save_pretrained`] method, e.g., `./my_model_directory/`.
- - A path or url to a single saved vocabulary file if and only if the tokenizer only requires a
- single vocabulary file (like Bert or XLNet), e.g.: `./my_model_directory/vocab.txt`. (Not
- applicable to all derived classes)
- inputs (additional positional arguments, *optional*):
- Will be passed along to the Tokenizer `__init__()` method.
- config ([`PretrainedConfig`], *optional*)
- The configuration object used to determine the tokenizer class to instantiate.
- cache_dir (`str` or `os.PathLike`, *optional*):
- Path to a directory in which a downloaded pretrained model configuration should be cached if the
- standard cache should not be used.
- force_download (`bool`, *optional*, defaults to `False`):
- Whether or not to force the (re-)download the model weights and configuration files and override the
- cached versions if they exist.
- resume_download:
- Deprecated and ignored. All downloads are now resumed by default when possible.
- Will be removed in v5 of Transformers.
- proxies (`dict[str, str]`, *optional*):
- A dictionary of proxy servers to use by protocol or endpoint, e.g., `{'http': 'foo.bar:3128',
- 'http://hostname': 'foo.bar:4012'}`. The proxies are used on each request.
- revision (`str`, *optional*, defaults to `"main"`):
- The specific model version to use. It can be a branch name, a tag name, or a commit id, since we use a
- git-based system for storing models and other artifacts on huggingface.co, so `revision` can be any
- identifier allowed by git.
- subfolder (`str`, *optional*):
- In case the relevant files are located inside a subfolder of the model repo on huggingface.co (e.g. for
- facebook/rag-token-base), specify it here.
- use_fast (`bool`, *optional*, defaults to `True`):
- Use a [fast Rust-based tokenizer](https://huggingface.co/docs/tokenizers/index) if it is supported for
- a given model. If a fast tokenizer is not available for a given model, a normal Python-based tokenizer
- is returned instead.
- tokenizer_type (`str`, *optional*):
- Tokenizer type to be loaded.
- trust_remote_code (`bool`, *optional*, defaults to `False`):
- Whether or not to allow for custom models defined on the Hub in their own modeling files. This option
- should only be set to `True` for repositories you trust and in which you have read the code, as it will
- execute code present on the Hub on your local machine.
- kwargs (additional keyword arguments, *optional*):
- Will be passed to the Tokenizer `__init__()` method. Can be used to set special tokens like
- `bos_token`, `eos_token`, `unk_token`, `sep_token`, `pad_token`, `cls_token`, `mask_token`,
- `additional_special_tokens`. See parameters in the `__init__()` for more details.
- Examples:
- ```python
- >>> from transformers import AutoTokenizer
- >>> # Download vocabulary from huggingface.co and cache.
- >>> tokenizer = AutoTokenizer.from_pretrained("google-bert/bert-base-uncased")
- >>> # Download vocabulary from huggingface.co (user-uploaded) and cache.
- >>> tokenizer = AutoTokenizer.from_pretrained("dbmdz/bert-base-german-cased")
- >>> # If vocabulary files are in a directory (e.g. tokenizer was saved using *save_pretrained('./test/saved_model/')*)
- >>> # tokenizer = AutoTokenizer.from_pretrained("./test/bert_saved_model/")
- >>> # Download vocabulary from huggingface.co and define model-specific arguments
- >>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base", add_prefix_space=True)
- ```"""
- use_auth_token = kwargs.pop("use_auth_token", None)
- if use_auth_token is not None:
- warnings.warn(
- "The `use_auth_token` argument is deprecated and will be removed in v5 of Transformers. Please use `token` instead.",
- FutureWarning,
- )
- if kwargs.get("token") is not None:
- raise ValueError(
- "`token` and `use_auth_token` are both specified. Please set only the argument `token`."
- )
- kwargs["token"] = use_auth_token
- config = kwargs.pop("config", None)
- kwargs["_from_auto"] = True
- use_fast = kwargs.pop("use_fast", True)
- tokenizer_type = kwargs.pop("tokenizer_type", None)
- trust_remote_code = kwargs.pop("trust_remote_code", None)
- gguf_file = kwargs.get("gguf_file")
- # First, let's see whether the tokenizer_type is passed so that we can leverage it
- if tokenizer_type is not None:
- tokenizer_class = None
- tokenizer_class_tuple = TOKENIZER_MAPPING_NAMES.get(tokenizer_type, None)
- if tokenizer_class_tuple is None:
- raise ValueError(
- f"Passed `tokenizer_type` {tokenizer_type} does not exist. `tokenizer_type` should be one of "
- f"{', '.join(c for c in TOKENIZER_MAPPING_NAMES)}."
- )
- tokenizer_class_name, tokenizer_fast_class_name = tokenizer_class_tuple
- if use_fast:
- if tokenizer_fast_class_name is not None:
- tokenizer_class = tokenizer_class_from_name(tokenizer_fast_class_name)
- else:
- logger.warning(
- "`use_fast` is set to `True` but the tokenizer class does not have a fast version. "
- " Falling back to the slow version."
- )
- if tokenizer_class is None:
- tokenizer_class = tokenizer_class_from_name(tokenizer_class_name)
- if tokenizer_class is None:
- raise ValueError(f"Tokenizer class {tokenizer_class_name} is not currently imported.")
- return tokenizer_class.from_pretrained(pretrained_model_name_or_path, *inputs, **kwargs)
- # Next, let's try to use the tokenizer_config file to get the tokenizer class.
- tokenizer_config = get_tokenizer_config(pretrained_model_name_or_path, **kwargs)
- if "_commit_hash" in tokenizer_config:
- kwargs["_commit_hash"] = tokenizer_config["_commit_hash"]
- config_tokenizer_class = tokenizer_config.get("tokenizer_class")
- tokenizer_auto_map = None
- if "auto_map" in tokenizer_config:
- if isinstance(tokenizer_config["auto_map"], (tuple, list)):
- # Legacy format for dynamic tokenizers
- tokenizer_auto_map = tokenizer_config["auto_map"]
- else:
- tokenizer_auto_map = tokenizer_config["auto_map"].get("AutoTokenizer", None)
- # If that did not work, let's try to use the config.
- if config_tokenizer_class is None:
- if not isinstance(config, PretrainedConfig):
- if gguf_file:
- gguf_path = cached_file(pretrained_model_name_or_path, gguf_file, **kwargs)
- config_dict = load_gguf_checkpoint(gguf_path, return_tensors=False)["config"]
- config = AutoConfig.for_model(**config_dict)
- else:
- config = AutoConfig.from_pretrained(
- pretrained_model_name_or_path, trust_remote_code=trust_remote_code, **kwargs
- )
- config_tokenizer_class = config.tokenizer_class
- if hasattr(config, "auto_map") and "AutoTokenizer" in config.auto_map:
- tokenizer_auto_map = config.auto_map["AutoTokenizer"]
- has_remote_code = tokenizer_auto_map is not None
- has_local_code = type(config) in TOKENIZER_MAPPING or (
- config_tokenizer_class is not None
- and (
- tokenizer_class_from_name(config_tokenizer_class) is not None
- or tokenizer_class_from_name(config_tokenizer_class + "Fast") is not None
- )
- )
- if has_remote_code:
- if use_fast and tokenizer_auto_map[1] is not None:
- class_ref = tokenizer_auto_map[1]
- else:
- class_ref = tokenizer_auto_map[0]
- if "--" in class_ref:
- upstream_repo = class_ref.split("--")[0]
- else:
- upstream_repo = None
- trust_remote_code = resolve_trust_remote_code(
- trust_remote_code, pretrained_model_name_or_path, has_local_code, has_remote_code, upstream_repo
- )
- if has_remote_code and trust_remote_code:
- tokenizer_class = get_class_from_dynamic_module(class_ref, pretrained_model_name_or_path, **kwargs)
- _ = kwargs.pop("code_revision", None)
- tokenizer_class.register_for_auto_class()
- return tokenizer_class.from_pretrained(
- pretrained_model_name_or_path, *inputs, trust_remote_code=trust_remote_code, **kwargs
- )
- elif config_tokenizer_class is not None:
- tokenizer_class = None
- if use_fast and not config_tokenizer_class.endswith("Fast"):
- tokenizer_class_candidate = f"{config_tokenizer_class}Fast"
- tokenizer_class = tokenizer_class_from_name(tokenizer_class_candidate)
- if tokenizer_class is None:
- tokenizer_class_candidate = config_tokenizer_class
- tokenizer_class = tokenizer_class_from_name(tokenizer_class_candidate)
- if tokenizer_class is None:
- raise ValueError(
- f"Tokenizer class {tokenizer_class_candidate} does not exist or is not currently imported."
- )
- return tokenizer_class.from_pretrained(pretrained_model_name_or_path, *inputs, **kwargs)
- # Otherwise we have to be creative.
- # if model is an encoder decoder, the encoder tokenizer class is used by default
- if isinstance(config, EncoderDecoderConfig):
- if type(config.decoder) is not type(config.encoder):
- logger.warning(
- f"The encoder model config class: {config.encoder.__class__} is different from the decoder model "
- f"config class: {config.decoder.__class__}. It is not recommended to use the "
- "`AutoTokenizer.from_pretrained()` method in this case. Please use the encoder and decoder "
- "specific tokenizer classes."
- )
- config = config.encoder
- model_type = config_class_to_model_type(type(config).__name__)
- if model_type is not None:
- tokenizer_class_py, tokenizer_class_fast = TOKENIZER_MAPPING[type(config)]
- if tokenizer_class_fast and (use_fast or tokenizer_class_py is None):
- return tokenizer_class_fast.from_pretrained(pretrained_model_name_or_path, *inputs, **kwargs)
- else:
- if tokenizer_class_py is not None:
- return tokenizer_class_py.from_pretrained(pretrained_model_name_or_path, *inputs, **kwargs)
- else:
- raise ValueError(
- "This tokenizer cannot be instantiated. Please make sure you have `sentencepiece` installed "
- "in order to use this tokenizer."
- )
- raise ValueError(
- f"Unrecognized configuration class {config.__class__} to build an AutoTokenizer.\n"
- f"Model type should be one of {', '.join(c.__name__ for c in TOKENIZER_MAPPING)}."
- )
- @staticmethod
- def register(config_class, slow_tokenizer_class=None, fast_tokenizer_class=None, exist_ok=False):
- """
- Register a new tokenizer in this mapping.
- Args:
- config_class ([`PretrainedConfig`]):
- The configuration corresponding to the model to register.
- slow_tokenizer_class ([`PretrainedTokenizer`], *optional*):
- The slow tokenizer to register.
- fast_tokenizer_class ([`PretrainedTokenizerFast`], *optional*):
- The fast tokenizer to register.
- """
- if slow_tokenizer_class is None and fast_tokenizer_class is None:
- raise ValueError("You need to pass either a `slow_tokenizer_class` or a `fast_tokenizer_class")
- if slow_tokenizer_class is not None and issubclass(slow_tokenizer_class, PreTrainedTokenizerFast):
- raise ValueError("You passed a fast tokenizer in the `slow_tokenizer_class`.")
- if fast_tokenizer_class is not None and issubclass(fast_tokenizer_class, PreTrainedTokenizer):
- raise ValueError("You passed a slow tokenizer in the `fast_tokenizer_class`.")
- if (
- slow_tokenizer_class is not None
- and fast_tokenizer_class is not None
- and issubclass(fast_tokenizer_class, PreTrainedTokenizerFast)
- and fast_tokenizer_class.slow_tokenizer_class != slow_tokenizer_class
- ):
- raise ValueError(
- "The fast tokenizer class you are passing has a `slow_tokenizer_class` attribute that is not "
- "consistent with the slow tokenizer class you passed (fast tokenizer has "
- f"{fast_tokenizer_class.slow_tokenizer_class} and you passed {slow_tokenizer_class}. Fix one of those "
- "so they match!"
- )
- # Avoid resetting a set slow/fast tokenizer if we are passing just the other ones.
- if config_class in TOKENIZER_MAPPING._extra_content:
- existing_slow, existing_fast = TOKENIZER_MAPPING[config_class]
- if slow_tokenizer_class is None:
- slow_tokenizer_class = existing_slow
- if fast_tokenizer_class is None:
- fast_tokenizer_class = existing_fast
- TOKENIZER_MAPPING.register(config_class, (slow_tokenizer_class, fast_tokenizer_class), exist_ok=exist_ok)
- __all__ = ["TOKENIZER_MAPPING", "AutoTokenizer"]
|