Skip to content

vllm.transformers_utils.tokenizer_base

TokenizerBase

Bases: ABC

Source code in vllm/transformers_utils/tokenizer_base.py 
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
class TokenizerBase(ABC):
    @property
    @abstractmethod
    def all_special_tokens_extended(self) -> list[str]:
        raise NotImplementedError()

    @property
    @abstractmethod
    def all_special_tokens(self) -> list[str]:
        raise NotImplementedError()

    @property
    @abstractmethod
    def all_special_ids(self) -> list[int]:
        raise NotImplementedError()

    @property
    @abstractmethod
    def bos_token_id(self) -> int:
        raise NotImplementedError()

    @property
    @abstractmethod
    def eos_token_id(self) -> int:
        raise NotImplementedError()

    @property
    @abstractmethod
    def sep_token(self) -> str:
        raise NotImplementedError()

    @property
    @abstractmethod
    def pad_token(self) -> str:
        raise NotImplementedError()

    @property
    @abstractmethod
    def is_fast(self) -> bool:
        raise NotImplementedError()

    @property
    @abstractmethod
    def vocab_size(self) -> int:
        raise NotImplementedError()

    @property
    @abstractmethod
    def max_token_id(self) -> int:
        raise NotImplementedError()

    @property
    @abstractmethod
    def truncation_side(self) -> str:
        raise NotImplementedError()

    def __len__(self) -> int:
        return self.vocab_size

    @abstractmethod
    def __call__(
        self,
        text: str | list[str] | list[int],
        text_pair: str | None = None,
        add_special_tokens: bool = False,
        truncation: bool = False,
        max_length: int | None = None,
    ):
        raise NotImplementedError()

    @abstractmethod
    def get_vocab(self) -> dict[str, int]:
        raise NotImplementedError()

    @abstractmethod
    def get_added_vocab(self) -> dict[str, int]:
        raise NotImplementedError()

    @abstractmethod
    def encode_one(
        self,
        text: str,
        truncation: bool = False,
        max_length: int | None = None,
    ) -> list[int]:
        raise NotImplementedError()

    @abstractmethod
    def encode(
        self,
        text: str,
        truncation: bool | None = None,
        max_length: int | None = None,
        add_special_tokens: bool | None = None,
    ) -> list[int]:
        raise NotImplementedError()

    @abstractmethod
    def apply_chat_template(
        self,
        messages: list["ChatCompletionMessageParam"],
        tools: list[dict[str, Any]] | None = None,
        **kwargs,
    ) -> list[int]:
        raise NotImplementedError()

    @abstractmethod
    def convert_tokens_to_string(self, tokens: list[str]) -> str:
        raise NotImplementedError()

    @abstractmethod
    def decode(self, ids: list[int] | int, skip_special_tokens: bool = True) -> str:
        raise NotImplementedError()

    @abstractmethod
    def convert_ids_to_tokens(
        self,
        ids: list[int],
        skip_special_tokens: bool = True,
    ) -> list[str]:
        raise NotImplementedError()

all_special_ids abstractmethod property 

all_special_ids: list[int]

all_special_tokens abstractmethod property 

all_special_tokens: list[str]

all_special_tokens_extended abstractmethod property 

all_special_tokens_extended: list[str]

bos_token_id abstractmethod property 

bos_token_id: int

eos_token_id abstractmethod property 

eos_token_id: int

is_fast abstractmethod property 

is_fast: bool

max_token_id abstractmethod property 

max_token_id: int

pad_token abstractmethod property 

pad_token: str

sep_token abstractmethod property 

sep_token: str

truncation_side abstractmethod property 

truncation_side: str

vocab_size abstractmethod property 

vocab_size: int

__call__ abstractmethod 

__call__(
    text: str | list[str] | list[int],
    text_pair: str | None = None,
    add_special_tokens: bool = False,
    truncation: bool = False,
    max_length: int | None = None,
)
Source code in vllm/transformers_utils/tokenizer_base.py 
71
72
73
74
75
76
77
78
79
80
@abstractmethod
def __call__(
    self,
    text: str | list[str] | list[int],
    text_pair: str | None = None,
    add_special_tokens: bool = False,
    truncation: bool = False,
    max_length: int | None = None,
):
    raise NotImplementedError()

__len__ 

__len__() -> int
Source code in vllm/transformers_utils/tokenizer_base.py 
68
69
def __len__(self) -> int:
    return self.vocab_size

apply_chat_template abstractmethod 

apply_chat_template(
    messages: list[ChatCompletionMessageParam],
    tools: list[dict[str, Any]] | None = None,
    **kwargs,
) -> list[int]
Source code in vllm/transformers_utils/tokenizer_base.py 
109
110
111
112
113
114
115
116
@abstractmethod
def apply_chat_template(
    self,
    messages: list["ChatCompletionMessageParam"],
    tools: list[dict[str, Any]] | None = None,
    **kwargs,
) -> list[int]:
    raise NotImplementedError()

