From f42eb7f1e36a6fc4f36a00050f6b4cc05023abef Mon Sep 17 00:00:00 2001 From: dengjiaji Date: Tue, 2 Sep 2025 12:06:44 +0800 Subject: [PATCH] update readme --- README_ZH.md | 143 +++++++++++++++++++++++++++------------------------ 1 file changed, 75 insertions(+), 68 deletions(-) diff --git a/README_ZH.md b/README_ZH.md index f317cab9..ea7f0a30 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -1,48 +1,45 @@ -# ReMe.ai +# ReMe (formerly memoryscope)

- ReMe.ai Logo + ReMe.ai Logo

Python Version PyPI Version License - GitHub Stars + GitHub Stars

- 记忆驱动的AI智能体框架
- "如果说我比别人看得更远些，那是因为我站在了巨人的肩膀上。" —— 牛顿 + ReMe: 为agent设计的记忆管理框架
+ Remember Me, Refine Me

--- -Remember Everyone, Recreate Everything +agent时代的记忆不单是用于保存个性化的用户信息。agent在完成任务时，我们希望它能够有区分性地记住用户的偏好，以及如何正确地行动。 -Remember Me, Reshape Me +当智能体处理任务时，它都在重新发明无数其他智能体已经发现的解决方案。这就像要求每个人都从头发现火、农业和数学一样。 -Remember Me, Refine Me - -Remember Me, Reinvent Me - -今天的每个AI智能体都在从零开始。每当智能体处理任务时，它都在重新发明无数其他智能体已经发现的解决方案。这就像要求每个人都从头发现火、农业和数学一样。 - -ReMe.ai希望改变这一点。我们为AI智能体提供了统一的记忆与经验系统——在跨用户、跨任务、跨智能体下抽取、复用和分享记忆的能力。 +ReMe为AI智能体提供了统一的记忆与经验系统——在跨用户、跨任务、跨智能体下抽取、复用和分享记忆的能力。 ``` -任务经验 (Task Memory) + 个人记忆 (Personal Memory) = agent的记忆管理 +个性化记忆 (Personal Memory) + 任务经验 (Task Memory)= agent的记忆管理 ``` -个人记忆回答"**如何理解用户需要**"，任务记忆回答"**如何做得更好**"， +个性化记忆能够"**理解用户需要**"，任务记忆让agent"**做得更好**"， --- ## 📰 最新动态 -- **[2025-09]** 🎉 ReMe.ai v1.0.0 正式发布，整合任务经验与个人记忆 + +- **[2025-09]** 🧪 我们在appworld, bfcl(v3) 以及frozenlake环境验证了记忆抽取与复用在agent中的效果，更多信息请查看 [appworld exp](./cookbook/appworld/quickstart.md), [bfcl exp](./cookbook/bfcl/quickstart.md) & [frozenlake exp](./cookbook/frozenlake/quickstart.md) +- **[2025-09]** 🎉 ReMe(formerly [MemoryScope](./memoryscope/README.md)) v1.0 正式发布，整合任务经验与个人记忆。 如果想使用原始的memoryscope项目，你可以在[MemoryScope](./memoryscope)找到 - **[2025-08]** 🚀 MCP协议支持已上线！→ [快速开始指南](./doc/mcp_quick_start.md) - **[2025-07]** 📚 完整文档和快速开始指南发布 -- **[2025-06]** 🚀 多后端向量存储支持 (Elasticsearch & ChromaDB) +- **[2025-06]** 🚀 多后端向量存储支持 (Elasticsearch & ChromaDB) -> [快速开始指南](./doc/vector_store_api_guide.md) +- **[2024-09]** 🧠 MemoryScope v0.1.1.0 发布，个性化和时间感知的记忆存储与使用 --- @@ -50,17 +47,16 @@ ReMe.ai希望改变这一点。我们为AI智能体提供了统一的记忆与 ### 🎯 双模记忆系统 -ReMe.ai整合两种互补的记忆能力： +ReMe整合两种互补的记忆能力： #### 🧠 **任务经验 (Task Memory/Experience)** 跨智能体复用的程序性知识 - **成功模式识别**：识别有效策略并理解其根本原理 - **失败分析学习**：从错误中学习，避免重复同样的问题 -- **规划策略**：不同问题类型的规划策略 -- **工具使用模式**：经过验证的有效工具使用方法 -- **标准操作流程**：经过验证的方法论和流程 +- **对比模式**：不同采样轨迹通过对比得到更有价值的经验 +- **验证模式**：经过验证模块确认抽取记忆的有效性 -你可以从[快速开始指南](./doc/task_memory_readme.md)了解更多如何使用task memory的方法 +你可以从[task memory](./doc/task_memory/task_memory.md)了解更多如何使用task memory的方法 #### 👤 **个人记忆 (personal memory)** 特定用户的情境化记忆 @@ -69,7 +65,7 @@ ReMe.ai整合两种互补的记忆能力： - **渐进学习**：通过长期交互逐步建立深度理解 - **时间感知**：检索和整合时都具备时间敏感性 -- 你可以从[快速开始指南](./doc/personal_memory_readme.md)了解更多如何使用personal memory的方法 +- 你可以从[personal](./doc/personal_memory/personal_memory.md)了解更多如何使用personal memory的方法 --- @@ -83,21 +79,23 @@ pip install reme-ai ### 从源码安装 ```bash -git clone https://github.com/modelscope/ReMe.ai.git -cd ReMe.ai +git clone https://github.com/modelscope/ReMe.git +cd ReMe pip install . ``` ### 环境配置 -创建`.env`文件： + +复制 `example.env` 为 .env并修改其中对应参数： + ```bash # 必需：LLM API配置 -LLM_API_KEY="sk-xxx" -LLM_BASE_URL="https://xxx.com/v1" +FLOW_LLM_API_KEY=sk-xxxx +FLOW_LLM_BASE_URL=https://xxxx/v1 # 必需：嵌入模型配置 -EMBEDDING_MODEL_API_KEY="sk-xxx" -EMBEDDING_MODEL_BASE_URL="https://xxx.com/v1" +FLOW_EMBEDDING_API_KEY=sk-xxxx +FLOW_EMBEDDING_BASE_URL=https://xxxx/v1 ``` --- @@ -171,37 +169,9 @@ response = requests.post("http://localhost:8002/retrieve_personal_memory", json= --- -## 🧪 实验结果 - -### Appworld基准测试 -使用qwen3-8b在Appworld上的测试结果： - -| 方法 | pass@1 | pass@2 | pass@4 | -|----------------------------|-----------|-------------|-----------| -| 无记忆（基线） | 0.083 | 0.140 | 0.228 | -| **使用任务经验** | **0.109** | **0.175** | **0.281** | - -详见：[quickstart.md](cookbook/appworld/quickstart.md) - -### FrozenLake实验 -使用qwen3-8b在100个随机FrozenLake地图上测试： - -| 方法 | 通过率 | -|---------------------------|-----------------| -| 无记忆（基线） | 0.66 | -| **使用任务经验** | 0.72 **(+9.1%)** | - -| 无经验 | 有经验 | -|:----------------------------------------------------------:|:---------------------------------------:| -|

