diff --git a/README.md b/README.md index 2bc08cef0..9ce8c031a 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,40 @@
- - MemOS Banner - -

- MemOS Logo  + + MemOS Logo +   MemOS 2.0 Stardust(星尘) -

-

-
- Docs - ArXiv - X - Discord - Resources -

- -

- 🏆 Leading Performance Across Agent and User Memory Benchmarks
- 🤖 OpenClaw Task Completion Improves from 36.63% to 50.87%
- 🎯 92.34 on LoCoMo and 93.40 on LongMemEval
- 📊 Unified Evaluation Across 14 Commercial Memory Products - - -

- +

+ Docs + ArXiv + X + Discord +
+ Resources +

+ +

+ Give your Agent persistent memory and the ability to grow.
+

+ +

+ English | 中文 +

- - - - - - -## 🧠 MemOS Plugin: Persistent Memory for Your AI Agents ✨
- -MemOS Plugin Banner - -Your lobsters and Hermes Agents now have **the best** memory system — choose ***Cloud Service*** or ***Self-hosted*** to get started 🏃🏻 - -| 🔌 Plugin |
💡 Core Features
| 🧩 Resources | -| :----: | :--- | :---: | -| 🧠 [**memos-local-plugin 2.0**](https://github.com/hijzy/MemOS/tree/main/apps/memos-local-plugin) | | 🌐 [Website](https://memos-claw.openmem.net/) · 📖 [Docs](https://memos-docs.openmem.net/cn/openclaw/local_plugin) · 🐙 [GitHub](https://github.com/hijzy/MemOS/tree/main/apps/memos-local-plugin) · 📦 [NPM](https://www.npmjs.com/package/@memtensor/memos-local-plugin) | -| ☁️ [**OpenClaw Cloud Plugin**](https://x.com/MemOS_dev/status/2019254160919769171?s=20) | | 🖥️ [MemOS Dashboard](https://memos-dashboard.openmem.net/login/) · 📖 [Full Tutorial](https://memos-docs.openmem.net/openclaw/guide#_4-update-plugin) | - -> **🐳 Docker Deployment Note**: When running memos-local-plugin in Docker containers, you must specify the config location using `MEMOS_HOME` environment variable or `--home` CLI flag. See [Docker Configuration Guide](./apps/memos-local-plugin/README.md#docker-deployment) for details. - + MemOS Plugin Banner
-
+ +--- ## 👾 MemOS: Memory Operating System for LLM & AI Agents **MemOS** is a Memory Operating System for LLMs and AI agents that unifies **store / retrieve / manage** for long-term memory, enabling **context-aware and personalized** interactions with **KB**, **multi-modal**, **tool memory**, and **enterprise-grade** optimizations built in. - ### Key Features - **Unified Memory API**: A single API to add, retrieve, edit, and delete memory—structured as a graph, inspectable and editable by design, not a black-box embedding store. @@ -83,341 +58,217 @@ Your lobsters and Hermes Agents now have **the best** memory system — choose * - **2026-03-08** · 🦞 **MemOS OpenClaw Plugin — Cloud & Local** Official OpenClaw memory plugins launched. **Cloud Plugin**: hosted memory service with 72% lower token usage and multi-agent memory sharing ([MemOS-Cloud-OpenClaw-Plugin](https://github.com/MemTensor/MemOS-Cloud-OpenClaw-Plugin)). **Local Plugin** (`v1.0.0`): 100% on-device memory with persistent SQLite, hybrid search (FTS5 + vector), task summarization & skill evolution, multi-agent collaboration, and a full Memory Viewer dashboard. -- **2025-12-24** · 🎉 **MemOS v2.0: Stardust (星尘) Release** - Comprehensive KB (doc/URL parsing + cross-project sharing), memory feedback & precise deletion, multi-modal memory (images/charts), tool memory for agent planning, Redis Streams scheduling + DB optimizations, streaming/non-streaming chat, MCP upgrade, and lightweight quick/full deployment. -
- ✨ New Features +## 📊 Performance - **Knowledge Base & Memory** - - Added knowledge base support for long-term memory from documents and URLs +MemOS leads across multiple benchmarks — evaluated against mainstream commercial memory products across 5 user memory and 5 agent memory tasks. - **Feedback & Memory Management** - - Added natural language feedback and correction for memories - - Added memory deletion API by memory ID - - Added MCP support for memory deletion and feedback - **Conversation & Retrieval** - - Added chat API with memory-aware retrieval - - Added memory filtering with custom tags (Cloud & Open Source) +| Benchmark | Score | +| --------------- | ----- | +| LoCoMo | 88.83 | +| LongMemEval | 89.20 | +| PersonaMem v2 | 40.58 | +| HaluMem | 80.91 | +| BEAM-10M | 56.75 | +| GDPVal | 62.07 | +| LiveCodeBench | 64.96 | +| OmniMath | 61.00 | +| SWE-Bench | 38.46 | +| BrowseComp-Plus | 23.85 | - **Multimodal & Tool Memory** - - Added tool memory for tool usage history - - Added image memory support for conversations and documents -
+Evaluated via OmniMemEval — [https://github.com/MemTensor/OmniMemEval](https://github.com/MemTensor/OmniMemEval). -
- 📈 Improvements +## 🎯 What MemOS Is For - **Data & Infrastructure** - - Upgraded database for better stability and performance +MemOS gives AI agents long-term memory. Common uses: - **Scheduler** - - Rebuilt task scheduler with Redis Streams and queue isolation - - Added task priority, auto-recovery, and quota-based scheduling +- AI assistants with consistent, context-rich conversations +- Customer support that recalls past tickets and user history +- Personalized agents that adapt to individual preferences +- Multi-agent collaboration with shared or isolated memory - **Deployment & Engineering** - - Added lightweight deployment with quick and full modes +## 🚀 Quick Start -
+MemOS is built around four entry points. Pick the one that matches your scenario. -
- 🐞 Bug Fixes - **Memory Scheduling & Updates** - - Fixed legacy scheduling API to ensure correct memory isolation - - Fixed memory update logging to show new memories correctly +| | Cloud API | Self-Host | OpenClaw Cloud Plugin | Local Plugin | +| ------------ | ----------------------- | ------------------ | ------------------------ | ------------------------------- | +| Best for | Your app, fully managed | Teams on own infra | OpenClaw users, zero ops | Hermes/OpenClaw, 100% on-device | +| Setup | Get an API key | docker compose up | openclaw plugins install | npm install + config | +| Infra needed | None (hosted) | Neo4j + Qdrant | None (uses MemOS Cloud) | None (local SQLite) | +| Data lives | MemOS Cloud | Your servers | MemOS Cloud | Your machine | -
+### ☁️ Use the Cloud API (Hosted) -- **2025-08-07** · 🎉 **MemOS v1.0.0 (MemCube) Release** - First MemCube release with a word-game demo, LongMemEval evaluation, BochaAISearchRetriever integration, improved search capabilities, and the official Playground launch. +You want to add memory to your app through a fully managed service — no infrastructure to run. -
- ✨ New Features +**1. Get an API key:** - **Playground** - - Expanded Playground features and algorithm performance. +- Sign up on the [MemOS dashboard](https://memos-dashboard.openmem.net/cn/quickstart/?source=landing). +- Go to **API Keys** and copy your key (starts with `mpg-`). Keep it server-side. - **MemCube Construction** - - Added a text game demo based on the MemCube novel. - - **Extended Evaluation Set** - - Added LongMemEval evaluation results and scripts. +**2. Add and search memories:** -
- -
- 📈 Improvements - - **Plaintext Memory** - - Integrated internet search with Bocha. - - Expanded graph database support. - - Added contextual understanding for the tree-structured plaintext memory search interface. - -
- -
- 🐞 Bug Fixes - - **KV Cache Concatenation** - - Fixed the concat_cache method. - - **Plaintext Memory** - - Fixed graph search-related issues. - -
- -- **2025-07-07** · 🎉 **MemOS v1.0: Stellar (星河) Preview Release** - A SOTA Memory OS for LLMs is now open-sourced. -- **2025-07-04** · 🎉 **MemOS Paper Release** - [MemOS: A Memory OS for AI System](https://arxiv.org/abs/2507.03724) is available on arXiv. -- **2024-07-04** · 🎉 **Memory3 Model Release at WAIC 2024** - The Memory3 model, featuring a memory-layered architecture, was unveiled at the 2024 World Artificial Intelligence Conference. - -
+```python +import requests -## 🚀 Quick-start Guide +API_KEY = "mpg-..." # keep this server-side +base = "https://memos.memtensor.cn/api/openmem/v1" +headers = {"Authorization": f"Token {API_KEY}", "Content-Type": "application/json"} -### ☁️ 1、Cloud API (Hosted) -#### Get API Key -- Sign up on the [MemOS dashboard](https://memos-dashboard.openmem.net/cn/quickstart/?source=landing) -- Go to **API Keys** and copy your key +# 1. Add a memory +requests.post(f"{base}/add/message", headers=headers, json={ + "user_id": "alice", + "conversation_id": "conv_001", + "messages": [{"role": "user", "content": "I like strawberry"}], +}) + +# 2. Search memories +res = requests.post(f"{base}/search/memory", headers=headers, json={ + "query": "What do I like?", + "user_id": "alice", +}) +print(res.json()) +``` -#### Next Steps -- [MemOS Cloud Getting Started](https://memos-docs.openmem.net/memos_cloud/quick_start/) - Connect to MemOS Cloud and enable memory in minutes. -- [MemOS Cloud Platform](https://memos.openmem.net/?from=/quickstart/) - Explore the Cloud dashboard, features, and workflows. - -### 🖥️ 2、Self-Hosted (Local/Private) -1. Get the repository. - ```bash - git clone https://github.com/MemTensor/MemOS.git - cd MemOS - pip install -r ./docker/requirements.txt - ``` -2. Configure `docker/.env.example` and copy to `MemOS/.env` - - The `OPENAI_API_KEY`,`MOS_EMBEDDER_API_KEY`,`MEMRADER_API_KEY` and others can be applied for through [`BaiLian`](https://bailian.console.aliyun.com/?spm=a2c4g.11186623.0.0.2f2165b08fRk4l&tab=api#/api). - - Fill in the corresponding configuration in the `MemOS/.env` file. - - Supported LLM providers: **OpenAI**, **Azure OpenAI**, **Qwen (DashScope)**, **DeepSeek**, **MiniMax**, **Ollama**, **HuggingFace**, **vLLM**. Set `MOS_CHAT_MODEL_PROVIDER` to select the backend (e.g., `openai`, `qwen`, `deepseek`, `minimax`). -3. Start the service. - -- Launch via Docker - ###### Tips: Please ensure that Docker Compose is installed successfully and that you have navigated to the docker directory (via `cd docker`) before executing the following command. - ```bash - # Enter docker directory - docker compose up - ``` - ##### For detailed steps, see the[`Docker Reference`](https://docs.openmem.net/open_source/getting_started/rest_api_server/#method-1-docker-use-repository-dependency-package-imagestart-recommended-use). - -- Launch via the uvicorn command line interface (CLI) - ###### Tips: Please ensure that Neo4j and Qdrant are running before executing the following command. - ```bash - cd src - uvicorn memos.api.server_api:app --host 0.0.0.0 --port 8001 --workers 1 - ``` - ##### For detailed integration steps, see the [`CLI Reference`](https://docs.openmem.net/open_source/getting_started/rest_api_server/#method-3client-install-with-CLI). - - - -### Basic Usage (Self-Hosted) - - Add User Message - ```python - import requests - import json - - data = { - "user_id": "8736b16e-1d20-4163-980b-a5063c3facdc", - "mem_cube_id": "b32d0977-435d-4828-a86f-4f47f8b55bca", - "messages": [ - { - "role": "user", - "content": "I like strawberry" - } - ], - "async_mode": "sync" - } - headers = { - "Content-Type": "application/json" - } - url = "http://localhost:8000/product/add" - - res = requests.post(url=url, headers=headers, data=json.dumps(data)) - print(f"result: {res.json()}") - ``` - - Search User Memory - ```python - import requests - import json - - data = { - "query": "What do I like", - "user_id": "8736b16e-1d20-4163-980b-a5063c3facdc", - "mem_cube_id": "b32d0977-435d-4828-a86f-4f47f8b55bca" - } - headers = { - "Content-Type": "application/json" - } - url = "http://localhost:8000/product/search" - - res = requests.post(url=url, headers=headers, data=json.dumps(data)) - print(f"result: {res.json()}") - ``` - -
- - -## FAQ - -### What is MemOS? - -MemOS is a **Memory Operating System** for LLMs and AI agents that unifies store/retrieve/manage for long-term memory. It enables context-aware and personalized interactions with knowledge base (KB), multi-modal memory, tool memory, and enterprise-grade optimizations built in. - -### What are the benchmark results? - -MemOS achieves **92.34 on LoCoMo** and **93.40 on LongMemEval** for User Memory, while improving **OpenClaw** average task completion from **36.63% to 50.87%** across five Agent Memory tasks. For details, see [OmniMemEval](https://github.com/MemTensor/OmniMemEval), our unified evaluation framework for benchmarking 14 commercial memory products across ten datasets. - - -### How does MemOS compare to other memory solutions? - -| Feature | MemOS | mem0 | LangChain Memory | Letta | -|---------|-------|------|------------------|-------| -| Multi-Modal Memory | ✅ Text/Images/Tools | ❌ Text only | ❌ Text only | ❌ Text only | -| Knowledge Base | ✅ Multi-Cube KB | ❌ No KB | ⚠️ RAG only | ❌ No KB | -| Memory Feedback | ✅ Natural language | ❌ No | ❌ No | ❌ No | -| Graph Memory | ✅ Inspectable/Editable | ❌ Black-box | ❌ Black-box | ❌ Limited | -| Async Ingestion | ✅ MemScheduler | ❌ No | ❌ No | ❌ No | -| Open Source | ✅ Apache 2.0 | ✅ MIT | ✅ Apache | ✅ MIT | -| ArXiv Paper | ✅ 2507.03724 | ❌ No | ❌ No | ❌ No | - -### What are the key features? - -| Feature | Description | -|---------|-------------| -| **Unified Memory API** | Single API for add/retrieve/edit/delete, graph-structured, inspectable | -| **Multi-Modal Memory** | Text, images, tool traces, personas retrieved together | -| **Multi-Cube KB** | Composable memory cubes for users/projects/agents | -| **Async Ingestion** | MemScheduler with millisecond latency | -| **Memory Feedback** | Natural-language correction/supplement/replacement | -| **Self-evolving Memory** | L1 traces, L2 policies, L3 world model, crystallized Skills | - -### What deployment options are available? - -| Option | Description | -|--------|-------------| -| **Cloud API** | Hosted service at memos.openmem.net | -| **Self-Hosted** | Local/private deployment via Docker | -| **Quick Mode** | Lightweight deployment | -| **Full Mode** | Complete deployment | - -### How do I get started with Cloud API? - -1. Sign up at [MemOS dashboard](https://memos-dashboard.openmem.net/) -2. Go to **API Keys** and copy your key -3. Use the Cloud API for memory operations - -See [Cloud Getting Started](https://memos-docs.openmem.net/memos_cloud/quick_start/). +**Next steps:** -### How do I self-host MemOS? +- [MemOS Cloud Getting Started](https://memos-docs.openmem.net/memos_cloud/quick_start/) — connect to MemOS Cloud and enable memory in minutes. +- [MemOS Cloud Platform](https://memos.openmem.net/?from=/quickstart/) — explore the Cloud dashboard, features, and workflows. + +### 🖥️ Self-Host the MemOS Service + +You want to run MemOS as a REST service on your own machine or cluster. + +**Option A — Docker (recommended):** ```bash -# Clone git clone https://github.com/MemTensor/MemOS.git cd MemOS +cp docker/.env.example .env # fill in your API keys in .env +cd docker +docker compose up # starts MemOS API + Neo4j + Qdrant +``` -# Install dependencies -pip install -r ./docker/requirements.txt +The API is served at `http://localhost:8000`. -# Configure .env (OPENAI_API_KEY, etc.) -cp docker/.env.example MemOS/.env +**Option B — Run with uvicorn (without Docker):** -# Start service -# See docs for full setup +```bash +git clone https://github.com/MemTensor/MemOS.git +cd MemOS +cp docker/.env.example .env # fill in your API keys in .env +# Ensure Neo4j and Qdrant are running, then: +cd src +uvicorn memos.api.server_api:app --host 0.0.0.0 --port 8000 --workers 1 +``` + +See `[docker/.env.example](./docker/.env.example)` for all configuration options (LLM provider, embedder, vector DB, graph DB, scheduler). The full deployment guide is at [https://memos-docs.openmem.net/open_source/getting_started/rest_api_server/](https://memos-docs.openmem.net/open_source/getting_started/rest_api_server/). + +**Try the API:** + +```python +import requests, json + +headers = {"Content-Type": "application/json"} +base = "http://localhost:8000/product" + +# 1. Create a memory cube +requests.post(f"{base}/create_cube", headers=headers, data=json.dumps({ + "cube_name": "Alice's memory", + "owner_id": "alice", + "cube_id": "alice_cube", +})) + +# 2. Add a memory +requests.post(f"{base}/add", headers=headers, data=json.dumps({ + "user_id": "alice", + "writable_cube_ids": ["alice_cube"], + "messages": [{"role": "user", "content": "I like strawberry"}], + "async_mode": "sync", +})) + +# 3. Search memories +res = requests.post(f"{base}/search", headers=headers, data=json.dumps({ + "query": "What do I like?", + "user_id": "alice", + "readable_cube_ids": ["alice_cube"], +})) +print(res.json()) ``` -### What LLM providers are supported? +### 🧠 MemOS Plugin: Persistent Memory for Your AI Agents ✨ -| Provider | Setting | -|----------|---------| -| OpenAI | `MOS_CHAT_MODEL_PROVIDER=openai` | -| Azure OpenAI | `MOS_CHAT_MODEL_PROVIDER=azure` | -| Qwen (DashScope) | `MOS_CHAT_MODEL_PROVIDER=qwen` | -| DeepSeek | `MOS_CHAT_MODEL_PROVIDER=deepseek` | -| MiniMax | `MOS_CHAT_MODEL_PROVIDER=minimax` | -| Ollama | `MOS_CHAT_MODEL_PROVIDER=ollama` | -| HuggingFace | `MOS_CHAT_MODEL_PROVIDER=huggingface` | -| vLLM | `MOS_CHAT_MODEL_PROVIDER=vllm` | +Your OpenClaw and Hermes Agents now have **the best** memory system — choose ***Cloud Service*** or ***Self-hosted*** to get started 🏃🏻 -### What plugins are available? +| 🔌 Plugin | 💡 Core Features | 🧩 Resources | +| ------------------------------------------------------------------------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| 🧠 **[memos-local-plugin 2.0](https://github.com/MemTensor/MemOS/tree/main/apps/memos-local-plugin)** | | 🌐 [Website](https://memos-claw.openmem.net/) · 📖 [Docs](https://memos-docs.openmem.net/cn/openclaw/local_plugin) · 🐙 [GitHub](https://github.com/MemTensor/MemOS/tree/main/apps/memos-local-plugin) · 📦 [NPM](https://www.npmjs.com/package/@memtensor/memos-local-plugin) | +| ☁️ **[OpenClaw Cloud Plugin](https://github.com/MemTensor/MemOS/tree/main/apps/MemOS-Cloud-OpenClaw-Plugin)** | | 🖥️ [MemOS Dashboard](https://memos-dashboard.openmem.net/login/) · 📖 [Full Tutorial](https://memos-docs.openmem.net/openclaw/guide#_4-update-plugin) | -| Plugin | Purpose | -|--------|---------| -| **memos-local-plugin 2.0** | Local-first memory for Hermes Agent & OpenClaw | -| **OpenClaw Cloud Plugin** | Hosted memory service, 72% token reduction | -| **OpenClaw Local Plugin** | 100% on-device SQLite memory | +#### 1. OpenClaw Cloud Plugin -### What is the memory architecture? +You use OpenClaw and want persistent memory via MemOS Cloud — no infrastructure to run. + +- **Repo:** [MemTensor/MemOS ·](https://github.com/MemTensor/MemOS/tree/main/apps/MemOS-Cloud-OpenClaw-Plugin) `apps/MemOS-Cloud-OpenClaw-Plugin` +- **NPM:** `[@memtensor/memos-cloud-openclaw-plugin](https://www.npmjs.com/package/@memtensor/memos-cloud-openclaw-plugin)` +- **Dashboard:** [https://memos-dashboard.openmem.net/](https://memos-dashboard.openmem.net/) +- **Tutorial:** [https://memos-docs.openmem.net/openclaw/guide](https://memos-docs.openmem.net/openclaw/guide) + +Install: + +```bash +openclaw plugins install @memtensor/memos-cloud-openclaw-plugin@latest +openclaw gateway restart +``` -| Layer | Purpose | -|-------|---------| -| **L1 Traces** | Raw interaction history | -| **L2 Policies** | Learned preferences/behaviors | -| **L3 World Model** | User understanding | -| **Crystallized Skills** | Reusable patterns | +The plugin recalls memories from MemOS Cloud before each agent run and saves new messages back after the run ends. -### What license does MemOS use? +#### 2. Local Plugin (memos-local-plugin 2.0) -Apache 2.0 License (see [LICENSE](./LICENSE)). +You use Hermes Agent or OpenClaw and want 100% on-device memory — nothing leaves your machine. -### Where can I get help? +- **Repo:** [MemTensor/MemOS ·](https://github.com/MemTensor/MemOS/tree/main/apps/memos-local-plugin) `apps/memos-local-plugin` +- **NPM:** `[@memtensor/memos-local-plugin](https://www.npmjs.com/package/@memtensor/memos-local-plugin)` +- **Docs:** [https://memos-docs.openmem.net/cn/openclaw/local_plugin](https://memos-docs.openmem.net/cn/openclaw/local_plugin) +- **Viewer dashboard:** see `apps/memos-local-plugin/viewer/` -| Resource | Link | -|----------|------| -| Documentation | [memos-docs.openmem.net](https://memos-docs.openmem.net/home/overview/) | -| ArXiv Paper | [2507.03724](https://arxiv.org/abs/2507.03724) | -| Discord | [Join Server](https://discord.gg/Txbx3gebZR) | -| X/Twitter | [@MemOS_dev](https://x.com/MemOS_dev) | -| GitHub Issues | [Submit issues](https://github.com/MemTensor/MemOS/issues) | -| Awesome-AI-Memory | [IAAR-Shanghai/Awesome-AI-Memory](https://github.com/IAAR-Shanghai/Awesome-AI-Memory) | +Install (macOS / Linux): -## 📚 Resources +```bash +curl -fsSL https://raw.githubusercontent.com/MemTensor/MemOS/main/apps/memos-local-plugin/install.sh | bash +``` -- **Awesome-AI-Memory** - This is a curated repository dedicated to resources on memory and memory systems for large language models. It systematically collects relevant research papers, frameworks, tools, and practical insights. The repository aims to organize and present the rapidly evolving research landscape of LLM memory, bridging multiple research directions including natural language processing, information retrieval, agentic systems, and cognitive science.
-**Get started** 👉🏻 [IAAR-Shanghai/Awesome-AI-Memory](https://github.com/IAAR-Shanghai/Awesome-AI-Memory) +Install (Windows PowerShell): -- **MemOS Cloud OpenClaw Plugin** - Official OpenClaw lifecycle plugin for MemOS Cloud. It automatically recalls context from MemOS before the agent starts and saves the conversation back to MemOS after the agent finishes.
-**Get started** 👉🏻 [MemTensor/MemOS-Cloud-OpenClaw-Plugin](https://github.com/MemTensor/MemOS-Cloud-OpenClaw-Plugin) +```powershell +irm https://raw.githubusercontent.com/MemTensor/MemOS/main/apps/memos-local-plugin/install.ps1 -OutFile "$env:TEMP\memos-install.ps1"; powershell -ExecutionPolicy Bypass -File "$env:TEMP\memos-install.ps1" +``` -
+Requires Node.js and an already-installed OpenClaw or Hermes. The installer auto-detects OpenClaw and Hermes, deploys the plugin to the right agent home (`~/.hermes/plugins/` or `~/.openclaw/plugins/`), writes the initial `config.yaml`, and restarts the agent runtime. -## 💬 Community & Support +Features: hybrid retrieval (FTS5 + vector), smart dedup, tiered skill evolution (L1 traces / L2 policies / L3 world model), multi-agent collaboration, local-first SQLite storage. -Join our community to ask questions, share your projects, and connect with other developers. +## 🤝 Community -- **GitHub Issues**: Report bugs or request features in our GitHub Issues. -- **GitHub Pull Requests**: Contribute code improvements via Pull Requests. -- **GitHub Discussions**: Participate in our GitHub Discussions to ask questions or share ideas. -- **Discord**: Join our Discord Server. -- **WeChat**: Scan the QR code to join our WeChat group. +- **GitHub Issues:** [https://github.com/MemTensor/MemOS/issues](https://github.com/MemTensor/MemOS/issues) +- **GitHub Discussions:** [https://github.com/MemTensor/MemOS/discussions](https://github.com/MemTensor/MemOS/discussions) +- **Discord:** [https://discord.gg/Txbx3gebZR](https://discord.gg/Txbx3gebZR) +- **WeChat:** scan the QR code to join the group.
QR Code
-
-## 📜 Citation -> [!NOTE] -> We publicly released the Short Version on **May 28, 2025**, making it the earliest work to propose the concept of a Memory Operating System for LLMs. +## 📚 Citation -If you use MemOS in your research, we would appreciate citations to our papers. +If you use MemOS in your research, please cite: ```bibtex - @article{li2025memos_long, title={MemOS: A Memory OS for AI System}, author={Li, Zhiyu and Song, Shichao and Xi, Chenyang and Wang, Hanyu and Tang, Chen and Niu, Simin and Chen, Ding and Yang, Jiawei and Li, Chunyu and Yu, Qingchen and Zhao, Jihao and Wang, Yezhaohui and Liu, Peng and Lin, Zehao and Wang, Pengyuan and Huo, Jiahao and Chen, Tianyi and Chen, Kai and Li, Kehang and Tao, Zhen and Ren, Junpeng and Lai, Huayi and Wu, Hao and Tang, Bo and Wang, Zhenren and Fan, Zhaoxin and Zhang, Ningyu and Zhang, Linfeng and Yan, Junchi and Yang, Mingchuan and Xu, Tong and Xu, Wei and Chen, Huajun and Wang, Haofeng and Yang, Hongkang and Zhang, Wentao and Xu, Zhi-Qin John and Chen, Siheng and Xiong, Feiyu}, @@ -433,29 +284,10 @@ If you use MemOS in your research, we would appreciate citations to our papers. year={2025}, url={https://arxiv.org/abs/2505.22101} } - -@article{yang2024memory3, -author = {Yang, Hongkang and Zehao, Lin and Wenjin, Wang and Wu, Hao and Zhiyu, Li and Tang, Bo and Wenqiang, Wei and Wang, Jinbo and Zeyun, Tang and Song, Shichao and Xi, Chenyang and Yu, Yu and Kai, Chen and Xiong, Feiyu and Tang, Linpeng and Weinan, E}, -title = {Memory$^3$: Language Modeling with Explicit Memory}, -journal = {Journal of Machine Learning}, -year = {2024}, -volume = {3}, -number = {3}, -pages = {300--346}, -issn = {2790-2048}, -doi = {https://doi.org/10.4208/jml.240708}, -url = {https://global-sci.com/article/91443/memory3-language-modeling-with-explicit-memory} -} ``` -
- -## 🙌 Contributing - -We welcome contributions from the community! Please read our [contribution guidelines](https://memos-docs.openmem.net/open_source/contribution/overview/) to get started. -
-## 📄 License +## ⚖️ License MemOS is licensed under the [Apache 2.0 License](./LICENSE). diff --git a/README_ZH.md b/README_ZH.md new file mode 100644 index 000000000..2ef403383 --- /dev/null +++ b/README_ZH.md @@ -0,0 +1,302 @@ +
+

+ + MemOS Logo +   + MemOS 2.0 Stardust(星尘) +

+ +

+ Docs + ArXiv + X + Discord +
+ Resources +

+ +

+ 让 Agent 拥有持续记忆与成长能力
+

+ +

+ English | 中文 +

+
+ + +
+ MemOS Plugin Banner +
+ +--- + +## 👾 MemOS:面向 LLM 与 AI Agent 的记忆操作系统 + +**MemOS** 是一个面向 LLM 与 AI Agent 的记忆操作系统,统一了长期记忆的**存/取/管**,内置 **KB**、**多模态**、**工具记忆** 与 **企业级** 优化,实现上下文感知与个性化的交互。 + +### 核心特性 + +- **统一记忆 API**:用单一 API 完成记忆的增、删、改、查——以图结构组织,可检视、可编辑,不是黑盒向量库。 +- **多模态记忆**:原生支持文本、图像、工具轨迹与人格,在同一记忆系统中统一检索与推理。 +- **多 Cube 知识库管理**:将多个知识库组合为可复用的记忆 Cube,实现跨用户、项目与 Agent 的隔离、受控共享与动态组合。 +- **MemScheduler 异步写入**:以异步方式执行记忆操作,毫秒级延迟,保障高并发下的生产稳定性。 +- **记忆反馈与修正**:通过自然语言反馈精炼记忆——可纠正、补充或替换已有记忆,持续演进。 + +### News + +- **2026-07-02** · 🏆 **MemOS 在 Agent 与用户记忆榜单上全面领先** + 在 MemOS 的加持下,**OpenClaw** 在五个 Agent 任务上的平均任务完成率从 **36.63% 提升到 50.87%**。MemOS 在 **LoCoMo** 取得 **92.34**、**LongMemEval** 取得 **93.40**,并在 **OmniMemEval**(覆盖 14 款商业记忆产品、十个数据集的统一评测)中领先。 + +- **2026-05-09** · 🧠 **memos-local-plugin 2.0** + **Hermes Agent** 与 **OpenClaw** 官方本地记忆插件。单一核心驱动自演化记忆:L1 轨迹、L2 策略、L3 世界模型与结晶化 Skill,本地优先存储 + 反馈驱动检索。 + +- **2026-04-10** · 👧🏻 **MemOS Hermes Agent 本地插件** + 官方 Hermes Agent 记忆插件发布:混合检索(FTS5 + 向量)、智能去重、分层技能演化、多 Agent 协作。100% 本地,零云依赖。 + +- **2026-03-08** · 🦞 **MemOS OpenClaw 插件——云端与本地** + 官方 OpenClaw 记忆插件发布。**云插件**:托管记忆服务,token 用量降低 72%,支持多 Agent 记忆共享([MemOS-Cloud-OpenClaw-Plugin](https://github.com/MemTensor/MemOS-Cloud-OpenClaw-Plugin))。**本地插件**(`v1.0.0`):100% 端侧记忆,持久化 SQLite,混合检索(FTS5 + 向量),任务摘要与技能演化,多 Agent 协作,配套完整记忆查看器面板。 + + + +## 📊 性能表现 + +MemOS 在多个评测榜单中处于领先地位——与主流商业记忆产品横向对比,覆盖 5 个用户记忆榜单和 5 个 Agent 记忆任务。 + + +| 榜单 | 分数 | +| --------------- | ----- | +| LoCoMo | 88.83 | +| LongMemEval | 89.20 | +| PersonaMem v2 | 40.58 | +| HaluMem | 80.91 | +| BEAM-10M | 56.75 | +| GDPVal | 62.07 | +| LiveCodeBench | 64.96 | +| OmniMath | 61.00 | +| SWE-Bench | 38.46 | +| BrowseComp-Plus | 23.85 | + + +评测框架 OmniMemEval——[https://github.com/MemTensor/OmniMemEval](https://github.com/MemTensor/OmniMemEval)。 + +## 🎯 MemOS 适用于 + +MemOS 为 AI agent 提供长期记忆能力,典型场景: + +- AI 助手:保持上下文一致的连续对话 +- 客服系统:召回历史工单与用户信息,提供针对性帮助 +- 个性化 agent:适应用户偏好,持续学习与调整 +- 多 agent 协作:共享或隔离的记忆空间 + + + +## 🚀 快速开始 + +MemOS 提供四种使用方式,按你的场景选择。 + + +| | Cloud API | 本地部署 | OpenClaw 云插件 | 本地插件 | +| ---- | ------------ | ----------------- | ------------------------ | ----------------------- | +| 适合谁 | 自建应用,全托管 | 自建基础设施的团队 | OpenClaw 用户,零运维 | Hermes/OpenClaw,100% 端侧 | +| 启动方式 | 申请 API Key | docker compose up | openclaw plugins install | npm install + 配置 | +| 依赖设施 | 无(托管) | Neo4j + Qdrant | 无(使用 MemOS Cloud) | 无(本地 SQLite) | +| 数据存放 | MemOS Cloud | 你的服务器 | MemOS Cloud | 你的机器 | + +### ☁️ 使用 Cloud API(托管) + +想通过全托管服务给应用加记忆——无需自建任何基础设施。 + +**1. 申请 API Key:** + +- 在 [MemOS 控制台](https://memos-dashboard.openmem.net/cn/quickstart/?source=landing) 注册。 +- 进入 **API Keys** 复制你的 Key(以 `mpg-` 开头),请妥善保存在服务端。 + +**2. 写入与检索记忆:** + +```python +import requests + +API_KEY = "mpg-..." # 请保存在服务端 +base = "https://memos.memtensor.cn/api/openmem/v1" +headers = {"Authorization": f"Token {API_KEY}", "Content-Type": "application/json"} + +# 1. 写入一条记忆 +requests.post(f"{base}/add/message", headers=headers, json={ + "user_id": "alice", + "conversation_id": "conv_001", + "messages": [{"role": "user", "content": "I like strawberry"}], +}) + +# 2. 检索记忆 +res = requests.post(f"{base}/search/memory", headers=headers, json={ + "query": "What do I like?", + "user_id": "alice", +}) +print(res.json()) +``` + +**下一步:** + +- [MemOS Cloud 快速开始](https://memos-docs.openmem.net/memos_cloud/quick_start/)——几分钟内接入 MemOS Cloud 并启用记忆。 +- [MemOS Cloud 平台](https://memos.openmem.net/?from=/quickstart/)——探索云端控制台、功能与工作流。 + +### 🖥️ 本地部署 MemOS 服务 + +想把 MemOS 作为 REST 服务跑在自己的机器或集群上。 + +**方式 A — Docker(推荐):** + +```bash +git clone https://github.com/MemTensor/MemOS.git +cd MemOS +cp docker/.env.example .env # 在 .env 中填入你的 API key +cd docker +docker compose up # 启动 MemOS API + Neo4j + Qdrant +``` + +API 服务地址:`http://localhost:8000`。 + +**方式 B — 用 uvicorn 启动(不用 Docker):** + +```bash +git clone https://github.com/MemTensor/MemOS.git +cd MemOS +cp docker/.env.example .env # 在 .env 中填入你的 API key +# 确保 Neo4j 和 Qdrant 已启动,然后: +cd src +uvicorn memos.api.server_api:app --host 0.0.0.0 --port 8000 --workers 1 +``` + +所有配置项(LLM、embedder、向量库、图库、调度器)见 `[docker/.env.example](./docker/.env.example)`。完整部署指南:[https://memos-docs.openmem.net/open_source/getting_started/rest_api_server/](https://memos-docs.openmem.net/open_source/getting_started/rest_api_server/)。 + +**试用 API:** + +```python +import requests, json + +headers = {"Content-Type": "application/json"} +base = "http://localhost:8000/product" + +# 1. 创建记忆 cube +requests.post(f"{base}/create_cube", headers=headers, data=json.dumps({ + "cube_name": "Alice's memory", + "owner_id": "alice", + "cube_id": "alice_cube", +})) + +# 2. 写入一条记忆 +requests.post(f"{base}/add", headers=headers, data=json.dumps({ + "user_id": "alice", + "writable_cube_ids": ["alice_cube"], + "messages": [{"role": "user", "content": "I like strawberry"}], + "async_mode": "sync", +})) + +# 3. 检索记忆 +res = requests.post(f"{base}/search", headers=headers, data=json.dumps({ + "query": "What do I like?", + "user_id": "alice", + "readable_cube_ids": ["alice_cube"], +})) +print(res.json()) +``` + + + +### 🧠 MemOS 插件:为你的 AI agent 提供持久记忆 ✨ + +你的 OpenClaw 和 Hermes Agent 现在拥有**最佳**记忆系统——选择***云服务***或***自部署***即可开始 🏃🏻 + + +| 🔌 插件 | 💡 核心特性 | 🧩 资源 | +| ----------------------------------------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 🧠 **[memos-local-plugin 2.0](https://github.com/MemTensor/MemOS/tree/main/apps/memos-local-plugin)** | | 🌐 [官网](https://memos-claw.openmem.net/) · 📖 [文档](https://memos-docs.openmem.net/cn/openclaw/local_plugin) · 🐙 [GitHub](https://github.com/MemTensor/MemOS/tree/main/apps/memos-local-plugin) · 📦 [NPM](https://www.npmjs.com/package/@memtensor/memos-local-plugin) | +| ☁️ **[OpenClaw 云插件](https://github.com/MemTensor/MemOS/tree/main/apps/MemOS-Cloud-OpenClaw-Plugin)** | | 🖥️ [MemOS 控制台](https://memos-dashboard.openmem.net/login/) · 📖 [完整教程](https://memos-docs.openmem.net/openclaw/guide#_4-update-plugin) | + + + + +#### 1. OpenClaw 云插件 + +使用 OpenClaw,想通过 MemOS Cloud 获得持久记忆——无需自建基础设施。 + +- **仓库:** [MemTensor/MemOS ·](https://github.com/MemTensor/MemOS/tree/main/apps/MemOS-Cloud-OpenClaw-Plugin) `apps/MemOS-Cloud-OpenClaw-Plugin` +- **NPM:** `[@memtensor/memos-cloud-openclaw-plugin](https://www.npmjs.com/package/@memtensor/memos-cloud-openclaw-plugin)` +- **控制台:** [https://memos-dashboard.openmem.net/](https://memos-dashboard.openmem.net/) +- **教程:** [https://memos-docs.openmem.net/openclaw/guide](https://memos-docs.openmem.net/openclaw/guide) + +安装: + +```bash +openclaw plugins install @memtensor/memos-cloud-openclaw-plugin@latest +openclaw gateway restart +``` + +插件在每次 agent 运行前从 MemOS Cloud 召回记忆,运行结束后把新消息写回。 + +#### 2. 本地插件(memos-local-plugin 2.0) + +使用 Hermes Agent 或 OpenClaw,想要 100% 端侧记忆——数据不离开本机。 + +- **仓库:** [MemTensor/MemOS ·](https://github.com/MemTensor/MemOS/tree/main/apps/memos-local-plugin) `apps/memos-local-plugin` +- **NPM:** `[@memtensor/memos-local-plugin](https://www.npmjs.com/package/@memtensor/memos-local-plugin)` +- **文档:** [https://memos-docs.openmem.net/cn/openclaw/local_plugin](https://memos-docs.openmem.net/cn/openclaw/local_plugin) +- **查看器面板:** 见 `apps/memos-local-plugin/viewer/` + +安装(macOS / Linux): + +```bash +curl -fsSL https://raw.githubusercontent.com/MemTensor/MemOS/main/apps/memos-local-plugin/install.sh | bash +``` + +安装(Windows PowerShell): + +```powershell +irm https://raw.githubusercontent.com/MemTensor/MemOS/main/apps/memos-local-plugin/install.ps1 -OutFile "$env:TEMP\memos-install.ps1"; powershell -ExecutionPolicy Bypass -File "$env:TEMP\memos-install.ps1" +``` + +需先安装 Node.js,且已安装 OpenClaw 或 Hermes。安装器会自动识别 OpenClaw 与 Hermes,将插件部署到对应的 agent 主目录(`~/.hermes/plugins/` 或 `~/.openclaw/plugins/`),写入初始 `config.yaml`,并按需重启 agent 运行时。 + +特性:混合检索(FTS5 + 向量)、智能去重、分层技能演化(L1 轨迹 / L2 策略 / L3 世界模型)、多 agent 协作、本地优先 SQLite 存储。 + +## 🤝 社区 + +- **GitHub Issues:** [https://github.com/MemTensor/MemOS/issues](https://github.com/MemTensor/MemOS/issues) +- **GitHub Discussions:** [https://github.com/MemTensor/MemOS/discussions](https://github.com/MemTensor/MemOS/discussions) +- **Discord:** [https://discord.gg/Txbx3gebZR](https://discord.gg/Txbx3gebZR) +- **微信:** 扫码加入微信群。 + +
+ QR Code +
+ + + +## 📚 引用 + +如果在研究中使用 MemOS,请引用: + +```bibtex +@article{li2025memos_long, + title={MemOS: A Memory OS for AI System}, + author={Li, Zhiyu and Song, Shichao and Xi, Chenyang and Wang, Hanyu and Tang, Chen and Niu, Simin and Chen, Ding and Yang, Jiawei and Li, Chunyu and Yu, Qingchen and Zhao, Jihao and Wang, Yezhaohui and Liu, Peng and Lin, Zehao and Wang, Pengyuan and Huo, Jiahao and Chen, Tianyi and Chen, Kai and Li, Kehang and Tao, Zhen and Ren, Junpeng and Lai, Huayi and Wu, Hao and Tang, Bo and Wang, Zhenren and Fan, Zhaoxin and Zhang, Ningyu and Zhang, Linfeng and Yan, Junchi and Yang, Mingchuan and Xu, Tong and Xu, Wei and Chen, Huajun and Wang, Haofeng and Yang, Hongkang and Zhang, Wentao and Xu, Zhi-Qin John and Chen, Siheng and Xiong, Feiyu}, + journal={arXiv preprint arXiv:2507.03724}, + year={2025}, + url={https://arxiv.org/abs/2507.03724} +} + +@article{li2025memos_short, + title={MemOS: An Operating System for Memory-Augmented Generation (MAG) in Large Language Models}, + author={Li, Zhiyu and Song, Shichao and Wang, Hanyu and Niu, Simin and Chen, Ding and Yang, Jiawei and Xi, Chenyang and Lai, Huayi and Zhao, Jihao and Wang, Yezhaohui and others}, + journal={arXiv preprint arXiv:2505.22101}, + year={2025}, + url={https://arxiv.org/abs/2505.22101} +} +``` + + + +## ⚖️ 许可证 + +MemOS 基于 [Apache 2.0 许可证](./LICENSE) 开源。 \ No newline at end of file