neural-memorygraph 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- neural_memorygraph-1.0.0/LICENSE +21 -0
- neural_memorygraph-1.0.0/PKG-INFO +611 -0
- neural_memorygraph-1.0.0/README.md +531 -0
- neural_memorygraph-1.0.0/memorygraph/__init__.py +142 -0
- neural_memorygraph-1.0.0/memorygraph/core/__init__.py +4 -0
- neural_memorygraph-1.0.0/memorygraph/core/edge.py +219 -0
- neural_memorygraph-1.0.0/memorygraph/core/graph.py +867 -0
- neural_memorygraph-1.0.0/memorygraph/core/node.py +485 -0
- neural_memorygraph-1.0.0/memorygraph/core/types.py +206 -0
- neural_memorygraph-1.0.0/memorygraph/decay/__init__.py +5 -0
- neural_memorygraph-1.0.0/memorygraph/decay/forgetting.py +465 -0
- neural_memorygraph-1.0.0/memorygraph/memory/__init__.py +1 -0
- neural_memorygraph-1.0.0/memorygraph/memory/working.py +370 -0
- neural_memorygraph-1.0.0/memorygraph/neural/__init__.py +47 -0
- neural_memorygraph-1.0.0/memorygraph/neural/encoder.py +404 -0
- neural_memorygraph-1.0.0/memorygraph/neural/hopfield.py +364 -0
- neural_memorygraph-1.0.0/memorygraph/neural/retriever.py +383 -0
- neural_memorygraph-1.0.0/memorygraph/persistence/__init__.py +4 -0
- neural_memorygraph-1.0.0/memorygraph/persistence/storage.py +564 -0
- neural_memorygraph-1.0.0/memorygraph/retrieval/__init__.py +1 -0
- neural_memorygraph-1.0.0/memorygraph/retrieval/spreading.py +370 -0
- neural_memorygraph-1.0.0/memorygraph/utils/__init__.py +0 -0
- neural_memorygraph-1.0.0/neural_memorygraph.egg-info/PKG-INFO +611 -0
- neural_memorygraph-1.0.0/neural_memorygraph.egg-info/SOURCES.txt +28 -0
- neural_memorygraph-1.0.0/neural_memorygraph.egg-info/dependency_links.txt +1 -0
- neural_memorygraph-1.0.0/neural_memorygraph.egg-info/requires.txt +35 -0
- neural_memorygraph-1.0.0/neural_memorygraph.egg-info/top_level.txt +1 -0
- neural_memorygraph-1.0.0/pyproject.toml +222 -0
- neural_memorygraph-1.0.0/setup.cfg +4 -0
- neural_memorygraph-1.0.0/setup.py +5 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 memorygraph contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,611 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: neural-memorygraph
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Graph-based memory system for AI agents — cognitive science meets deep learning
|
|
5
|
+
Author: UeCollaxion
|
|
6
|
+
License: MIT License
|
|
7
|
+
|
|
8
|
+
Copyright (c) 2026 memorygraph contributors
|
|
9
|
+
|
|
10
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
11
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
12
|
+
in the Software without restriction, including without limitation the rights
|
|
13
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
14
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
15
|
+
furnished to do so, subject to the following conditions:
|
|
16
|
+
|
|
17
|
+
The above copyright notice and this permission notice shall be included in all
|
|
18
|
+
copies or substantial portions of the Software.
|
|
19
|
+
|
|
20
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
21
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
22
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
23
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
24
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
25
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
26
|
+
SOFTWARE.
|
|
27
|
+
|
|
28
|
+
Project-URL: Homepage, https://github.com/memorygraph/memorygraph
|
|
29
|
+
Project-URL: Documentation, https://memorygraph.readthedocs.io
|
|
30
|
+
Project-URL: Repository, https://github.com/memorygraph/memorygraph
|
|
31
|
+
Project-URL: Issues, https://github.com/memorygraph/memorygraph/issues
|
|
32
|
+
Project-URL: Changelog, https://github.com/memorygraph/memorygraph/blob/main/CHANGELOG.md
|
|
33
|
+
Keywords: memory,graph,ai,agents,llm,hopfield,neural-memory,spaced-repetition,knowledge-graph,cognitive-architecture,rag,working-memory,episodic-memory,transformer,dnc,memory-networks
|
|
34
|
+
Classifier: Development Status :: 4 - Beta
|
|
35
|
+
Classifier: Intended Audience :: Science/Research
|
|
36
|
+
Classifier: Intended Audience :: Developers
|
|
37
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
38
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
39
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
40
|
+
Classifier: Operating System :: OS Independent
|
|
41
|
+
Classifier: Programming Language :: Python :: 3
|
|
42
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
43
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
44
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
45
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
46
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
47
|
+
Classifier: Typing :: Typed
|
|
48
|
+
Requires-Python: >=3.9
|
|
49
|
+
Description-Content-Type: text/markdown
|
|
50
|
+
License-File: LICENSE
|
|
51
|
+
Requires-Dist: numpy>=1.21.0
|
|
52
|
+
Provides-Extra: torch
|
|
53
|
+
Requires-Dist: torch>=2.0.0; extra == "torch"
|
|
54
|
+
Provides-Extra: hdf5
|
|
55
|
+
Requires-Dist: h5py>=3.0.0; extra == "hdf5"
|
|
56
|
+
Provides-Extra: msgpack
|
|
57
|
+
Requires-Dist: msgpack>=1.0.0; extra == "msgpack"
|
|
58
|
+
Provides-Extra: faiss-cpu
|
|
59
|
+
Requires-Dist: faiss-cpu>=1.7.0; extra == "faiss-cpu"
|
|
60
|
+
Provides-Extra: faiss-gpu
|
|
61
|
+
Requires-Dist: faiss-gpu>=1.7.0; extra == "faiss-gpu"
|
|
62
|
+
Provides-Extra: full
|
|
63
|
+
Requires-Dist: torch>=2.0.0; extra == "full"
|
|
64
|
+
Requires-Dist: h5py>=3.0.0; extra == "full"
|
|
65
|
+
Requires-Dist: msgpack>=1.0.0; extra == "full"
|
|
66
|
+
Requires-Dist: faiss-cpu>=1.7.0; extra == "full"
|
|
67
|
+
Provides-Extra: dev
|
|
68
|
+
Requires-Dist: pytest>=7.4; extra == "dev"
|
|
69
|
+
Requires-Dist: pytest-cov>=4.0; extra == "dev"
|
|
70
|
+
Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
|
|
71
|
+
Requires-Dist: black>=23.0; extra == "dev"
|
|
72
|
+
Requires-Dist: isort>=5.12; extra == "dev"
|
|
73
|
+
Requires-Dist: mypy>=1.5; extra == "dev"
|
|
74
|
+
Requires-Dist: ruff>=0.1.0; extra == "dev"
|
|
75
|
+
Requires-Dist: pre-commit>=3.4; extra == "dev"
|
|
76
|
+
Requires-Dist: sphinx>=7.0; extra == "dev"
|
|
77
|
+
Requires-Dist: sphinx-rtd-theme>=1.3; extra == "dev"
|
|
78
|
+
Requires-Dist: sphinxcontrib-napoleon>=0.7; extra == "dev"
|
|
79
|
+
Dynamic: license-file
|
|
80
|
+
|
|
81
|
+
# memorygraph
|
|
82
|
+
|
|
83
|
+
**Graph-based memory system for AI agents — cognitive science meets deep learning.**
|
|
84
|
+
|
|
85
|
+
`memorygraph` provides a production-ready, research-grade memory layer for LLM agents, autonomous systems, and any AI application that needs to store, retrieve, and reason over structured knowledge across time.
|
|
86
|
+
|
|
87
|
+
[](https://www.python.org/downloads/)
|
|
88
|
+
[](LICENSE)
|
|
89
|
+
[](https://pytorch.org)
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Overview
|
|
94
|
+
|
|
95
|
+
Most agent memory systems are flat key-value stores or simple vector databases. `memorygraph` treats memory the way cognitive science does — as a dynamic, associative graph where:
|
|
96
|
+
|
|
97
|
+
- **Nodes** are memories (semantic facts, episodic events, procedural skills, emotional anchors)
|
|
98
|
+
- **Edges** are typed relationships (causal, hierarchical, associative, temporal, similarity)
|
|
99
|
+
- **Activation spreads** through the graph like priming in the human brain
|
|
100
|
+
- **Forgetting** follows empirically validated curves (Ebbinghaus, Power Law, FSRS-4.5)
|
|
101
|
+
- **Working memory** enforces a bounded attentional buffer with interference effects
|
|
102
|
+
- **Neural components** (Modern Hopfield, DNC, MemN2N, Transformer encoder) are available for learned retrieval
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Architecture
|
|
107
|
+
|
|
108
|
+
```
|
|
109
|
+
memorygraph/
|
|
110
|
+
├── core/
|
|
111
|
+
│ ├── types.py # Enums, protocols, exception hierarchy, type aliases
|
|
112
|
+
│ ├── node.py # MemoryNode — ACT-R activation, retention models, embeddings
|
|
113
|
+
│ ├── edge.py # MemoryEdge — Hebbian weight updates, typed relationships
|
|
114
|
+
│ └── graph.py # MemoryGraph — thread-safe CRUD, search, graph algorithms
|
|
115
|
+
│
|
|
116
|
+
├── memory/
|
|
117
|
+
│ └── working.py # Baddeley working memory buffer (phonological, visuospatial,
|
|
118
|
+
│ # episodic, central executive slots)
|
|
119
|
+
│
|
|
120
|
+
├── retrieval/
|
|
121
|
+
│ └── spreading.py # Collins & Loftus spreading activation (Dijkstra-based)
|
|
122
|
+
│
|
|
123
|
+
├── decay/
|
|
124
|
+
│ └── forgetting.py # Forgetting models: Ebbinghaus, Power Law, SM-2, FSRS-4.5
|
|
125
|
+
│ # SpacedRepetitionScheduler with per-node review tracking
|
|
126
|
+
│
|
|
127
|
+
├── neural/ # PyTorch components (optional — graceful degradation)
|
|
128
|
+
│ ├── hopfield.py # Modern Hopfield Networks (Ramsauer et al., 2020)
|
|
129
|
+
│ ├── encoder.py # Transformer memory encoder + contrastive loss
|
|
130
|
+
│ └── retriever.py # DNC-style differentiable memory + End-to-End Memory Networks
|
|
131
|
+
│
|
|
132
|
+
└── persistence/
|
|
133
|
+
└── storage.py # JSON, Pickle, SQLite backends; backup rotation; npz export
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## Installation
|
|
139
|
+
|
|
140
|
+
**Minimal (NumPy only):**
|
|
141
|
+
```bash
|
|
142
|
+
pip install memorygraph
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
**With PyTorch neural components:**
|
|
146
|
+
```bash
|
|
147
|
+
pip install "memorygraph[torch]"
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
**Full installation:**
|
|
151
|
+
```bash
|
|
152
|
+
pip install "memorygraph[full]"
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
**Development:**
|
|
156
|
+
```bash
|
|
157
|
+
git clone https://github.com/memorygraph/memorygraph
|
|
158
|
+
cd memorygraph
|
|
159
|
+
pip install -e ".[dev,torch]"
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## Quick Start
|
|
165
|
+
|
|
166
|
+
### Basic Memory Graph
|
|
167
|
+
|
|
168
|
+
```python
|
|
169
|
+
import numpy as np
|
|
170
|
+
from memorygraph import (
|
|
171
|
+
MemoryGraph, MemoryNode, MemoryEdge,
|
|
172
|
+
MemoryType, EdgeType,
|
|
173
|
+
)
|
|
174
|
+
|
|
175
|
+
# Create a graph with 768-dimensional embeddings (e.g. BERT output size)
|
|
176
|
+
graph = MemoryGraph(embedding_dim=768, name="agent_memory")
|
|
177
|
+
|
|
178
|
+
# Add a semantic memory node
|
|
179
|
+
fact = MemoryNode(
|
|
180
|
+
content = "The Eiffel Tower is located in Paris, France.",
|
|
181
|
+
memory_type = MemoryType.SEMANTIC,
|
|
182
|
+
embedding = np.random.randn(768).astype(np.float32), # use your encoder
|
|
183
|
+
importance = 0.85,
|
|
184
|
+
tags = ["geography", "landmarks", "europe"],
|
|
185
|
+
)
|
|
186
|
+
graph.add_node(fact)
|
|
187
|
+
|
|
188
|
+
# Add an episodic memory
|
|
189
|
+
event = MemoryNode(
|
|
190
|
+
content = "User asked about European landmarks at 14:32.",
|
|
191
|
+
memory_type = MemoryType.EPISODIC,
|
|
192
|
+
embedding = np.random.randn(768).astype(np.float32),
|
|
193
|
+
importance = 0.6,
|
|
194
|
+
emotional_valence = 0.2, # slightly positive
|
|
195
|
+
)
|
|
196
|
+
graph.add_node(event)
|
|
197
|
+
|
|
198
|
+
# Link them causally
|
|
199
|
+
graph.add_edge(MemoryEdge(
|
|
200
|
+
source_id = event.id,
|
|
201
|
+
target_id = fact.id,
|
|
202
|
+
edge_type = EdgeType.CAUSAL,
|
|
203
|
+
weight = 0.9,
|
|
204
|
+
))
|
|
205
|
+
|
|
206
|
+
print(graph.stats())
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### Embedding-Based Retrieval
|
|
210
|
+
|
|
211
|
+
```python
|
|
212
|
+
query_embedding = np.random.randn(768).astype(np.float32)
|
|
213
|
+
|
|
214
|
+
results = graph.similarity_search(
|
|
215
|
+
query = query_embedding,
|
|
216
|
+
k = 10,
|
|
217
|
+
threshold = 0.5,
|
|
218
|
+
memory_type = MemoryType.SEMANTIC, # optional filter
|
|
219
|
+
tags = ["geography"], # optional tag filter (AND)
|
|
220
|
+
)
|
|
221
|
+
|
|
222
|
+
for result in results:
|
|
223
|
+
node = graph.get_node(result.node_id)
|
|
224
|
+
print(f"[{result.score:.4f}] {node.content}")
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Spreading Activation
|
|
228
|
+
|
|
229
|
+
Retrieve memories by simulating associative priming — activation flows through the graph from seed nodes, decaying with distance and modulated by edge weights and node importance.
|
|
230
|
+
|
|
231
|
+
```python
|
|
232
|
+
from memorygraph import SpreadingActivation, SpreadingConfig
|
|
233
|
+
|
|
234
|
+
config = SpreadingConfig(
|
|
235
|
+
max_depth = 4,
|
|
236
|
+
activation_decay = 0.6,
|
|
237
|
+
use_edge_weights = True,
|
|
238
|
+
use_node_importance = True,
|
|
239
|
+
use_temporal_boost = True, # recently accessed nodes get a boost
|
|
240
|
+
return_top_k = 20,
|
|
241
|
+
sort_by = "activation",
|
|
242
|
+
)
|
|
243
|
+
|
|
244
|
+
spreader = SpreadingActivation(graph, config)
|
|
245
|
+
activated = spreader.spread(source_ids=[fact.id])
|
|
246
|
+
|
|
247
|
+
for result in activated:
|
|
248
|
+
node = graph.get_node(result.node_id)
|
|
249
|
+
print(f"[act={result.activation:.4f} depth={result.depth}] {node.content}")
|
|
250
|
+
|
|
251
|
+
# Cognitive priming: does seeing A make B more accessible?
|
|
252
|
+
primed = spreader.priming_search(prime_ids=[event.id], query_id=fact.id)
|
|
253
|
+
|
|
254
|
+
# Find the conceptual chain between two distant memories
|
|
255
|
+
chain = spreader.concept_chain(start_id=node_a.id, end_id=node_b.id)
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
### Working Memory Buffer
|
|
259
|
+
|
|
260
|
+
A bounded attentional buffer modelled after Baddeley's multi-component working memory model. Supports four slot types with independent capacities, interference between similar items, and LRU/activation-based eviction.
|
|
261
|
+
|
|
262
|
+
```python
|
|
263
|
+
from memorygraph import WorkingMemoryBuffer, WorkingMemorySlot
|
|
264
|
+
|
|
265
|
+
wm = WorkingMemoryBuffer(
|
|
266
|
+
capacity = 7, # Miller's magical number
|
|
267
|
+
decay_rate = 0.05,
|
|
268
|
+
interference_rate = 0.1,
|
|
269
|
+
eviction_policy = "lru_activation",
|
|
270
|
+
)
|
|
271
|
+
|
|
272
|
+
# Push nodes into specific slots
|
|
273
|
+
wm.push(node, slot=WorkingMemorySlot.CENTRAL, activation=1.0, priority=1.0)
|
|
274
|
+
wm.push(fact, slot=WorkingMemorySlot.PHONOLOGICAL, activation=0.8)
|
|
275
|
+
wm.push(event, slot=WorkingMemorySlot.EPISODIC, activation=0.7)
|
|
276
|
+
|
|
277
|
+
# Tick to apply decay (call periodically or on each agent step)
|
|
278
|
+
wm.tick()
|
|
279
|
+
|
|
280
|
+
# Inspect the buffer
|
|
281
|
+
snapshot = wm.snapshot()
|
|
282
|
+
print(f"Utilization: {snapshot['utilization']*100:.0f}%")
|
|
283
|
+
|
|
284
|
+
# Get the current focus of attention
|
|
285
|
+
focus_item = wm.focus()
|
|
286
|
+
|
|
287
|
+
# Register eviction callback
|
|
288
|
+
wm.on_evict = lambda item: print(f"Evicted: {item.node.content}")
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### Spaced Repetition & Forgetting
|
|
292
|
+
|
|
293
|
+
Schedule memory reviews using FSRS-4.5, SM-2, Ebbinghaus, or Power Law models. Track stability and difficulty per node.
|
|
294
|
+
|
|
295
|
+
```python
|
|
296
|
+
from memorygraph import SpacedRepetitionScheduler
|
|
297
|
+
|
|
298
|
+
scheduler = SpacedRepetitionScheduler(model="fsrs", target_retention=0.90)
|
|
299
|
+
|
|
300
|
+
# Register nodes for spaced repetition
|
|
301
|
+
for node in graph.query_by_type(MemoryType.SEMANTIC):
|
|
302
|
+
scheduler.register_node(node.id, initial_grade=node.importance)
|
|
303
|
+
|
|
304
|
+
# Record a review (grade: 0.0 = forgot, 1.0 = perfect recall)
|
|
305
|
+
entry = scheduler.record_review(node_id=fact.id, grade=0.9)
|
|
306
|
+
print(f"Next review in {entry.time_until_due() / 86400:.1f} days")
|
|
307
|
+
print(f"Stability: {entry.stability:.2f}")
|
|
308
|
+
|
|
309
|
+
# Get all nodes due for review right now
|
|
310
|
+
due_nodes = scheduler.get_due_nodes()
|
|
311
|
+
|
|
312
|
+
# Get upcoming reviews within the next 3 days
|
|
313
|
+
upcoming = scheduler.get_upcoming(within_seconds=3 * 86400)
|
|
314
|
+
|
|
315
|
+
# Plot the forgetting curve for a specific node
|
|
316
|
+
t_array, r_array = scheduler.forgetting_curve_points(
|
|
317
|
+
node_id = fact.id,
|
|
318
|
+
num_points = 100,
|
|
319
|
+
time_horizon_days = 30,
|
|
320
|
+
)
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
### Persistence
|
|
324
|
+
|
|
325
|
+
```python
|
|
326
|
+
from memorygraph import GraphStorageManager
|
|
327
|
+
|
|
328
|
+
manager = GraphStorageManager(backend="sqlite") # or "json", "pickle"
|
|
329
|
+
manager.save(graph, "agent_memory.db")
|
|
330
|
+
|
|
331
|
+
# Load back
|
|
332
|
+
graph = manager.load("agent_memory.db")
|
|
333
|
+
|
|
334
|
+
# Automatic backup rotation (keeps last 3 backups)
|
|
335
|
+
manager.save_with_backup("agent_memory.db", keep_backups=3)
|
|
336
|
+
|
|
337
|
+
# Periodic checkpoints
|
|
338
|
+
manager.checkpoint(directory="./checkpoints", prefix="agent")
|
|
339
|
+
|
|
340
|
+
# Export / import embeddings separately (for fine-tuning pipelines)
|
|
341
|
+
manager.export_embeddings(graph, "embeddings.npz")
|
|
342
|
+
manager.import_embeddings(graph, "embeddings_v2.npz")
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
### Transactions
|
|
346
|
+
|
|
347
|
+
```python
|
|
348
|
+
with graph.transaction():
|
|
349
|
+
graph.add_node(node_a)
|
|
350
|
+
graph.add_node(node_b)
|
|
351
|
+
graph.add_edge(edge)
|
|
352
|
+
# If any operation raises an exception, the entire transaction rolls back
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
---
|
|
356
|
+
|
|
357
|
+
## Neural Components (PyTorch)
|
|
358
|
+
|
|
359
|
+
All neural components require `pip install "memorygraph[torch]"`. They are imported lazily — if PyTorch is not installed, the rest of the library works without modification.
|
|
360
|
+
|
|
361
|
+
### Modern Hopfield Networks
|
|
362
|
+
|
|
363
|
+
Based on [Ramsauer et al. (2020)](https://arxiv.org/abs/2008.02217). Exponential storage capacity compared to classical Hopfield networks. Mathematically equivalent to attention with a specific energy function.
|
|
364
|
+
|
|
365
|
+
```python
|
|
366
|
+
from memorygraph.neural import ModernHopfieldLayer, HopfieldMemoryPool, HopfieldStack
|
|
367
|
+
import torch
|
|
368
|
+
|
|
369
|
+
layer = ModernHopfieldLayer(
|
|
370
|
+
input_dim = 512,
|
|
371
|
+
hidden_dim = 512,
|
|
372
|
+
num_heads = 8,
|
|
373
|
+
beta = 4.0, # inverse temperature (higher = sharper retrieval)
|
|
374
|
+
num_iter = 3, # retrieval iterations
|
|
375
|
+
)
|
|
376
|
+
|
|
377
|
+
query = torch.randn(batch, seq_q, 512)
|
|
378
|
+
patterns = torch.randn(batch, seq_k, 512)
|
|
379
|
+
output, attn_weights = layer(query, patterns, return_attn=True)
|
|
380
|
+
|
|
381
|
+
# Energy of the Hopfield network
|
|
382
|
+
energy = layer.energy(query, patterns)
|
|
383
|
+
|
|
384
|
+
# Fixed learnable memory pool
|
|
385
|
+
pool = HopfieldMemoryPool(capacity=1024, pattern_dim=512, num_heads=8)
|
|
386
|
+
retrieved, weights = pool(query)
|
|
387
|
+
|
|
388
|
+
# Deep stacked Hopfield with geometric beta schedule
|
|
389
|
+
stack = HopfieldStack(
|
|
390
|
+
input_dim = 512,
|
|
391
|
+
num_layers = 6,
|
|
392
|
+
beta_schedule = "geometric",
|
|
393
|
+
initial_beta = 1.0,
|
|
394
|
+
final_beta = 8.0,
|
|
395
|
+
)
|
|
396
|
+
output, all_attentions = stack(query, patterns, return_all_attn=True)
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
### Transformer Memory Encoder
|
|
400
|
+
|
|
401
|
+
```python
|
|
402
|
+
from memorygraph.neural import MemoryEncoder, MemoryContrastiveLoss
|
|
403
|
+
import torch
|
|
404
|
+
|
|
405
|
+
encoder = MemoryEncoder(
|
|
406
|
+
vocab_size = 30522, # BERT vocabulary
|
|
407
|
+
dim = 768,
|
|
408
|
+
num_heads = 12,
|
|
409
|
+
num_layers = 6,
|
|
410
|
+
max_len = 512,
|
|
411
|
+
pooling = "mean", # or "cls", "max", "attn"
|
|
412
|
+
)
|
|
413
|
+
|
|
414
|
+
input_ids = torch.randint(0, 30522, (batch, seq_len))
|
|
415
|
+
output = encoder(input_ids)
|
|
416
|
+
|
|
417
|
+
print(output.embedding.shape) # (batch, 768)
|
|
418
|
+
print(output.importance) # (batch, 1) — learned importance score
|
|
419
|
+
print(output.emotion) # (batch, 1) — emotional valence
|
|
420
|
+
print(output.confidence) # (batch, 1) — retrieval confidence
|
|
421
|
+
|
|
422
|
+
# Contrastive training with InfoNCE / NT-Xent loss
|
|
423
|
+
loss_fn = MemoryContrastiveLoss(temperature=0.07)
|
|
424
|
+
labels = torch.arange(batch)
|
|
425
|
+
loss = loss_fn(output.embedding, output.embedding, labels)
|
|
426
|
+
loss.backward()
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
### Differentiable Neural Memory (DNC-inspired)
|
|
430
|
+
|
|
431
|
+
```python
|
|
432
|
+
from memorygraph.neural import NeuralMemoryModule
|
|
433
|
+
import torch
|
|
434
|
+
|
|
435
|
+
dnc = NeuralMemoryModule(
|
|
436
|
+
memory_size = 128, # number of memory slots
|
|
437
|
+
memory_dim = 64, # dimensionality per slot
|
|
438
|
+
controller_dim = 512, # controller hidden size
|
|
439
|
+
num_reads = 4, # parallel read heads
|
|
440
|
+
)
|
|
441
|
+
|
|
442
|
+
# Process a sequence; state carries memory across steps
|
|
443
|
+
controller_sequence = torch.randn(batch, time_steps, 512)
|
|
444
|
+
output_sequence, final_state = dnc.process_sequence(controller_sequence)
|
|
445
|
+
# output_sequence: (batch, time_steps, 512) controller enriched with memory reads
|
|
446
|
+
# final_state.memory: (batch, 128, 64) memory after all writes
|
|
447
|
+
```
|
|
448
|
+
|
|
449
|
+
### End-to-End Memory Networks (MemN2N)
|
|
450
|
+
|
|
451
|
+
Based on [Sukhbaatar et al. (2015)](https://arxiv.org/abs/1503.08895). Multi-hop reasoning over a bag of memory sentences.
|
|
452
|
+
|
|
453
|
+
```python
|
|
454
|
+
from memorygraph.neural import MemoryNetwork
|
|
455
|
+
import torch
|
|
456
|
+
|
|
457
|
+
model = MemoryNetwork(
|
|
458
|
+
vocab_size = 10000,
|
|
459
|
+
embed_dim = 256,
|
|
460
|
+
num_hops = 3,
|
|
461
|
+
output_size = 10000, # answer vocabulary
|
|
462
|
+
)
|
|
463
|
+
|
|
464
|
+
query_tokens = torch.randint(0, 10000, (batch, q_len))
|
|
465
|
+
memory_tokens = torch.randint(0, 10000, (batch, num_memories, sent_len))
|
|
466
|
+
|
|
467
|
+
logits = model(query_tokens, memory_tokens) # (batch, output_size)
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
---
|
|
471
|
+
|
|
472
|
+
## Core Concepts
|
|
473
|
+
|
|
474
|
+
### Memory Node Lifecycle
|
|
475
|
+
|
|
476
|
+
```
|
|
477
|
+
Register → Encode → Store → Retrieve → Reinforce / Decay → Consolidate → (Forget)
|
|
478
|
+
```
|
|
479
|
+
|
|
480
|
+
Each `MemoryNode` tracks:
|
|
481
|
+
|
|
482
|
+
| Attribute | Description |
|
|
483
|
+
|-----------|-------------|
|
|
484
|
+
| `importance` | 0–1 base importance score |
|
|
485
|
+
| `emotional_valence` | –1 to +1 emotional tone |
|
|
486
|
+
| `confidence` | 0–1 retrieval confidence |
|
|
487
|
+
| `consolidation_state` | `LABILE → CONSOLIDATING → CONSOLIDATED → LONG_TERM` |
|
|
488
|
+
| `temporal_info` | access history, ACT-R activation computation |
|
|
489
|
+
| `embedding` | dense vector representation |
|
|
490
|
+
| `tags` | string tags for structured filtering |
|
|
491
|
+
|
|
492
|
+
**ACT-R Base-Level Learning:**
|
|
493
|
+
|
|
494
|
+
$$A_i = \ln\left(\sum_j t_j^{-d}\right) + \alpha \cdot e_i \cdot c_i$$
|
|
495
|
+
|
|
496
|
+
where $t_j$ are times since past accesses, $d$ is the decay parameter, $\alpha$ is emotional boost, $e_i$ is emotional valence, and $c_i$ is confidence.
|
|
497
|
+
|
|
498
|
+
**Retention Models:**
|
|
499
|
+
|
|
500
|
+
| Model | Formula | Use Case |
|
|
501
|
+
|-------|---------|----------|
|
|
502
|
+
| Ebbinghaus | $R = e^{-t/S}$ | Classic forgetting curve |
|
|
503
|
+
| Power Law | $R = (1 + bt)^{-\alpha}$ | Power forgetting (Wixted & Ebbesen) |
|
|
504
|
+
| Hyperbolic | $R = 1/(1 + t/S)$ | Hyperbolic discounting |
|
|
505
|
+
| FSRS-4.5 | Spaced repetition algorithm | Anki-compatible scheduling |
|
|
506
|
+
|
|
507
|
+
### Edge Types
|
|
508
|
+
|
|
509
|
+
| Type | Meaning |
|
|
510
|
+
|------|---------|
|
|
511
|
+
| `ASSOCIATION` | General semantic association |
|
|
512
|
+
| `CAUSAL` | A caused B |
|
|
513
|
+
| `TEMPORAL` | A preceded B |
|
|
514
|
+
| `HIERARCHICAL` | A is a kind of / part of B |
|
|
515
|
+
| `SIMILARITY` | A and B are similar |
|
|
516
|
+
| `CONTRADICTS` | A contradicts B |
|
|
517
|
+
| `COMPOSITIONAL` | A is composed of B |
|
|
518
|
+
| `EMOTIONAL` | A triggered the emotion in B |
|
|
519
|
+
| `EPISODIC_LINK` | Same episode / context |
|
|
520
|
+
| `INFERENCE` | B was inferred from A |
|
|
521
|
+
|
|
522
|
+
### Consolidation States
|
|
523
|
+
|
|
524
|
+
```
|
|
525
|
+
LABILE → CONSOLIDATING → CONSOLIDATED → LONG_TERM
|
|
526
|
+
↑ ↓
|
|
527
|
+
└──────────────── RECONSOLIDATING ───────────────┘
|
|
528
|
+
```
|
|
529
|
+
|
|
530
|
+
Call `graph.advance_consolidation(node_id)` to progress a node through the consolidation pipeline. Long-term memories are protected from `prune_forgotten()`.
|
|
531
|
+
|
|
532
|
+
---
|
|
533
|
+
|
|
534
|
+
## Graph Algorithms
|
|
535
|
+
|
|
536
|
+
```python
|
|
537
|
+
# Breadth-first search up to depth 3, only CAUSAL edges
|
|
538
|
+
nodes = graph.bfs(start_id, max_depth=3, edge_type=EdgeType.CAUSAL)
|
|
539
|
+
|
|
540
|
+
# Dijkstra shortest path (cost = 1 - edge_weight)
|
|
541
|
+
path = graph.shortest_path(source_id, target_id)
|
|
542
|
+
|
|
543
|
+
# Strongly connected components (Kosaraju's algorithm)
|
|
544
|
+
sccs = graph.strongly_connected_components()
|
|
545
|
+
|
|
546
|
+
# Merge near-duplicate nodes (cosine similarity > threshold)
|
|
547
|
+
merged = graph.merge_similar_nodes(similarity_threshold=0.92)
|
|
548
|
+
|
|
549
|
+
# Remove forgotten memories below retention threshold
|
|
550
|
+
pruned = graph.prune_forgotten(retention_threshold=0.1)
|
|
551
|
+
```
|
|
552
|
+
|
|
553
|
+
---
|
|
554
|
+
|
|
555
|
+
## Thread Safety
|
|
556
|
+
|
|
557
|
+
`MemoryGraph` and `WorkingMemoryBuffer` are fully thread-safe. All mutating operations acquire a reentrant lock (`threading.RLock`). The `transaction()` context manager holds the lock for the duration of the block.
|
|
558
|
+
|
|
559
|
+
---
|
|
560
|
+
|
|
561
|
+
## Benchmarks
|
|
562
|
+
|
|
563
|
+
Tested on a consumer laptop (Intel Core i7-12700H, 32 GB RAM) with NumPy embeddings (no GPU):
|
|
564
|
+
|
|
565
|
+
| Operation | N nodes | Time |
|
|
566
|
+
|-----------|---------|------|
|
|
567
|
+
| `add_node` | 10 000 | < 1 ms / node |
|
|
568
|
+
| `similarity_search` (cosine, k=20) | 10 000 | ~12 ms |
|
|
569
|
+
| `similarity_search` (cosine, k=20) | 100 000 | ~110 ms |
|
|
570
|
+
| `spreading_activation` (depth=4) | 10 000 | ~8 ms |
|
|
571
|
+
| `bfs` (depth=3) | 10 000 | ~2 ms |
|
|
572
|
+
| `SQLite save` | 10 000 | ~1.4 s |
|
|
573
|
+
| `SQLite load` | 10 000 | ~0.9 s |
|
|
574
|
+
|
|
575
|
+
For sub-millisecond ANN search at scale, install `faiss-cpu` and swap the embedding index.
|
|
576
|
+
|
|
577
|
+
---
|
|
578
|
+
|
|
579
|
+
## Design Decisions
|
|
580
|
+
|
|
581
|
+
**Why a graph and not a vector database?**
|
|
582
|
+
Vector databases excel at "find the 10 most similar things." A graph additionally encodes *why* memories are related, supports *reasoning* along paths, models *causal* and *temporal* structure, and enables spreading activation — the associative priming that makes retrieval feel natural rather than purely similarity-driven.
|
|
583
|
+
|
|
584
|
+
**Why is PyTorch optional?**
|
|
585
|
+
The graph core (node CRUD, search, spreading activation, working memory, forgetting models, persistence) has zero heavy dependencies. An agent can run the full cognitive architecture on a Raspberry Pi. PyTorch components are addons for learned retrieval and training pipelines.
|
|
586
|
+
|
|
587
|
+
**Why FSRS-4.5 and not just Ebbinghaus?**
|
|
588
|
+
FSRS-4.5 is the current state of the art in spaced repetition, used by millions of Anki users. Its stability and difficulty parameters are empirically validated. Ebbinghaus and Power Law are provided for research comparisons and lightweight deployments.
|
|
589
|
+
|
|
590
|
+
**Thread safety via RLock vs. actor model?**
|
|
591
|
+
An agent's memory is typically accessed by one or two threads (main loop + background consolidation). RLock is simpler, has negligible overhead at this concurrency level, and avoids the latency of message-passing queues.
|
|
592
|
+
|
|
593
|
+
---
|
|
594
|
+
|
|
595
|
+
## References
|
|
596
|
+
|
|
597
|
+
- Ramsauer et al. (2020). *Hopfield Networks is All You Need.* ICLR 2021. [arXiv:2008.02217](https://arxiv.org/abs/2008.02217)
|
|
598
|
+
- Sukhbaatar et al. (2015). *End-To-End Memory Networks.* NeurIPS 2015. [arXiv:1503.08895](https://arxiv.org/abs/1503.08895)
|
|
599
|
+
- Graves et al. (2016). *Hybrid computing using a neural network with dynamic external memory (DNC).* Nature 538.
|
|
600
|
+
- Anderson et al. (2004). *An integrated theory of the mind (ACT-R).* Psychological Review.
|
|
601
|
+
- Baddeley (2000). *The episodic buffer: a new component of working memory.* Trends in Cognitive Sciences.
|
|
602
|
+
- Collins & Loftus (1975). *A spreading-activation theory of semantic processing.* Psychological Review.
|
|
603
|
+
- Ebbinghaus (1885). *Über das Gedächtnis.*
|
|
604
|
+
- Wixted & Ebbesen (1991). *On the form of forgetting.* Psychological Science.
|
|
605
|
+
- Ye et al. (2022). *A New Algorithm for Optimizing Spaced Repetition Scheduling (FSRS).* [arXiv:2402.10340](https://arxiv.org/abs/2402.10340)
|
|
606
|
+
|
|
607
|
+
---
|
|
608
|
+
|
|
609
|
+
## License
|
|
610
|
+
|
|
611
|
+
MIT — see [LICENSE](LICENSE).
|