feature: customizable mappings for presets per model name / chat template (#4153) * feature: customizable mappings for presets per chat template This adds the ability to assign custom context/instruct presets on a per-chat-template(-hash) basis. Users using custom templates may use this feature to auto-enable the preset of their choice, rather than the built-in defaults. * fix: do not use chat tempate based instruct preset derivation if a preset was auto-selected already This fixes issues where regex matched presets are overridden. * reset chat template hash on connect * handle derive_mappings being null * unorthodox eslint requirement adherence * button styling * un-nest derivation related properties * Migrate setting * add bind model to preset button to the miscellaneous section * switch to unified button for model preset mappings * fix bind UI * eslint * do not include koboldcpp/ggml-model-xxx.gguf in preset saving * review fixes * stray console.log / eslint * Update checkbox state if no model map exists --------- Co-authored-by: Cohee <18619528+Cohee1207@users.noreply.github.com>

1b2976ae1d6eace7785057e00eaa2db8a22b5374

kallewoof <karljohan-alm@garage.co.jp>

Signed

Parents: 380c88d401b6f4b262cab96883aedc37f0983b5d

public/index.html+7 -0 Viewed

                         </div>
                         <div>
                             <h4 class="standoutHeader" data-i18n="Miscellaneous">Miscellaneous</h4>
+                            <div name="bindModelPresetBlock">
+                                <label for="bind_model_templates" class="checkbox_label">
+                                    <input id="bind_model_templates" type="checkbox" />
+                                    <small data-i18n="Bind Model to Templates">Bind Model to Templates</small>
+                                    <span class="fa-solid fa-circle-question" data-i18n="[title]bind_model_templates_desc" title="When connecting to an API or choosing a model, automatically activate the current Instruct and Context templates if the model name or its chat template matches the currently loaded model."></span>
+                                </label>
+                            </div>
                             <div>
                                 <small>
                                     <span data-i18n="Non-markdown strings">

public/script.js+11 -9 Viewed

             setOnlineStatus('no_connection');
+        }
+        power_user.chat_template_hash = '';
         // Determine instruct mode preset
-        autoSelectInstructPreset(online_status);
+        const autoSelected = autoSelectInstructPreset(online_status);
         const supportsTokenization = response.headers.get('x-supports-tokenization') === 'true';
         supportsTokenization ? sessionStorage.setItem(TOKENIZER_SUPPORTED_KEY, 'true') : sessionStorage.removeItem(TOKENIZER_SUPPORTED_KEY);
