reme-ai 0.1.2__tar.gz → 0.1.4__tar.gz

reme_ai-0.1.4/PKG-INFO

@@ -0,0 +1,649 @@
+Metadata-Version: 2.4
+Name: reme_ai
+Version: 0.1.4
+Summary: Remember me
+Author-email: "jinli.yl" <jinli.yl@alibaba-inc.com>, "dengjiaji.djj" <dengjiaji.djj@alibaba-inc.com>, "caozouying.czy" <caozouying.czy@alibaba-inc.com>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2025 Alibaba Group
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Keywords: llm,memory,experience,memoryscope,ai,mcp,http
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flowllm>=0.1.3
+Dynamic: license-file
+
+<p align="center">
+ <img src="docs/figure/reme_logo.png" alt="ReMe Logo" width="50%">
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/reme-ai/"><img src="https://img.shields.io/badge/python-3.12+-blue" alt="Python Version"></a>
+  <a href="https://pypi.org/project/reme-ai/"><img src="https://img.shields.io/badge/pypi-v0.1.x-blue?logo=pypi" alt="PyPI Version"></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-black" alt="License"></a>
+  <a href="https://github.com/modelscope/ReMe"><img src="https://img.shields.io/github/stars/modelscope/ReMe?style=social" alt="GitHub Stars"></a>
+</p>
+
+<p align="center">
+  <strong>ReMe (formerly MemoryScope): Memory Management Framework for Agents</strong><br>
+  <em>Remember Me, Refine Me.</em>
+</p>
+
+---
+ReMe provides AI agents with a unified memory system—enabling the ability to extract, reuse, and share memories across
+users, tasks, and agents.
+
+```
+Personal Memory + Task Memory = Agent Memory
+```
+
+Personal memory helps "**understand user preferences**", while task memory helps agents "**perform better**".
+
+---
+
+## 📰 Latest Updates
+
+- **[2025-09]** 🎉 ReMe v0.1
+  officially released, integrating task memory and personal memory. If you want to use the original memoryscope project,
+  you can find it in [MemoryScope](https://github.com/modelscope/Reme/tree/memoryscope_branch).
+- **[2025-09]** 🧪 We validated the effectiveness of task memory extraction and reuse in agents in appworld, bfcl(v3),
+  and frozenlake environments. For more information,
+  check [appworld exp](./cookbook/appworld/quickstart.md), [bfcl exp](./cookbook/bfcl/quickstart.md),
+  and [frozenlake exp](./cookbook/frozenlake/quickstart.md).
+- **[2025-08]** 🚀 MCP protocol support is now available -> [MCP Quick Start](docs/mcp_quick_start.md).
+- **[2025-06]** 🚀 Multiple backend vector storage support (Elasticsearch &
+  ChromaDB) -> [Vector DB quick start](docs/vector_store_api_guide.md).
+- **[2024-09]** 🧠 [MemoryScope](https://github.com/modelscope/Reme/tree/memoryscope_branch) v0.1.x released,
+  personalized and time-aware memory storage and usage.
+
+---
+
+## ✨ Architecture Design
+
+<p align="center">
+ <img src="docs/figure/reme_structure.jpg" alt="ReMe Logo" width="100%">
+</p>
+
+ReMe integrates two complementary memory capabilities:
+
+#### 🧠 **Task Memory/Experience**
+
+Procedural knowledge reused across agents
+
+- **Success Pattern Recognition**: Identify effective strategies and understand their underlying principles
+- **Failure Analysis Learning**: Learn from mistakes and avoid repeating the same issues
+- **Comparative Patterns**: Different sampling trajectories provide more valuable memories through comparison
+- **Validation Patterns**: Confirm the effectiveness of extracted memories through validation modules
+
+Learn more about how to use task memory from [task memory](docs/task_memory/task_memory.md)
+
+#### 👤 **Personal Memory**
+
+Contextualized memory for specific users
+
+- **Individual Preferences**: User habits, preferences, and interaction styles
+- **Contextual Adaptation**: Intelligent memory management based on time and context
+- **Progressive Learning**: Gradually build deep understanding through long-term interaction
+- **Time Awareness**: Time sensitivity in both retrieval and integration
+
+Learn more about how to use personal memory from [personal memory](docs/personal_memory/personal_memory.md)
+
+---
+
+## 🛠️ Installation
+
+### Install from PyPI (Recommended)
+
+```bash
+pip install reme-ai
+```
+
+### Install from Source
+
+```bash
+git clone https://github.com/modelscope/ReMe.git
+cd ReMe
+pip install .
+```
+
+### Environment Configuration
+
+Copy `example.env` to .env and modify the corresponding parameters:
+
+```bash
+# Required: LLM API Configuration
+FLOW_LLM_API_KEY=sk-xxxx
+FLOW_LLM_BASE_URL=https://xxxx/v1
+
+# Required: Embedding Model Configuration  
+FLOW_EMBEDDING_API_KEY=sk-xxxx
+FLOW_EMBEDDING_BASE_URL=https://xxxx/v1
+```
+
+---
+
+## 🚀 Quick Start
+
+### HTTP Service Startup
+
+```bash
+reme \
+  backend=http \
+  http.port=8002 \
+  llm.default.model_name=qwen3-30b-a3b-thinking-2507 \
+  embedding_model.default.model_name=text-embedding-v4 \
+  vector_store.default.backend=local
+```
+
+### MCP Server Support
+
+```bash
+reme \
+  backend=mcp \
+  mcp.transport=stdio \
+  llm.default.model_name=qwen3-30b-a3b-thinking-2507 \
+  embedding_model.default.model_name=text-embedding-v4 \
+  vector_store.default.backend=local
+```
+
+### Core API Usage
+
+#### Task Memory Management
+
+```python
+import requests
+
+# Experience Summarizer: Learn from execution trajectories
+response = requests.post("http://localhost:8002/summary_task_memory", json={
+    "workspace_id": "task_workspace",
+    "trajectories": [
+        {"messages": [{"role": "user", "content": "Help me create a project plan"}], "score": 1.0}
+    ]
+})
+
+# Retriever: Get relevant memories
+response = requests.post("http://localhost:8002/retrieve_task_memory", json={
+    "workspace_id": "task_workspace",
+    "query": "How to efficiently manage project progress?",
+    "top_k": 1
+})
+```
+
+<details>
+<summary>curl version</summary>
+
+```bash
+# Experience Summarizer: Learn from execution trajectories
+curl -X POST http://localhost:8002/summary_task_memory \
+  -H "Content-Type: application/json" \
+  -d '{
+    "workspace_id": "task_workspace",
+    "trajectories": [
+      {"messages": [{"role": "user", "content": "Help me create a project plan"}], "score": 1.0}
+    ]
+  }'
+
+# Retriever: Get relevant memories
+curl -X POST http://localhost:8002/retrieve_task_memory \
+  -H "Content-Type: application/json" \
+  -d '{
+    "workspace_id": "task_workspace",
+    "query": "How to efficiently manage project progress?",
+    "top_k": 1
+  }'
+```
+
+</details>
+
+<details>
+<summary>Node.js version</summary>
+
+```javascript
+// Experience Summarizer: Learn from execution trajectories
+fetch("http://localhost:8002/summary_task_memory", {
+  method: "POST",
+  headers: {
+    "Content-Type": "application/json",
+  },
+  body: JSON.stringify({
+    workspace_id: "task_workspace",
+    trajectories: [
+      {messages: [{role: "user", content: "Help me create a project plan"}], score: 1.0}
+    ]
+  })
+})
+.then(response => response.json())
+.then(data => console.log(data));
+
+// Retriever: Get relevant memories
+fetch("http://localhost:8002/retrieve_task_memory", {
+  method: "POST",
+  headers: {
+    "Content-Type": "application/json",
+  },
+  body: JSON.stringify({
+    workspace_id: "task_workspace",
+    query: "How to efficiently manage project progress?",
+    top_k: 1
+  })
+})
+.then(response => response.json())
+.then(data => console.log(data));
+```
+
+</details>
+
+#### Personal Memory Management
+
+```python
+# Memory Integration: Learn from user interactions
+response = requests.post("http://localhost:8002/summary_personal_memory", json={
+    "workspace_id": "task_workspace",
+    "trajectories": [
+        {"messages":
+            [
+                {"role": "user", "content": "I like to drink coffee while working in the morning"},
+                {"role": "assistant",
+                 "content": "I understand, you prefer to start your workday with coffee to stay energized"}
+            ]
+        }
+    ]
+})
+
+# Memory Retrieval: Get personal memory fragments
+response = requests.post("http://localhost:8002/retrieve_personal_memory", json={
+    "workspace_id": "task_workspace",
+    "query": "What are the user's work habits?",
+    "top_k": 5
+})
+```
+
+<details>
+<summary>curl version</summary>
+
+```bash
+# Memory Integration: Learn from user interactions
+curl -X POST http://localhost:8002/summary_personal_memory \
+  -H "Content-Type: application/json" \
+  -d '{
+    "workspace_id": "task_workspace",
+    "trajectories": [
+      {"messages": [
+        {"role": "user", "content": "I like to drink coffee while working in the morning"},
+        {"role": "assistant", "content": "I understand, you prefer to start your workday with coffee to stay energized"}
+      ]}
+    ]
+  }'
+
+# Memory Retrieval: Get personal memory fragments
+curl -X POST http://localhost:8002/retrieve_personal_memory \
+  -H "Content-Type: application/json" \
+  -d '{
+    "workspace_id": "task_workspace",
+    "query": "What are the user's work habits?",
+    "top_k": 5
+  }'
+```
+
+</details>
+
+<details>
+<summary>Node.js version</summary>
+
+```javascript
+// Memory Integration: Learn from user interactions
+fetch("http://localhost:8002/summary_personal_memory", {
+  method: "POST",
+  headers: {
+    "Content-Type": "application/json",
+  },
+  body: JSON.stringify({
+    workspace_id: "task_workspace",
+    trajectories: [
+      {messages: [
+        {role: "user", content: "I like to drink coffee while working in the morning"},
+        {role: "assistant", content: "I understand, you prefer to start your workday with coffee to stay energized"}
+      ]}
+    ]
+  })
+})
+.then(response => response.json())
+.then(data => console.log(data));
+
+// Memory Retrieval: Get personal memory fragments
+fetch("http://localhost:8002/retrieve_personal_memory", {
+  method: "POST",
+  headers: {
+    "Content-Type": "application/json",
+  },
+  body: JSON.stringify({
+    workspace_id: "task_workspace",
+    query: "What are the user's work habits?",
+    top_k: 5
+  })
+})
+.then(response => response.json())
+.then(data => console.log(data));
+```
+
+</details>
+
+---
+
+## 📦 Ready-to-Use Libraries
+
+ReMe provides pre-built memory libraries that agents can immediately use with verified best practices:
+
+### Available Libraries
+
+- **`appworld.jsonl`**: Memory library for Appworld agent interactions, covering complex task planning and execution
+  patterns
+- **`bfcl_v3.jsonl`**: Working memory library for BFCL tool calls
+
+### Quick Usage
+
+```python
+# Load pre-built memories
+response = requests.post("http://localhost:8002/vector_store", json={
+    "workspace_id": "appworld",
+    "action": "load",
+    "path": "./library/"
+})
+
+# Query relevant memories
+response = requests.post("http://localhost:8002/retrieve_task_memory", json={
+    "workspace_id": "appworld",
+    "query": "How to navigate to settings and update user profile?",
+    "top_k": 1
+})
+```
+
+## 🧪 Experiments
+
+### 🌍 [Appworld Experiment](./cookbook/appworld/quickstart.md)
+
+We tested ReMe on Appworld using qwen3-8b:
+
+| Method       | pass@1            | pass@2            | pass@4            |
+|--------------|-------------------|-------------------|-------------------|
+| without ReMe | 0.083             | 0.140             | 0.228             |
+| with ReMe    | 0.109 **(+2.6%)** | 0.175 **(+3.5%)** | 0.281 **(+5.3%)** |
+
+Pass@K measures the probability that at least one of the K generated samples successfully completes the task (
+score=1).  
+The current experiment uses an internal AppWorld environment, which may have slight differences.
+
+You can find more details on reproducing the experiment in [quickstart.md](cookbook/appworld/quickstart.md).
+
+### 🧊 [Frozenlake Experiment](./cookbook/frozenlake/quickstart.md)
+
+|                                         without ReMe                                         |                                          with ReMe                                           |
+|:--------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------:|
+| <p align="center"><img src="docs/figure/frozenlake_failure.gif" alt="GIF 1" width="30%"></p> | <p align="center"><img src="docs/figure/frozenlake_success.gif" alt="GIF 2" width="30%"></p> |
+
+We tested on 100 random frozenlake maps using qwen3-8b:
+
+| Method       | pass rate        |
+|--------------|------------------|
+| without ReMe | 0.66             |
+| with ReMe    | 0.72 **(+6.0%)** |
+
+You can find more details on reproducing the experiment in [quickstart.md](cookbook/frozenlake/quickstart.md).
+
+### 🔧 [BFCL-V3 Experiment](./cookbook/bfcl/quickstart.md)
+
+We tested ReMe on BFCL-V3 multi-turn-base (randomly split 50train/150val) using qwen3-8b:
+
+| Method       | pass@1              | pass@2              | pass@4              |
+|--------------|---------------------|---------------------|---------------------|
+| without ReMe | 0.2472              | 0.2733              | 0.2922              |
+| with ReMe    | 0.3061 **(+5.89%)** | 0.3500 **(+7.67%)** | 0.3888 **(+9.66%)** |
+
+## 📚 Resources
+
+- **[Quick Start](./cookbook/simple_demo)**: Get started quickly with practical examples
+- **[Vector Storage Setup](docs/vector_store_api_guide.md)**: Configure local/vector databases and usage
+- **[MCP Guide](docs/mcp_quick_start.md)**: Create MCP services
+- **[personal memory](docs/personal_memory)** & **[task memory](docs/task_memory)** : Operators used in personal memory and task memory, You can modify the config to customize the pipelines.
+- **[Example Collection](./cookbook)**: Real use cases and best practices
+
+---
+
+## 🤝 Contribution
+
+We believe the best memory systems come from collective wisdom. Contributions welcome 👉[Guide](docs/contribution.md):
+
+### Code Contributions
+
+- New operation and tool development
+- Backend implementation and optimization
+- API enhancements and new endpoints
+
+### Documentation Improvements
+
+- Usage examples and tutorials
+- Best practice guides
+
+
+---
+
+## 📄 Citation
+
+```bibtex
+@software{ReMe2025,
+  title = {ReMe: Memory Framework for AI Agent},
+  author = {Li Yu, Jiaji Deng, Zouying Cao},
+  url = {https://github.com/modelscope/ReMe},
+  year = {2025}
+}
+```
+
+---
+
+## ⚖️ License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](./LICENSE) file for details.
+
+---