Update README.md

README.md

@@ -1,3 +1,98 @@
 # Memory
 
-Both short-term, and long-term memory.
+Memory-empowered LLMs with a cognitive memory system for AI assistants, using Ollama for LLM capabilities. This system provides persistent memory across three distinct types: Semantic, Episodic, and Procedural.
+
+## Memory Types
+
+This system implements three types of memory inspired by human cognition:
+
+1. **Semantic Memory**: Stores factual knowledge (e.g., information about historical figures, concepts, facts)
+   - Example: "Einstein developed the theory of relativity", "The Earth orbits the Sun"
+   - Implementation: Key-value store with concept identifiers and associated facts
+
+2. **Episodic Memory**: Stores experiences and events (e.g., past conversations, interactions)
+   - Example: "Last week we discussed quantum mechanics", "You previously asked about leadership styles"
+   - Implementation: Timestamped interaction records with content and metadata
+
+3. **Procedural Memory**: Stores information about how to perform tasks (e.g., analysis methods, procedures)
+   - Example: "Steps to analyze a scientific theory", "Scientific method procedure"
+   - Implementation: Named procedures with structured step-by-step instructions
+
+## Architecture
+
+The system consists of several core components:
+
+- `SimpleMemoryStore`: Basic storage backend with persistence capabilities
+- `IntegratedMemory`: Combines all memory types with a unified interface
+- `OllamaMemoryAssistant`: Connects memory to LLM capabilities via Ollama
+
+### Data Flow
+
+1. User submits a query
+2. System searches across all memory types for relevant information
+3. Relevant memories are formatted as context
+4. Context and query are sent to LLM via Ollama
+5. Response is generated and stored in episodic memory
+6. Response is returned to user
+
+## Persistence
+
+This implementation supports persistent memory across sessions via JSON file storage:
+
+- Each user gets a dedicated memory file
+- Memory contents are automatically saved after modifications
+- Memory is loaded when creating a new assistant with the same user ID
+
+## Example Usage
+
+```python
+# Create an assistant with persistent memory
+assistant = OllamaMemoryAssistant(
+    user_id="research_assistant",
+    model_name="gemma3:12b",
+    memory_dir="./memories"
+)
+
+# Add factual knowledge (semantic memory)
+assistant.learn_fact("albert_einstein", {
+    "birth": "1879, Ulm, Germany",
+    "death": "1955, Princeton, USA",
+    "contributions": ["Theory of Relativity", "Photoelectric effect", "Brownian motion"]
+})
+
+# Add procedural knowledge
+assistant.learn_procedure("analyze_scientific_theory", {
+    "steps": [
+        "1. Identify the core principles",
+        "2. Examine the empirical evidence",
+        "3. Consider predictive power and falsifiability",
+        "4. Evaluate practical applications"
+    ]
+})
+
+# Query the system
+response = assistant.process_query("What do we know about Einstein?")
+```
+
+## Advanced Features
+
+- **Historical Figures Demo**: Specialized demo showing memory usage with historical figures
+- **Persistent Memory**: Save and load memories across different sessions
+- **Character Adaptation**: Example adaptation using prompt engineering to create personas with memory
+
+## Requirements
+
+- Python 3.8+
+- Ollama (running locally)
+- A language model (e.g., gemma3:12b) available via Ollama
+
+## Getting Started
+
+1. Install Ollama from [ollama.com](https://ollama.com)
+2. Pull a language model: `ollama pull gemma3:12b`
+3. Initialize an assistant with memory
+4. Add knowledge and start asking questions!
+
+## Project Structure
+
+- `src/memory_model.py` - Core memory system implementation