-        const wantsInstructDerivation = (power_user.instruct.enabled && power_user.instruct.derived);
+        const wantsInstructDerivation = !autoSelected && (power_user.instruct.enabled && power_user.instruct_derived);
-        const wantsContextDerivation = power_user.context_derived;
+        const wantsContextDerivation = !autoSelected && power_user.context_derived;
         const wantsContextSize = power_user.context_size_derived;
         const supportsChatTemplate = [textgen_types.KOBOLDCPP, textgen_types.LLAMACPP].includes(textgen_settings.type);
         if (supportsChatTemplate && (wantsInstructDerivation || wantsContextDerivation || wantsContextSize)) {
             const response = await fetch('/api/backends/text-completions/props', {
                 method: 'POST',

                 const data = await response.json();
                 if (data) {
                     const { chat_template, chat_template_hash } = data;
+                    power_user.chat_template_hash = chat_template_hash;
                     if (wantsContextSize && 'default_generation_settings' in data) {
                         const backend_max_context = data['default_generation_settings']['n_ctx'];
                         const old_value = max_context;

@@ -1351,19 +1356,16 @@ async function getStatusTextgen() {
1351	}	1356	}
1352	}	1357	}
1353	console.log(`We have chat template ${chat_template.split('\n')[0]}...`);	1358	console.log(`We have chat template ${chat_template.split('\n')[0]}...`);
1354	const templates = await deriveTemplatesFromChatTemplate(chat_template, chat_template_hash);	1359	const { context, instruct } = await deriveTemplatesFromChatTemplate(chat_template, chat_template_hash);
1355	if (templates) {	1360	if (wantsContextDerivation && context) {
1356	const { context, instruct } = templates;
1357	if (wantsContextDerivation) {
1358	selectContextPreset(context, { isAuto: true });	1361	selectContextPreset(context, { isAuto: true });
1359	}	1362	}
1360	if (wantsInstructDerivation) {	1363	if (wantsInstructDerivation && power_user.instruct.enabled && instruct) {
1361	selectInstructPreset(instruct, { isAuto: true });	1364	selectInstructPreset(instruct, { isAuto: true });
1362	}	1365	}
1363	}	1366	}
1364	}	1367	}
1365	}	1368	}
1366	}
1367		1369
1368	// We didn't get a 200 status code, but the endpoint has an explanation. Which means it DID connect, but I digress.	1370	// We didn't get a 200 status code, but the endpoint has an explanation. Which means it DID connect, but I digress.
1369	if (online_status === 'no_connection' && data.response) {	1371	if (online_status === 'no_connection' && data.response) {

public/scripts/chat-templates.js+64 -2 Viewed

     'instruct': derivation,
 } : derivation;
+const not_found = { context: null, instruct: null };
 export async function deriveTemplatesFromChatTemplate(chat_template, hash) {
     if (chat_template.trim() === '') {
         console.log('Missing chat template.');
-        return null;
+        return not_found;
+    }
     if (hash in hash_derivations) {

+    }
     console.warn(`Unknown chat template hash: ${hash} for [${chat_template}]`);
-    return null;
+    return not_found;
+}
+export async function bindModelTemplates(power_user, online_status) {
+    if (online_status === 'no_connection') {
+        return false;
+    }
+    const chat_template_hash = power_user.chat_template_hash;
+    const bind_model_templates = power_user.model_templates_mappings[online_status]
+        ?? power_user.model_templates_mappings[chat_template_hash]
+        ?? {};
+    const bindings_match = bind_model_templates && power_user.context.preset == bind_model_templates['context'] && (!power_user.instruct.enabled || power_user.instruct.preset === bind_model_templates['instruct']);
+    const bound = [];
+    if (bindings_match) {
+        // unmap current preset
+        delete power_user.model_templates_mappings[chat_template_hash];
+        delete power_user.model_templates_mappings[online_status];
+        toastr.info(`Context preset for ${online_status} will use defaults when loaded the next time.`);
+    } else {
+        if (power_user.context_derived) {
+            if (power_user.context.preset !== bind_model_templates['context']) {
+                bound.push(`${power_user.context.preset} context preset`);
+                // toastr.info(`Bound ${power_user.context.preset} preset to currently loaded model and all models that share its chat template.`);
+                // map current preset to current chat template hash
+                bind_model_templates['context'] = power_user.context.preset;
+            }
+        } else {
+            toastr.warning('Note: Context derivation is disabled. Not including context preset.');
+        }
+        if (power_user.instruct.enabled) {
+            if (power_user.instruct_derived) {
+                if (power_user.instruct.preset !== bind_model_templates['instruct']) {
+                    bound.push(`${power_user.instruct.preset} instruct preset`);
+                    bind_model_templates['instruct'] = power_user.instruct.preset;
+                }
+            } else {
+                toastr.warning('Note: Instruct derivation is disabled. Not including instruct preset.');
+            }
+        }
+        if (bound.length == 0) {
+            toastr.warning('No applicable presets available.');
+            return false;
+        }
+        toastr.info(`Bound ${online_status} to ${bound.join(', ')}.`);
+        if (!online_status.startsWith('koboldcpp/ggml-model-')) {
+            power_user.model_templates_mappings[online_status] = bind_model_templates;
+        }
+        if (chat_template_hash !== '') {
+            power_user.model_templates_mappings[chat_template_hash] = bind_model_templates;
+        }
+    }
+    return true;
+}

public/scripts/instruct-mode.js+37 -4 Viewed

 'use strict';
-import { name1, name2, saveSettingsDebounced, substituteParams } from '../script.js';
+import { name1, name2, online_status, saveSettingsDebounced, substituteParams } from '../script.js';
 import { selected_group } from './group-chats.js';
 import { parseExampleIntoIndividual } from './openai.js';
 import {

     { id: 'instruct_first_input_sequence', property: 'first_input_sequence', isCheckbox: false },
     { id: 'instruct_last_input_sequence', property: 'last_input_sequence', isCheckbox: false },
     { id: 'instruct_activation_regex', property: 'activation_regex', isCheckbox: false },
-    { id: 'instruct_derived', property: 'derived', isCheckbox: true },
     { id: 'instruct_bind_to_context', property: 'bind_to_context', isCheckbox: true },
     { id: 'instruct_skip_examples', property: 'skip_examples', isCheckbox: true },
     { id: 'instruct_names_behavior', property: 'names_behavior', isCheckbox: false },

     $('#instruct_enabled').parent().find('i').toggleClass('toggleEnabled', !!power_user.instruct.enabled);
     $('#instructSettingsBlock, #InstructSequencesColumn').toggleClass('disabled', !power_user.instruct.enabled);
-    $('#instruct_derived').parent().find('i').toggleClass('toggleEnabled', !!power_user.instruct.derived);
+    $('#instruct_derived').parent().find('i').toggleClass('toggleEnabled', !!power_user.instruct_derived);
     $('#instruct_bind_to_context').parent().find('i').toggleClass('toggleEnabled', !!power_user.instruct.bind_to_context);
     controls.forEach(control => {

+}
 /**
+ * Updates the bind model template state based on the current model, instruct and context preset.
+ */
+export function updateBindModelTemplatesState() {
+    const bind_model_templates = power_user.model_templates_mappings[online_status] ?? power_user.model_templates_mappings[power_user.chat_template_hash];
+    const bindings_match = (bind_model_templates && power_user.context.preset === bind_model_templates['context'] && (!power_user.instruct.enabled || power_user.instruct.preset === bind_model_templates['instruct'])) ?? false;
+    const current = $('#bind_model_templates').prop('checked');
+    if (bindings_match === current) {
+        return; // No change needed
+    }
+    $('#bind_model_templates').prop('checked', bindings_match);
+}
+/**
  * Select context template if not already selected.
  * @param {string} preset Preset name.
  * @param {object} [options={}] Optional arguments.

@@ -161,6 +173,8 @@ export function selectContextPreset(preset, { quiet = false, isAuto = false } =
161	!quiet && toastr.info(`Context Template: "${preset}" ${isAuto ? 'auto-' : ''}selected`);	173	!quiet && toastr.info(`Context Template: "${preset}" ${isAuto ? 'auto-' : ''}selected`);
162	}	174	}
163		175
		176	updateBindModelTemplatesState();
		177
164	saveSettingsDebounced();	178	saveSettingsDebounced();
165	}	179	}
166		180

@@ -191,6 +205,8 @@ export function selectInstructPreset(preset, { quiet = false, isAuto = false } =
191	!quiet && toastr.info('Instruct Mode enabled');	205	!quiet && toastr.info('Instruct Mode enabled');
192	}	206	}
193		207
		208	updateBindModelTemplatesState();
		209
194	saveSettingsDebounced();	210	saveSettingsDebounced();
195	}	211	}
196		212

  * @returns {boolean} True if instruct preset was activated by model id, false otherwise.
  */
 export function autoSelectInstructPreset(modelId) {
+    const model_templates_map = power_user.model_templates_mappings[modelId];
+    if (model_templates_map) {
+        const { instruct, context } = model_templates_map;
+        if (instruct) {
+            selectInstructPreset(instruct, { isAuto: true });
+        }
+        if (context) {
+            selectContextPreset(context, { isAuto: true });
+        }
+        return true;
+    } else {
+        updateBindModelTemplatesState();
+    }
     // If instruct mode is disabled, don't do anything
     if (!power_user.instruct.enabled) {
         return false;

     });
     $('#instruct_derived').on('change', function () {
-        $('#instruct_derived').parent().find('i').toggleClass('toggleEnabled', !!power_user.instruct.derived);
+        $('#instruct_derived').parent().find('i').toggleClass('toggleEnabled', !!power_user.instruct_derived);
     });
     $('#instruct_bind_to_context').on('change', function () {

             // Select matching context template
             selectMatchingContextTemplate(name);
+        }
+        updateBindModelTemplatesState();
     });
     if (!CSS.supports('field-sizing', 'content')) {

public/scripts/power-user.js+36 -1 Viewed

     setActiveCharacter,
     entitiesFilter,
     doNewChat,
+    online_status,
     messageFormatting,
 } from '../script.js';
 import { isMobile, initMovingUI, favsToHotswap } from './RossAscends-mods.js';

     loadInstructMode,
     names_behavior_types,
     selectInstructPreset,
+    updateBindModelTemplatesState,
 } from './instruct-mode.js';
 import { getTagsList, tag_import_setting, tag_map, tags } from './tags.js';

 import { fuzzySearchCategories } from './filters.js';
 import { accountStorage } from './util/AccountStorage.js';
 import { DEFAULT_REASONING_TEMPLATE, loadReasoningTemplates } from './reasoning.js';
+import { bindModelTemplates } from './chat-templates.js';
 export {
     loadPowerUserSettings,

         macro: true,
         names_behavior: names_behavior_types.FORCE,
         activation_regex: '',
-        derived: false,
         bind_to_context: false,
         user_alignment_message: '',
         system_same_as_user: false,

         names_as_stop_strings: true,
     },
+    chat_template_hash: '', /** the chat template hash of the currently loaded model, if any; used when deriving mappings */
+    instruct_derived: false,
     context_derived: false,
     context_size_derived: false,
+    model_templates_mappings: {}, /** user defined model identifier / chat template hash to instruct/context template mappings */
     sysprompt: {
         enabled: true,

         delete power_user.import_card_tags;
+    }
+    if (power_user?.instruct?.derived === true) {
+        power_user.instruct_derived = true;
+        delete power_user.instruct.derived;
+    }
+    power_user.chat_template_hash = '';
     $('#single_line').prop('checked', power_user.single_line);
     $('#relaxed_api_urls').prop('checked', power_user.relaxed_api_urls);
     $('#world_import_dialog').prop('checked', power_user.world_import_dialog);

     $('#encode_tags').prop('checked', power_user.encode_tags);
     $('#example_messages_behavior').val(getExampleMessagesBehavior());
     $(`#example_messages_behavior option[value="${getExampleMessagesBehavior()}"]`).prop('selected', true);
+    $('#instruct_derived').parent().find('i').toggleClass('toggleEnabled', !!power_user.instruct_derived);
     $('#context_derived').parent().find('i').toggleClass('toggleEnabled', !!power_user.context_derived);
     $('#context_size_derived').prop('checked', !!power_user.context_size_derived);

@@ -1910,6 +1924,7 @@ async function loadContextSettings() {
1910	}	1924	}
1911		1925
1912	power_user.context.preset = name;	1926	power_user.context.preset = name;
		1927
