MAXIM
Usage Guide
Installing, Configuring, and Running Maxim
Contents
Requirements
- Python 3.10+
- Hardware: Reachy Mini robot (optional — runs in headless mode without one)
- RAM: 4GB minimum (8GB+ for larger LLMs)
- GPU: Optional. Metal (macOS) or CUDA (Linux) supported
- Network: Same LAN as Reachy Mini for Zenoh discovery (if using robot)
Blackwell GPU Note
RTX 50-series (Blackwell) GPUs have a known GStreamer/CUDA incompatibility. Maxim auto-detects this and falls back to CPU mode. You can force CPU mode manually with CUDA_VISIBLE_DEVICES="".
Installation
- Install from PyPI
pip install pymaxim
The package is called
pymaximon PyPI, but you import it asmaxim. - Add LLM support (pick one or more)
# Local LLM via llama.cpp pip install 'pymaxim[llm-llama]' # Claude (Anthropic) pip install 'pymaxim[llm-anthropic]' # OpenAI / GPT pip install 'pymaxim[llm-openai]'
- Download a local model (optional — skip if using cloud)
maxim --list-models # see available models ./scripts/download_models.sh --llm # download SmolLM 1.7B (~1.1GB)
Developer install: To work on Maxim itself, clone the repo and use pip install -e '.[test]' instead.
Optional Extras
| Extra | Install Command | What It Enables |
|---|---|---|
| TTS | pip install 'pymaxim[tts]' | Text-to-speech (Piper TTS) |
| Semantic | pip install 'pymaxim[semantic]' | Neural similarity (SentenceTransformer) |
| Torch LLM | pip install 'pymaxim[llm-torch]' | PyTorch transformers backend |
| YOLOv8 | pip install 'pymaxim[yolo]' | YOLOv8 vision engine via Ultralytics (AGPL-3.0). Default engine is RTMDet-m (Apache 2.0) |
Configuration
Configuration Files
All configuration lives in ~/.maxim/ (override with $MAXIM_DATA_HOME):
| File | Purpose |
|---|---|
| llm.json | LLM model selection, quantization, per-mode response sizing |
| robots.yaml | Robot connection settings (type, name, timeout) |
| phrase_responses.json | Voice command mappings ("Maxim sleep" → sleep mode) |
| key_responses.json | Keyboard shortcut bindings |
| whisper.json | Audio transcription settings (model size, compute type) |
Environment Variables
Peer & Tunnel Commands
Connect peers to a leader's GPU for distributed inference. See Networking & Mesh for full details.
Prompt Profiles
Three tiers of cognitive effort, matched to your hardware:
| Profile | Max Depth | LLM Calls | Parallelism | Best For |
|---|---|---|---|---|
| minimal | 2 levels | 8 max | None | CPU-only, low RAM, Raspberry Pi |
| standard | 5 levels | 20 max | 4 workers | Laptop with GPU or fast CPU |
| rich | 7 levels | 50 max | 8 workers | Desktop with dedicated GPU |
Operating Modes
Maxim uses a decomposed mode architecture combining processing states (awake/sleep), operational modes (passive/active/singularity), and strategies (observe/explore/research/assist/reflect/learn). For backward compatibility, the CLI accepts legacy mode names that map to specific combinations. See the Operating Modes deep dive for full details.
Menu / Exploration
Running maxim with no arguments opens a Rich interactive menu with campaign discovery, recent sessions, and quick-start options. Select a campaign or mode to launch directly.
maxim
Live
Active + assist strategy. Full embodied runtime with self-evolving behavioral intent.
maxim --mode live
Sleep
Sleep processing state. Audio monitoring, memory consolidation, wake keyword detection.
maxim --mode sleep
Reflection
Passive + reflect strategy. Internal analysis, memory review, pattern identification.
maxim --mode reflection
Train
Passive + learn strategy. Watch demonstrations, incorporate feedback, update behavior.
maxim --mode train
Observe
Passive + observe strategy. Watch and understand without interfering.
maxim --mode observe
Operational Modes & Autonomy
Operational modes map directly to autonomy levels:
| Mode | Autonomy | Behavior | Max Initiative |
|---|---|---|---|
| passive | planning | Proposes actions, waits for human approval | 0.3 |
| active | supervised | Acts within defined boundaries, escalates on uncertainty | 0.7 |
| singularity | autonomous | Full agency with self-correction (safety constraints still apply) | 1.0 |
CLI Reference
Voice Commands
All voice commands begin with the wake word "Maxim":
| Command | Effect |
|---|---|
| "Maxim sleep" | Enter sleep mode (audio monitoring only) |
| "Maxim wake up" | Return to previous active mode |
| "Maxim observe" | Switch to observe strategy |
| "Maxim explore" | Switch to explore strategy |
| "Maxim assist" | Switch to assist strategy |
| "Maxim reflect" | Switch to reflect strategy |
| "Maxim passive" / "active" / "singularity" | Switch operational mode |
| "Maxim shutdown" | Clean shutdown |
See the Operating Modes
Networking & Mesh
Roadmap page for the full list. Custom voice commands can be added in ~/.maxim/util/phrase_responses.json.
Keyboard Controls
Available in interactive mode (default):
Common Recipes
First Run (No Robot)
Run maxim with no arguments to open the Rich interactive menu. Browse available campaigns, pick a recent session, or jump into a mode:
Or launch exploration mode directly:
Full Agentic Mode with Mistral
CPU-Only with Small Model
Verbose Debugging Session
Memory Management
Clearing Memory
Available Memory Types
| Type | What It Clears | Effect |
|---|---|---|
| focus | FocusLearner gains | Resets movement calibration |
| bounds | Workspace limits | Relearns reachable space |
| nac | Causal links | Forgets action-outcome predictions |
| scn | Temporal patterns | Forgets time-of-day associations |
| hippo | Episodic memories | Complete amnesia |
| pain | Pain thresholds | Resets pain sensitivity |
| fear | Fear associations | Forgets learned dangers |
| escalation | Escalation thresholds | Resets when to ask for help |
| threshold | Adaptive thresholds | Resets all learned limits |
| semantic | Neural embeddings | Resets similarity cache |
Where Data Lives
Debugging
Verbosity Levels
| Level | What You See |
|---|---|
| 0 | Errors only |
| 1 | Key events (mode changes, goals, tool calls) |
| 2 | Detailed processing (every detection, memory query, decision) |
| 3 (agentic only) | Full trace (LLM prompts, raw responses, bridge activity) |
Inspecting Learned State
Hardware Diagnostics
Checks Zenoh connection, motor controller, video stream, and audio stream availability.
Log Files
Session logs are written to ~/.maxim/logs/reachy_log_YYYY-MM-DD_HHMMSS.log with timestamps, thread IDs, and structured event data.
Getting Help
Maxim is open source. If you run into issues, check the GitHub repository for the latest documentation and issue tracker.