Skip to content

Commit ae48edc

Browse files
committed
update: readme structure
1 parent 4148798 commit ae48edc

1 file changed

Lines changed: 128 additions & 16 deletions

File tree

README.md

Lines changed: 128 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@
2626
</p>
2727

2828
MemU is an open-source memory framework for personalized AI companions. We treat memory as an agent-controlled file system that stores user information as documents. It provides high-speed memory retrieval and enables self-evolution without interacting with users. The framework is easily extendable, enabling you to create AI companions that genuinely remember and grow with their users.
29+
30+
![MemU Architecture](assets/architecture-overview.png)
31+
2932
</div>
3033

3134
---
@@ -46,8 +49,14 @@ Star MemU to get notified about new releases and join our growing community of A
4649

4750
## 📈 Performance Benchmark
4851

52+
<div align="center">
53+
54+
![Performance Chart](assets/performance-chart.png)
55+
4956
MemU outperforms other memory solutions in multiple reasoning tasks.
5057

58+
</div>
59+
5160
| Model | Single-Hop | Multi-Hop | Open Domain | Temporal Reasoning | Avg. Score |
5261
|-------------|------------|-----------|-------------|------------|---------------------|
5362
| **OpenAI** | 63.79 | 42.92 | 62.29 | 21.71 | 52.90 |
@@ -63,44 +72,121 @@ model : gpt-4.1-mini
6372

6473
## ✨ Key Features
6574

75+
---
76+
77+
## 📋 **Organized Memory**
78+
6679
<div align="center">
6780

68-
### 🧠 **Specialized for AI companion**
69-
![Memory Demo](assets/memory-demo.gif)
70-
*Automatic profile updates and event tracking across conversations*
71-
#### user reminder
72-
#### important event
73-
#### user profile
74-
#### memory ranking
75-
#### forget memory
81+
**Transform chaotic information into structured knowledge**
7682

83+
![Organized Memory Demo](assets/organized-memory-demo.gif)
7784

85+
</div>
7886

87+
MemU intelligently organizes memories into well-structured documents, creating a coherent knowledge base that grows with each interaction. Unlike traditional memory systems that store isolated fragments, MemU maintains contextual relationships and categorical organization.
7988

89+
**Key Benefits:**
90+
- 🗂️ **Document-based storage** - Each memory type is stored as readable documents
91+
- 🏷️ **Smart categorization** - Automatic classification by topics and contexts
92+
- 🔍 **Easy retrieval** - Quick access to relevant information through semantic search
93+
- 📊 **Structured format** - Consistent organization across all memory types
8094

81-
### 🔍 **Retrieval Fast**
82-
![Search Demo](assets/search-demo.gif)
95+
---
8396

97+
## 🔗 **Linked Connections**
8498

85-
### 🎯 **Extension Framework**
86-
![Psychology Demo](assets/psychology-demo.gif)
99+
<table align="center">
100+
<tr>
101+
<td width="50%">
87102

103+
**Build a web of interconnected knowledge**
88104

105+
Different memories are interconnected through sophisticated semantic relationships, creating a rich network of contextual associations. This enables the AI to understand not just individual facts, but how concepts relate to each other across different conversations and contexts.
89106

107+
**Key Benefits:**
108+
- 🕸️ **Semantic linking** - Memories connect based on meaning and context
109+
- 🔄 **Cross-referencing** - Related information surfaces automatically
110+
- 🧩 **Contextual understanding** - AI grasps relationships between different topics
111+
- 📈 **Knowledge graph** - Dynamic network that expands with each interaction
90112

91-
### **Self Evolvement**
113+
</td>
114+
<td width="50%">
92115

116+
![Linked Connections Demo](assets/linked-connections-demo.gif)
93117

94-
</div>
118+
</td>
119+
</tr>
120+
</table>
95121

122+
---
123+
124+
## 🧠 **Evolved Intelligence**
125+
126+
<table align="center">
127+
<tr>
128+
<td width="50%">
129+
130+
![Evolved Intelligence Demo](assets/evolved-intelligence-demo.gif)
131+
132+
</td>
133+
<td width="50%">
134+
135+
**Self-improving AI that grows smarter over time**
96136

