From e8fe360476b2cd0346f48efa61140b1dd0b648da Mon Sep 17 00:00:00 2001 From: jinliyl <6469360+jinliyl@users.noreply.github.com> Date: Tue, 16 Sep 2025 17:39:52 +0800 Subject: [PATCH 1/8] Create python-publish.yml --- .github/workflows/python-publish.yml | 40 ++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/workflows/python-publish.yml diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml new file mode 100644 index 00000000..dc60503b --- /dev/null +++ b/.github/workflows/python-publish.yml @@ -0,0 +1,40 @@ +# This workflow will upload a Python Package using Twine when a release is created +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries + +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Publish Python Package to Pypi + +on: + workflow_dispatch: + release: + types: [published] + +permissions: + contents: read + +jobs: + deploy: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.10' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install setuptools wheel build + - name: Build package + run: python -m build + - name: Publish package to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + with: + user: __token__ + password: ${{ secrets.PYPI_API_TOKEN }} From 785e78a7a1780befdb7c97e7087637e158d06975 Mon Sep 17 00:00:00 2001 From: dengjiaji Date: Tue, 16 Sep 2025 20:30:06 +0800 Subject: [PATCH 2/8] docs(restructure): reorganize documentation , add experiment overview & use library guide --- docs/experiment_overview.md | 39 +++++++++++ docs/index.md | 128 ++---------------------------------- docs/library/use_library.md | 30 +++++++++ mkdocs.yml | 2 + 4 files changed, 76 insertions(+), 123 deletions(-) create mode 100644 docs/experiment_overview.md create mode 100644 docs/library/use_library.md diff --git a/docs/experiment_overview.md b/docs/experiment_overview.md new file mode 100644 index 00000000..5dd7a74e --- /dev/null +++ b/docs/experiment_overview.md @@ -0,0 +1,39 @@ + +### 🌍 [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 | +|:-------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------:| +|

GIF 1

|

GIF 2

| + +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%)** | diff --git a/docs/index.md b/docs/index.md index 75a9894a..3da16e50 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,25 +33,6 @@ Personal memory helps "**understand user preferences**", while task memory helps --- -## 📰 Latest Updates - -- **[2025-09]** 🎉 ReMe v0.1.8 has been officially released, adding support for asynchronous operations. It has also been - integrated into the memory service of agentscope-runtime. -- **[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](mcp_quick_start.md). -- **[2025-06]** 🚀 Multiple backend vector storage support (Elasticsearch & - ChromaDB) -> [Vector DB quick start](vector_store_api_guide.md). -- **[2024-09]** 🧠 [MemoryScope](https://github.com/modelscope/Reme/tree/memoryscope_branch) v0.1 released, - personalized and time-aware memory storage and usage. - ---- - ## ✨ Architecture Design