convert_ids_to_tokens abstractmethod 

convert_ids_to_tokens(
    ids: list[int], skip_special_tokens: bool = True
) -> list[str]
Source code in vllm/transformers_utils/tokenizer_base.py 
126
127
128
129
130
131
132
@abstractmethod
def convert_ids_to_tokens(
    self,
    ids: list[int],
    skip_special_tokens: bool = True,
) -> list[str]:
    raise NotImplementedError()

convert_tokens_to_string abstractmethod 

convert_tokens_to_string(tokens: list[str]) -> str
Source code in vllm/transformers_utils/tokenizer_base.py 
118
119
120
@abstractmethod
def convert_tokens_to_string(self, tokens: list[str]) -> str:
    raise NotImplementedError()

decode abstractmethod 

decode(
    ids: list[int] | int, skip_special_tokens: bool = True
) -> str
Source code in vllm/transformers_utils/tokenizer_base.py 
122
123
124
@abstractmethod
def decode(self, ids: list[int] | int, skip_special_tokens: bool = True) -> str:
    raise NotImplementedError()

encode abstractmethod 

encode(
    text: str,
    truncation: bool | None = None,
    max_length: int | None = None,
    add_special_tokens: bool | None = None,
) -> list[int]
Source code in vllm/transformers_utils/tokenizer_base.py 
 99
100
101
102
103
104
105
106
107
@abstractmethod
def encode(
    self,
    text: str,
    truncation: bool | None = None,
    max_length: int | None = None,
    add_special_tokens: bool | None = None,
) -> list[int]:
    raise NotImplementedError()

encode_one abstractmethod 

encode_one(
    text: str,
    truncation: bool = False,
    max_length: int | None = None,
) -> list[int]
Source code in vllm/transformers_utils/tokenizer_base.py 
90
91
92
93
94
95
96
97
@abstractmethod
def encode_one(
    self,
    text: str,
    truncation: bool = False,
    max_length: int | None = None,
) -> list[int]:
    raise NotImplementedError()

get_added_vocab abstractmethod 

get_added_vocab() -> dict[str, int]
Source code in vllm/transformers_utils/tokenizer_base.py 
86
87
88
@abstractmethod
def get_added_vocab(self) -> dict[str, int]:
    raise NotImplementedError()

get_vocab abstractmethod 

get_vocab() -> dict[str, int]
Source code in vllm/transformers_utils/tokenizer_base.py 
82
83
84
@abstractmethod
def get_vocab(self) -> dict[str, int]:
    raise NotImplementedError()

TokenizerRegistry

Source code in vllm/transformers_utils/tokenizer_base.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
class TokenizerRegistry:
    # Tokenizer name -> (tokenizer module, tokenizer class)
    REGISTRY: dict[str, tuple[str, str]] = {}

    @staticmethod
    def register(name: str, module: str, class_name: str) -> None:
        TokenizerRegistry.REGISTRY[name] = (module, class_name)

    @staticmethod
    def get_tokenizer(
        tokenizer_name: str,
        *args,
        **kwargs,
    ) -> TokenizerBase:
        tokenizer_cls = TokenizerRegistry.REGISTRY.get(tokenizer_name)
        if tokenizer_cls is None:
            raise ValueError(f"Tokenizer {tokenizer_name} not found.")

        tokenizer_module = importlib.import_module(tokenizer_cls[0])
        class_ = getattr(tokenizer_module, tokenizer_cls[1])
        return class_.from_pretrained(*args, **kwargs)

REGISTRY class-attribute instance-attribute 

REGISTRY: dict[str, tuple[str, str]] = {}

get_tokenizer staticmethod 

get_tokenizer(
    tokenizer_name: str, *args, **kwargs
) -> TokenizerBase
Source code in vllm/transformers_utils/tokenizer_base.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
@staticmethod
def get_tokenizer(
    tokenizer_name: str,
    *args,
    **kwargs,
) -> TokenizerBase:
    tokenizer_cls = TokenizerRegistry.REGISTRY.get(tokenizer_name)
    if tokenizer_cls is None:
        raise ValueError(f"Tokenizer {tokenizer_name} not found.")

    tokenizer_module = importlib.import_module(tokenizer_cls[0])
    class_ = getattr(tokenizer_module, tokenizer_cls[1])
    return class_.from_pretrained(*args, **kwargs)

register staticmethod 

register(name: str, module: str, class_name: str) -> None
Source code in vllm/transformers_utils/tokenizer_base.py 
139
140
141
@staticmethod
def register(name: str, module: str, class_name: str) -> None:
    TokenizerRegistry.REGISTRY[name] = (module, class_name)