modprompt 0.0.7 → 0.0.9

package/README.md

@@ -36,11 +36,11 @@ console.log(templateNames);
 To load a template:
 
 ```js
-import { templates, ModTemplate } from "modprompt";
+import { templates, PromptTemplate } from "modprompt";
 
-const tpl = new ModTemplate(templates.alpaca)
+const tpl = new PromptTemplate(templates.alpaca)
 // or
-const tpl = new ModTemplate("alpaca")
+const tpl = new PromptTemplate("alpaca")
 ```
 
 ### Render a template
@@ -158,7 +158,7 @@ fix this invalid json:
 The calls can be chained. Example with the code above:
 
 ```js
-const tpl = new ModTemplate(templates.llama)
+const tpl = new PromptTemplate(templates.llama)
   .afterSystem("You are a javascript specialist")
   .afterAssistant(" (answer in valid json)")
   .replacePrompt("fix this invalid json:\n\n```json\n{prompt}\n```")

package/dist/cls.d.ts

@@ -1,5 +1,6 @@
 import { LmTemplate, PromptBlock, TurnBlock, SpacingSlots } from "./interfaces";
-declare class ModTemplate implements LmTemplate {
+declare class PromptTemplate {
+    id: string;
     name: string;
     user: string;
     assistant: string;
@@ -7,14 +8,15 @@ declare class ModTemplate implements LmTemplate {
     shots?: Array<TurnBlock>;
     stop?: Array<string>;
     linebreaks?: SpacingSlots;
-    spacing?: SpacingSlots;
-    private _systemBlock;
+    _systemBlock: string;
     constructor(template: string | LmTemplate);
-    replaceSystem(msg: string): ModTemplate;
-    afterSystem(msg: string): ModTemplate;
-    afterAssistant(msg: string): ModTemplate;
-    replacePrompt(msg: string): ModTemplate;
-    addShot(user: string, assistant: string): ModTemplate;
+    cloneTo(name: string): PromptTemplate;
+    toJson(): LmTemplate;
+    replaceSystem(msg: string): PromptTemplate;
+    afterSystem(msg: string): PromptTemplate;
+    afterAssistant(msg: string): PromptTemplate;
+    replacePrompt(msg: string): PromptTemplate;
+    addShot(user: string, assistant: string): PromptTemplate;
     render(): string;
     prompt(msg: string): string;
     private _buildSystemBlock;
@@ -22,4 +24,4 @@ declare class ModTemplate implements LmTemplate {
     private _buildAssistantBlock;
     private _load;
 }
-export { ModTemplate };
+export { PromptTemplate };

package/dist/interfaces.d.ts

@@ -12,6 +12,7 @@ interface TurnBlock {
     assistant: string;
 }
 interface LmTemplate {
+    id: string;
     name: string;
     user: string;
     assistant: string;

package/dist/main.d.ts

@@ -1,4 +1,4 @@
 import { templates } from "./db.js";
-import { ModTemplate } from "./cls.js";
+import { PromptTemplate } from "./cls.js";
 import { SpacingSlots, PromptBlock, TurnBlock, LmTemplate } from "./interfaces.js";
-export { templates, ModTemplate, SpacingSlots, PromptBlock, TurnBlock, LmTemplate };
+export { templates, PromptTemplate, SpacingSlots, PromptBlock, TurnBlock, LmTemplate };

package/dist/mod.es.mjs

@@ -1,5 +1,6 @@
 const templates = {
     "alpaca": {
+        "id": "alpaca",
         "name": "Alpaca",
         "system": {
             "schema": "{system}",
@@ -13,19 +14,21 @@ const templates = {
         }
     },
     "llama": {
+        "id": "llama",
         "name": "Llama",
         "system": {
             "schema": "<s>[INST] <<SYS>>\n{system}\n<</SYS>>",
             "message": "You are a helpful, respectful and honest assistant. Always answer as helpfully as possible\n\nIf a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information."
         },
         "user": "{prompt}",
-        "assistant": " [/INST]",
+        "assistant": " [/INST] ",
         "linebreaks": {
             "system": 2,
             "user": 0
         }
     },
     "llama_instruct": {
+        "id": "llama_instruct",
         "name": "Llama instruct",
         "user": "[INST] {prompt}",
         "assistant": " [/INST]",
@@ -33,7 +36,15 @@ const templates = {
             "user": 1
         },
     },
+    "mistral": {
+        "id": "mistral",
+        "name": "Mistral",
+        "user": "<s>[INST] {prompt}",
+        "assistant": " [/INST]",
+        "stop": ["</s>"]
+    },
     "orca": {
+        "id": "orca",
         "name": "Orca",
         "system": {
             "schema": "### System:\n{system}",
@@ -47,6 +58,7 @@ const templates = {
         }
     },
     "vicuna": {
+        "id": "vicuna",
         "name": "Vicuna",
         "user": "USER: {prompt}",
         "assistant": "### ASSISTANT:",
@@ -55,6 +67,7 @@ const templates = {
         },
     },
     "vicuna_system": {
+        "id": "vicuna_system",
         "name": "Vicuna system",
         "system": {
             "schema": "SYSTEM: {system}",
@@ -66,6 +79,7 @@ const templates = {
         },
     },
     "wizard_vicuna": {
+        "id": "wizard_vicuna",
         "name": "Wizard Vicuna",
         "user": "### Human:\n{prompt}",
         "assistant": "### ASSISTANT:",
@@ -75,6 +89,7 @@ const templates = {
         "stop": ["<|endoftext|>"]
     },
     "guanaco": {
+        "id": "guanaco",
         "name": "Guanaco",
         "user": "### Human: {prompt}",
         "assistant": "### Assistant:",
@@ -83,6 +98,7 @@ const templates = {
         },
     },
     "chatml": {
+        "id": "chatml",
         "name": "ChatMl",
         "system": {
             "schema": "<|im_start|>system\n{system}\n<|im_end|>",
@@ -96,12 +112,14 @@ const templates = {
         }
     },
     "mamba": {
+        "id": "mamba",
         "name": "Mamba",
         "user": "<|prompt|>{prompt}</s>",
         "assistant": "<|answer|>",
         "stop": ["<|endoftext|>"]
     },
     "wizardlm": {
+        "id": "wizardlm",
         "name": "WizardLM",
         "system": {
             "schema": "{system}",
@@ -114,6 +132,7 @@ const templates = {
         },
     },
     "human_response": {
+        "id": "human_response",
         "name": "Human response",
         "user": "### HUMAN:\n{prompt}",
         "assistant": "### RESPONSE:",
@@ -123,6 +142,7 @@ const templates = {
         },
     },
     "coding_assistant": {
+        "id": "coding_assistant",
         "name": "Coding assistant",
         "system": {
             "schema": "{system}",
@@ -134,10 +154,11 @@ const templates = {
             "user": 2,
             "system": 1,
         },
-    }
+    },
 };
 
-class ModTemplate {
+class PromptTemplate {
+    id;
     name;
     user;
     assistant;
@@ -145,7 +166,6 @@ class ModTemplate {
     shots;
     stop;
     linebreaks;
-    spacing;
     _systemBlock = "";
     constructor(template) {
         let tpl;
@@ -155,6 +175,7 @@ class ModTemplate {
         else {
             tpl = template;
         }
+        this.id = tpl.id;
         this.name = tpl.name;
         this.user = tpl.user;
         this.assistant = tpl.assistant;
@@ -174,6 +195,46 @@ class ModTemplate {
             this._systemBlock = this._buildSystemBlock();
         }
     }
+    cloneTo(name) {
+        const tpl = new PromptTemplate(name);
+        if (this?.system) {
+            tpl.system = this.system;
+        }
+        if (this?.shots) {
+            tpl.shots = this.shots;
+        }
+        if (this?.stop) {
+            tpl.stop = this.stop;
+        }
+        if (this?.linebreaks) {
+            tpl.linebreaks = this.linebreaks;
+        }
+        if (tpl?.system) {
+            tpl.replaceSystem(this._buildSystemBlock());
+        }
+        return tpl;
+    }
+    toJson() {
+        const res = {
+            id: this.id,
+            name: this.name,
+            user: this.user,
+            assistant: this.assistant,
+        };
+        if (this?.system) {
+            this.system = this.system;
+        }
+        if (this?.shots) {
+            this.shots = this.shots;
+        }
+        if (this?.stop) {
+            this.stop = this.stop;
+        }
+        if (this?.linebreaks) {
+            this.linebreaks = this.linebreaks;
+        }
+        return res;
+    }
     replaceSystem(msg) {
         this._systemBlock = this._buildSystemBlock(msg);
         return this;
@@ -277,9 +338,9 @@ class ModTemplate {
             }
         }
         catch (err) {
-            throw new Error(`Error loading template ${name}`);
+            throw new Error(`Error loading template ${name}: ${err}`);
         }
     }
 }
 
-export { ModTemplate, templates };
+export { PromptTemplate, templates };

package/dist/mod.min.js

@@ -1 +1 @@
-var $tpl=function(s){"use strict";const t={alpaca:{name:"Alpaca",system:{schema:"{system}",message:"Below is an instruction that describes a task. Write a response that appropriately completes the request."},user:"### Instruction:\n{prompt}",assistant:"### Response:",linebreaks:{system:2,user:2}},llama:{name:"Llama",system:{schema:"<s>[INST] <<SYS>>\n{system}\n<</SYS>>",message:"You are a helpful, respectful and honest assistant. Always answer as helpfully as possible\n\nIf a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information."},user:"{prompt}",assistant:" [/INST]",linebreaks:{system:2,user:0}},llama_instruct:{name:"Llama instruct",user:"[INST] {prompt}",assistant:" [/INST]",linebreaks:{user:1}},orca:{name:"Orca",system:{schema:"### System:\n{system}",message:"You are an AI assistant that follows instruction extremely well. Help as much as you can."},user:"### User:\n{prompt}",assistant:"### Response:",linebreaks:{system:2,user:2}},vicuna:{name:"Vicuna",user:"USER: {prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2}},vicuna_system:{name:"Vicuna system",system:{schema:"SYSTEM: {system}"},user:"USER: {prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2}},wizard_vicuna:{name:"Wizard Vicuna",user:"### Human:\n{prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2},stop:["<|endoftext|>"]},guanaco:{name:"Guanaco",user:"### Human: {prompt}",assistant:"### Assistant:",linebreaks:{user:1}},chatml:{name:"ChatMl",system:{schema:"<|im_start|>system\n{system}\n<|im_end|>"},user:"<|im_start|>user\n{prompt}<|im_end|>",assistant:"<|im_start|>assistant",linebreaks:{system:1,user:1,assistant:1}},mamba:{name:"Mamba",user:"<|prompt|>{prompt}</s>",assistant:"<|answer|>",stop:["<|endoftext|>"]},wizardlm:{name:"WizardLM",system:{schema:"{system}",message:"You are a helpful AI assistant."},user:"USER: {prompt}",assistant:"ASSISTANT:",linebreaks:{user:1}},human_response:{name:"Human response",user:"### HUMAN:\n{prompt}",assistant:"### RESPONSE:",linebreaks:{user:2,assistant:1}},coding_assistant:{name:"Coding assistant",system:{schema:"{system}",message:"You are a coding assistant that will help the user to resolve the following instruction:"},user:"### Instruction: {prompt}",assistant:"### Solution:",linebreaks:{user:2,system:1}}};return s.ModTemplate=class{name;user;assistant;system;shots;stop;linebreaks;spacing;_systemBlock="";constructor(s){let t;t="string"==typeof s?this._load(s):s,this.name=t.name,this.user=t.user,this.assistant=t.assistant,t?.system&&(this.system=t.system),t?.shots&&(this.shots=t.shots),t?.stop&&(this.stop=t.stop),t?.linebreaks&&(this.linebreaks=t.linebreaks),t?.system&&(this._systemBlock=this._buildSystemBlock())}replaceSystem(s){return this._systemBlock=this._buildSystemBlock(s),this}afterSystem(s){if(!this.system)throw new Error("This template has no system var");return this.system?.message||(this.system.message=""),this._systemBlock=this._buildSystemBlock(this.system.message+" "+s),this}afterAssistant(s){return this.assistant=this.assistant+s,this}replacePrompt(s){return this.user=this.user.replace("{prompt}",s),this}addShot(s,t){return this?.shots||(this.shots=[]),this.shots.push({user:s,assistant:t}),this}render(){const s=new Array;if(this._systemBlock.length>0&&(s.push(this._systemBlock),this?.linebreaks?.system&&s.push("\n".repeat(this.linebreaks.system))),this?.shots)for(const t of this.shots)s.push(this._buildUserBlock(t.user)),s.push(this._buildAssistantBlock(t.assistant));return s.push(this._buildUserBlock()),s.push(this._buildAssistantBlock()),s.join("")}prompt(s){return this.render().replace("{prompt}",s)}_buildSystemBlock(s){let t="";if(!this?.system)throw new Error(`The template ${this.name} has no system var`);return t=s?this.system.schema.replace("{system}",s):this.system?.message?this.system.schema.replace("{system}",this.system.message):this.system.schema,t}_buildUserBlock(s){let t=[];return t.push(this.user),this?.linebreaks?.user&&t.push("\n".repeat(this.linebreaks.user)),s&&(t[0]=t[0].replace("{prompt}",s)),t.join("")}_buildAssistantBlock(s){let t=[];return t.push(this.assistant),this?.linebreaks?.assistant&&t.push("\n".repeat(this.linebreaks.assistant)),s&&(t[0]=t[0]+s+"\n"),t.join("")}_load(s){try{if(s in t)return t[s];throw new Error(`Template ${s} not found`)}catch(t){throw new Error(`Error loading template ${s}`)}}},s.templates=t,s}({});
+var $tpl=function(s){"use strict";const t={alpaca:{id:"alpaca",name:"Alpaca",system:{schema:"{system}",message:"Below is an instruction that describes a task. Write a response that appropriately completes the request."},user:"### Instruction:\n{prompt}",assistant:"### Response:",linebreaks:{system:2,user:2}},llama:{id:"llama",name:"Llama",system:{schema:"<s>[INST] <<SYS>>\n{system}\n<</SYS>>",message:"You are a helpful, respectful and honest assistant. Always answer as helpfully as possible\n\nIf a question does not make any sense, or is not factually coherent, explain why instead of answering something not correct. If you don't know the answer to a question, please don't share false information."},user:"{prompt}",assistant:" [/INST] ",linebreaks:{system:2,user:0}},llama_instruct:{id:"llama_instruct",name:"Llama instruct",user:"[INST] {prompt}",assistant:" [/INST]",linebreaks:{user:1}},mistral:{id:"mistral",name:"Mistral",user:"<s>[INST] {prompt}",assistant:" [/INST]",stop:["</s>"]},orca:{id:"orca",name:"Orca",system:{schema:"### System:\n{system}",message:"You are an AI assistant that follows instruction extremely well. Help as much as you can."},user:"### User:\n{prompt}",assistant:"### Response:",linebreaks:{system:2,user:2}},vicuna:{id:"vicuna",name:"Vicuna",user:"USER: {prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2}},vicuna_system:{id:"vicuna_system",name:"Vicuna system",system:{schema:"SYSTEM: {system}"},user:"USER: {prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2}},wizard_vicuna:{id:"wizard_vicuna",name:"Wizard Vicuna",user:"### Human:\n{prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2},stop:["<|endoftext|>"]},guanaco:{id:"guanaco",name:"Guanaco",user:"### Human: {prompt}",assistant:"### Assistant:",linebreaks:{user:1}},chatml:{id:"chatml",name:"ChatMl",system:{schema:"<|im_start|>system\n{system}\n<|im_end|>"},user:"<|im_start|>user\n{prompt}<|im_end|>",assistant:"<|im_start|>assistant",linebreaks:{system:1,user:1,assistant:1}},mamba:{id:"mamba",name:"Mamba",user:"<|prompt|>{prompt}</s>",assistant:"<|answer|>",stop:["<|endoftext|>"]},wizardlm:{id:"wizardlm",name:"WizardLM",system:{schema:"{system}",message:"You are a helpful AI assistant."},user:"USER: {prompt}",assistant:"ASSISTANT:",linebreaks:{user:1}},human_response:{id:"human_response",name:"Human response",user:"### HUMAN:\n{prompt}",assistant:"### RESPONSE:",linebreaks:{user:2,assistant:1}},coding_assistant:{id:"coding_assistant",name:"Coding assistant",system:{schema:"{system}",message:"You are a coding assistant that will help the user to resolve the following instruction:"},user:"### Instruction: {prompt}",assistant:"### Solution:",linebreaks:{user:2,system:1}}};class e{id;name;user;assistant;system;shots;stop;linebreaks;_systemBlock="";constructor(s){let t;t="string"==typeof s?this._load(s):s,this.id=t.id,this.name=t.name,this.user=t.user,this.assistant=t.assistant,t?.system&&(this.system=t.system),t?.shots&&(this.shots=t.shots),t?.stop&&(this.stop=t.stop),t?.linebreaks&&(this.linebreaks=t.linebreaks),t?.system&&(this._systemBlock=this._buildSystemBlock())}cloneTo(s){const t=new e(s);return this?.system&&(t.system=this.system),this?.shots&&(t.shots=this.shots),this?.stop&&(t.stop=this.stop),this?.linebreaks&&(t.linebreaks=this.linebreaks),t?.system&&t.replaceSystem(this._buildSystemBlock()),t}toJson(){const s={id:this.id,name:this.name,user:this.user,assistant:this.assistant};return this?.system&&(this.system=this.system),this?.shots&&(this.shots=this.shots),this?.stop&&(this.stop=this.stop),this?.linebreaks&&(this.linebreaks=this.linebreaks),s}replaceSystem(s){return this._systemBlock=this._buildSystemBlock(s),this}afterSystem(s){if(!this.system)throw new Error("This template has no system var");return this.system?.message||(this.system.message=""),this._systemBlock=this._buildSystemBlock(this.system.message+" "+s),this}afterAssistant(s){return this.assistant=this.assistant+s,this}replacePrompt(s){return this.user=this.user.replace("{prompt}",s),this}addShot(s,t){return this?.shots||(this.shots=[]),this.shots.push({user:s,assistant:t}),this}render(){const s=new Array;if(this._systemBlock.length>0&&(s.push(this._systemBlock),this?.linebreaks?.system&&s.push("\n".repeat(this.linebreaks.system))),this?.shots)for(const t of this.shots)s.push(this._buildUserBlock(t.user)),s.push(this._buildAssistantBlock(t.assistant));return s.push(this._buildUserBlock()),s.push(this._buildAssistantBlock()),s.join("")}prompt(s){return this.render().replace("{prompt}",s)}_buildSystemBlock(s){let t="";if(!this?.system)throw new Error(`The template ${this.name} has no system var`);return t=s?this.system.schema.replace("{system}",s):this.system?.message?this.system.schema.replace("{system}",this.system.message):this.system.schema,t}_buildUserBlock(s){let t=[];return t.push(this.user),this?.linebreaks?.user&&t.push("\n".repeat(this.linebreaks.user)),s&&(t[0]=t[0].replace("{prompt}",s)),t.join("")}_buildAssistantBlock(s){let t=[];return t.push(this.assistant),this?.linebreaks?.assistant&&t.push("\n".repeat(this.linebreaks.assistant)),s&&(t[0]=t[0]+s+"\n"),t.join("")}_load(s){try{if(s in t)return t[s];throw new Error(`Template ${s} not found`)}catch(t){throw new Error(`Error loading template ${s}: ${t}`)}}}return s.PromptTemplate=e,s.templates=t,s}({});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modprompt",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Prompt templates for language models",
   "license": "MIT",
   "scripts": {
@@ -10,7 +10,6 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^25.0.4",
     "@rollup/plugin-node-resolve": "^15.2.1",
     "@rollup/plugin-typescript": "^11.1.3",
     "@types/node": "^20.6.0",