Skip to main content

Quick Start

Basic Installation (Core Only)

This installs the core: multi-model chat (OpenAI, Claude, Ollama), routing, CLI, and context transfer. Ollama needs no extra — the client talks to a running Ollama instance over HTTP.

Optional Features (Install What You Need)

These are the extras actually defined in pyproject.toml:

RAG Support

Adds: faiss-cpu, chromadb, sentence-transformers, beautifulsoup4, lxml, numpy, networkx

Additional Vector Store Backends

Adds: chromadb, qdrant-client, weaviate-client, pinecone-client, pymilvus, elasticsearch

Agent Framework

Adds: the [memory] extra (redis, numpy) that agents rely on

Memory Backends

Adds: redis, numpy, networkx

Document Processing

Adds: pdfplumber, PyPDF2, python-docx, python-pptx, pillow, pytesseract, unstructured

Fine-tuning (CPU / general)

Adds: torch, transformers, datasets, accelerate, peft, scikit-learn, numpy, pandas, optuna. Also required for the non-transformer models (Mamba, RWKV), which are HuggingFace-backed.

Fine-tuning (GPU, Linux + CUDA only)

Adds: everything in [finetune] plus bitsandbytes (Linux only; does not install on macOS/ARM)

Compliance Features

Adds: cryptography, bcrypt, pycryptodome, plotly, dash, pandas (dashboard visualization included)

Gateway / API Server

Adds: fastapi, uvicorn, redis, PyJWT, python-multipart, numpy

MCP Server (Claude Desktop / Claude Code integration)

Adds: mcp (the Model Context Protocol SDK) — needed to run the compliance MCP server (python -m multimind.mcp_server) described in docs/mcp-server.md

Framework Integrations

Each adds only the corresponding framework’s core package, for the adapters described in docs/integrations.md.

Everything

All of the above except dev, finetune-gpu, and the framework extras (langchain, llamaindex, crewai, autogen, haystack) — large download; includes torch and ML frameworks.
Note: extras like [router], [llm], [minimal], and [fine-tuning] documented in older versions of this guide do not exist. The router and LLM providers are part of the core install.

Development Setup

Clone & Install for Development

Run Tests

Code Quality

See the Makefile for shortcuts (make lint, make format, make test, …).

Dependency Matrix


Troubleshooting

Issue: ModuleNotFoundError for specific feature

Solution: Install the corresponding extra:

Issue: CUDA/GPU support for PyTorch

Solution: Install the GPU build of torch first, then the extra:

Issue: bitsandbytes fails to install on macOS/ARM

Solution: bitsandbytes is Linux/CUDA-only. Use [finetune] instead of [finetune-gpu] on macOS.

Verification

Test your installation:

Next Steps

  1. Check out the Getting Started Guide
  2. Browse Examples
  3. Read the API Reference
  4. Join our Discord Community