a70146df0f* Studio: override chat template for unsloth/gemma-4-*-GGUF with bundled gemma-4.jinja The chat templates baked into the shipped unsloth/gemma-4-*-GGUF quants predate Google's gemma-4 chat-template PR #118 and lack the preserve_thinking flag, so Studio cannot surface the "Preserve thinking" toggle for Gemma 4. Bundle the updated template and override the embedded one at llama-server launch via --chat-template-file, scoped to the gemma-4 GGUF family, so users do not need to re-download any quant. - Add studio/backend/assets/chat_templates/gemma-4.jinja (PR #118 based; preserve_thinking defaults false, the one deliberate divergence from upstream). - Add core/inference/chat_templates.py: gemma-4 GGUF matcher plus an effective-override resolver (explicit user template still wins). - Wire the resolver into routes/inference.py ahead of the reload-dedup check and both load_model calls so the live backend and the incoming request compare against the same template text (no spurious reloads). - Default preserve_thinking off in the launch-time chat_template_kwargs so direct API callers match the UI default. - Ship the asset via package-data and add unit tests. * Studio: ship E2B/E4B edge variant of the bundled Gemma 4 template Google ships two distinct gemma-4 chat templates: E2B and E4B omit the empty "<|channel>thought<channel|>" block on enable_thinking=false, while the 12b/26B-A4B/31B family emits it (confirmed against google/gemma-4-E2B-it, -E4B-it, -12b-it, -26B-A4B-it, -31B-it; the two families differ only in that one block). The single PR #118 based template followed the larger-model behavior, which is wrong for the E2B/E4B GGUFs this feature most targets. - Add studio/backend/assets/chat_templates/gemma-4-edge.jinja: identical to gemma-4.jinja minus the empty-thought-block, matching E2B/E4B behavior. - Route unsloth/gemma-4-E2B-it-GGUF and -E4B-it-GGUF to the edge template; 12b/26B-A4B/31B keep gemma-4.jinja. - Extend tests for the edge matcher, per-family routing, and the empty-thought block difference (off for edge, on for standard). * Studio: address review feedback on the gemma-4 template override - Normalize owner-less shorthand model ids in the template matcher: a bare "gemma-4-E2B-it-GGUF" is canonicalized to "unsloth/" the same way ModelConfig.from_identifier does, so shorthand loads still get the override (and the preserve_thinking capability) instead of falling back to the embedded template. - Scope the test's module stubs with unittest.mock.patch.dict instead of sys.modules.setdefault, and only stub deps that are missing, so the global module registry is not polluted for tests that run afterwards. - Guard the Jinja render tests with pytest.importorskip("jinja2") so the suite stays runnable in minimal Studio environments where jinja2 is not present. - Add tests for shorthand resolution. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Studio: address 10-reviewer P1 findings on the gemma-4 template override - /status no longer surfaces Studio's auto-applied bundled template as a user-authored chat_template_override. The frontend adopts that field as editable state and would otherwise re-send the gemma-4 template as an explicit override for a later, unrelated model. /status now reports None when the live override equals the model's auto-resolved bundled template. - When a bundled family template is in effect, strip an inherited --chat-template-file from llama_extra_args too (not only when the raw request set chat_template_override). Otherwise a stale inherited template, appended last, shadows the bundled one while Studio reports the bundled template's capabilities. - Write the temp chat-template file as UTF-8 explicitly, and keep the bundled templates ASCII (replaced em dashes), so non-UTF-8 Windows locales cannot raise UnicodeEncodeError or emit a mis-encoded template. Added an ASCII guard test. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
397 lines
19 KiB
Django/Jinja
397 lines
19 KiB
Django/Jinja
{#-
|
|
Gemma 4 chat template, vendored for Unsloth Studio.
|
|
Source: google/gemma-4-31B-it HF discussion/PR #118 (adds the preserve_thinking
|
|
flag plus null-rendering, string-arguments validation, balanced turn tags, empty
|
|
messages handling, and OpenAI image_url/input_audio aliases).
|
|
Studio-local change: preserve_thinking defaults to false (see SETUP block below).
|
|
Applied to unsloth/gemma-4-*-GGUF models so the embedded GGUF template does not
|
|
need re-downloading. Keep in sync with upstream if PR #118 changes.
|
|
-#}
|
|
{%- macro format_parameters(properties, required, filter_keys=false) -%}
|
|
{%- set standard_keys = ['description', 'type', 'properties', 'required', 'nullable'] -%}
|
|
{%- set ns = namespace(found_first=false) -%}
|
|
{%- for key, value in properties | dictsort -%}
|
|
{%- set add_comma = false -%}
|
|
{%- if not filter_keys or key not in standard_keys -%}
|
|
{%- if ns.found_first %},{% endif -%}
|
|
{%- set ns.found_first = true -%}
|
|
{{ key }}:{
|
|
{%- if value['description'] -%}
|
|
description:<|"|>{{ value['description'] }}<|"|>
|
|
{%- set add_comma = true -%}
|
|
{%- endif -%}
|
|
{%- if value['type'] | upper == 'STRING' -%}
|
|
{%- if value['enum'] -%}
|
|
{%- if add_comma %},{%- else -%} {%- set add_comma = true -%} {% endif -%}
|
|
enum:{{ format_argument(value['enum']) }}
|
|
{%- endif -%}
|
|
{%- elif value['type'] | upper == 'ARRAY' -%}
|
|
{%- if value['items'] is mapping and value['items'] -%}
|
|
{%- if add_comma %},{%- else -%} {%- set add_comma = true -%} {% endif -%}
|
|
items:{
|
|
{%- set ns_items = namespace(found_first=false) -%}
|
|
{%- for item_key, item_value in value['items'] | dictsort -%}
|
|
{%- if item_value is not none -%}
|
|
{%- if ns_items.found_first %},{% endif -%}
|
|
{%- set ns_items.found_first = true -%}
|
|
{%- if item_key == 'properties' -%}
|
|
properties:{
|
|
{%- if item_value is mapping -%}
|
|
{{- format_parameters(item_value, value['items']['required'] | default([])) -}}
|
|
{%- endif -%}
|
|
}
|
|
{%- elif item_key == 'required' -%}
|
|
required:[
|
|
{%- for req_item in item_value -%}
|
|
<|"|>{{- req_item -}}<|"|>
|
|
{%- if not loop.last %},{% endif -%}
|
|
{%- endfor -%}
|
|
]
|
|
{%- elif item_key == 'type' -%}
|
|
{%- if item_value is string -%}
|
|
type:{{ format_argument(item_value | upper) }}
|
|
{%- else -%}
|
|
type:{{ format_argument(item_value | map('upper') | list) }}
|
|
{%- endif -%}
|
|
{%- else -%}
|
|
{{ item_key }}:{{ format_argument(item_value) }}
|
|
{%- endif -%}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
}
|
|
{%- endif -%}
|
|
{%- endif -%}
|
|
{%- if value['nullable'] %}
|
|
{%- if add_comma %},{%- else -%} {%- set add_comma = true -%} {% endif -%}
|
|
nullable:true
|
|
{%- endif -%}
|
|
{%- if value['type'] | upper == 'OBJECT' -%}
|
|
{%- if value['properties'] is defined and value['properties'] is mapping -%}
|
|
{%- if add_comma %},{%- else -%} {%- set add_comma = true -%} {% endif -%}
|
|
properties:{
|
|
{{- format_parameters(value['properties'], value['required'] | default([])) -}}
|
|
}
|
|
{%- elif value is mapping -%}
|
|
{%- if add_comma %},{%- else -%} {%- set add_comma = true -%} {% endif -%}
|
|
properties:{
|
|
{{- format_parameters(value, value['required'] | default([]), filter_keys=true) -}}
|
|
}
|
|
{%- endif -%}
|
|
{%- if value['required'] -%}
|
|
{%- if add_comma %},{%- else -%} {%- set add_comma = true -%} {% endif -%}
|
|
required:[
|
|
{%- for item in value['required'] | default([]) -%}
|
|
<|"|>{{- item -}}<|"|>
|
|
{%- if not loop.last %},{% endif -%}
|
|
{%- endfor -%}
|
|
]
|
|
{%- endif -%}
|
|
{%- endif -%}
|
|
{%- if add_comma %},{%- else -%} {%- set add_comma = true -%} {% endif -%}
|
|
type:<|"|>{{ value['type'] | upper }}<|"|>}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{%- endmacro -%}
|
|
{%- macro format_function_declaration(tool_data) -%}
|
|
declaration:{{- tool_data['function']['name'] -}}{description:<|"|>{{- tool_data['function']['description'] -}}<|"|>
|
|
{%- set params = tool_data['function']['parameters'] -%}
|
|
{%- if params -%}
|
|
,parameters:{
|
|
{%- if params['properties'] -%}
|
|
properties:{ {{- format_parameters(params['properties'], params['required']) -}} },
|
|
{%- endif -%}
|
|
{%- if params['required'] -%}
|
|
required:[
|
|
{%- for item in params['required'] -%}
|
|
<|"|>{{- item -}}<|"|>
|
|
{{- ',' if not loop.last -}}
|
|
{%- endfor -%}
|
|
],
|
|
{%- endif -%}
|
|
{%- if params['type'] -%}
|
|
type:<|"|>{{- params['type'] | upper -}}<|"|>}
|
|
{%- endif -%}
|
|
{%- endif -%}
|
|
{%- if 'response' in tool_data['function'] -%}
|
|
{%- set response_declaration = tool_data['function']['response'] -%}
|
|
,response:{
|
|
{%- if response_declaration['description'] -%}
|
|
description:<|"|>{{- response_declaration['description'] -}}<|"|>,
|
|
{%- endif -%}
|
|
{%- if response_declaration['type'] | upper == 'OBJECT' -%}
|
|
type:<|"|>{{- response_declaration['type'] | upper -}}<|"|>}
|
|
{%- endif -%}
|
|
{%- endif -%}
|
|
}
|
|
{%- endmacro -%}
|
|
{%- macro format_argument(argument, escape_keys=True) -%}
|
|
{%- if argument is none -%}
|
|
{{- 'null' -}}
|
|
{%- elif argument is string -%}
|
|
{{- '<|"|>' + argument + '<|"|>' -}}
|
|
{%- elif argument is boolean -%}
|
|
{{- 'true' if argument else 'false' -}}
|
|
{%- elif argument is mapping -%}
|
|
{{- '{' -}}
|
|
{%- set ns = namespace(found_first=false) -%}
|
|
{%- for key, value in argument | dictsort -%}
|
|
{%- if ns.found_first %},{% endif -%}
|
|
{%- set ns.found_first = true -%}
|
|
{%- if escape_keys -%}
|
|
{{- '<|"|>' + key + '<|"|>' -}}
|
|
{%- else -%}
|
|
{{- key -}}
|
|
{%- endif -%}
|
|
:{{- format_argument(value, escape_keys=escape_keys) -}}
|
|
{%- endfor -%}
|
|
{{- '}' -}}
|
|
{%- elif argument is sequence -%}
|
|
{{- '[' -}}
|
|
{%- for item in argument -%}
|
|
{{- format_argument(item, escape_keys=escape_keys) -}}
|
|
{%- if not loop.last %},{% endif -%}
|
|
{%- endfor -%}
|
|
{{- ']' -}}
|
|
{%- else -%}
|
|
{{- argument -}}
|
|
{%- endif -%}
|
|
{%- endmacro -%}
|
|
{%- macro strip_thinking(text) -%}
|
|
{%- set ns = namespace(result='') -%}
|
|
{%- for part in text.split('<channel|>') -%}
|
|
{%- if '<|channel>' in part -%}
|
|
{%- set ns.result = ns.result + part.split('<|channel>')[0] -%}
|
|
{%- else -%}
|
|
{%- set ns.result = ns.result + part -%}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{{- ns.result | trim -}}
|
|
{%- endmacro -%}
|
|
|
|
{%- macro format_tool_response_block(tool_name, response) -%}
|
|
{{- '<|tool_response>' -}}
|
|
{%- if response is mapping -%}
|
|
{{- 'response:' + tool_name + '{' -}}
|
|
{%- for key, value in response | dictsort -%}
|
|
{{- key -}}:{{- format_argument(value, escape_keys=False) -}}
|
|
{%- if not loop.last %},{% endif -%}
|
|
{%- endfor -%}
|
|
{{- '}' -}}
|
|
{%- else -%}
|
|
{{- 'response:' + tool_name + '{value:' + format_argument(response, escape_keys=False) + '}' -}}
|
|
{%- endif -%}
|
|
{{- '<tool_response|>' -}}
|
|
{%- endmacro -%}
|
|
|
|
{#- ===== SETUP ===== -#}
|
|
{%- set ns = namespace(prev_message_type=None, prev_non_tool_role=None) -%}
|
|
{%- set loop_messages = messages -%}
|
|
{%- set enable_thinking = enable_thinking | default(false) -%}
|
|
{#- Unsloth Studio: preserve_thinking defaults OFF (upstream PR #118 defaults true). -#}
|
|
{%- set preserve_thinking = preserve_thinking | default(false) -%}
|
|
{{- bos_token -}}
|
|
{#- Handle System/Tool Definitions Block -#}
|
|
{%- if enable_thinking or tools or (messages and messages[0]['role'] in ['system', 'developer']) -%}
|
|
{{- '<|turn>system\n' -}}
|
|
{#- Inject Thinking token at the very top of the FIRST system turn -#}
|
|
{%- if enable_thinking -%}
|
|
{{- '<|think|>\n' -}}
|
|
{%- set ns.prev_message_type = 'think' -%}
|
|
{%- endif -%}
|
|
{%- if messages and messages[0]['role'] in ['system', 'developer'] -%}
|
|
{%- if messages[0]['content'] is string -%}
|
|
{{- messages[0]['content'] | trim -}}
|
|
{%- elif messages[0]['content'] is sequence -%}
|
|
{%- for item in messages[0]['content'] -%}
|
|
{{- item['text'] | trim + ' '-}}
|
|
{%- endfor -%}
|
|
{%- endif -%}
|
|
{%- set loop_messages = messages[1:] -%}
|
|
{%- endif -%}
|
|
{%- if tools -%}
|
|
{%- for tool in tools %}
|
|
{{- '<|tool>' -}}
|
|
{{- format_function_declaration(tool) | trim -}}
|
|
{{- '<tool|>' -}}
|
|
{%- endfor %}
|
|
{%- set ns.prev_message_type = 'tool' -%}
|
|
{%- endif -%}
|
|
{{- '<turn|>\n' -}}
|
|
{%- endif %}
|
|
|
|
{#- Pre-scan: find last user message index for reasoning guard -#}
|
|
{%- set ns_turn = namespace(last_user_idx=-1) -%}
|
|
{%- for i in range(loop_messages | length) -%}
|
|
{%- if loop_messages[i]['role'] == 'user' -%}
|
|
{%- set ns_turn.last_user_idx = i -%}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
|
|
{#- Loop through messages -#}
|
|
{%- for message in loop_messages -%}
|
|
{%- if message['role'] != 'tool' -%}
|
|
{%- set ns.prev_message_type = None -%}
|
|
{%- set role = 'model' if message['role'] == 'assistant' else message['role'] -%}
|
|
{#- Detect continuation using tracked state - O(1) instead of O(n) backward scan -#}
|
|
{%- set continue_same_model_turn = (role == 'model' and ns.prev_non_tool_role == 'assistant') -%}
|
|
{%- if not continue_same_model_turn -%}
|
|
{{- '<|turn>' + role + '\n' }}
|
|
{%- endif -%}
|
|
|
|
{#- Render reasoning/reasoning_content as thinking channel (tool-call turns only) -#}
|
|
{%- set thinking_text = message.get('reasoning') or message.get('reasoning_content') -%}
|
|
{%- set thinking_gate = (loop.index0 > ns_turn.last_user_idx) or preserve_thinking -%}
|
|
{%- if thinking_text and thinking_gate and message.get('tool_calls') -%}
|
|
{{- '<|channel>thought\n' + thinking_text + '\n<channel|>' -}}
|
|
{%- endif -%}
|
|
|
|
{%- if message.get('tool_calls') -%}
|
|
{%- for tool_call in message.get('tool_calls') -%}
|
|
{%- set function = tool_call['function'] -%}
|
|
{{- '<|tool_call>call:' + function['name'] + '{' -}}
|
|
{%- if function['arguments'] is mapping -%}
|
|
{%- set ns_args = namespace(found_first=false) -%}
|
|
{%- for key, value in function['arguments'] | dictsort -%}
|
|
{%- if ns_args.found_first %},{% endif -%}
|
|
{%- set ns_args.found_first = true -%}
|
|
{{- key -}}:{{- format_argument(value, escape_keys=False) -}}
|
|
{%- endfor -%}
|
|
{%- elif function['arguments'] is none -%}
|
|
{%- else -%}
|
|
{{- raise_exception(
|
|
"chat_template: tool_calls[].function.arguments must be a "
|
|
"JSON object (mapping), not a string. Deserialize arguments "
|
|
"before passing to the template."
|
|
) -}}
|
|
{%- endif -%}
|
|
{{- '}<tool_call|>' -}}
|
|
{%- endfor -%}
|
|
{%- set ns.prev_message_type = 'tool_call' -%}
|
|
{%- endif -%}
|
|
|
|
{%- set ns_tr_out = namespace(flag=false) -%}
|
|
{%- if message.get('tool_responses') -%}
|
|
{#- Legacy: tool_responses embedded on the assistant message (Google/Gemma native) -#}
|
|
{%- for tool_response in message.get('tool_responses') -%}
|
|
{{- format_tool_response_block(tool_response['name'] | default('unknown', true), tool_response['response']) -}}
|
|
{%- set ns_tr_out.flag = true -%}
|
|
{%- set ns.prev_message_type = 'tool_response' -%}
|
|
{%- endfor -%}
|
|
{%- elif message.get('tool_calls') -%}
|
|
{#- OpenAI Chat Completions: forward-scan consecutive role:tool messages -#}
|
|
{%- set ns_tool_scan = namespace(stopped=false) -%}
|
|
{%- for k in range(loop.index0 + 1, loop_messages | length) -%}
|
|
{%- if ns_tool_scan.stopped -%}
|
|
{%- elif loop_messages[k]['role'] != 'tool' -%}
|
|
{%- set ns_tool_scan.stopped = true -%}
|
|
{%- else -%}
|
|
{%- set follow = loop_messages[k] -%}
|
|
{#- Resolve tool_call_id to function name -#}
|
|
{%- set ns_tname = namespace(name=follow.get('name') or 'unknown') -%}
|
|
{%- for tc in message.get('tool_calls') -%}
|
|
{%- if tc.get('id') == follow.get('tool_call_id') -%}
|
|
{%- set ns_tname.name = tc['function']['name'] -%}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{#- Handle content as string or content-parts array -#}
|
|
{%- set tool_body = follow.get('content') -%}
|
|
{%- if tool_body is string -%}
|
|
{{- format_tool_response_block(ns_tname.name, tool_body) -}}
|
|
{%- elif tool_body is sequence and tool_body is not string -%}
|
|
{%- set ns_txt = namespace(s='') -%}
|
|
{%- for part in tool_body -%}
|
|
{%- if part.get('type') == 'text' -%}
|
|
{%- set ns_txt.s = ns_txt.s + (part.get('text') | default('')) -%}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{{- format_tool_response_block(ns_tname.name, ns_txt.s) -}}
|
|
{%- for part in tool_body -%}
|
|
{%- if part.get('type') in ['image', 'image_url'] -%}
|
|
{{- '<|image|>' -}}
|
|
{%- elif part.get('type') in ['audio', 'input_audio'] -%}
|
|
{{- '<|audio|>' -}}
|
|
{%- elif part.get('type') == 'video' -%}
|
|
{{- '<|video|>' -}}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{%- else -%}
|
|
{{- format_tool_response_block(ns_tname.name, tool_body) -}}
|
|
{%- endif -%}
|
|
{%- set ns_tr_out.flag = true -%}
|
|
{%- set ns.prev_message_type = 'tool_response' -%}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{%- endif -%}
|
|
|
|
{%- set captured_content -%}
|
|
{%- if message.get('content') is string -%}
|
|
{%- if role == 'model' -%}
|
|
{{- strip_thinking(message['content']) -}}
|
|
{%- else -%}
|
|
{{- message['content'] | trim -}}
|
|
{%- endif -%}
|
|
{%- elif message.get('content') is sequence -%}
|
|
{%- for item in message['content'] -%}
|
|
{%- if item.get('type') == 'text' -%}
|
|
{%- if role == 'model' -%}
|
|
{{- strip_thinking(item['text']) -}}
|
|
{%- else -%}
|
|
{{- item['text'] | trim -}}
|
|
{%- endif -%}
|
|
{%- elif item.get('type') in ['image', 'image_url'] -%}
|
|
{{- '<|image|>' -}}
|
|
{%- elif item.get('type') in ['audio', 'input_audio'] -%}
|
|
{{- '<|audio|>' -}}
|
|
{%- elif item.get('type') == 'video' -%}
|
|
{{- '<|video|>' -}}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{%- endif -%}
|
|
{%- endset -%}
|
|
|
|
{{- captured_content -}}
|
|
{%- set has_content = captured_content | trim | length > 0 -%}
|
|
|
|
{#- Forward-scan: find next non-tool message role for continuation detection -#}
|
|
{%- set next_nt = namespace(role=None, found=false) -%}
|
|
{%- for j in range(loop.index0 + 1, loop_messages | length) -%}
|
|
{%- if not next_nt.found -%}
|
|
{%- if loop_messages[j]['role'] != 'tool' -%}
|
|
{%- set next_nt.role = loop_messages[j]['role'] -%}
|
|
{%- set next_nt.found = true -%}
|
|
{%- endif -%}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
|
|
{%- set continues_into_next = (
|
|
role == 'model'
|
|
and next_nt.role == 'assistant'
|
|
and not message.get('tool_calls')
|
|
and not ns_tr_out.flag
|
|
) -%}
|
|
|
|
{%- if ns.prev_message_type == 'tool_call' and not ns_tr_out.flag -%}
|
|
{{- '<|tool_response>' -}}
|
|
{%- elif continues_into_next -%}
|
|
{{- '\n' -}}
|
|
{%- elif not (ns_tr_out.flag and not has_content) -%}
|
|
{{- '<turn|>\n' -}}
|
|
{%- endif -%}
|
|
|
|
{#- Track previous non-tool role for next iteration (avoids O(n) backward scan) -#}
|
|
{%- set ns.prev_non_tool_role = message['role'] -%}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
|
|
{%- if add_generation_prompt -%}
|
|
{%- if ns.prev_message_type != 'tool_response' and ns.prev_message_type != 'tool_call' -%}
|
|
{{- '<|turn>model\n' -}}
|
|
{%- endif -%}
|
|
|
|
{%- if not enable_thinking -%}
|
|
{#- Suppress thinking - but not when awaiting tool responses -#}
|
|
{%- if ns.prev_message_type != 'tool_call' -%}
|
|
{{- '<|channel>thought\n<channel|>' -}}
|
|
{%- endif -%}
|
|
{%- endif -%}
|
|
{%- endif -%}
|