-
Notifications
You must be signed in to change notification settings - Fork 157
Expand file tree
/
Copy pathinstruct.py
More file actions
1421 lines (1204 loc) · 55.9 KB
/
Copy pathinstruct.py
File metadata and controls
1421 lines (1204 loc) · 55.9 KB
1
2
3
4
5
6
7
8
9
10
11
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import json
import warnings
from abc import abstractmethod
from typing import Any, Generic, Sequence, overload
import numpy as np
from mistral_common.exceptions import (
InvalidAssistantMessageException,
InvalidMessageStructureException,
InvalidRequestException,
TokenizerException,
)
from mistral_common.protocol.fim.request import FIMRequest
from mistral_common.protocol.instruct.chunk import (
AudioChunk,
AudioURLChunk,
ContentChunk,
ImageChunk,
ImageURLChunk,
TextChunk,
ThinkChunk,
)
from mistral_common.protocol.instruct.messages import (
UATS,
AssistantMessage,
AssistantMessageType,
SystemMessage,
ToolMessage,
UserMessage,
)
from mistral_common.protocol.instruct.request import InstructRequest, ModelSettings
from mistral_common.protocol.instruct.tool_calls import Tool, ToolCall
from mistral_common.protocol.speech.request import SpeechRequest
from mistral_common.protocol.transcription.request import StreamingMode, TranscriptionRequest
from mistral_common.tokens.tokenizers.audio import Audio, AudioEncoder, TranscriptionFormat
from mistral_common.tokens.tokenizers.base import (
FIMRequestType,
InstructRequestType,
InstructTokenizer,
SpecialTokenPolicy,
SpecialTokens,
Tokenized,
TokenizedType,
Tokenizer,
UserMessagePosition,
)
from mistral_common.tokens.tokenizers.image import ImageEncoder
from mistral_common.tokens.tokenizers.tekken import Tekkenizer
class InstructTokenizerBase(
InstructTokenizer, Generic[InstructRequestType, FIMRequestType, TokenizedType, AssistantMessageType]
):
r"""Base instruct tokenizer."""
def __init__(
self,
tokenizer: Tokenizer,
image_encoder: ImageEncoder | None = None,
audio_encoder: AudioEncoder | None = None,
):
r"""Initialize the instruct tokenizer.
Args:
tokenizer: The tokenizer to use.
image_encoder: The image encoder to use if any.
audio_encoder: The audio encoder to use.
"""
self.tokenizer = tokenizer
self.image_encoder = image_encoder
self.audio_encoder = audio_encoder
super().__init__(tokenizer, image_encoder, audio_encoder)
@property
def mm_encoder(self) -> ImageEncoder | None:
# this funtion is deprecated, use image_encoder instead
# TODO(Patrick) - throw a deprecation warning once
# changes applied to vllm and transformers
return self.image_encoder
def start(self) -> list[int]:
r"""Return the start tokens."""
return [self.tokenizer.bos_id]
@staticmethod
def find_first_last_user(request: InstructRequest) -> tuple[int, int]:
r"""Find the first and last user message in the request.
Args:
request: The request to search for user messages.
Returns:
The index of the first and last user message.
"""
last_user_idx = -1
first_user_idx = -1
for i, msg in list(enumerate(request.messages)):
if isinstance(msg, UserMessage):
if first_user_idx == -1:
first_user_idx = i
last_user_idx = i
return first_user_idx, last_user_idx
@abstractmethod
def encode_tool_message(
self, message: ToolMessage, is_before_last_user_message: bool
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
r"""Encode a tool message.
Raises:
NotImplementedError: The tool message is not implemented for the base tokenizer.
"""
raise NotImplementedError("Tool message not implemented")
@abstractmethod
def encode_assistant_message(
self, message: AssistantMessageType, is_before_last_user_message: bool, continue_message: bool
) -> list[int]:
r"""Encode an assistant message.
Raises:
NotImplementedError: The assistant message is not implemented for the base tokenizer.
"""
raise NotImplementedError("Assistant message not implemented")
@abstractmethod
def encode_think(self, chunk: ThinkChunk) -> list[int]:
r"""Encode a think chunk.
Raises:
NotImplementedError: The think chunk is not implemented for the base tokenizer.
"""
raise NotImplementedError("Think chunk not implemented")
def _truncate_for_max_tokens(
self,
tokenized: list[list[int] | None],
messages: list[AssistantMessageType],
max_tokens: int,
last_user_message_index: int,
) -> None:
# Tokenizer ⩽ V3 does not support truncation
return
@classmethod
def validate_messages(cls, messages: list[UATS]) -> None:
# We start validating messages for v7
return
def encode_instruct(
self,
request: InstructRequest[AssistantMessageType, Tool],
) -> Tokenized:
r"""Encode an instruct request.
Args:
request: The request to encode.
Returns:
The encoded tokens.
"""
# init at bos
images: list[np.ndarray] = []
audios: list[Audio] = []
prefix_ids: list[int] | None = None
tokens_list: list[list[int] | None] = []
# validate messages
self.validate_messages(request.messages)
# find last user message
first_user_idx, last_user_idx = self.find_first_last_user(request)
for msg_idx, msg in enumerate(request.messages):
if (
request.continue_final_message
and (msg_idx == len(request.messages) - 1)
and not isinstance(msg, AssistantMessage)
):
raise InvalidMessageStructureException(
"Cannot continue final message if it is not an assistant message"
)
if isinstance(msg, UserMessage):
new_tokens, new_images, new_audios = self.encode_user_message(
msg,
request.available_tools,
msg_idx == last_user_idx,
msg_idx == first_user_idx,
system_prompt=request.system_prompt,
force_img_first=True, # img is always first when providing text/img chunk pair
settings=request.settings,
)
images.extend(new_images)
audios.extend(new_audios)
elif isinstance(msg, ToolMessage):
new_tokens, new_images, new_audios = self.encode_tool_message(msg, msg_idx < last_user_idx)
images.extend(new_images)
audios.extend(new_audios)
elif isinstance(msg, AssistantMessage):
continue_message = request.continue_final_message and (msg_idx == len(request.messages) - 1)
new_tokens = self.encode_assistant_message(
msg, msg_idx < last_user_idx, continue_message=continue_message
)
if msg_idx == len(request.messages) - 1:
prefix_ids = new_tokens
elif isinstance(msg, SystemMessage):
new_tokens, new_audios = self.encode_system_message(msg)
audios.extend(new_audios)
else:
raise TokenizerException(f"Unknown message type {type(msg)}")
tokens_list.append(new_tokens)
if request.truncate_at_max_tokens is not None:
self._truncate_for_max_tokens(
tokens_list,
request.messages,
request.truncate_at_max_tokens,
last_user_idx,
)
tokens = self.start()
for tok in tokens_list:
if tok is not None:
tokens.extend(tok)
return Tokenized(
tokens=tokens,
text=self.decode(tokens, special_token_policy=SpecialTokenPolicy.KEEP),
prefix_ids=prefix_ids,
images=images,
audios=audios,
)
def decode(self, tokens: list[int], special_token_policy: SpecialTokenPolicy = SpecialTokenPolicy.IGNORE) -> str:
r"""Decode tokens to a string.
Args:
tokens: The tokens to decode.
special_token_policy: The policy to use for special tokens.
Returns:
The decoded string.
"""
return self.tokenizer.decode(tokens, special_token_policy=special_token_policy)
def _to_string(self, tokens: list[int]) -> str:
return self.tokenizer._to_string(tokens)
class InstructTokenizerV1(
InstructTokenizerBase, Generic[InstructRequestType, FIMRequestType, TokenizedType, AssistantMessageType]
):
r"""Instruct tokenizer V1.
This tokenizer has basic for messages. It does not support tools or image inputs.
"""
def encode_user_message(
self,
message: UserMessage,
available_tools: list[Tool] | None,
is_last: bool,
is_first: bool,
system_prompt: str | None = None,
force_img_first: bool = False,
settings: ModelSettings = ModelSettings.none(),
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
r"""Encode a user message.
Args:
message: The message to encode.
available_tools: Not used.
is_last: Not used.
is_first: Whether the message is the first one.
system_prompt: The system prompt.
force_img_first: Not used.
Returns:
The encoded tokens and empty list.
"""
assert isinstance(message.content, str), "Message content must be normalized"
assert self.image_encoder is None, "InstructTokenizerV1 cannot encode images"
content = ""
if is_first and system_prompt:
content = system_prompt + "\n\n" + message.content
else:
content = message.content
message_txt = f"[INST] {content} [/INST]"
curr_tokens, image, audio = self.encode_user_content(content=message_txt, is_last=False, system_prompt=None)
return curr_tokens, image, audio
def encode_system_message(self, message: SystemMessage) -> tuple[list[int], list[Audio]]:
raise NotImplementedError(f"System message encoding not implemented for {self.__class__.__name__}")
def encode_user_content(
self,
content: str | list[ContentChunk],
is_last: bool,
system_prompt: str | None = None,
force_img_first: bool = False,
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
r"""Encode a user content.
Args:
content: The content to encode.
is_last: Whether the message is the last one.
system_prompt: The system prompt.
force_img_first: Not used.
Returns:
The encoded tokens and empty list.
"""
assert isinstance(content, str)
if is_last and system_prompt:
content = system_prompt + "\n\n" + content
tokens = self.tokenizer.encode(content, bos=False, eos=False)
return tokens, [], []
def encode_tool_message(
self, message: ToolMessage, is_before_last_user_message: bool
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
r"""Encode a tool message.
Raises:
TokenizerException: The tool message is not implemented for this version.
"""
raise TokenizerException("Tools not implemented for tokenizer V1")
def encode_assistant_message(
self, message: AssistantMessageType, is_before_last_user_message: bool, continue_message: bool
) -> list[int]:
r"""Encode an assistant message.
Args:
message: The message to encode.
is_before_last_user_message: Not used.
continue_message: Whether to continue the message generation.
Only use this if the assistant message is the last message.
Returns:
The encoded tokens.
"""
assert isinstance(message, AssistantMessage), message
if message.tool_calls is not None and len(message.tool_calls) > 0:
raise TokenizerException("Tools not implemented for tokenizer V1")
if continue_message and message.prefix:
raise InvalidAssistantMessageException(
"`continue_message` is only supported for assistant messages that have `prefix=False`."
)
elif message.content:
assert isinstance(message.content, str), "Message content must be a string for tokenizer < V13"
curr_tokens = self.tokenizer.encode(message.content, bos=False, eos=False)
else:
raise TokenizerException(f"{message.content} // {message.tool_calls}")
if not message.prefix and not continue_message:
curr_tokens.append(self.tokenizer.eos_id)
return curr_tokens
def encode_think(self, chunk: ThinkChunk) -> list[int]:
r"""Encode a think chunk.
Raises:
TokenizerException: The think chunk is not implemented for this version.
"""
raise TokenizerException("Think not implemented for tokenizer < V13.")
def encode_fim(self, request: FIMRequest) -> Tokenized:
r"""Encode a FIM request.
Raises:
TokenizerException: The FIM request is not implemented for this version.
"""
raise TokenizerException(f"FIM not available for {self.tokenizer.version}")
def encode_transcription(self, request: TranscriptionRequest) -> Tokenized:
raise TokenizerException(f"Transcription not available for {self.tokenizer.version}")
def encode_speech_request(self, request: SpeechRequest) -> Tokenized:
raise TokenizerException(f"Speech request not available for tokenizer {self.tokenizer.version.value}")
class InstructTokenizerV2(
InstructTokenizerV1, Generic[InstructRequestType, FIMRequestType, TokenizedType, AssistantMessageType]
):
r"""Instruct tokenizer V2.
This tokenizer adds supports to images, tools and FIM requests.
"""
_message_position_to_encode_tools_settings = UserMessagePosition.last
def __init__(
self,
tokenizer: Tokenizer,
image_encoder: ImageEncoder | None = None,
audio_encoder: AudioEncoder | None = None,
):
r"""Initialize the tokenizer.
Args:
tokenizer: The tokenizer to use.
image_encoder: The image encoder to use.
audio_encoder: The audio encoder to use.
"""
super().__init__(tokenizer, image_encoder, audio_encoder)
self.BEGIN_INST = self.tokenizer.get_special_token(SpecialTokens.begin_inst.value)
self.END_INST = self.tokenizer.get_special_token(SpecialTokens.end_inst.value)
self.BEGIN_AVAILABLE_TOOLS = self.tokenizer.get_special_token(SpecialTokens.begin_tools.value)
self.END_AVAILABLE_TOOLS = self.tokenizer.get_special_token(SpecialTokens.end_tools.value)
self.BEGIN_TOOL_RESULTS = self.tokenizer.get_special_token(SpecialTokens.begin_tool_results.value)
self.END_TOOL_RESULTS = self.tokenizer.get_special_token(SpecialTokens.end_tool_results.value)
self.TOOL_CALLS = self.tokenizer.get_special_token(SpecialTokens.tool_calls.value)
self.BOS = self.tokenizer.get_special_token(SpecialTokens.bos.value)
self.PREFIX = self.tokenizer.get_special_token(SpecialTokens.prefix.value)
self.SUFFIX = self.tokenizer.get_special_token(SpecialTokens.suffix.value)
def encode_user_message(
self,
message: UserMessage,
available_tools: list[Tool] | None,
is_last: bool,
is_first: bool,
system_prompt: str | None = None,
force_img_first: bool = False,
settings: ModelSettings = ModelSettings.none(),
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
r"""Encode a user message.
Args:
message: The message to encode.
available_tools: The list of available tools if any.
is_last: Whether the message is the last one.
is_first: Not used.
system_prompt: The system prompt.
force_img_first: Whether to force the image to be first.
Returns:
The encoded tokens and the list of images.
"""
do_encode_tools_settings = False
do_encode_tools_settings |= is_first and (
self._message_position_to_encode_tools_settings == UserMessagePosition.first
)
do_encode_tools_settings |= is_last and (
self._message_position_to_encode_tools_settings == UserMessagePosition.last
)
tools_settings_tokens: list[int] = []
if do_encode_tools_settings and available_tools:
tools = [tool.model_dump(exclude={"function": {"strict": True}}) for tool in available_tools]
tools_json_tokens = self.tokenizer.encode(json.dumps(tools, ensure_ascii=False), bos=False, eos=False)
tools_settings_tokens.extend(
[
self.BEGIN_AVAILABLE_TOOLS,
*tools_json_tokens,
self.END_AVAILABLE_TOOLS,
]
)
if do_encode_tools_settings:
tools_settings_tokens.extend(self._encode_settings(settings=settings))
tokens, image, audio = self.encode_user_content(
content=message.content,
is_last=is_last,
system_prompt=system_prompt,
force_img_first=force_img_first,
)
prefix_tokens = [*tools_settings_tokens, self.BEGIN_INST]
suffix_tokens = [self.END_INST]
curr_tokens = prefix_tokens + tokens + suffix_tokens
return curr_tokens, image, audio
def _parse_json_content(self, content: str) -> Any:
try:
return json.loads(content)
except json.JSONDecodeError:
return content
def _parse_tool_content(self, content: str | list[ContentChunk]) -> Any:
if isinstance(content, list):
text_parts: list[str] = []
for chunk in content:
assert isinstance(chunk, TextChunk), (
f"Tool content only supports text chunks, got {type(chunk).__name__}."
)
text_parts.append(chunk.text)
content = "".join(text_parts)
return self._parse_json_content(content)
def _prepare_tool_result(self, tool_message: ToolMessage) -> dict[str, Any]:
r"""Bit of a hack due to the way tool results are tokenized."""
return {
"name": tool_message.name,
"content": self._parse_tool_content(tool_message.content),
}
def encode_tool_message(
self, message: ToolMessage, is_before_last_user_message: bool
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
r"""Encode a tool message.
Args:
message: The message to encode.
is_before_last_user_message: Whether the message is before the last user message. If true, the message is
not encoded.
Returns:
The encoded tokens, images, and audios.
"""
if is_before_last_user_message:
# don't tokenize last tool response before last user msg
return [], [], []
# Currently only supports single tool results
tool_result_str = json.dumps([self._prepare_tool_result(message)], ensure_ascii=False)
curr_tokens = [
self.BEGIN_TOOL_RESULTS,
*self.tokenizer.encode(tool_result_str, bos=False, eos=False),
self.END_TOOL_RESULTS,
]
return curr_tokens, [], []
def _prepare_function_call(self, tool_call: ToolCall) -> dict[str, Any]:
r"""Bit of a hack due to the way function calls are tokenized."""
return {
"name": tool_call.function.name,
"arguments": self._parse_json_content(tool_call.function.arguments),
}
def _encode_normal_content_assistant_message(self, message: AssistantMessageType) -> list[int]:
assert message.content, f"Assistant message must have content. Got {message}"
assert isinstance(message.content, str), "Message content must be a string for tokenizer < V7"
return self.tokenizer.encode(message.content.rstrip(" "), bos=False, eos=False)
def _encode_tool_calls_in_assistant_message(self, message: AssistantMessageType) -> list[int]:
assert message.tool_calls, f"Assistant message must have tool calls. Got {message}"
prepared_tool_calls = []
for tool_call in message.tool_calls:
prepared_tool_calls.append(self._prepare_function_call(tool_call))
tool_call_str = json.dumps(prepared_tool_calls, ensure_ascii=False)
curr_tokens = [
self.TOOL_CALLS,
*self.tokenizer.encode(tool_call_str, bos=False, eos=False),
]
return curr_tokens
def _encode_settings(
self,
settings: ModelSettings,
) -> list[int]:
r"""Encode model settings as tokens. Returns empty list by default."""
assert self.tokenizer.model_settings_builder is None, "`model_settings_builder` not supported for this version."
return []
def encode_assistant_message(
self, message: AssistantMessageType, is_before_last_user_message: bool, continue_message: bool
) -> list[int]:
r"""Encode an assistant message.
Args:
message: The message to encode.
is_before_last_user_message: Whether the message is before the last user message. If has tools and true, the
message is not encoded.
continue_message: Whether to continue the message generation.
Only use this if the assistant message is the last message.
Returns:
The encoded tokens.
"""
if message.tool_calls and message.content:
raise ValueError(f"Cannot have tool calls and content defined in the same assistant message {message}")
if continue_message and message.prefix:
raise InvalidAssistantMessageException(
"`continue_message` is only supported for assistant messages that have `prefix=False`."
)
if message.tool_calls:
if is_before_last_user_message:
# don't tokenize tool call before last user message
return []
curr_tokens = self._encode_tool_calls_in_assistant_message(message)
elif message.content:
assert isinstance(message.content, str), "Message content must be a string for tokenizer < V7"
curr_tokens = self._encode_normal_content_assistant_message(message)
else:
raise TokenizerException(f"Invalid assistant message: {message.content}")
if not message.prefix and not continue_message:
curr_tokens.append(self.tokenizer.eos_id)
return curr_tokens
def _encode_infilling(self, text: str) -> list[int]:
r"""Remove prefix space in the case of SentencePieceTokenizers."""
return self.tokenizer.encode("☺" + text, bos=False, eos=False)[2:]
def encode_fim(self, request: FIMRequest) -> Tokenized:
r"""Encode a FIM request.
Args:
request: The request to encode.
Returns:
The encoded tokens.
"""
prefix_tokens = self.tokenizer.encode(request.prompt, bos=False, eos=False)
suffix_tokens = self._encode_infilling(request.suffix) if request.suffix else []
tokens = [
self.BOS,
self.SUFFIX,
*suffix_tokens,
self.PREFIX,
*prefix_tokens,
]
return Tokenized(tokens=tokens, text=self.decode(tokens, special_token_policy=SpecialTokenPolicy.KEEP))
class InstructTokenizerV3(
InstructTokenizerV2, Generic[InstructRequestType, FIMRequestType, TokenizedType, AssistantMessageType]
):
r"""Instruct tokenizer V3.
The only difference with V2 tokenizer is that it encodes the tool messages differently.
"""
def __init__(
self,
tokenizer: Tokenizer,
image_encoder: ImageEncoder | None = None,
audio_encoder: AudioEncoder | None = None,
):
r"""Initialize the tokenizer.
Args:
tokenizer: The tokenizer to use.
image_encoder: The image encoder to use.
audio_encoder: The audio encoder to use.
"""
super().__init__(tokenizer, image_encoder=image_encoder, audio_encoder=audio_encoder)
def _prepare_function_call(self, tool_call: ToolCall) -> dict[str, Any]:
function_call = {
"name": tool_call.function.name,
"arguments": self._parse_json_content(tool_call.function.arguments),
}
if tool_call.id and tool_call.id != "null":
function_call["id"] = tool_call.id
return function_call
def _prepare_tool_result(self, tool_message: ToolMessage) -> dict[str, Any]:
assert tool_message.tool_call_id is not None, "Tool message has to have the tool call id defined in v3"
return {
"content": self._parse_tool_content(tool_message.content),
"call_id": tool_message.tool_call_id,
}
def encode_tool_message(
self, message: ToolMessage, is_before_last_user_message: bool
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
r"""Encode a tool message.
Note:
Same as [V2][mistral_common.tokens.tokenizers.instruct.InstructTokenizerV2.encode_tool_message] but tools
are not wrapped in a list and the history is also tokenized.
Args:
message: The message to encode.
is_before_last_user_message: Whether the message is before the last user message. If true, the message is
not encoded.
Returns:
The encoded tokens, images, and audios.
"""
tool_result_str = json.dumps(self._prepare_tool_result(message), ensure_ascii=False)
curr_tokens = [
self.BEGIN_TOOL_RESULTS,
*self.tokenizer.encode(tool_result_str, bos=False, eos=False),
self.END_TOOL_RESULTS,
]
return curr_tokens, [], []
def encode_assistant_message(
self, message: AssistantMessageType, is_before_last_user_message: bool, continue_message: bool
) -> list[int]:
r"""Encode an assistant message.
Note:
Same as [V2][mistral_common.tokens.tokenizers.instruct.InstructTokenizerV2.encode_assistant_message] but
always encode the tool history.
continue_message: Whether to continue the message generation.
Only use this if the assistant message is the last message.
Args:
message: The message to encode.
is_before_last_user_message: Not used.
Returns:
The encoded tokens.
"""
return super().encode_assistant_message(message, False, continue_message)
@overload
def _encode_content_chunk(self, chunk: str | TextChunk | ThinkChunk) -> tuple[list[int], None, None]: ...
@overload
def _encode_content_chunk(self, chunk: ImageChunk | ImageURLChunk) -> tuple[list[int], np.ndarray, None]: ...
@overload
def _encode_content_chunk(self, chunk: AudioChunk | AudioURLChunk) -> tuple[list[int], None, Audio]: ...
def _encode_content_chunk(self, chunk: str | ContentChunk) -> tuple[list[int], np.ndarray | None, Audio | None]:
if isinstance(chunk, str):
return self.tokenizer.encode(chunk, bos=False, eos=False), None, None
elif isinstance(chunk, TextChunk):
return self.tokenizer.encode(chunk.text, bos=False, eos=False), None, None
elif isinstance(chunk, ThinkChunk):
return self.encode_think(chunk), None, None
elif isinstance(chunk, (ImageChunk, ImageURLChunk)):
assert self.image_encoder is not None, "Make sure to define a image encoder at init"
img_encoding = self.image_encoder(chunk)
return img_encoding.tokens, img_encoding.image, None
elif isinstance(chunk, (AudioChunk, AudioURLChunk)):
# the following is only possible for >= v7
assert self.audio_encoder is not None, "Make sure to define a audio encoder at init"
audio_encoding = self.audio_encoder(chunk)
return audio_encoding.tokens, None, audio_encoding.audio
else:
raise ValueError(f"Unknown chunk type: {chunk}")
@staticmethod
def _maybe_put_image_first(content: list[ContentChunk]) -> list[ContentChunk]:
# Compatibility hack: this belongs in normalization and will be removed in an upcoming version.
image_types = (ImageChunk, ImageURLChunk)
if (
len(content) >= 2
and isinstance(content[-1], image_types)
and all(isinstance(chunk, TextChunk) for chunk in content[:-1])
):
return [content[-1], *content[:-1]]
return content
def _encode_content_chunks(
self, content: Sequence[ContentChunk]
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
tokens: list[int] = []
images: list[np.ndarray] = []
audio: list[Audio] = []
for chunk in content:
chunk_tokens, maybe_image, maybe_audio = self._encode_content_chunk(chunk)
tokens.extend(chunk_tokens)
if maybe_image is not None:
images.append(maybe_image)
if maybe_audio is not None:
audio.append(maybe_audio)
return tokens, images, audio
def encode_user_content(
self,
content: str | list[ContentChunk],
is_last: bool,
system_prompt: str | None = None,
force_img_first: bool = False,
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
r"""Encode a user content.
Args:
content: The content to encode.
is_last: Whether the message is the last one.
system_prompt: The system prompt.
force_img_first: Whether to force the image to be first.
Returns:
The encoded tokens and the images.
"""
if isinstance(content, str):
return super().encode_user_content(content, is_last, system_prompt)
tokens: list[int] = []
images: list[np.ndarray] = []
audio: list[Audio] = []
if force_img_first:
content = self._maybe_put_image_first(content)
first_chunk = True
for chunk in content:
content_str = ""
if first_chunk and is_last and system_prompt:
first_chunk = False
content_str = system_prompt + "\n\n"
tokens += self.tokenizer.encode(content_str, bos=False, eos=False)
if isinstance(chunk, (AudioChunk, AudioURLChunk)):
assert not content_str, (
f"It is not possible that `content` is non-empty when chunk is of type {type(chunk)}."
)
chunk_tokens, maybe_image, chunk_audio = self._encode_content_chunk(chunk)
assert maybe_image is None, f"Unexpected image for audio chunk {type(chunk).__name__}."
audio.append(chunk_audio)
elif isinstance(chunk, (ImageChunk, ImageURLChunk)):
chunk_tokens, chunk_image, maybe_audio = self._encode_content_chunk(chunk)
assert maybe_audio is None, f"Unexpected audio for image chunk {type(chunk).__name__}."
images.append(chunk_image)
else:
chunk_tokens, maybe_image, maybe_audio = self._encode_content_chunk(chunk)
assert maybe_image is None and maybe_audio is None, (
f"Unexpected image/audio for chunk {type(chunk).__name__}."
)
tokens.extend(chunk_tokens)
return tokens, images, audio
class InstructTokenizerV7(InstructTokenizerV3):
r"""Instruct tokenizer V7.
The difference with V3 tokenizer is that it encodes the system prompts differently:
- in V7 the system prompts are treated as separate SystemMessages
- they are no longer prepended to the last user message
- they are printed between special tokens
"""
def __init__(
self,
tokenizer: Tokenizer,
image_encoder: ImageEncoder | None = None,
audio_encoder: AudioEncoder | None = None,
) -> None:
r"""Initialize the tokenizer.
Args:
tokenizer: The tokenizer to use.
image_encoder: The image encoder to use.
audio_encoder: The audio encoder to use.
"""
super().__init__(tokenizer, image_encoder, audio_encoder)
self.BEGIN_SYSTEM = self.tokenizer.get_special_token(SpecialTokens.begin_system.value)
self.END_SYSTEM = self.tokenizer.get_special_token(SpecialTokens.end_system.value)
self.BEGIN_TOOL_CONTENT = self.tokenizer.get_special_token(SpecialTokens.begin_tool_content.value)
self.TRANSCRIBE = None
if audio_encoder is not None and not audio_encoder.audio_config.is_streaming:
self.TRANSCRIBE = self.tokenizer.get_special_token(SpecialTokens.transcribe.value)
def _truncate_for_max_tokens(
self,
tokenized_messages: list[list[int] | None],
messages: list[AssistantMessageType],
max_tokens: int,
last_user_message_index: int,
) -> None:
# drop some messages to fit in max_tokens. Rules:
# - don't drop any system messages
# - when a user message is dropped, all following assistant|tool message should be dropped until the next
# user message
# - we never drop the last message
to_drop = sum(len(t) for t in tokenized_messages if t is not None) - max_tokens
def drop(idx: int) -> None:
nonlocal to_drop
if isinstance(messages[idx], SystemMessage):
# never drop system messages
return
if idx == last_user_message_index:
# never drop the last user message
return
if idx == len(messages) - 1:
# never drop the last message
return
tok = tokenized_messages[idx]
assert tok is not None
to_drop -= len(tok)
tokenized_messages[idx] = None
current_idx = 0
while to_drop > 0 and current_idx < len(messages):
drop(current_idx)
current_idx += 1
if isinstance(messages[current_idx - 1], UserMessage):
# if we just dropped a UserMessage,
# also drop everything until the next user message
while current_idx < len(messages) and not isinstance(messages[current_idx], UserMessage):
drop(current_idx)
current_idx += 1
if to_drop > 0:
raise TokenizerException("Input couldn't fit in truncate_at_max_token")
def encode_system_message(self, message: SystemMessage) -> tuple[list[int], list[Audio]]:
r"""Encode a system message.
Args:
message: The message to encode.
Returns:
The encoded tokens and audios.
"""
tokens = [self.BEGIN_SYSTEM]
if isinstance(content := message.content, str):
content = [TextChunk(text=content)]
content_tokens, images, audios = self._encode_content_chunks(content)
assert not images, f"System messages cannot contain images, got {len(images)}."
tokens += content_tokens
tokens.append(self.END_SYSTEM)
return tokens, audios
def encode_user_content(
self,
content: str | list[ContentChunk],
is_last: bool,
system_prompt: str | None = None,
force_img_first: bool = False,
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
r"""Encode a user content.
Args:
content: The content to encode.
is_last: Whether the message is the last one.
system_prompt: The system prompt.
force_img_first: Whether to force the image to be first.
Returns:
The encoded tokens and the images.
"""
assert system_prompt is None, "in Tokenizer V7 we don't encode system prompts in user messages"
if isinstance(content, str):
return super().encode_user_content(content, is_last, system_prompt)
if force_img_first:
content = self._maybe_put_image_first(content)
tokens, images, audio = self._encode_content_chunks(content)
return tokens, images, audio
def encode_user_message(
self,
message: UserMessage,
available_tools: list[Tool] | None,
is_last: bool,
is_first: bool,
system_prompt: str | None = None,
force_img_first: bool = False,
settings: ModelSettings = ModelSettings.none(),
) -> tuple[list[int], list[np.ndarray], list[Audio]]:
r"""Encode a user message.
Args:
message: The message to encode.
available_tools: The list of available tools if any.
is_last: Whether the message is the last one.
is_first: Whether the message is the first one.
system_prompt: Not used.
force_img_first: Whether to force the image to be first.
Returns:
The encoded tokens and the list of images.
"""
assert system_prompt is None, "in Tokenizer V7 we don't encode system prompts in user messages"
tokens, images, audio = super().encode_user_message(
message,
available_tools,
is_last=is_last,
is_first=is_first,
system_prompt=None,
force_img_first=force_img_first,
settings=settings,
)
return tokens, images, audio
def encode_transcription(self, request: TranscriptionRequest) -> Tokenized:
r"""
Encodes an audio transcription request into a tokenized format.
This method processes a transcription request containing audio data,
encodes the user message, and returns the tokenized output.
Args:
request: The transcription request object containing
the audio data to be encoded.
Returns:
Tokenized: The tokenized representation of the audio data, including processed audio and tokens