Fix README yaml header
Browse files
README.md
CHANGED
|
@@ -1,3 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# 🧠 Mnemo v4.1 - SLM-Inspired Memory System
|
| 2 |
|
| 3 |
Memory augmentation library for LLMs based on the Semantic-Loop Memory architecture.
|
|
@@ -37,40 +46,15 @@ results = mnemo.search("programming language")
|
|
| 37 |
## API
|
| 38 |
|
| 39 |
```python
|
| 40 |
-
# Initialize
|
| 41 |
mnemo = Mnemo()
|
| 42 |
-
|
| 43 |
-
# Add memory
|
| 44 |
-
mnemo.add(content, namespace="default", metadata={})
|
| 45 |
-
|
| 46 |
-
# Search
|
| 47 |
results = mnemo.search(query, top_k=5)
|
| 48 |
-
|
| 49 |
-
# Get context for LLM injection
|
| 50 |
context = mnemo.get_context(query, top_k=3)
|
| 51 |
-
|
| 52 |
-
# Check if injection would help
|
| 53 |
should_inject = mnemo.should_inject(query)
|
| 54 |
-
|
| 55 |
-
# Run maintenance (decay + prune)
|
| 56 |
mnemo.maintenance_cycle()
|
| 57 |
-
|
| 58 |
-
# Get statistics
|
| 59 |
-
stats = mnemo.get_stats()
|
| 60 |
```
|
| 61 |
|
| 62 |
-
## Parameters
|
| 63 |
-
|
| 64 |
-
| Parameter | Default | Description |
|
| 65 |
-
|-----------|---------|-------------|
|
| 66 |
-
| similarity_threshold | 0.10 | Min score for search results |
|
| 67 |
-
| quality_threshold | 0.35 | Min quality for new memories |
|
| 68 |
-
| memory_decay_rate | 0.01 | Daily quality decay (1%) |
|
| 69 |
-
| memory_stale_days | 30 | Days before eligible for pruning |
|
| 70 |
-
|
| 71 |
## Links
|
| 72 |
|
| 73 |
-
- [Demo
|
| 74 |
- [MCP Server](https://huggingface.co/spaces/AthelaPerk/mnemo-mcp)
|
| 75 |
-
|
| 76 |
-
MIT License
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
tags:
|
| 4 |
+
- memory
|
| 5 |
+
- llm
|
| 6 |
+
- rag
|
| 7 |
+
- semantic-search
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
# 🧠 Mnemo v4.1 - SLM-Inspired Memory System
|
| 11 |
|
| 12 |
Memory augmentation library for LLMs based on the Semantic-Loop Memory architecture.
|
|
|
|
| 46 |
## API
|
| 47 |
|
| 48 |
```python
|
|
|
|
| 49 |
mnemo = Mnemo()
|
| 50 |
+
mnemo.add(content, namespace="default")
|
|
|
|
|
|
|
|
|
|
|
|
|
| 51 |
results = mnemo.search(query, top_k=5)
|
|
|
|
|
|
|
| 52 |
context = mnemo.get_context(query, top_k=3)
|
|
|
|
|
|
|
| 53 |
should_inject = mnemo.should_inject(query)
|
|
|
|
|
|
|
| 54 |
mnemo.maintenance_cycle()
|
|
|
|
|
|
|
|
|
|
| 55 |
```
|
| 56 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 57 |
## Links
|
| 58 |
|
| 59 |
+
- [Demo](https://huggingface.co/spaces/AthelaPerk/mnemo)
|
| 60 |
- [MCP Server](https://huggingface.co/spaces/AthelaPerk/mnemo-mcp)
|
|
|
|
|
|