Merge pull request #2794 from SillyTavern/more-tokenizers Implement downloadable tokenizers

37b3184cda2637c558ac28cbbd06aa9fd5fb6a5c

Cohee <18619528+Cohee1207@users.noreply.github.com>

Signed
Parents: a6e50241225174e7b70714c69602675e4d07cbe4 81251b073aeb2f97f8e888f712b34a72f31915b5
6 files changed, +187 -10Showing whitespace changes
default/config.yaml+3 -0
@@ -95,6 +95,9 @@ requestOverrides: []
9595enableExtensions: true
9696# Automatically update extensions when a release version changes
9797enableExtensionsAutoUpdate: true
98+# Additional model tokenizers can be downloaded on demand.
99+# Disabling will fallback to another locally available tokenizer.
100+enableDownloadableTokenizers: true
98101# Extension settings
99102extras:
100103 # Disables automatic model download from HuggingFace
public/index.html+2 -0
@@ -3289,6 +3289,8 @@
32893289 <option value="12">Llama 3</option>
32903290 <option value="13">Gemma / Gemini</option>
32913291 <option value="14">Jamba</option>
3292+ <option value="15">Qwen2</option>
3293+ <option value="16">Command-R</option>
32923294 <option value="4">NerdStash (NovelAI Clio)</option>
32933295 <option value="5">NerdStash v2 (NovelAI Kayra)</option>
32943296 <option value="7">Mistral</option>
public/scripts/textgen-models.js+7 -0
@@ -590,6 +590,9 @@ function calculateOpenRouterCost() {
590590export function getCurrentOpenRouterModelTokenizer() {
591591 const modelId = textgen_settings.openrouter_model;
592592 const model = openRouterModels.find(x => x.id === modelId);
593+ if (modelId?.includes('jamba')) {
594+ return tokenizers.JAMBA;
595+ }
593596 switch (model?.architecture?.tokenizer) {
594597 case 'Llama2':
595598 return tokenizers.LLAMA;
@@ -603,6 +606,10 @@ export function getCurrentOpenRouterModelTokenizer() {
603606 return tokenizers.GEMMA;
604607 case 'Claude':
605608 return tokenizers.CLAUDE;
609+ case 'Cohere':
610+ return tokenizers.COMMAND_R;
611+ case 'Qwen':
612+ return tokenizers.QWEN2;
606613 default:
607614 return tokenizers.OPENAI;
608615 }
public/scripts/tokenizers.js+30 -0
@@ -28,6 +28,8 @@ export const tokenizers = {
2828 LLAMA3: 12,
2929 GEMMA: 13,
3030 JAMBA: 14,
31+ QWEN2: 15,
32+ COMMAND_R: 16,
3133 BEST_MATCH: 99,
3234};
3335
@@ -105,6 +107,16 @@ const TOKENIZER_URLS = {
105107 decode: '/api/tokenizers/jamba/decode',
106108 count: '/api/tokenizers/jamba/encode',
107109 },
110+ [tokenizers.QWEN2]: {
111+ encode: '/api/tokenizers/qwen2/encode',
112+ decode: '/api/tokenizers/qwen2/decode',
113+ count: '/api/tokenizers/qwen2/encode',
114+ },
115+ [tokenizers.COMMAND_R]: {
116+ encode: '/api/tokenizers/command-r/encode',
117+ decode: '/api/tokenizers/command-r/decode',
118+ count: '/api/tokenizers/command-r/encode',
119+ },
108120 [tokenizers.API_TEXTGENERATIONWEBUI]: {
109121 encode: '/api/tokenizers/remote/textgenerationwebui/encode',
110122 count: '/api/tokenizers/remote/textgenerationwebui/encode',
@@ -293,6 +305,12 @@ export function getTokenizerBestMatch(forApi) {
293305 if (model.includes('jamba')) {
294306 return tokenizers.JAMBA;
295307 }
308+ if (model.includes('command-r')) {
309+ return tokenizers.COMMAND_R;
310+ }
311+ if (model.includes('qwen2')) {
312+ return tokenizers.QWEN2;
313+ }
296314 }
297315
298316 return tokenizers.LLAMA;
@@ -511,6 +529,8 @@ export function getTokenizerModel() {
511529 const yiTokenizer = 'yi';
512530 const gemmaTokenizer = 'gemma';
513531 const jambaTokenizer = 'jamba';
532+ const qwen2Tokenizer = 'qwen2';
533+ const commandRTokenizer = 'command-r';
514534
515535 // Assuming no one would use it for different models.. right?
516536 if (oai_settings.chat_completion_source == chat_completion_sources.SCALE) {
@@ -558,6 +578,12 @@ export function getTokenizerModel() {
558578 else if (model?.architecture?.tokenizer === 'Gemini') {
559579 return gemmaTokenizer;
560580 }
581+ else if (model?.architecture?.tokenizer === 'Qwen') {
582+ return qwen2Tokenizer;
583+ }
584+ else if (model?.architecture?.tokenizer === 'Cohere') {
585+ return commandRTokenizer;
586+ }
561587 else if (oai_settings.openrouter_model.includes('gpt-4o')) {
562588 return gpt4oTokenizer;
563589 }
@@ -581,6 +607,10 @@ export function getTokenizerModel() {
581607 }
582608 }
583609
610+ if (oai_settings.chat_completion_source == chat_completion_sources.COHERE) {
611+ return commandRTokenizer;
612+ }
613+
584614 if (oai_settings.chat_completion_source == chat_completion_sources.MAKERSUITE) {
585615 return gemmaTokenizer;
586616 }
src/endpoints/tokenizers.js+130 -10
@@ -4,13 +4,12 @@ const express = require('express');
44const { SentencePieceProcessor } = require('@agnai/sentencepiece-js');
55const tiktoken = require('tiktoken');
66const { Tokenizer } = require('@agnai/web-tokenizers');
77const { convertClaudePrompt, convertGooglePrompt } = require('../prompt-converters');
8-const { readSecret, SECRET_KEYS } = require('./secrets');
98const { TEXTGEN_TYPES } = require('../constants');
109const { jsonParser } = require('../express-common');
1110const { setAdditionalHeaders } = require('../additional-headers');
12-
11+const { getConfigValue, isValidUrl } = require('../util');
13-const API_MAKERSUITE = 'https://generativelanguage.googleapis.com';
12+const writeFileAtomicSync = require('write-file-atomic').sync;
1413
1514/**
1615 * @typedef { (req: import('express').Request, res: import('express').Response) => Promise<any> } TokenizationHandler
@@ -53,6 +52,65 @@ const TEXT_COMPLETION_MODELS = [
5352];
5453
5554const CHARS_PER_TOKEN = 3.35;
55+const IS_DOWNLOAD_ALLOWED = getConfigValue('enableDownloadableTokenizers', true);
56+
57+/**
58+ * Gets a path to the tokenizer model. Downloads the model if it's a URL.
59+ * @param {string} model Model URL or path
60+ * @param {string|undefined} fallbackModel Fallback model path\
61+ * @returns {Promise<string>} Path to the tokenizer model
62+ */
63+async function getPathToTokenizer(model, fallbackModel) {
64+ if (!isValidUrl(model)) {
65+ return model;
66+ }
67+
68+ try {
69+ const url = new URL(model);
70+
71+ if (!['https:', 'http:'].includes(url.protocol)) {
72+ throw new Error('Invalid URL protocol');
73+ }
74+
75+ const fileName = url.pathname.split('/').pop();
76+
77+ if (!fileName) {
78+ throw new Error('Failed to extract the file name from the URL');
79+ }
80+
81+ const CACHE_PATH = path.join(global.DATA_ROOT, '_cache');
82+ if (!fs.existsSync(CACHE_PATH)) {
83+ fs.mkdirSync(CACHE_PATH, { recursive: true });
84+ }
85+
86+ const cachedFile = path.join(CACHE_PATH, fileName);
87+ if (fs.existsSync(cachedFile)) {
88+ return cachedFile;
89+ }
90+
91+ if (!IS_DOWNLOAD_ALLOWED) {
92+ throw new Error('Downloading tokenizers is disabled, the model is not cached');
93+ }
94+
95+ console.log('Downloading tokenizer model:', model);
96+ const response = await fetch(model);
97+ if (!response.ok) {
98+ throw new Error(`Failed to fetch the model: ${response.status} ${response.statusText}`);
99+ }
100+
101+ const arrayBuffer = await response.arrayBuffer();
102+ writeFileAtomicSync(cachedFile, Buffer.from(arrayBuffer));
103+ return cachedFile;
104+ } catch (error) {
105+ const getLastSegment = str => str?.split('/')?.pop() || '';
106+ if (fallbackModel) {
107+ console.log(`Could not get a tokenizer from ${getLastSegment(model)}. Reason: ${error.message}. Using a fallback model: ${getLastSegment(fallbackModel)}.`);
108+ return fallbackModel;
109+ }
110+
111+ throw new Error(`Failed to instantiate a tokenizer and fallback is not provided. Reason: ${error.message}`);
112+ }
113+}
56114
57115/**
58116 * Sentencepiece tokenizer for tokenizing text.
@@ -66,13 +124,19 @@ class SentencePieceTokenizer {
66124 * @type {string} Path to the tokenizer model
67125 */
68126 #model;
127+ /**
128+ * @type {string|undefined} Path to the fallback model
129+ */
130+ #fallbackModel;
69131
70132 /**
71133 * Creates a new Sentencepiece tokenizer.
72134 * @param {string} model Path to the tokenizer model
135+ * @param {string} [fallbackModel] Path to the fallback model
73136 */
74137 constructor(model, fallbackModel) {
75138 this.#model = model;
139+ this.#fallbackModel = fallbackModel;
76140 }
77141
78142 /**
@@ -85,9 +149,10 @@ class SentencePieceTokenizer {
85149 }
86150
87151 try {
152+ const pathToModel = await getPathToTokenizer(this.#model, this.#fallbackModel);
88153 this.#instance = new SentencePieceProcessor();
89154 await this.#instance.load(this.#modelpathToModel);
90155 console.log('Instantiated the tokenizer for', path.parse(this.#modelpathToModel).name);
91156 return this.#instance;
92157 } catch (error) {
93158 console.error('Sentencepiece tokenizer failed to load: ' + this.#model, error);
@@ -108,13 +173,19 @@ class WebTokenizer {
108173 * @type {string} Path to the tokenizer model
109174 */
110175 #model;
176+ /**
177+ * @type {string|undefined} Path to the fallback model
178+ */
179+ #fallbackModel;
111180
112181 /**
113182 * Creates a new Web tokenizer.
114183 * @param {string} model Path to the tokenizer model
184+ * @param {string} [fallbackModel] Path to the fallback model
115185 */
116186 constructor(model, fallbackModel) {
117187 this.#model = model;
188+ this.#fallbackModel = fallbackModel;
118189 }
119190
120191 /**
@@ -127,9 +198,10 @@ class WebTokenizer {
127198 }
128199
129200 try {
130201 const arrayBufferpathToModel = fs.readFileSyncawait getPathToTokenizer(this.#model), this.buffer#fallbackModel);
202+ const arrayBuffer = fs.readFileSync(pathToModel).buffer;
131203 this.#instance = await Tokenizer.fromJSON(arrayBuffer);
132204 console.log('Instantiated the tokenizer for', path.parse(this.#modelpathToModel).name);
133205 return this.#instance;
134206 } catch (error) {
135207 console.error('Web tokenizer failed to load: ' + this.#model, error);
@@ -147,6 +219,8 @@ const spp_gemma = new SentencePieceTokenizer('src/tokenizers/gemma.model');
147219const spp_jamba = new SentencePieceTokenizer('src/tokenizers/jamba.model');
148220const claude_tokenizer = new WebTokenizer('src/tokenizers/claude.json');
149221const llama3_tokenizer = new WebTokenizer('src/tokenizers/llama3.json');
222+const commandTokenizer = new WebTokenizer('https://github.com/SillyTavern/SillyTavern-Tokenizers/raw/main/command-r.json', 'src/tokenizers/llama3.json');
223+const qwen2Tokenizer = new WebTokenizer('https://github.com/SillyTavern/SillyTavern-Tokenizers/raw/main/qwen2.json', 'src/tokenizers/llama3.json');
150224
151225const sentencepieceTokenizers = [
152226 'llama',
@@ -332,6 +406,14 @@ function getTokenizerModel(requestModel) {
332406 return 'jamba';
333407 }
334408
409+ if (requestModel.includes('qwen2')) {
410+ return 'qwen2';
411+ }
412+
413+ if (requestModel.includes('command-r')) {
414+ return 'command-r';
415+ }
416+
335417 // default
336418 return 'gpt-3.5-turbo';
337419}
@@ -557,6 +639,8 @@ router.post('/jamba/encode', jsonParser, createSentencepieceEncodingHandler(spp_
557639router.post('/gpt2/encode', jsonParser, createTiktokenEncodingHandler('gpt2'));
558640router.post('/claude/encode', jsonParser, createWebTokenizerEncodingHandler(claude_tokenizer));
559641router.post('/llama3/encode', jsonParser, createWebTokenizerEncodingHandler(llama3_tokenizer));
642+router.post('/qwen2/encode', jsonParser, createWebTokenizerEncodingHandler(qwen2Tokenizer));
643+router.post('/command-r/encode', jsonParser, createWebTokenizerEncodingHandler(commandTokenizer));
560644router.post('/llama/decode', jsonParser, createSentencepieceDecodingHandler(spp_llama));
561645router.post('/nerdstash/decode', jsonParser, createSentencepieceDecodingHandler(spp_nerd));
562646router.post('/nerdstash_v2/decode', jsonParser, createSentencepieceDecodingHandler(spp_nerd_v2));
@@ -567,6 +651,8 @@ router.post('/jamba/decode', jsonParser, createSentencepieceDecodingHandler(spp_
567651router.post('/gpt2/decode', jsonParser, createTiktokenDecodingHandler('gpt2'));
568652router.post('/claude/decode', jsonParser, createWebTokenizerDecodingHandler(claude_tokenizer));
569653router.post('/llama3/decode', jsonParser, createWebTokenizerDecodingHandler(llama3_tokenizer));
654+router.post('/qwen2/decode', jsonParser, createWebTokenizerDecodingHandler(qwen2Tokenizer));
655+router.post('/command-r/decode', jsonParser, createWebTokenizerDecodingHandler(commandTokenizer));
570656
571657router.post('/openai/encode', jsonParser, async function (req, res) {
572658 try {
@@ -607,6 +693,16 @@ router.post('/openai/encode', jsonParser, async function (req, res) {
607693 return handler(req, res);
608694 }
609695
696+ if (queryModel.includes('qwen2')) {
697+ const handler = createWebTokenizerEncodingHandler(qwen2Tokenizer);
698+ return handler(req, res);
699+ }
700+
701+ if (queryModel.includes('command-r')) {
702+ const handler = createWebTokenizerEncodingHandler(commandTokenizer);
703+ return handler(req, res);
704+ }
705+
610706 const model = getTokenizerModel(queryModel);
611707 const handler = createTiktokenEncodingHandler(model);
612708 return handler(req, res);
@@ -655,6 +751,16 @@ router.post('/openai/decode', jsonParser, async function (req, res) {
655751 return handler(req, res);
656752 }
657753
754+ if (queryModel.includes('qwen2')) {
755+ const handler = createWebTokenizerDecodingHandler(qwen2Tokenizer);
756+ return handler(req, res);
757+ }
758+
759+ if (queryModel.includes('command-r')) {
760+ const handler = createWebTokenizerDecodingHandler(commandTokenizer);
761+ return handler(req, res);
762+ }
763+
658764 const model = getTokenizerModel(queryModel);
659765 const handler = createTiktokenDecodingHandler(model);
660766 return handler(req, res);
@@ -711,6 +817,20 @@ router.post('/openai/count', jsonParser, async function (req, res) {
711817 return res.send({ 'token_count': num_tokens });
712818 }
713819
820+ if (model === 'qwen2') {
821+ const instance = await qwen2Tokenizer.get();
822+ if (!instance) throw new Error('Failed to load the Qwen2 tokenizer');
823+ num_tokens = countWebTokenizerTokens(instance, req.body);
824+ return res.send({ 'token_count': num_tokens });
825+ }
826+
827+ if (model === 'command-r') {
828+ const instance = await commandTokenizer.get();
829+ if (!instance) throw new Error('Failed to load the Command-R tokenizer');
830+ num_tokens = countWebTokenizerTokens(instance, req.body);
831+ return res.send({ 'token_count': num_tokens });
832+ }
833+
714834 const tokensPerName = queryModel.includes('gpt-3.5-turbo-0301') ? -1 : 1;
715835 const tokensPerMessage = queryModel.includes('gpt-3.5-turbo-0301') ? 4 : 3;
716836 const tokensPadding = 3;
src/util.js+15 -0
@@ -647,6 +647,20 @@ function getSeparator(n) {
647647 return '='.repeat(n);
648648}
649649
650+/**
651+ * Checks if the string is a valid URL.
652+ * @param {string} url String to check
653+ * @returns {boolean} If the URL is valid
654+ */
655+function isValidUrl(url) {
656+ try {
657+ new URL(url);
658+ return true;
659+ } catch (error) {
660+ return false;
661+ }
662+}
663+
650664module.exports = {
651665 getConfig,
652666 getConfigValue,
@@ -676,4 +690,5 @@ module.exports = {
676690 makeHttp2Request,
677691 removeColorFormatting,
678692 getSeparator,
693+ isValidUrl,
679694};