modprompt 0.0.1 → 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 synw
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -4,6 +4,12 @@
 
 A collection of prompt templates for language models
 
+- Classic templates formats for different models
+- Easily modify and adapt templates on-the-fly
+- Few shots support
+
+:books: [Api doc](https://synw.github.io/modprompt/)
+
 ## Install
 
 ```bash
@@ -30,11 +36,11 @@ console.log(templateNames);
 To load a template:
 
 ```js
-import { templates, useTemplate } from "modprompt";
+import { templates, ModTemplate } from "modprompt";
 
-const tpl = useTemplate(templates.alpaca);
+const tpl = new ModTemplate(templates.alpaca)
 // or
-const tpl = useTemplate("alpaca");
+const tpl = new ModTemplate("alpaca")
 ```
 
 ### Render a template
@@ -109,9 +115,9 @@ is assembled in a prompt template. Example with custom user and assistant messag
 // modify system message
 tpl.afterSystem("You are a javascript specialist");
 // modify assistant message
-tpl.template.assistant = tpl.template.assistant + " (answer in valid json)"
+tpl.afterAssistant(" (answer in valid json)")
 // modify the prompt message
-tpl.template.user = tpl.template.user.replace("{prompt}", "fix this invalid json:\n\n```json\n{prompt}\n```")
+tpl.replacePrompt("fix this invalid json:\n\n```json\n{prompt}\n```")
 // add a one shot example
 tpl.addShot(
   "{'a':1,}",
@@ -147,6 +153,21 @@ fix this invalid json:
 ### Response: (answer in valid json)
 ```
 
+### Chainable api
+
+The calls can be chained. Example with the code above:
+
+```js
+const tpl = new ModTemplate(templates.llama)
+  .afterSystem("You are a javascript specialist")
+  .afterAssistant(" (answer in valid json)")
+  .replacePrompt("fix this invalid json:\n\n```json\n{prompt}\n```")
+  .addShot(
+    "{'a':1,}",
+    '\n\n```json\n{"a":1}\n```\n',
+  );
+```
+
 ## Types
 
 Template types:
@@ -176,7 +197,6 @@ interface LmTemplate {
   shots?: Array<TurnBlock>;
   stop?: Array<string>;
   linebreaks?: SpacingSlots;
-  spacing?: SpacingSlots;
 }
 ```
 
@@ -198,4 +218,6 @@ const orca: LmTemplate = {
     "user": 2
   }
 }
-```
+```
+
+:books: [Api doc](https://synw.github.io/modprompt/)

package/dist/cls.d.ts

@@ -0,0 +1,25 @@
+import { LmTemplate, PromptBlock, TurnBlock, SpacingSlots } from "./interfaces";
+declare class ModTemplate implements LmTemplate {
+    name: string;
+    user: string;
+    assistant: string;
+    system?: PromptBlock;
+    shots?: Array<TurnBlock>;
+    stop?: Array<string>;
+    linebreaks?: SpacingSlots;
+    spacing?: SpacingSlots;
+    private _systemBlock;
+    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;
+    render(): string;
+    prompt(msg: string): string;
+    private _buildSystemBlock;
+    private _buildUserBlock;
+    private _buildAssistantBlock;
+    private _load;
+}
+export { ModTemplate };

package/dist/interfaces.d.ts

@@ -19,6 +19,5 @@ interface LmTemplate {
     shots?: Array<TurnBlock>;
     stop?: Array<string>;
     linebreaks?: SpacingSlots;
-    spacing?: SpacingSlots;
 }
 export { SpacingSlots, PromptBlock, TurnBlock, LmTemplate };

package/dist/main.d.ts

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

package/dist/mod.cjs.min.js

@@ -1 +1 @@
-"use strict";const s={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}},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}},wizard_vicuna:{name:"Wizard Vicuna",user:"### Human:\n{prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2},stop:["<|endoftext|>"]},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}}};exports.templates=s,exports.useTemplate=e=>{let t=s.alpaca,a="";function r(s){let e="";if(!t?.system)throw new Error(`The template ${t.name} has no system var`);return e=s?t.system.schema.replace("{system}",s):t.system?.message?t.system.schema.replace("{system}",t.system.message):t.system.schema,e}function n(s){let e=[];return e.push(t.user),t?.spacing?.user&&e.push(" ".repeat(t.spacing.user)),t?.linebreaks?.user&&e.push("\n".repeat(t.linebreaks.user)),s&&(e[0]=e[0].replace("{prompt}",s)),e.join("")}function m(s){let e=[];return e.push(t.assistant),t?.spacing?.assistant&&e.push(" ".repeat(t.spacing.assistant)),t?.linebreaks?.assistant&&e.push("\n".repeat(t.linebreaks.assistant)),s&&(e[0]=e[0]+s+"\n"),e.join("")}e&&("string"==typeof e?function(e){try{if(!(e in s))throw new Error(`Template ${e} not found`);console.log("Loading",e),t=s[e]}catch(s){throw new Error(`Error loading template ${e}`)}t?.system&&(a=r())}(e):(t=e,t?.system&&(a=r())));const p=()=>{const s=new Array;if(a.length>0&&(s.push(a),t?.spacing?.system&&s.push(" ".repeat(t.spacing.system)),t?.linebreaks?.system&&s.push("\n".repeat(t.linebreaks.system))),t?.shots)for(const e of t.shots)s.push(n(e.user)),s.push(m(e.assistant));return s.push(n()),s.push(m()),s.join("")};return{template:t,system:s=>{a=r(s)},afterSystem:s=>{if(!t.system)throw new Error("This template has no system var");t.system?.message||(t.system.message=""),a=r(t.system.message+" "+s)},render:p,prompt:s=>p().replace("{prompt}",s),addShot:(s,e)=>{t?.shots||(t.shots=[]),t.shots.push({user:s,assistant:e})}}};
+"use strict";const s={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:"Guanaco",user:"### HUMAN:\n{prompt}",assistant:"### RESPONSE:",linebreaks:{user:2,assistant:1}}};exports.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),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(t){try{if(t in s)return console.log("Loading",t),s[t];throw new Error(`Template ${t} not found`)}catch(s){throw new Error(`Error loading template ${t}`)}}},exports.templates=s;

package/dist/mod.es.js

@@ -12,6 +12,27 @@ const templates = {
             "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": {
@@ -25,6 +46,25 @@ const templates = {
             "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}",
@@ -34,6 +74,14 @@ const templates = {
         },
         "stop": ["<|endoftext|>"]
     },
+    "guanaco": {
+        "name": "Guanaco",
+        "user": "### Human: {prompt}",
+        "assistant": "### Assistant:",
+        "linebreaks": {
+            "user": 1
+        },
+    },
     "chatml": {
         "name": "ChatMl",
         "system": {
@@ -47,138 +95,177 @@ const templates = {
             "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": "Guanaco",
+        "user": "### HUMAN:\n{prompt}",
+        "assistant": "### RESPONSE:",
+        "linebreaks": {
+            "user": 2,
+            "assistant": 1
+        },
+    },
 };
 
-const useTemplate = (_template) => {
-    let template = templates.alpaca;
-    let _systemBlock = "";
-    if (_template) {
-        if (typeof _template == "string") {
-            load(_template);
+class ModTemplate {
+    name;
+    user;
+    assistant;
+    system;
+    shots;
+    stop;
+    linebreaks;
+    spacing;
+    _systemBlock = "";
+    constructor(template) {
+        let tpl;
+        if (typeof template == "string") {
+            tpl = this._load(template);
         }
         else {
-            template = _template;
-            if (template?.system) {
-                _systemBlock = _buildSystemBlock();
-            }
+            tpl = template;
+        }
+        this.name = tpl.name;
+        this.user = tpl.user;
+        this.assistant = tpl.assistant;
+        if (tpl?.system) {
+            this.system = tpl.system;
+        }
+        if (tpl?.shots) {
+            this.shots = tpl.shots;
         }
+        if (tpl?.stop) {
+            this.stop = tpl.stop;
+        }
+        if (tpl?.linebreaks) {
+            this.linebreaks = tpl.linebreaks;
+        }
+        this._systemBlock = this._buildSystemBlock();
     }
-    function load(name) {
-        try {
-            if (name in templates) {
-                console.log("Loading", name);
-                template = templates[name];
-            }
-            else {
-                throw new Error(`Template ${name} not found`);
-            }
+    replaceSystem(msg) {
+        this._systemBlock = this._buildSystemBlock(msg);
+        return this;
+    }
+    afterSystem(msg) {
+        if (!this.system) {
+            throw new Error("This template has no system var");
         }
-        catch (err) {
-            throw new Error(`Error loading template ${name}`);
+        if (!this.system?.message) {
+            this.system.message = "";
+        }
+        this._systemBlock = this._buildSystemBlock(this.system.message + " " + msg);
+        return this;
+    }
+    afterAssistant(msg) {
+        this.assistant = this.assistant + msg;
+        return this;
+    }
+    replacePrompt(msg) {
+        this.user = this.user.replace("{prompt}", msg);
+        return this;
+    }
+    addShot(user, assistant) {
+        if (!this?.shots) {
+            this.shots = [];
         }
-        if (template?.system) {
-            _systemBlock = _buildSystemBlock();
+        this.shots.push({
+            user: user,
+            assistant: assistant,
+        });
+        return this;
+    }
+    render() {
+        const buf = new Array();
+        if (this._systemBlock.length > 0) {
+            buf.push(this._systemBlock);
+            if (this?.linebreaks?.system) {
+                buf.push("\n".repeat(this.linebreaks.system));
+            }
+        }
+        if (this?.shots) {
+            for (const shot of this.shots) {
+                buf.push(this._buildUserBlock(shot.user));
+                buf.push(this._buildAssistantBlock(shot.assistant));
+            }
         }
+        buf.push(this._buildUserBlock());
+        buf.push(this._buildAssistantBlock());
+        return buf.join("");
+    }
+    prompt(msg) {
+        return this.render().replace("{prompt}", msg);
     }
-    function _buildSystemBlock(systemMsg) {
+    _buildSystemBlock(systemMsg) {
         let res = "";
-        if (!template?.system) {
-            throw new Error(`The template ${template.name} has no system var`);
+        if (!this?.system) {
+            throw new Error(`The template ${this.name} has no system var`);
         }
         if (systemMsg) {
-            res = template.system.schema.replace("{system}", systemMsg);
+            res = this.system.schema.replace("{system}", systemMsg);
         }
         else {
-            if (template.system?.message) {
-                res = template.system.schema.replace("{system}", template.system.message);
+            if (this.system?.message) {
+                res = this.system.schema.replace("{system}", this.system.message);
             }
             else {
-                res = template.system.schema;
+                res = this.system.schema;
             }
         }
         return res;
     }
-    function _buildUserBlock(msg) {
+    _buildUserBlock(msg) {
         let buf = [];
-        buf.push(template.user);
-        if (template?.spacing?.user) {
-            buf.push(" ".repeat(template.spacing.user));
-        }
-        if (template?.linebreaks?.user) {
-            buf.push("\n".repeat(template.linebreaks.user));
+        buf.push(this.user);
+        if (this?.linebreaks?.user) {
+            buf.push("\n".repeat(this.linebreaks.user));
         }
         if (msg) {
             buf[0] = buf[0].replace("{prompt}", msg);
         }
         return buf.join("");
     }
-    function _buildAssistantBlock(msg) {
+    _buildAssistantBlock(msg) {
         let buf = [];
-        buf.push(template.assistant);
-        if (template?.spacing?.assistant) {
-            buf.push(" ".repeat(template.spacing.assistant));
-        }
-        if (template?.linebreaks?.assistant) {
-            buf.push("\n".repeat(template.linebreaks.assistant));
+        buf.push(this.assistant);
+        if (this?.linebreaks?.assistant) {
+            buf.push("\n".repeat(this.linebreaks.assistant));
         }
         if (msg) {
             buf[0] = buf[0] + msg + "\n";
         }
         return buf.join("");
     }
-    const addShot = (user, assistant) => {
-        if (!template?.shots) {
-            template.shots = [];
-        }
-        template.shots.push({
-            user: user,
-            assistant: assistant,
-        });
-    };
-    const system = (msg) => {
-        _systemBlock = _buildSystemBlock(msg);
-    };
-    const afterSystem = (msg) => {
-        if (!template.system) {
-            throw new Error("This template has no system var");
-        }
-        if (!template.system?.message) {
-            template.system.message = "";
-        }
-        _systemBlock = _buildSystemBlock(template.system.message + " " + msg);
-    };
-    const render = () => {
-        const buf = new Array();
-        if (_systemBlock.length > 0) {
-            buf.push(_systemBlock);
-            if (template?.spacing?.system) {
-                buf.push(" ".repeat(template.spacing.system));
+    _load(name) {
+        try {
+            if (name in templates) {
+                console.log("Loading", name);
+                return templates[name];
             }
-            if (template?.linebreaks?.system) {
-                buf.push("\n".repeat(template.linebreaks.system));
+            else {
+                throw new Error(`Template ${name} not found`);
             }
         }
-        if (template?.shots) {
-            for (const shot of template.shots) {
-                buf.push(_buildUserBlock(shot.user));
-                buf.push(_buildAssistantBlock(shot.assistant));
-            }
+        catch (err) {
+            throw new Error(`Error loading template ${name}`);
         }
-        buf.push(_buildUserBlock());
-        buf.push(_buildAssistantBlock());
-        return buf.join("");
-    };
-    const prompt = (msg) => {
-        return render().replace("{prompt}", msg);
-    };
-    return {
-        template,
-        system,
-        afterSystem,
-        render,
-        prompt,
-        addShot,
-    };
-};
+    }
+}
 
-export { templates, useTemplate };
+export { ModTemplate, templates };

package/dist/mod.min.js

@@ -1 +1 @@
-var $tpl=function(s){"use strict";const e={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}},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}},wizard_vicuna:{name:"Wizard Vicuna",user:"### Human:\n{prompt}",assistant:"### ASSISTANT:",linebreaks:{user:2},stop:["<|endoftext|>"]},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}}};return s.templates=e,s.useTemplate=s=>{let t=e.alpaca,a="";function r(s){let e="";if(!t?.system)throw new Error(`The template ${t.name} has no system var`);return e=s?t.system.schema.replace("{system}",s):t.system?.message?t.system.schema.replace("{system}",t.system.message):t.system.schema,e}function n(s){let e=[];return e.push(t.user),t?.spacing?.user&&e.push(" ".repeat(t.spacing.user)),t?.linebreaks?.user&&e.push("\n".repeat(t.linebreaks.user)),s&&(e[0]=e[0].replace("{prompt}",s)),e.join("")}function m(s){let e=[];return e.push(t.assistant),t?.spacing?.assistant&&e.push(" ".repeat(t.spacing.assistant)),t?.linebreaks?.assistant&&e.push("\n".repeat(t.linebreaks.assistant)),s&&(e[0]=e[0]+s+"\n"),e.join("")}s&&("string"==typeof s?function(s){try{if(!(s in e))throw new Error(`Template ${s} not found`);console.log("Loading",s),t=e[s]}catch(e){throw new Error(`Error loading template ${s}`)}t?.system&&(a=r())}(s):(t=s,t?.system&&(a=r())));const i=()=>{const s=new Array;if(a.length>0&&(s.push(a),t?.spacing?.system&&s.push(" ".repeat(t.spacing.system)),t?.linebreaks?.system&&s.push("\n".repeat(t.linebreaks.system))),t?.shots)for(const e of t.shots)s.push(n(e.user)),s.push(m(e.assistant));return s.push(n()),s.push(m()),s.join("")};return{template:t,system:s=>{a=r(s)},afterSystem:s=>{if(!t.system)throw new Error("This template has no system var");t.system?.message||(t.system.message=""),a=r(t.system.message+" "+s)},render:i,prompt:s=>i().replace("{prompt}",s),addShot:(s,e)=>{t?.shots||(t.shots=[]),t.shots.push({user:s,assistant:e})}}},s}({});
+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:"Guanaco",user:"### HUMAN:\n{prompt}",assistant:"### RESPONSE:",linebreaks:{user:2,assistant: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),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 console.log("Loading",s),t[s];throw new Error(`Template ${s} not found`)}catch(t){throw new Error(`Error loading template ${s}`)}}},s.templates=t,s}({});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "modprompt",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Prompt templates for language models",
   "license": "MIT",
   "scripts": {
@@ -14,10 +14,13 @@
     "@rollup/plugin-node-resolve": "^15.2.1",
     "@rollup/plugin-typescript": "^11.1.3",
     "@types/node": "^20.6.0",
-    "rollup": "^3.29.0",
+    "rollup": "^3.29.1",
     "rollup-plugin-terser": "^7.0.2",
     "tslib": "^2.6.2",
-    "typescript": "^4.9.5"
+    "typedoc": "^0.25.1",
+    "typedoc-plugin-markdown": "^3.15.4",
+    "typedoc-plugin-rename-defaults": "^0.6.5",
+    "typescript": "^5.2.2"
   },
   "files": [
     "dist"

package/dist/template.d.ts

@@ -1,10 +0,0 @@
-import { LmTemplate } from "./interfaces.js";
-declare const useTemplate: (_template?: string | LmTemplate) => {
-    template: LmTemplate;
-    system: (msg: string) => void;
-    afterSystem: (msg: string) => void;
-    render: () => string;
-    prompt: (msg: string) => string;
-    addShot: (user: string, assistant: string) => void;
-};
-export { useTemplate };