@@ -322,104 +303,18 @@ fetch("http://localhost:8002/retrieve_personal_memory", { --- -## 📦 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": "./docs/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 | -|:-------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------:| -|

GIF 1

|

GIF 2

| - -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](https://github.com/modelscope/ReMe/tree/main/cookbook/simple_demo)**: Get started quickly with practical examples +- - **[Vector Storage Setup](vector_store_api_guide.md)**: Configure local/vector databases and usage - **[MCP Guide](mcp_quick_start.md)**: Create MCP services - **[personal memory](personal_memory/personal_memory.md)** & **[task memory](task_memory/task_memory.md)** : Operators used in personal memory and task memory, You can modify the config to customize the pipelines. -- **[Example Collection](./cookbook/appworld/quickstart.md)**: Real use cases and best practices +- **[Example Collection](./experiment_overview.md)**: Real use cases and best practices +- **[Library](./library/library.md)**: Directly use existing task memory/experience for your tasks, and you can also contribute more task memory/experience to us. +- **[Contribution](contribution.md)**: welcome to your Contributions! --- -## 🤝 Contribution - -We believe the best memory systems come from collective wisdom. Contributions welcome 👉[Guide](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 +## Citation ```bibtex @software{ReMe2025, @@ -429,16 +324,3 @@ We believe the best memory systems come from collective wisdom. Contributions we year = {2025} } ``` - ---- - -## ⚖️ License - -This project is licensed under the Apache License 2.0 - see the [LICENSE](https://github.com/modelscope/ReMe/blob/main/LICENSE) file for details. - ---- - -## Star History - -[![Star History Chart](https://api.star-history.com/svg?repos=modelscope/ReMe&type=Date)](https://www.star-history.com/#modelscope/ReMe&Date) - diff --git a/docs/library/use_library.md b/docs/library/use_library.md new file mode 100644 index 00000000..5b42a5c4 --- /dev/null +++ b/docs/library/use_library.md @@ -0,0 +1,30 @@ +--- +title: Use Library +summary: Ready-to-use libraries at your disposal. +--- + +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": "./docs/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 +}) +``` diff --git a/mkdocs.yml b/mkdocs.yml index 40ebab03..3b82eaa5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,6 +14,7 @@ nav: - Library: - Library Home: library/library.md + - Use Library: library/use_library.md - Personal Memory: - Overview: personal_memory/personal_memory.md @@ -33,6 +34,7 @@ nav: - Vector Store: vector_store_api_guide.md - Experimental Tutorials: + - Overview: experiment_overview.md - AppWorld: cookbook/appworld/quickstart.md - BFCL: cookbook/bfcl/quickstart.md - FrozenLake: cookbook/frozenlake/quickstart.md From d5871c11ed6dff1a4e99c28023a80e812bb80854 Mon Sep 17 00:00:00 2001 From: dengjiaji Date: Tue, 16 Sep 2025 21:12:54 +0800 Subject: [PATCH 3/8] docs: Move experiment_overview &Modify mkdocs.yml --- docs/{ => cookbook}/experiment_overview.md | 19 ++++---- docs/index.md | 55 +++++++++++----------- mkdocs.yml | 4 +- 3 files changed, 40 insertions(+), 38 deletions(-) rename docs/{ => cookbook}/experiment_overview.md (66%) diff --git a/docs/experiment_overview.md b/docs/cookbook/experiment_overview.md similarity index 66% rename from docs/experiment_overview.md rename to docs/cookbook/experiment_overview.md index 5dd7a74e..f7a44891 100644 --- a/docs/experiment_overview.md +++ b/docs/cookbook/experiment_overview.md @@ -1,5 +1,8 @@ +--- +order: 1 +--- -### 🌍 [Appworld Experiment](cookbook/appworld/quickstart.md) +### 🌍 [Appworld Experiment](appworld/quickstart.md) We tested ReMe on Appworld using qwen3-8b: @@ -12,13 +15,13 @@ Pass@K measures the probability that at least one of the K generated samples suc 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). +You can find more details on reproducing the experiment in [quickstart.md](appworld/quickstart.md). -### 🧊 [Frozenlake Experiment](./cookbook/frozenlake/quickstart.md) +### 🧊 [Frozenlake Experiment](frozenlake/quickstart.md) -| without ReMe | with ReMe | -|:-------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------:| -|

GIF 1

|

GIF 2

| +| without ReMe | with ReMe | +|:------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------:| +|

GIF 1

|

GIF 2

| We tested on 100 random frozenlake maps using qwen3-8b: @@ -27,9 +30,9 @@ We tested on 100 random frozenlake maps using qwen3-8b: | 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). +You can find more details on reproducing the experiment in [quickstart.md](frozenlake/quickstart.md). -### 🔧 [BFCL-V3 Experiment](./cookbook/bfcl/quickstart.md) +### 🔧 [BFCL-V3 Experiment](bfcl/quickstart.md) We tested ReMe on BFCL-V3 multi-turn-base (randomly split 50train/150val) using qwen3-8b: diff --git a/docs/index.md b/docs/index.md index 3da16e50..9a9d1e17 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,18 +22,17 @@ show_datetime: true

--- + 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 -``` +!!! info "Personal Memory + Task Memory = Agent Memory" Personal memory helps "**understand user preferences**", while task memory helps agents "**perform better**". ---- -## ✨ Architecture Design + +## Architecture Design

ReMe Logo @@ -41,31 +40,32 @@ Personal memory helps "**understand user preferences**", while task memory helps ReMe integrates two complementary memory capabilities: -#### 🧠 **Task Memory/Experience** +!!! note "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 + Procedural knowledge reused across agents -Learn more about how to use task memory from [task memory](task_memory/task_memory.md) + - **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 -#### 👤 **Personal Memory** + Learn more about how to use task memory from [task memory](task_memory/task_memory.md) -Contextualized memory for specific users +!!! note "Personal Memory" -- **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 + Contextualized memory for specific users -Learn more about how to use personal memory from [personal memory](personal_memory/personal_memory.md) + - **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](personal_memory/personal_memory.md) -## 🛠️ Installation + +## Installation ### Install from PyPI (Recommended) @@ -95,7 +95,7 @@ FLOW_EMBEDDING_BASE_URL=https://xxxx/v1 --- -## 🚀 Quick Start +## Quick Start ### HTTP Service Startup @@ -303,14 +303,13 @@ fetch("http://localhost:8002/retrieve_personal_memory", { --- -## 📚 Resources -- +## Resources +- **[Personal memory](personal_memory/personal_memory.md)** & **[Task memory](task_memory/task_memory.md)** : Operators used in personal memory and task memory, You can modify the config to customize the pipelines. +- **[Example Collection](cookbook/experiment_overview.md)**: Real use cases and best practices +- **[Library](./library/library.md)**: Directly use existing task memory/experience for your tasks, and you can also contribute more task memory/experience to us. +- **[Contribution](contribution.md)**: welcome to your contributions! - **[Vector Storage Setup](vector_store_api_guide.md)**: Configure local/vector databases and usage - **[MCP Guide](mcp_quick_start.md)**: Create MCP services -- **[personal memory](personal_memory/personal_memory.md)** & **[task memory](task_memory/task_memory.md)** : Operators used in personal memory and task memory, You can modify the config to customize the pipelines. -- **[Example Collection](./experiment_overview.md)**: Real use cases and best practices -- **[Library](./library/library.md)**: Directly use existing task memory/experience for your tasks, and you can also contribute more task memory/experience to us. -- **[Contribution](contribution.md)**: welcome to your Contributions! --- diff --git a/mkdocs.yml b/mkdocs.yml index 3b82eaa5..0dd03135 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -34,13 +34,13 @@ nav: - Vector Store: vector_store_api_guide.md - Experimental Tutorials: - - Overview: experiment_overview.md + - Overview: cookbook/experiment_overview.md - AppWorld: cookbook/appworld/quickstart.md - BFCL: cookbook/bfcl/quickstart.md - FrozenLake: cookbook/frozenlake/quickstart.md - - Contributions: contribution.md + - Contribution Guide: contribution.md plugins: - search From 0bb6728ecd4d84c794a18b8e50dcc9b345a335d3 Mon Sep 17 00:00:00 2001 From: dengjiaji Date: Wed, 17 Sep 2025 12:22:09 +0800 Subject: [PATCH 4/8] docs: add format --- docs/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/index.md b/docs/index.md index 9a9d1e17..99ebf2ac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -55,6 +55,8 @@ ReMe integrates two complementary memory capabilities: !!! note "Personal Memory" + --- + Contextualized memory for specific users - **Individual Preferences**: User habits, preferences, and interaction styles From 31143caae83498d5255c000fb546ceb051bfb60a Mon Sep 17 00:00:00 2001 From: dengjiaji Date: Wed, 17 Sep 2025 12:24:59 +0800 Subject: [PATCH 5/8] docs(cookbook): update frozenlake figure path --- docs/cookbook/experiment_overview.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/cookbook/experiment_overview.md b/docs/cookbook/experiment_overview.md index f7a44891..61a5cd6b 100644 --- a/docs/cookbook/experiment_overview.md +++ b/docs/cookbook/experiment_overview.md @@ -19,9 +19,9 @@ You can find more details on reproducing the experiment in [quickstart.md](appwo ### 🧊 [Frozenlake Experiment](frozenlake/quickstart.md) -| without ReMe | with ReMe | -|:------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------:| -|

GIF 1

|

GIF 2

| +| without ReMe | with ReMe | +|:---------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------:| +|

GIF 1

|

GIF 2

| We tested on 100 random frozenlake maps using qwen3-8b: From c1ae740ebac124d072f432e45c09520aa289a013 Mon Sep 17 00:00:00 2001 From: dengjiaji Date: Wed, 17 Sep 2025 15:48:29 +0800 Subject: [PATCH 6/8] feat(library): implement category view --- docs/library/library.md | 216 +++++++++++++++++++++++++++++----------- 1 file changed, 159 insertions(+), 57 deletions(-) diff --git a/docs/library/library.md b/docs/library/library.md index 9144a9cb..52aa58b3 100644 --- a/docs/library/library.md +++ b/docs/library/library.md @@ -38,8 +38,18 @@ new: true - + + +