mikupad

mikupad 是一个用户友好的基于浏览器的界面，用于与语言模型交互。它使用 ReactJS 构建，支持多种文本生成后端，所有功能都集成在一个 HTML 文件中。

功能特性

• 多后端支持：支持 llama.cpp、koboldcpp、AI Horde 以及任何 OpenAI 兼容 的 API。
• 会话持久化：您的提示会自动保存并恢复，让您可以在多个会话之间无缝继续。还可以导入和导出会话，方便分享或备份。
• 可选服务器：可以托管在本地 Node.js 服务器上，从而实现远程或局域网内的数据库访问。
• 持久化上下文：
  • 记忆：可在上下文开头无缝插入您选择的文本。
  • 作者注：可在上下文结尾无缝插入您选择的文本，并可调整其深度。
  • 世界信息：根据特定关键词动态地将额外信息纳入上下文。
• 预测撤销/重做：通过撤销和重做预测功能，您可以轻松尝试和优化生成的文本。
• 标记概率：将鼠标悬停在任意标记上，即可显示该位置最可能的前 10 个标记。点击某个概率值，即可从该标记重新生成文本。
  • 如果您使用的是 oobabooga，请确保使用 _HF 采样器，以使此功能正常工作。
  • 如果您使用的是 koboldcpp，标记概率仅在禁用标记流式传输时可用。
• 逻辑回归偏置：通过实时调整特定标记的出现概率偏置，精细调控生成过程。
• 完成模式/聊天模式：
  • 完成模式：让语言模型直接续写您的提示。
  • 聊天模式：Mikupad 简化了指令型模型的使用。根据您选择的模板，它会在开始或停止生成时自动添加正确的分隔符。同时，它还会将您的提示组织成消息格式，使其兼容 Chat Completions API（适用于 OpenAI 兼容的后端）。
• 主题：您可以通过选择多种主题来自定义界面外观。

快速入门

您只需在浏览器中打开 mikupad.html 文件，即可轻松运行 mikupad。无需任何额外安装。选择您喜欢的后端，即可开始生成文本！

git clone https://github.com/lmg-anon/mikupad.git
cd mikupad
open mikupad.html

若要完全离线使用 mikupad，请运行提供的 compile 脚本，或从 Releases 下载预编译的 mikupad_compiled.html 文件。

您也可以在 GitHub Pages 上试用。

参与贡献

我们欢迎开源社区的贡献。无论是修复 bug、添加新功能，还是改进文档，您的贡献都将受到高度赞赏。如需为 mikupad 做出贡献，请按照以下步骤操作：

1. Fork 该仓库。
2. 创建一个新的分支来存放您的更改：git checkout -b feature/your-feature-name
3. 进行更改并提交：git commit -m '添加您的功能'
4. 将更改推送到您 fork 的仓库：git push origin feature/your-feature-name
5. 在主仓库中打开一个 Pull Request，并详细说明您的更改。

许可证

本项目采用 GNU Affero 通用公共许可证 v3.0 许可证授权——详情请参阅 LICENSE 文件。

mikupad 快速上手指南

mikupad 是一个基于浏览器的轻量级语言模型交互界面，无需复杂安装，支持多种后端（如 llama.cpp、koboldcpp、AI Horde 及 OpenAI 兼容接口），单文件即可运行。

环境准备

• 系统要求：Windows、macOS 或 Linux 均可，只需具备现代网页浏览器（推荐 Chrome、Edge 或 Firefox）。
• 前置依赖：
  • 基础模式：无需安装任何软件或依赖，直接打开 HTML 文件即可使用。
  • 离线完整版：若需完全离线使用（不依赖 CDN 加载资源），需本地安装 Node.js 以运行编译脚本，或直接下载预编译文件。
  • 后端服务：需自行部署或连接已有的推理后端（如本地运行的 koboldcpp、llama.cpp server 或远程 API）。

安装步骤

你可以通过以下两种方式获取 mikupad：

方式一：直接使用（在线/局域网）

克隆仓库并直接在浏览器中打开主文件：

git clone https://github.com/lmg-anon/mikupad.git
cd mikupad
open mikupad.html

(注：Windows 用户若 open 命令无效，可直接在文件管理器中双击 mikupad.html)

方式二：完全离线使用

若需要在无网络环境下使用，请选择以下任一方法：

1. 下载预编译版本（推荐）： 访问 Releases 页面 下载 mikupad_compiled.html，直接用浏览器打开即可。

2. 自行编译： 在项目根目录下运行提供的编译脚本（需已安装 Node.js）：

   npm install
   npm run compile
   

   编译完成后，使用生成的 mikupad_compiled.html 文件。

基本使用

1. 启动界面：双击打开 mikupad.html（或 mikupad_compiled.html）。
2. 配置后端：
   • 点击界面右上角的设置图标（或连接设置区域）。
   • 在 Backend 选项中选择你的推理后端类型（例如 OpenAI Compatible 或 KoboldCPP）。
   • 输入后端服务的 API 地址（例如本地运行通常为 http://localhost:5001 或 http://127.0.0.1:8080）。
3. 开始生成：
   • 补全模式 (Completion)：直接在输入框输入提示词，模型将继续撰写后续内容。
   • 聊天模式 (Chat)：切换至 Chat 模式，输入对话内容。mikupad 会自动根据所选模板添加必要的指令标记（Delimiters）。
4. 高级功能：
   • 概率查看：将鼠标悬停在生成的文字上，可查看该位置概率最高的 10 个令牌；点击特定概率可从此处重新生成。
   • 上下文管理：利用 "Memory"（记忆）在上下文开头注入固定文本，或使用 "Author's Note"（作者注）在末尾注入引导信息。
   • 会话保存：你的提示词和上下文会自动保存在浏览器本地，刷新页面后可继续之前的对话；也可通过导入/导出功能备份会话。