1913	contextControls.forEach(control => {	1928	contextControls.forEach(control => {
1914	const presetValue = preset[control.property] ?? control.defaultValue;	1929	const presetValue = preset[control.property] ?? control.defaultValue;
1915		1930

@@ -1944,6 +1959,8 @@ async function loadContextSettings() {
1944	}	1959	}
1945	}	1960	}
1946		1961
		1962	updateBindModelTemplatesState();
		1963
1947	saveSettingsDebounced();	1964	saveSettingsDebounced();
1948	});	1965	});
1949	}	1966	}

         $('#context_derived').parent().find('i').toggleClass('toggleEnabled', !!power_user.context_derived);
     });
+    $('#instruct_derived').on('input', function () {
+        const value = !!$(this).prop('checked');
+        power_user.instruct_derived = value;
+        saveSettingsDebounced();
+    });
+    $('#instruct_derived').on('change', function () {
+        $('#instruct_derived').parent().find('i').toggleClass('toggleEnabled', !!power_user.instruct_derived);
+    });
     $('#context_size_derived').on('input', function () {
         const value = !!$(this).prop('checked');
         power_user.context_size_derived = value;

         $('#context_size_derived').prop('checked', !!power_user.context_size_derived);
     });
+    $('#bind_model_templates').on('input', function () {
+        if (bindModelTemplates(power_user, online_status)) {
+            saveSettingsDebounced();
+        }
+    });
+    $('#bind_model_templates').on('change', updateBindModelTemplatesState);
     $('#always-force-name2-checkbox').change(function () {
         power_user.always_force_name2 = !!$(this).prop('checked');
         saveSettingsDebounced();