mem-llm 1.0.0__py3-none-any.whl

mem_llm-1.0.0.dist-info/METADATA

@@ -0,0 +1,382 @@
+Metadata-Version: 2.4
+Name: mem-llm
+Version: 1.0.0
+Summary: Memory-enabled AI assistant with local LLM support
+Home-page: https://github.com/emredeveloper/Mem-LLM
+Author: C. Emre Karataş
+Author-email: karatasqemre@gmail.com
+Project-URL: Bug Reports, https://github.com/emredeveloper/Mem-LLM/issues
+Project-URL: Source, https://github.com/emredeveloper/Mem-LLM
+Keywords: llm ai memory agent chatbot ollama local
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pyyaml>=6.0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: black>=23.7.0; extra == "dev"
+Requires-Dist: flake8>=6.1.0; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 🧠 Mem-Agent: Memory-Enabled Mini Assistant
+
+<div align="center">
+
+[![Python](https://img.shields.io/badge/Python-3.8%2B-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+[![Ollama](https://img.shields.io/badge/Ollama-Compatible-orange.svg)](https://ollama.ai/)
+
+**A local AI assistant that remembers user interactions and responds with context awareness using a lightweight 4-billion parameter LLM.**
+
+[Quick Start](#-quick-start) • [Features](#-features) • [Documentation](#-documentation) • [Examples](#-usage-examples)
+
+</div>
+
+---
+
+## 🎯 Why Mem-Agent?
+
+Most Large Language Models (LLMs) treat every conversation as "new" and don't remember past interactions. **Mem-Agent** uses a small locally-running model to:
+
+- ✅ **Remember user history** - Separate memory for each customer/user
+- ✅ **Context awareness** - Responds based on previous conversations
+- ✅ **Fully local** - No internet connection required
+- ✅ **Lightweight & fast** - Only 2.5 GB model size
+- ✅ **Easy integration** - Get started with 3 lines of code
+
+## 🚀 Quick Start
+
+### 1. Install Ollama
+
+```bash
+# Windows/Mac/Linux: https://ollama.ai/download
+curl https://ollama.ai/install.sh | sh
+
+# Start the service
+ollama serve
+```
+
+### 2. Download Model
+
+```bash
+ollama pull granite4:tiny-h
+```
+
+### 3. Use Mem-Agent
+
+```python
+from memory_llm import MemAgent
+
+# Create agent
+agent = MemAgent(model="granite4:tiny-h")
+
+# System check
+status = agent.check_setup()
+if status['status'] == 'ready':
+    print("✅ System ready!")
+else:
+    print("❌ Error:", status)
+
+# Set user
+agent.set_user("user123")
+
+# First conversation
+response = agent.chat("Hello, my name is Ali")
+print(response)
+
+# Second conversation - It remembers me!
+response = agent.chat("Do you remember my name?")
+print(response)
+```
+
+## 📚 Example Scripts
+
+### 1. Simple Test
+
+```bash
+python examples/example_simple.py
+```
+
+### 2. Customer Service Simulation
+
+```bash
+python examples/example_customer_service.py
+```
+
+## 🏗️ Project Structure
+
+```
+Memory LLM/
+├── memory_llm/              # Main package
+│   ├── __init__.py          # Package initialization
+│   ├── mem_agent.py         # Main assistant class
+│   ├── memory_manager.py    # Memory management
+│   ├── memory_db.py         # SQL database support
+│   ├── llm_client.py        # Ollama integration
+│   ├── memory_tools.py      # User tools
+│   ├── knowledge_loader.py  # Knowledge base loader
+│   ├── prompt_templates.py  # Prompt templates
+│   └── config_manager.py    # Configuration manager
+├── examples/                # Example scripts
+├── tests/                   # Test files
+├── setup.py                 # Installation script
+├── requirements.txt         # Dependencies
+└── README.md               # This file
+```
+
+## 🔧 API Usage
+
+### MemAgent Class
+
+```python
+from memory_llm import MemAgent
+
+agent = MemAgent(
+    model="granite4:tiny-h",           # Ollama model name
+    memory_dir="memories",             # Memory directory
+    ollama_url="http://localhost:11434" # Ollama API URL
+)
+```
+
+#### Basic Methods
+
+```python
+# Set user
+agent.set_user("user_id")
+
+# Chat
+response = agent.chat(
+    message="Hello",
+    user_id="optional_user_id",  # If set_user not used
+    metadata={"key": "value"}     # Additional information
+)
+
+# Get memory summary
+summary = agent.memory_manager.get_summary("user_id")
+
+# Search in history
+results = agent.search_user_history("keyword", "user_id")
+
+# Update profile
+agent.update_user_info({
+    "name": "Ali",
+    "preferences": {"language": "en"}
+})
+
+# Get statistics
+stats = agent.get_statistics()
+
+# Export memory
+json_data = agent.export_memory("user_id")
+
+# Clear memory (WARNING!)
+agent.clear_user_memory("user_id", confirm=True)
+```
+
+### MemoryManager Class
+
+```python
+from memory_llm import MemoryManager
+
+memory = MemoryManager(memory_dir="memories")
+
+# Load memory
+data = memory.load_memory("user_id")
+
+# Add interaction
+memory.add_interaction(
+    user_id="user_id",
+    user_message="Hello",
+    bot_response="Hello! How can I help you?",
+    metadata={"timestamp": "2025-01-13"}
+)
+
+# Get recent conversations
+recent = memory.get_recent_conversations("user_id", limit=5)
+
+# Search
+results = memory.search_memory("user_id", "order")
+```
+
+### OllamaClient Class
+
+```python
+from memory_llm import OllamaClient
+
+client = OllamaClient(model="granite4:tiny-h")
+
+# Simple generation
+response = client.generate("Hello world!")
+
+# Chat format
+response = client.chat([
+    {"role": "system", "content": "You are a helpful assistant"},
+    {"role": "user", "content": "Hello"}
+])
+
+# Connection check
+is_ready = client.check_connection()
+
+# Model list
+models = client.list_models()
+```
+
+## 💡 Usage Scenarios
+
+### 1. Customer Service Bot
+- Remembers customer history
+- Knows previous issues
+- Makes personalized recommendations
+
+### 2. Personal Assistant
+- Tracks daily activities
+- Learns preferences
+- Makes reminders
+
+### 3. Education Assistant
+- Tracks student progress
+- Adjusts difficulty level
+- Remembers past mistakes
+
+### 4. Support Ticket System
+- Stores ticket history
+- Finds related old tickets
+- Provides solution suggestions
+
+## 📊 Memory Format
+
+Memories are stored in JSON format:
+
+```json
+{
+  "conversations": [
+    {
+      "timestamp": "2025-01-13T10:30:00",
+      "user_message": "Hello",
+      "bot_response": "Hello! How can I help you?",
+      "metadata": {
+        "topic": "greeting"
+      }
+    }
+  ],
+  "profile": {
+    "user_id": "user123",
+    "first_seen": "2025-01-13T10:30:00",
+    "preferences": {},
+    "summary": {}
+  },
+  "last_updated": "2025-01-13T10:35:00"
+}
+```
+
+## 🔒 Privacy and Security
+
+- ✅ Works completely locally (no internet connection required)
+- ✅ Data stored on your computer
+- ✅ No data sent to third-party services
+- ✅ Memories in JSON format, easily deletable
+
+## 🛠️ Development
+
+### Test Mode
+
+```python
+# Simple chat without memory (for testing)
+response = agent.simple_chat("Test message")
+```
+
+### Using Your Own Model
+
+```python
+# Different Ollama model
+agent = MemAgent(model="llama2:7b")
+
+# Or another LLM API
+# Customize llm_client.py file
+```
+
+## 🐛 Troubleshooting
+
+### Ollama Connection Error
+
+```bash
+# Start Ollama service
+ollama serve
+
+# Port check
+netstat -an | findstr "11434"
+```
+
+### Model Not Found
+
+```bash
+# Check model list
+ollama list
+
+# Download model
+ollama pull granite4:tiny-h
+```
+
+### Memory Issues
+
+```python
+# Check memory directory
+import os
+os.path.exists("memories")
+
+# List memory files
+os.listdir("memories")
+```
+
+## 📈 Performance
+
+- **Model Size**: ~2.5 GB
+- **Response Time**: ~1-3 seconds (depends on CPU)
+- **Memory Usage**: ~4-6 GB RAM
+- **Disk Usage**: ~10-50 KB per user
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit changes (`git commit -m 'feat: Add amazing feature'`)
+4. Push to branch (`git push origin feature/amazing-feature`)
+5. Open Pull Request
+
+## 📝 License
+
+MIT License - See LICENSE file for details.
+
+## 🙏 Acknowledgments
+
+- [Ollama](https://ollama.ai/) - Local LLM server
+- [Granite](https://www.ibm.com/granite) - IBM Granite models
+
+## 📞 Contact
+
+You can open an issue for your questions.
+
+---
+
+**Note**: This project is for educational and research purposes. Please perform comprehensive testing before using in production environment.

mem_llm-1.0.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+memory_llm/__init__.py,sha256=74hTFnqEMUtTnTLUtZllFo-8NM-JghqZgPH9SDgQj0g,827
+memory_llm/config.yaml.example,sha256=lgmfaU5pxnIm4zYxwgCcgLSohNx1Jw6oh3Qk0Xoe2DE,917
+memory_llm/config_manager.py,sha256=8PIHs21jZWlI-eG9DgekjOvNxU3-U4xH7SbT8Gr-Z6M,7075
+memory_llm/knowledge_loader.py,sha256=oSNhfYYcx7DlZLVogxnbSwaIydq_Q3__RDJFeZR2XVw,2699
+memory_llm/llm_client.py,sha256=tLNulVEV_tWdktvcQUokdhd0gTkIISUHipglRt17IWk,5255
+memory_llm/mem_agent.py,sha256=AMw8X5cFdHoyphyHf9B4eBXDFGTLEv9nkDBXnO_fGL4,19907
+memory_llm/memory_db.py,sha256=OGWTIHBHh1qETGvmrlZWfmv9szSaFuSCzJGMZg6HBww,12329
+memory_llm/memory_manager.py,sha256=-JM0Qb5dYm1Rj4jd3FQfDpZSaya-ly9rcgEjyvnyDzk,8052
+memory_llm/memory_tools.py,sha256=ARANFqu_bmL56SlV1RzTjfQsJj-Qe2QvqY0pF92hDxU,8678
+memory_llm/prompt_templates.py,sha256=tCiQJw3QQKIaH8NsxEKOIaIVxw4XT43PwdmyfCINzzM,6536
+mem_llm-1.0.0.dist-info/METADATA,sha256=Pdiho_vUo-vCZgKde5WYCqfabFtXoubMJA97u_qLjaY,9359
+mem_llm-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mem_llm-1.0.0.dist-info/top_level.txt,sha256=7I8wePWMtiZ-viJGXLYAiHpxiwpwPbFhNn1cyufySok,11
+mem_llm-1.0.0.dist-info/RECORD,,

mem_llm-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mem_llm-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+memory_llm

memory_llm/__init__.py

@@ -0,0 +1,34 @@
+"""
+Memory-LLM: Memory-Enabled Mini Assistant
+AI library that remembers user interactions
+"""
+
+from .mem_agent import MemAgent
+from .memory_manager import MemoryManager
+from .llm_client import OllamaClient
+
+# Tools (optional)
+try:
+    from .memory_tools import MemoryTools, ToolExecutor
+    __all_tools__ = ["MemoryTools", "ToolExecutor"]
+except ImportError:
+    __all_tools__ = []
+
+# Pro version imports (optional)
+try:
+    from .memory_db import SQLMemoryManager
+    from .prompt_templates import prompt_manager
+    from .config_manager import get_config
+    __all_pro__ = ["SQLMemoryManager", "prompt_manager", "get_config"]
+except ImportError:
+    __all_pro__ = []
+
+__version__ = "1.0.0"
+__author__ = "C. Emre Karataş"
+
+__all__ = [
+    "MemAgent",
+    "MemoryManager",
+    "OllamaClient",
+] + __all_tools__ + __all_pro__
+

memory_llm/config.yaml.example

@@ -0,0 +1,52 @@
+# Memory-LLM Configuration File
+# Copy this file to config.yaml and edit as needed
+
+# Usage Mode: "personal" or "business"
+usage_mode: "personal"
+
+# LLM Settings
+llm:
+  model: "granite4:tiny-h"
+  base_url: "http://localhost:11434"
+  temperature: 0.7
+  max_tokens: 500
+
+# Memory Settings
+memory:
+  backend: "json"  # "json" or "sql"
+  json_dir: "memories"
+  db_path: "memories.db"
+
+# System Prompt Template
+prompt:
+  template: "personal_assistant"
+  variables:
+    user_name: "User"
+    tone: "friendly"
+
+# Knowledge Base
+knowledge_base:
+  enabled: true
+  auto_load: true
+  default_kb: "ecommerce"
+  search_limit: 5
+
+# Response Settings
+response:
+  use_knowledge_base: true
+  use_memory: true
+  recent_conversations_limit: 5
+
+# Logging
+logging:
+  enabled: true
+  level: "INFO"
+  file: "mem_agent.log"
+
+# Security
+security:
+  filter_sensitive_data: true
+  rate_limit:
+    enabled: true
+    max_requests_per_minute: 60
+