Skip to content

vllm.tokenizers.protocol

TokenizerLike

Bases: Protocol

Source code in vllm/tokenizers/protocol.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
class TokenizerLike(Protocol):
    @classmethod
    def from_pretrained(
        cls,
        path_or_repo_id: str | Path,
        *args,
        trust_remote_code: bool = False,
        revision: str | None = None,
        download_dir: str | None = None,
        **kwargs,
    ) -> "TokenizerLike":
        raise NotImplementedError

    def num_special_tokens_to_add(self) -> int:
        raise NotImplementedError

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

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

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

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

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

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

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

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

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

    def __hash__(self) -> int:
        return hash(id(self))

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

    def __call__(
        self,
        text: str | list[str],
        text_pair: str | None = None,
        add_special_tokens: bool = True,
        truncation: bool = False,
        max_length: int | None = None,
    ) -> "BatchEncoding":
        raise NotImplementedError

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

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

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

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

    @overload
    def convert_tokens_to_ids(self, tokens: str) -> int: ...

    @overload
    def convert_tokens_to_ids(self, tokens: list[str]) -> list[int]: ...

    def convert_tokens_to_ids(self, tokens: str | list[str]) -> int | list[int]:
        raise NotImplementedError

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

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

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

all_special_ids property 

all_special_ids: list[int]

all_special_tokens property 

all_special_tokens: list[str]

bos_token_id property 

bos_token_id: int

eos_token_id property 

eos_token_id: int

is_fast property 

is_fast: bool

max_token_id property 

max_token_id: int

pad_token_id property 

pad_token_id: int

truncation_side property 

truncation_side: str

vocab_size property 

vocab_size: int

__call__ 

__call__(
    text: str | list[str],
    text_pair: str | None = None,
    add_special_tokens: bool = True,
    truncation: bool = False,
    max_length: int | None = None,
) -> BatchEncoding
Source code in vllm/tokenizers/protocol.py 
70
71
72
73
74
75
76
77
78
def __call__(
    self,
    text: str | list[str],
    text_pair: str | None = None,
    add_special_tokens: bool = True,
    truncation: bool = False,
    max_length: int | None = None,
) -> "BatchEncoding":
    raise NotImplementedError

__hash__ 

__hash__() -> int
Source code in vllm/tokenizers/protocol.py 
64
65
def __hash__(self) -> int:
    return hash(id(self))

__len__ 

__len__() -> int
Source code in vllm/tokenizers/protocol.py 
67
68
def __len__(self) -> int:
    return self.vocab_size

apply_chat_template 

apply_chat_template(
    messages: list[ChatCompletionMessageParam],
    tools: list[dict[str, Any]] | None = None,
    **kwargs,
) -> str | list[int]
Source code in vllm/tokenizers/protocol.py 
 95
 96
 97
 98
 99
100
101
def apply_chat_template(
    self,
    messages: list["ChatCompletionMessageParam"],
    tools: list[dict[str, Any]] | None = None,
    **kwargs,
) -> str | list[int]:
    raise NotImplementedError

convert_ids_to_tokens 

convert_ids_to_tokens(
    ids: list[int], skip_special_tokens: bool = False
) -> list[str]
Source code in vllm/tokenizers/protocol.py 
118
119
120
121
122
123
def convert_ids_to_tokens(
    self,
    ids: list[int],
    skip_special_tokens: bool = False,
) -> list[str]:
    raise NotImplementedError

convert_tokens_to_ids 

convert_tokens_to_ids(tokens: str) -> int

convert_tokens_to_ids(tokens: list[str]) -> list[int]

convert_tokens_to_ids(
    tokens: str | list[str],
) -> int | list[int]
Source code in vllm/tokenizers/protocol.py 
109
110
def convert_tokens_to_ids(self, tokens: str | list[str]) -> int | list[int]:
    raise NotImplementedError

convert_tokens_to_string 

convert_tokens_to_string(tokens: list[str]) -> str
Source code in vllm/tokenizers/protocol.py 
112
113
def convert_tokens_to_string(self, tokens: list[str]) -> str:
    raise NotImplementedError

decode 

decode(
    ids: list[int] | int, skip_special_tokens: bool = False
) -> str
Source code in vllm/tokenizers/protocol.py 
115
116
def decode(self, ids: list[int] | int, skip_special_tokens: bool = False) -> str:
    raise NotImplementedError

encode 

encode(
    text: str,
    truncation: bool | None = None,
    max_length: int | None = None,
    add_special_tokens: bool = True,
) -> list[int]
Source code in vllm/tokenizers/protocol.py 
86
87
88
89
90
91
92
93
def encode(
    self,
    text: str,
    truncation: bool | None = None,
    max_length: int | None = None,
    add_special_tokens: bool = True,
) -> list[int]:
    raise NotImplementedError

from_pretrained classmethod 

from_pretrained(
    path_or_repo_id: str | Path,
    *args,
    trust_remote_code: bool = False,
    revision: str | None = None,
    download_dir: str | None = None,
    **kwargs,
) -> TokenizerLike
Source code in vllm/tokenizers/protocol.py 
13
14
15
16
17
18
19
20
21
22
23
@classmethod
def from_pretrained(
    cls,
    path_or_repo_id: str | Path,
    *args,
    trust_remote_code: bool = False,
    revision: str | None = None,
    download_dir: str | None = None,
    **kwargs,
) -> "TokenizerLike":
    raise NotImplementedError

get_added_vocab 

get_added_vocab() -> dict[str, int]
Source code in vllm/tokenizers/protocol.py 
83
84
def get_added_vocab(self) -> dict[str, int]:
    raise NotImplementedError

get_vocab 

get_vocab() -> dict[str, int]
Source code in vllm/tokenizers/protocol.py 
80
81
def get_vocab(self) -> dict[str, int]:
    raise NotImplementedError

num_special_tokens_to_add 

num_special_tokens_to_add() -> int
Source code in vllm/tokenizers/protocol.py 
25
26
def num_special_tokens_to_add(self) -> int:
    raise NotImplementedError