memorix-docs

Welcome to Memorix AI

## AI Memory Management Framework **Transform your AI applications with intelligent memory systems** [![PyPI version](https://badge.fury.io/py/memorix.svg)](https://badge.fury.io/py/memorix) [![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)

What is Memorix AI?

Memorix AI is a powerful Python framework designed to manage and enhance AI memory systems. It provides a unified interface for working with various vector stores, embedding models, and memory management strategies.

Key Features

#### 🧠 Intelligent Memory Management Store, retrieve, and manage AI conversation history and knowledge with advanced semantic search capabilities.
#### 🔍 Multi-Vector Store Support Work with Chroma, Pinecone, Weaviate, and more vector databases seamlessly through a unified API.
#### 🎯 Flexible Embedding Models Support for OpenAI, Hugging Face, and custom embedding models to match your specific needs.
#### ⚡ High Performance Optimized for speed and efficiency with batch operations and intelligent caching.
#### 🔧 Easy Integration Simple API that works with any AI framework - from chatbots to knowledge bases.
#### 📊 Rich Metadata Store and query contextual information alongside embeddings for powerful filtering and organization.
## 🏗️ Architecture Overview
![Memorix AI Architecture](../img/image.png)

Quick Start

from memorix import MemoryAPI

# Initialize memory system
memory = MemoryAPI(
    vector_store="chroma",
    embedder="openai",
    collection_name="my_chatbot"
)

# Store a conversation
memory.store(
    text="User asked about Python programming",
    metadata={"user_id": "123", "timestamp": "2024-01-01"}
)

# Retrieve relevant memories
results = memory.retrieve(
    query="Python programming help",
    top_k=5
)

Installation

pip install memorix

Documentation Sections

#### 📚 Installation Get started with Memorix AI in minutes with our comprehensive installation guide. Get Started
#### 🚀 Quick Start Build your first memory system with step-by-step tutorials and examples. Start Building
#### 📖 User Guide Learn the core concepts and advanced features of Memorix AI. Learn More
#### 🔧 API Reference Complete API documentation with examples and best practices. View API
#### 💡 Examples Real-world usage examples and implementation patterns. See Examples
#### 🤝 Contributing Join our community and help improve Memorix AI. Contribute

Community