Skip to content

Commit a0b3404

Browse files
committed
update: readme
1 parent ab03c25 commit a0b3404

2 files changed

Lines changed: 22 additions & 134 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 22 additions & 134 deletions
Original file line numberDiff line numberDiff line change
@@ -94,159 +94,47 @@ For users and developers who prefer local control, data privacy, or customizatio
9494
## ✨ Key Features
9595

9696
---
97+
### Autonomous Memory Management System
9798

98-
## πŸ“‹ **Categorized Memories**
99+
#### **Organize** - Autonomous Memory Management
100+
Your memories are structured as intelligent folders managed by a dedicated memory agent. We do not do explicit modeling for memories. The memory agent automatically decides what to record, modify, or archive based on relevance and usage patterns. Think of it as having a personal librarian who knows exactly how to organize your thoughts.
99101

100-
**Your AI companion remembers everything about you, organized and ready**
101-
102-
![Organized Memory Demo](assets/organized-memory-demo.gif)
103-
104-
MemU automatically organizes your conversations into meaningful categories - your hobbies, work life, family stories, and personal preferences. Instead of scattered chat fragments, your AI companion builds a structured understanding of who you are, making every conversation feel personal and contextual.
105-
106-
**Key Benefits:**
107-
- πŸ—‚οΈ **Document-based storage** - Each memory type is stored as readable documents
108-
- 🏷️ **Smart categorization** - Automatic classification by topics and contexts
109-
- πŸ” **Easy retrieval** - Quick access to relevant information through categories
110-
111-
---
112-
113-
## πŸ”— **Memory Connections**
114-
115-
**Your AI companion connects the dots between your stories**
116-
117-
![Linked Connections Demo](assets/linked-connections-demo.gif)
118-
119-
When you mention your love for hiking, your AI companion remembers you talked about buying boots last month, and connects it to your upcoming mountain trip. These connections help your AI understand the full context of your infomation, making conversations feel natural and insightful.
120-
121-
**Key Benefits:**
122-
- πŸ•ΈοΈ **Smart connections** - Your AI links related memories automatically
123-
- πŸ”„ **Context awareness** - Previous conversations inform current ones
124-
125-
---
126-
127-
## 🧠 **Evolving Insights**
128-
129-
**Your AI companion learns about you even when you're not chatting**
130-
131-
![Evolved Intelligence Demo](assets/evolved-intelligence-demo.gif)
132-
133-
Even when you're not actively talking to it, your AI companion continuously analyzes your stored memories, discovering new patterns and insights about your preferences, habits, and personality. It's like having a friend who's always thinking about you and getting to know you better in the background.
134-
135-
**Key Benefits:**
136-
- πŸ€” **Theory of Mind** - Deep understanding of your mental states and preferences
137-
- πŸ“ **Self-improvement** - Automatically enhances existing memories
138-
- 🌱 **Continuous learning** - Gets smarter about you over time
102+
#### **Link** - Interconnected Knowledge Graph
103+
Memories don't exist in isolation. Our system automatically creates meaningful connections between related memories, building a rich network of hyperlinked documents. As your knowledge base grows, so does the web of relationships, making information discovery intuitive and contextual.
139104

105+
#### **Evolve** - Continuous Self-Improvement
106+
Even when offline, your memory system keeps working. It generates new insights by analyzing existing memories, identifies patterns, and creates summary documents through self-reflection. Your knowledge base becomes smarter over time, not just larger.
140107

108+
#### **Never Forget** - Intelligent Retention System
109+
We've revolutionized memory persistence with a dynamic importance algorithm. Recently referenced memories gain higher priority, ensuring that what matters most to you now stays readily accessible. The system adapts to your changing needs, keeping relevant information at your fingertips while gracefully archiving what's no longer critical.
141110
---
142111

143-
## 🌫️ **Adaptive Forgetting**
144-
145-
**Your AI companion remembers what matters most**
146-
147-
![Memory Fade Demo](assets/memory-fade-1.gif)
112+
## Advantages
148113

149-
MemU implements an intelligent LRU-like forgetting mechanism where memories naturally fade in importance without disappearing entirely. This mimics human memory patterns - rarely accessed information becomes less prominent while frequently referenced memories gain stronger relevance.
150-
151-
**Key Benefits:**
152-
- ⏰ **Time-based decay** - Unused memories naturally fade in importance
153-
- πŸ”„ **Usage-based boost** - Recently accessed memories gain higher relevance
154-
- πŸ’Ύ **Never truly lost** - Information fades but remains retrievable when needed
155-
- 🎯 **Smart prioritization** - Most relevant memories surface first in conversations
156-
157-
---
114+
### Higher Memory Accuracy
115+
MemU achieves 92.09% average accuracy across all reasoning tasks, significantly outperforming competitors.
158116