137+
The Memory Agent continuously performs Theory of Mind reasoning, analyzing stored memories to generate deeper insights about user preferences, behaviors, and needs. This creates an evolving understanding that enhances existing documents and generates new knowledge automatically.
138+
139+
**Key Benefits:**
140+
- 🤔 **Theory of Mind** - Deep understanding of user mental states and preferences
141+
- 📝 **Self-enhancement** - Automatically improves existing memory documents
142+
- 💡 **Insight generation** - Creates new understanding from existing information
143+
- 🌱 **Continuous growth** - Knowledge base becomes more sophisticated over time
144+
145+
</td>
146+
</tr>
147+
</table>
97148

98149
---
99-
## 🤖 **Memory as documents**
100-
![LLM Integration](assets/llm-integration.gif)
150+
151+
## 🌫️ **Fade Memory**
152+
153+
<div align="center">
154+
155+
**Natural forgetting that preserves what matters**
156+
157+
<table>
158+
<tr>
159+
<td width="33%">
160+
161+
![Memory Fade 1](assets/memory-fade-1.gif)
162+
163+
</td>
164+
<td width="34%">
165+
166+
![Memory Fade 2](assets/memory-fade-2.gif)
167+
168+
</td>
169+
<td width="33%">
170+
171+
![Memory Fade 3](assets/memory-fade-3.gif)
172+
173+
</td>
174+
</tr>
175+
</table>
176+
177+
</div>
178+
179+
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.
180+
181+
**Key Benefits:**
182+
-**Time-based decay** - Unused memories naturally fade in importance
183+
- 🔄 **Usage-based boost** - Recently accessed memories gain higher relevance
184+
- 💾 **Never truly lost** - Information fades but remains retrievable when needed
185+
- 🎯 **Smart prioritization** - Most relevant memories surface first in conversations
101186

102187
---
103188

189+
104190
## 🚀 Quick Start
105191

106192
<div align="center">
@@ -139,6 +225,8 @@ Try MemU instantly in your browser: [**🔗 Interactive Demo**](https://demo.nev
139225

140226
<div align="center">
141227

228+
![Use Cases Demo](assets/use-cases-demo.gif)
229+
142230
### 🎓 **Use Cases**
143231

144232
<table>
@@ -150,17 +238,22 @@ Try MemU instantly in your browser: [**🔗 Interactive Demo**](https://demo.nev
150238

151239
**🎯 Role play**
152240

241+
**🛠️ AI companion**
242+
153243
**🎯 Educational AI**
154244

155245
**🛠️ Customer Support**
156246

247+
157248
**Creation Support**
158249
---
159250

160251
## 🤝 Contributing
161252

162253
<div align="center">
163254

255+
![Contributing Flow](assets/contributing-flow.png)
256+
164257
### **Join Our Mission**
165258

166259
Help us build the future of AI memory! We welcome contributions of all kinds.
@@ -202,6 +295,21 @@ git push origin feature/amazing-feature
202295

203296
<div align="center">
204297

298+
<table>
299+
<tr>
300+
<td width="50%">
301+
302+
![Community Network](assets/community-network.gif)
303+
304+
</td>
305+
<td width="50%">
306+
307+
![Global Users](assets/global-users-map.png)
308+
309+
</td>
310+
</tr>
311+
</table>
312+
205313
### **Connect with the MemU Community**
206314

207315
<p align="center">
@@ -244,8 +352,12 @@ Licensed under [Apache License 2.0](LICENSE)
244352

245353
<div align="center">
246354

355+
![AI Memory Animation](assets/ai-memory-animation.gif)
356+
247357
**MemU** - Building the memory foundation for next-generation AI agents 🧠✨
248358

249359
*Made with ❤️ by the [NevaMind AI](https://nevamind.ai) team*
250360

361+
![Footer Decoration](assets/footer-decoration.png)
362+
251363
</div>

0 commit comments

Comments
 (0)