mirror of
https://gitcode.com/JianFeeeee/TrulyMEM-TrueHumanMEM.git
synced 2026-10-15 12:15:32 +00:00
refactor: Web 服务内嵌主进程 + 文档移到 docs/ 二级目录
1. Web 服务改为 threading 模式： - 新增 run_web_server(port) / stop_web_server() 函数 - TUI 通过 from web_api import run_web_server 直接调用 - 使用 werkzeug make_server 实现线程内优雅启动/停止 2. 构建脚本精简为单二进制： - 移除 trulymem-web 独立打包步骤 - 添加 werkzeug 到 hidden-imports 3. 详细启动文档移到 docs/zh/quick_start.md 4. README 精简为概述，指向 docs/ 目录
This commit is contained in:
root
167
README.md
167
README.md
@ -4,190 +4,61 @@
|
||||
<img src="pic/image.png" alt="TrulyMEM Logo" width="200">
|
||||
</p>
|
||||
|
||||
> **📜 开源协议**: [GNU General Public License v3.0 (GPLv3)](https://www.gnu.org/licenses/gpl-3.0)
|
||||
> 本项目自由开源，可自由使用、修改和分发，但修改后的作品必须以相同许可证发布。
|
||||
> **📜 开源协议**: [GNU General Public License v3.0 (GPLv3)](https://www.gnu.org/licenses/gpl-3.0)
|
||||
|
||||
> **English**: [Switch to English version](./README_EN.md)
|
||||
> **English**: [README_EN.md](./README_EN.md)
|
||||
|
||||
**让 AI 拥有自知、可塑、有分寸感的长期记忆**
|
||||
|
||||
*The More Human Choice.*
|
||||
**让 AI 拥有自知、可塑、有分寸感的长期记忆** — *The More Human Choice.*
|
||||
|
||||
[](https://www.gnu.org/licenses/gpl-3.0)
|
||||
[](https://www.python.org/downloads/)
|
||||
[]()
|
||||
[]()
|
||||
|
||||
---
|
||||
|
||||
## 故事的开头
|
||||
## 一句话
|
||||
|
||||
行业普遍认为，LLM 海量参数让其涌现了智能。但这个智能是「死的」——它不会真的记住，也不理解「记住」的概念。它输出的一切，都是当前输入的全部文本经历无数次前向传播计算出的概率最优解。LLM 不会因为某次对话意识到错误而去修正权重，也无法因此针对模型进行一次反向传播。它的意识是被冻结的，展现出的智能只是冻结的意识的回响。
|
||||
|
||||
现在的所谓记忆系统，只是将记忆外化，让「系统」去替 LLM 记住。或者就是粗暴地将一切上下文文本丢给 LLM。这就是对模型输入的浪费。
|
||||
|
||||
**TrulyMEM 想，既然 LLM 无法实时纠正模型权重，为什么不把记忆权交还给 LLM 呢？**
|
||||
|
||||
我们提供一系列机制，让 LLM 决定它要记住什么、遗忘，什么是重点、什么是糟粕。LLM 推理的过程，就是思考的过程，也是回忆的过程。完全摒弃传统的 messages 数组上下文，将全部记忆以**三元组（图）**的形式保存在图数据库中。在 LLM 思考时，可以按照图数据库的链接自主跳转、联想相关关系，让 LLM 自然地实现联想与回忆。
|
||||
|
||||
赋予 LLM 真正的记忆。
|
||||
TrulyMEM 将记忆权交还给 LLM。通过图数据库（三元组）替代传统 messages 数组，让 LLM 自主决定记什么、忘什么。
|
||||
|
||||
---
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 方式一：打包后的可执行文件
|
||||
|
||||
```bash
|
||||
# Windows: TrulyMEM.exe
|
||||
# Linux/macOS: TrulyMEM
|
||||
chmod +x TrulyMEM
|
||||
./TrulyMEM
|
||||
python trulymem_entry.py # 从源码
|
||||
./dist/TrulyMEM # 打包后
|
||||
```
|
||||
|
||||
### 方式二：从源码运行
|
||||
首次启动 → TUI 登录页面 → 创建/登录账号 → 按 **F2** 配置 API Key → 开始聊天
|
||||
|
||||
```bash
|
||||
git clone <repo-url>
|
||||
cd TrulyMEM-TrueHumanMEM
|
||||
|
||||
pip install -r requirements.txt
|
||||
|
||||
python trulymem_entry.py
|
||||
```
|
||||
|
||||
### 首次使用（TUI 登录）
|
||||
|
||||
首次运行时会检测数据库状态，引导你完成：
|
||||
|
||||
1. **TUI 登录页面** — 如果是新部署或无迁移需求，直接设置账号密码
|
||||
2. **旧版自动迁移** — 如果检测到旧版 `~/.trulymem/config.json`，自动引导迁移为多用户模式
|
||||
3. **首个用户自动成为管理员**
|
||||
|
||||
登录后进入聊天界面：
|
||||
|
||||
1. 按 **F2** 展开右侧配置面板
|
||||
2. 输入 **API Key**（支持 DeepSeek、OpenAI 等兼容 API）
|
||||
3. 按 **Enter** 保存配置
|
||||
4. 开始对话！
|
||||
|
||||
📌 **管理员** 可在右侧面板管理 Web 服务开关、修改 Web 登录凭据。
|
||||
📌 **普通用户** 只能配置 API Key 和模型参数。
|
||||
📖 **详细启动文档**: [docs/zh/quick_start.md](docs/zh/quick_start.md)
|
||||
|
||||
---
|
||||
|
||||
### 多用户系统
|
||||
## 主要特性
|
||||
|
||||
TrulyMEM 支持多用户隔离，每个用户拥有独立的配置和数据目录：
|
||||
|
||||
```
|
||||
~/.trulymem/
|
||||
├── trulymem.db # 全局用户数据库
|
||||
├── .migrated # 旧版迁移标记
|
||||
├── admin/
|
||||
│ ├── config.json # 管理员配置
|
||||
│ └── admin_graph.db # 管理员知识图谱
|
||||
└── user2/
|
||||
├── config.json # user2 配置
|
||||
└── user2_graph.db # user2 知识图谱
|
||||
```
|
||||
|
||||
- **首个注册用户自动成为管理员**
|
||||
- 管理员可在 Web 设置页添加/删除用户
|
||||
- 普通用户无法看到用户管理区域
|
||||
|
||||
### Web 可视化界面
|
||||
|
||||
TUI 启动后，管理员可在右侧面板勾选「启用 Web 服务」自动启动，或手动运行：
|
||||
|
||||
```bash
|
||||
# 手动启动 Web 服务
|
||||
python web_api.py --port 4096
|
||||
```
|
||||
|
||||
然后打开浏览器访问 `http://localhost:4096`。
|
||||
|
||||
**首次访问** → 自动跳转至设置页，创建管理员账号 → 跳转至星图可视化页面。
|
||||
|
||||
**Web 功能：**
|
||||
- 🌟 星图可视化浏览知识图谱
|
||||
- ⚙ 设置页：修改密码、管理用户（管理员专属）
|
||||
- 🔒 会话认证，多用户安全隔离
|
||||
|
||||
---
|
||||
|
||||
## 打包构建
|
||||
|
||||
项目支持 PyInstaller 打包为单文件可执行文件：
|
||||
|
||||
```bash
|
||||
# Linux
|
||||
bash build/build_linux.sh
|
||||
|
||||
# macOS
|
||||
bash build/build_macos.sh
|
||||
|
||||
# Windows
|
||||
build\build_windows.bat
|
||||
|
||||
# AppImage（Linux 通用打包）
|
||||
bash build/build_appimage.sh
|
||||
```
|
||||
|
||||
构建产出在 `dist/` 目录：
|
||||
|
||||
| 文件 | 用途 |
|
||||
| 特性 | 说明 |
|
||||
|------|------|
|
||||
| `TrulyMEM` | TUI 主程序（含 Web 子进程启动能力） |
|
||||
| `trulymem-web` | Web 服务独立二进制（TUI 启动子进程时自动使用） |
|
||||
|
||||
### Web 启动优先级（TUI 内）
|
||||
1. 同目录 `trulymem-web` 二进制（打包环境）
|
||||
2. `sys._MEIPASS/web_api.py`（PyInstaller 数据文件回退）
|
||||
3. `python3 web_api.py`（开发环境回退）
|
||||
| 🧠 **图记忆** | 三元组存储，LLM 自主推理跳转 |
|
||||
| 🔐 **多用户** | 用户隔离 + Admin/User 角色权限 |
|
||||
| 🌐 **Web 可视化** | 内嵌 Flask 服务（线程模式），实时浏览知识图谱 |
|
||||
| 🎮 **TUI 界面** | Textual 终端界面，F2 配置面板 |
|
||||
| 📦 **单文件打包** | PyInstaller 打包，Web 服务内嵌于主二进制 |
|
||||
|
||||
---
|
||||
|
||||
## 文档索引
|
||||
|
||||
详细技术文档请参阅 [docs/zh/](docs/zh/) 目录：
|
||||
|
||||
| 文档 | 内容 |
|
||||
|------|------|
|
||||
| [docs/zh/quick_start.md](docs/zh/quick_start.md) | 🔥 **完整启动指南**（含 Web、多用户、打包） |
|
||||
| [docs/zh/architecture.md](docs/zh/architecture.md) | 系统架构和技术设计 |
|
||||
| [docs/zh/quick_start.md](docs/zh/quick_start.md) | 完整启动指南与配置说明 |
|
||||
| [docs/zh/memory.md](docs/zh/memory.md) | 内部记忆工作机制 |
|
||||
| [docs/zh/persona.md](docs/zh/persona.md) | 人设图机制 |
|
||||
| [docs/zh/working_memory.md](docs/zh/working_memory.md) | 连续性任务处理机制 |
|
||||
| [docs/zh/api.md](docs/zh/api.md) | 后端 API 接口（供扩展开发） |
|
||||
| [docs/zh/api.md](docs/zh/api.md) | 后端 API 接口 |
|
||||
| [docs/zh/prompts.md](docs/zh/prompts.md) | 提示词管理模块 |
|
||||
|
||||
---
|
||||
|
||||
## 贡献
|
||||
|
||||
欢迎提交 Issue 和 Pull Request！
|
||||
|
||||
1. Fork 本仓库
|
||||
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
|
||||
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. 推送到分支 (`git push origin feature/AmazingFeature`)
|
||||
5. 创建 Pull Request
|
||||
|
||||
---
|
||||
|
||||
## 许可证
|
||||
|
||||
本项目采用 **GNU General Public License v3.0 (GPLv3)** 许可证开源。
|
||||
详见 [LICENSE](LICENSE) 文件。
|
||||
|
||||
---
|
||||
|
||||
## 特别鸣谢
|
||||
|
||||
- [Prof. Meiting Wang](https://www.xxmu.edu.cn/yxgcxy/info/1260/4252.htm) — 学术指导
|
||||
- [逝水秋生白](https://atomgit.com/cenber) — 架构支持
|
||||
- anzhitinglan — 测试资源支持
|
||||
- 崔莉萍老师 — 理论指导
|
||||
- Annie — 专业指导
|
||||
- 王梓沣、马悦华、隆梦婷 — 神经科学理论支持
|
||||
GNU General Public License v3.0 (GPLv3)
|
||||
|
||||
Reference in New Issue
Block a user