modprompt 0.0.1

package/README.md

@@ -0,0 +1,201 @@
+# Modprompt
+
+[![pub package](https://img.shields.io/npm/v/modprompt)](https://www.npmjs.com/package/modprompt)
+
+A collection of prompt templates for language models
+
+## Install
+
+```bash
+npm install modprompt
+# or
+yarn add modprompt
+```
+
+## Usage
+
+### Available templates
+
+List the available templates:
+
+```js
+import { templates } from "modprompt";
+
+const templateNames = Object.keys(templates);
+console.log(templateNames);
+```
+
+### Load a template
+
+To load a template:
+
+```js
+import { templates, useTemplate } from "modprompt";
+
+const tpl = useTemplate(templates.alpaca);
+// or
+const tpl = useTemplate("alpaca");
+```
+
+### Render a template
+
+To render a template to string:
+
+```js
+const templateText = tpl.render();
+```
+
+Rendering for an Alpaca template:
+
+```
+Below is an instruction that describes a task. Write a response that appropriately completes the request.
+
+### Instruction:
+{prompt}
+
+### Response:
+```
+
+### Render a prompt
+
+Similar to the `render` function above, but replaces `{prompt}` by the provided text:
+
+```js
+const templateText = tpl.prompt("What is the capital of Kenya?");
+```
+
+### System messages
+
+The template have system messages support if the original template supports it.
+
+To replace a system message:
+
+```js
+tpl.system("You are a javascript specialist");
+```
+
+Rendering for an Alpaca template:
+
+```
+You are a javascript specialist
+
+### Instruction:
+{prompt}
+
+### Response:
+```
+
+To append to a system message:
+
+```js
+tpl.afterSystem("You are a javascript specialist");
+```
+
+### Example shots
+
+The templates have support for example shots. Add one shot:
+
+```js
+tpl.addShot(
+  "fix this invalid json:\n\n```json\n{'a':1,}\n```",
+  '\n\n```json\n{"a":1}\n```\n',
+)
+```
+
+The first param is the user question, and the second is the assistant response. It
+is assembled in a prompt template. Example with custom user and assistant messages:
+
+```js
+// modify system message
+tpl.afterSystem("You are a javascript specialist");
+// modify assistant message
+tpl.template.assistant = tpl.template.assistant + " (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```")
+// add a one shot example
+tpl.addShot(
+  "{'a':1,}",
+  '\n\n```json\n{"a":1}\n```\n',
+)
+```
+
+Rendering for an Alpaca template:
+
+```
+Below is an instruction that describes a task. Write a response that appropriately completes the request. You are a javascript specialist
+
+### Instruction:
+fix this invalid json:
+
+'''json
+{'a':1,}
+'''
+
+### Response: (answer in valid json)
+
+'''json
+{"a":1}
+'''
+
+### Instruction:
+fix this invalid json:
+
+'''json
+{prompt}
+'''
+
+### Response: (answer in valid json)
+```
+
+## Types
+
+Template types:
+
+```ts
+interface SpacingSlots {
+  system?: number;
+  user?: number;
+  assistant?: number;
+}
+
+interface PromptBlock {
+  schema: string;
+  message?: string;
+}
+
+interface TurnBlock {
+  user: string;
+  assistant: string;
+}
+
+interface LmTemplate {
+  name: string;
+  user: string;
+  assistant: string;
+  system?: PromptBlock;
+  shots?: Array<TurnBlock>;
+  stop?: Array<string>;
+  linebreaks?: SpacingSlots;
+  spacing?: SpacingSlots;
+}
+```
+
+Example raw template:
+
+```ts
+import type { LmTemplate } from "modprompt";
+
+const orca: LmTemplate = {
+  "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
+  }
+}
+```

package/dist/db.d.ts

@@ -0,0 +1,3 @@
+import { LmTemplate } from "./interfaces";
+declare const templates: Record<string, LmTemplate>;
+export { templates };

package/dist/interfaces.d.ts

@@ -0,0 +1,24 @@
+interface SpacingSlots {
+    system?: number;
+    user?: number;
+    assistant?: number;
+}
+interface PromptBlock {
+    schema: string;
+    message?: string;
+}
+interface TurnBlock {
+    user: string;
+    assistant: string;
+}
+interface LmTemplate {
+    name: string;
+    user: string;
+    assistant: string;
+    system?: PromptBlock;
+    shots?: Array<TurnBlock>;
+    stop?: Array<string>;
+    linebreaks?: SpacingSlots;
+    spacing?: SpacingSlots;
+}
+export { SpacingSlots, PromptBlock, TurnBlock, LmTemplate };

package/dist/main.d.ts

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

package/dist/mod.cjs.min.js

@@ -0,0 +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})}}};

package/dist/mod.es.js

@@ -0,0 +1,184 @@
+const templates = {
+    "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,
+        }
+    },
+};
+
+const useTemplate = (_template) => {
+    let template = templates.alpaca;
+    let _systemBlock = "";
+    if (_template) {
+        if (typeof _template == "string") {
+            load(_template);
+        }
+        else {
+            template = _template;
+            if (template?.system) {
+                _systemBlock = _buildSystemBlock();
+            }
+        }
+    }
+    function load(name) {
+        try {
+            if (name in templates) {
+                console.log("Loading", name);
+                template = templates[name];
+            }
+            else {
+                throw new Error(`Template ${name} not found`);
+            }
+        }
+        catch (err) {
+            throw new Error(`Error loading template ${name}`);
+        }
+        if (template?.system) {
+            _systemBlock = _buildSystemBlock();
+        }
+    }
+    function _buildSystemBlock(systemMsg) {
+        let res = "";
+        if (!template?.system) {
+            throw new Error(`The template ${template.name} has no system var`);
+        }
+        if (systemMsg) {
+            res = template.system.schema.replace("{system}", systemMsg);
+        }
+        else {
+            if (template.system?.message) {
+                res = template.system.schema.replace("{system}", template.system.message);
+            }
+            else {
+                res = template.system.schema;
+            }
+        }
+        return res;
+    }
+    function _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));
+        }
+        if (msg) {
+            buf[0] = buf[0].replace("{prompt}", msg);
+        }
+        return buf.join("");
+    }
+    function _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));
+        }
+        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));
+            }
+            if (template?.linebreaks?.system) {
+                buf.push("\n".repeat(template.linebreaks.system));
+            }
+        }
+        if (template?.shots) {
+            for (const shot of template.shots) {
+                buf.push(_buildUserBlock(shot.user));
+                buf.push(_buildAssistantBlock(shot.assistant));
+            }
+        }
+        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 };

package/dist/mod.min.js

@@ -0,0 +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}({});

package/dist/template.d.ts

@@ -0,0 +1,10 @@
+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 };

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "modprompt",
+  "version": "0.0.1",
+  "description": "Prompt templates for language models",
+  "license": "MIT",
+  "scripts": {
+    "build": "rm -rf dist/* && rollup -c",
+    "test": "jest --coverage",
+    "docs": "typedoc --entryPointStrategy expand"
+  },
+  "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",
+    "rollup": "^3.29.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "tslib": "^2.6.2",
+    "typescript": "^4.9.5"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/mod.cjs.min.js",
+  "module": "./dist/mod.es.js",
+  "types": "./dist/main.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/mod.es.js",
+      "require": "./dist/mod.cjs.min.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}