失败案例

|

成功案例

- -详见：[quickstart.md](cookbook/frozenlake/quickstart.md) - ---- - ## 📦 即用型经验库 -ReMe.ai提供预构建的经验库，智能体可以立即使用经过验证的最佳实践： +ReMe提供预构建的经验库，智能体可以立即使用经过验证的最佳实践： ### 可用经验库 - **`appworld_v1.jsonl`**：Appworld智能体交互的记忆库，涵盖复杂任务规划和执行模式 @@ -224,12 +194,50 @@ response = requests.post("http://localhost:8002/retrieve_task_memory", json={ }) ``` +## 🧪 实验 + +### 🌍 Appworld 实验 + +我们在 Appworld 上使用 qwen3-8b 测试 ReMe： + +| 方法 | pass@1 | pass@2 | pass@4 | +|---------------------|-----------|-------------|-----------| +| 不使用 ReMe (baseline) | 0.083 | 0.140 | 0.228 | +| **使用 ReMe** | | | | +| w/ memory(直接使用) | **0.109** | **0.175** | **0.281** | + +Pass@K 衡量的是在生成的 K 个样本中，至少有一个成功完成任务（score=1）的概率。 +当前实验使用的是一个内部的 AppWorld 环境，可能存在轻微差异。 + +你可以在 [quickstart.md](cookbook/appworld/quickstart.md) 中找到复现实验的更多细节。 + + +### 🧊 Frozenlake 实验 + +| 不使用memory | 使用memory | +|:-------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------:| +|

GIF 1

|

GIF 2

| + +我们在 100 个随机 frozenlake 地图上使用 qwen3-8b 进行测试： + +| 方法 | pass rate | +|---------------------|----------------| +| 不使用 ReMe (baseline) | 0.66 | +| **使用 ReMe** | | +| w/ memory (直接使用) | 0.72 **(+9.1%)** | + +你可以在 [quickstart.md](cookbook/frozenlake/quickstart.md) 中找到复现实验的更多细节。 + +### 🔧 BFCL-V3 实验 + +即将推出！请持续关注完整的评估结果。 + ## 📚 相关资源 -- **[快速开始](./cookbook/simple_demo/quick_start.md)**：通过实际示例快速上手 -- **[向量存储设置](./doc/vector_store_setup.md)**：生产部署指南 -- **[配置指南](./doc/configuration_guide.md)**：详细配置参考 -- **[操作文档](./doc/operations_documentation.md)**：操作配置说明 +- **[快速开始](./cookbook/simple_demo)**：通过实际示例快速上手 +- **[向量存储设置](./doc/vector_store_api_guide.md)**：配置本地/向量数据库以及使用 +- **[mcp指南](./doc/mcp_quick_start.md)**：创建mcp服务 +- **链路说明**: 个性化记忆与任务记忆中分别使用的算子及其含义可以分别在 [personal memory](./doc/personal_memory) 与 [task memory](./doc/task_memory)中找到，你可以修改config以自定义链路 - **[示例集合](./cookbook)**：实际用例和最佳实践 --- @@ -246,7 +254,6 @@ response = requests.post("http://localhost:8002/retrieve_task_memory", json={ ### 文档改进 - 使用示例和教程 - 最佳实践指南 -- 翻译和本地化 --- @@ -254,9 +261,9 @@ response = requests.post("http://localhost:8002/retrieve_task_memory", json={ ```bibtex @software{ReMe2025, - title = {ReMe.ai: Memory-Driven AI Agent Framework}, - author = {The ReMe.ai Team}, - url = {https://github.com/modelscope/ReMe.ai}, + title = {ReMe: Memory Framework for AI Agent}, + author = {The ReMe Team}, + url = {https://github.com/modelscope/ReMe}, year = {2025} } ```