-
Notifications
You must be signed in to change notification settings - Fork 12.1k
models/templates: add mistralai/Mistral-Small-3.1-24B-Instruct-2503 template with tool calling support #14148
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bretello
wants to merge
2
commits into
ggml-org:master
Choose a base branch
from
bretello:add-mistral-small-chat-template
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
132 changes: 132 additions & 0 deletions
132
models/templates/mistralai-Mistral-Small-3.1-24B-Instruct-2503.jinja
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
{%- set today = strftime_now("%Y-%m-%d") %} | ||
{%- set default_system_message = "You are Mistral Small 3, a Large Language Model (LLM) created by Mistral AI, a French startup headquartered in Paris.\ | ||
Your knowledge base was last updated on 2023-10-01. The current date is " + today + ".\ | ||
\ | ||
When you're not sure about some information, you say that you don't have the information and don't make up anything.\ | ||
If the user's question is not clear, ambiguous, or does not provide enough context for you to accurately answer the question, you do not try to answer it right away and you rather ask the user to clarify their request (e.g. \"What are some good restaurants around me?\" => \"Where are you?\" or \"When is the next flight to Tokyo\" => \"Where do you travel from?\")" %} | ||
|
||
{{- bos_token }} | ||
|
||
{%- if messages[0]['role'] == 'system' %} | ||
{%- if messages[0]['content'] is string %} | ||
{%- set system_message = messages[0]['content'] %} | ||
{%- set loop_messages = messages[1:] %} | ||
{%- else %} | ||
{%- set system_message = messages[0]['content'][0]['text'] %} | ||
{%- set loop_messages = messages[1:] %} | ||
{%- endif %} | ||
{%- else %} | ||
{%- set system_message = default_system_message %} | ||
{%- set loop_messages = messages %} | ||
{%- endif %} | ||
{%- if not tools is defined %} | ||
{%- set tools = none %} | ||
{%- elif tools is not none %} | ||
{%- set parallel_tool_prompt = "You are a helpful assistant that can call tools. If you call one or more tools, format them in a single JSON array or objects, where each object is a tool call, not as separate objects outside of an array or multiple arrays. Use the format [{\"name\": tool call name, \"arguments\": tool call arguments}, additional tool calls] if you call more than one tool. If you call tools, do not attempt to interpret them or otherwise provide a response until you receive a tool call result that you can interpret for the user." %} | ||
{%- if system_message is defined %} | ||
{%- set system_message = parallel_tool_prompt + "\ | ||
\ | ||
" + system_message %} | ||
{%- else %} | ||
{%- set system_message = parallel_tool_prompt %} | ||
{%- endif %} | ||
{%- endif %} | ||
{{- '[SYSTEM_PROMPT]' + system_message + '[/SYSTEM_PROMPT]' }} | ||
|
||
{%- set user_messages = loop_messages | selectattr("role", "equalto", "user") | list %} | ||
|
||
{%- set filtered_messages = [] %} | ||
{%- for message in loop_messages %} | ||
{%- if message["role"] not in ["tool", "tool_results"] and not message.get("tool_calls") %} | ||
{%- set filtered_messages = filtered_messages + [message] %} | ||
{%- endif %} | ||
{%- endfor %} | ||
|
||
{%- for message in filtered_messages %} | ||
{%- if (message["role"] == "user") != (loop.index0 % 2 == 0) %} | ||
{{- raise_exception("After the optional system message, conversation roles must alternate user/assistant/user/assistant/...") }} | ||
{%- endif %} | ||
{%- endfor %} | ||
|
||
{%- for message in loop_messages %} | ||
{%- if message["role"] == "user" %} | ||
{%- if tools is not none and (message == user_messages[-1]) %} | ||
{{- "[AVAILABLE_TOOLS] [" }} | ||
{%- for tool in tools %} | ||
{%- set tool = tool.function %} | ||
{{- '{"type": "function", "function": {' }} | ||
{%- for key, val in tool.items() if key != "return" %} | ||
{%- if val is string %} | ||
{{- '"' + key + '": "' + val + '"' }} | ||
{%- else %} | ||
{{- '"' + key + '": ' + val|tojson }} | ||
{%- endif %} | ||
{%- if not loop.last %} | ||
{{- ", " }} | ||
{%- endif %} | ||
{%- endfor %} | ||
{{- "}}" }} | ||
{%- if not loop.last %} | ||
{{- ", " }} | ||
{%- else %} | ||
{{- "]" }} | ||
{%- endif %} | ||
{%- endfor %} | ||
{{- "[/AVAILABLE_TOOLS]" }} | ||
{%- endif %} | ||
{%- if message['content'] is string %} | ||
{{- '[INST]' + message['content'] + '[/INST]' }} | ||
{%- else %} | ||
{{- '[INST]' }} | ||
{%- for block in message['content'] %} | ||
{%- if block['type'] == 'text' %} | ||
{{- block['text'] }} | ||
{%- elif block['type'] == 'image' or block['type'] == 'image_url' %} | ||
{{- '[IMG]' }} | ||
{%- else %} | ||
{{- raise_exception('Only text and image blocks are supported in message content!') }} | ||
{%- endif %} | ||
{%- endfor %} | ||
{{- '[/INST]' }} | ||
{%- endif %} | ||
{%- elif message["role"] == "tool_calls" or message.tool_calls is defined %} | ||
{%- if message.tool_calls is defined %} | ||
{%- set tool_calls = message.tool_calls %} | ||
{%- else %} | ||
{%- set tool_calls = message.content %} | ||
{%- endif %} | ||
{{- "[TOOL_CALLS] [" }} | ||
{%- for tool_call in tool_calls %} | ||
{%- set out = tool_call.function|tojson %} | ||
{{- out[:-1] }} | ||
{%- if not tool_call.id is defined or tool_call.id|length < 9 %} | ||
{{- raise_exception("Tool call IDs should be alphanumeric strings with length >= 9! (1)" + tool_call.id) }} | ||
{%- endif %} | ||
{{- ', "id": "' + tool_call.id[-9:] + '"}' }} | ||
{%- if not loop.last %} | ||
{{- ", " }} | ||
{%- else %} | ||
{{- "]" + eos_token }} | ||
{%- endif %} | ||
{%- endfor %} | ||
{%- elif message['role'] == 'assistant' %} | ||
{%- if message['content'] is string %} | ||
{{- message['content'] + eos_token }} | ||
{%- else %} | ||
{{- message['content'][0]['text'] + eos_token }} | ||
{%- endif %} | ||
{%- elif message["role"] == "tool_results" or message["role"] == "tool" %} | ||
{%- if message.content is defined and message.content.content is defined %} | ||
{%- set content = message.content.content %} | ||
{%- else %} | ||
{%- set content = message.content %} | ||
{%- endif %} | ||
{{- '[TOOL_RESULTS] {"content": ' + content|string + ", " }} | ||
{%- if not message.tool_call_id is defined or message.tool_call_id|length < 9 %} | ||
{{- raise_exception("Tool call IDs should be alphanumeric strings with length >= 9! (2)" + message.tool_call_id) }} | ||
{%- endif %} | ||
{{- '"call_id": "' + message.tool_call_id[-9:] + '"}[/TOOL_RESULTS]' }} | ||
{%- else %} | ||
{{- raise_exception("Only user and assistant roles are supported, with the exception of an initial optional system message!") }} | ||
{%- endif %} | ||
{%- endfor %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem with this one-off fix is that there's no logic to expand this string to a template. For example when when using
llama-server
, this will always cause the prompt to be set to</s>mistral-v7-tekken
if the gguf doesn't have a chat template.In my specific case (tool calling), I had an a chat template but not a tool calling chat template, resulting in this line always executing and breaking generation.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see why this should be removed. Many users run mistral small without
--chat-template
and it will now break most use casesEven with this removed, you still need
--jinja --chat-template-file
to make it work correctlyAnd the worst is, someone will do
--jinja --chat-template mistral-v7-tekken
which bring back exactly the same issue.In short, I against this removal as it make the UX even worse
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ngxson, perhaps I'm missing something, but with this patch (the gguf I'm using does have a chat template):
I get the following logs:
Note that the chat template is set to
mistral-v7-tekken
, which is wrong.And if I query the model, I get nonsensical outputs about the tekken game:
From the logs, since I force-enabled prompt logging:
You can see that after evaluating the (wrong) template, the prompt is set to
mistral-v7-tekken