How-to guides

Task-oriented recipes. Each guide answers a specific question: how do I do this?

If you're new to AIMU, start with the tutorials instead — those build a working mental model. How-to guides assume you already know the basics and want the steps for a particular task.

Working with models

• Switch providers — change backends without changing call sites
• Add a new model — register a model enum member
• Stream output — stream=True, phase filtering, helpers
• Use async (aio) — embed AIMU in async apps; asyncio.TaskGroup-backed Parallel
• Handle vision input — pass images via images=
• Generate images — aimu.image_client() / generate_image() with HuggingFace diffusers + Google Nano Banana

Tools

• Add a custom tool — @tool decorator rules and patterns
• Use MCP tools — cross-process tools via FastMCP

Agents and workflows

• Use skills — SkillAgent and the SKILL.md format
• Build an orchestrator — OrchestratorAgent.assemble or subclass
• Plan, execute, evaluate, replan — PlanExecuteEvaluator for tasks with measurable success criteria

Memory and persistence

• Persist conversations — ConversationManager
• Use semantic memory — SemanticMemoryStore
• Use document memory — DocumentStore

Prompts and evaluation

• Tune prompts — hill-climbing optimisation against labelled data
• Benchmark models — multi-model comparison harness
• Integrate DeepEval — use DeepEval metrics as scorers / judges