From 785e78a7a1780befdb7c97e7087637e158d06975 Mon Sep 17 00:00:00 2001 From: dengjiaji Date: Tue, 16 Sep 2025 20:30:06 +0800 Subject: [PATCH] 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