159-
## πŸ† **Competitive Advantages**
160-
161-
![Competitive Analysis](assets/competitive-analysis.png)
162-
163-
**Why MemU stands out from other memory solutions**
164-
165-
### 🎯 **Higher Memory Accuracy**
166-
167-
MemU achieves **92.09% average accuracy** across all reasoning tasks, significantly outperforming competitors.
168-
169-
| Model | Single-Hop | Multi-Hop | Open Domain | Temporal Reasoning | Avg. Score |
170-
|-------------|------------|-----------|-------------|------------|---------------------|
171-
| **OpenAI** | 63.79 | 42.92 | 62.29 | 21.71 | 52.90 |
172-
| **Mem0** | 67.13 | 51.15 | 72.93 | 55.51 | 66.88 | |
173-
| **Memobase** | 70.92 | 46.88 | 77.17 | 85.05 | 75.78 |
174-
| **Zep** | 74.11 | 66.04 | 67.71 | 79.76 | 75.14 | |
175-
| **MemU** | **94.88** | **88.30** | 77.08 | **92.52** | **92.09** |
176-
177-
*Based on comprehensive benchmarks against other memory frameworks*
178-
179-
---
117+
![Memory Accuracy Comparison](assets/benchmark.png)
180118

181-
### πŸ”„ **Flexible Retrieval Strategies**
182-
183-
184-
**Multiple recall methods for every use case**
119+
### Flexible Retrieval Strategies
185120

186121
MemU provides a comprehensive suite of retrieval strategies, allowing you to choose the optimal approach for your specific scenario. From semantic similarity to category search, our flexible system adapts to your needs.
187122

188-
**Available Strategies:**
189-
190-
- πŸ” **Semantic Search** - Find memories by meaning and context using advanced embedding models. Perfect for natural language queries and conceptual searches that go beyond keyword matching.
191-
192-
- 🏷️ **Category-based Retrieval** - Organize memories through topic category classification. Ideal for structured information retrieval and domain-specific searches.
193-
194-
- πŸ”— **Graph Traversal** - Discover related information by following memory connections and relationship networks. Enables exploration of indirect relationships and contextual paths between concepts.
195-
196-
- 🎯 **Hybrid Fusion** - Combine multiple strategies using ensemble methods. Delivers optimal performance for complex queries requiring maximum accuracy.
197-
198-
- 🧠 **Active Retrieval** - Determine when to retrieve memories based on conversation context and relevance. Prevents unnecessary retrievals while ensuring important memories are surfaced when needed.
199-
---
200-
201-
### πŸ“– **Human-Readable Memory Format**
202-
203-
**Memories you can actually read and understand**
204-
205-
Unlike other memory frameworks that store information as fragmented sentences, MemU organizes memories as **coherent, readable documents**. While competitors break down information into scattered fragments, MemU maintains context and structure, enabling easy debugging, manual editing, and seamless integration with existing workflows.
206-
207-
**Readability Benefits:**
208-
- πŸ“ **Document Structure** - Organized as markdown files with clear headers
209-
- πŸ”— **Wiki-like Links** - Documents with interconnected links enabling seamless navigation between related memories
210-
- πŸ“‹ **Export Friendly** - Standard formats compatible with any system
211-
212-
---
213-
214-
215-
216-
## πŸš€ Quick Start
123+
### Human-Readable & Analyzable Memory Architecture
217124

218-
### **Installation in 30 seconds**
125+
Unlike other memory frameworks that store information as fragmented sentences, MemU organizes memories as coherent, readable documents while simultaneously transforming raw data into structured, analyzable datasets. While competitors break down information into scattered fragments, MemU maintains complete context and relationships, enabling easy debugging, manual editing, seamless analytics, and effortless integration with existing workflows.
219126

220-
```bash
221-
# Install MemU with all features
222-
pip install memu-py
223-
```
224-
225-
### **3-Line Demo**
226-
227-
```python
228-
from memu.memory import MemoryAgent
229-
from memu.llm import OpenAIClient
230-
231-
# Create AI agent with unified memory
232-
memory_agent = MemoryAgent(llm_client=OpenAIClient(), memory_dir="memory")
233-
234-
# Process conversation with persistent memory
235-
results = memory_agent.process_conversation("Hi, I'm learning Python", "student_123")
236-
```
237-
238-
![Quick Start Demo](assets/quickstart-demo.gif)
239-
240-
### **Live Demo**
127+
**Key Benefits:**
128+
- πŸ“ **Document Structure** - Organized as markdown files with clear headers for human readability
129+
- πŸ”— **Wiki-like Links** - Documents with interconnected links enabling seamless navigation between related memories
130+
- πŸ“Š **Analytics Ready** - Structured datasets that power intelligent decision-making and business intelligence
131+
- πŸ“‹ **Export Friendly** - Standard formats compatible with any system and analytics tools
132+
- πŸ”„ **Real-time Processing** - Automated data classification with smart tagging and dynamic updates
241133

242-
Try MemU instantly in your browser: [**πŸ”— Interactive Demo**](https://demo.nevamind.ai)
243134

244135
---
245-
246136
## πŸ“š Usage Guide & Research Highlights
247137

248-
249-
250138
![Use Cases Demo](assets/use-cases-demo.gif)
251139

252140
### πŸŽ“ **Use Cases**

β€Žassets/benchmark.pngβ€Ž

342 KB
Loading

0 commit comments

Comments
Β (0)