AI Foundation Addon
The AI Foundation Addon is the easiest way to run AI models on your device. Start running inference in under 15 minutes. No coding, no cloud APIs, no data leaving your device.
What is the AI Foundation Addon?
The AI Foundation Addon is an addon package for mimOE that includes everything you need to run AI models locally:
- Model Registry: Service for managing your AI models with two-step provisioning
- Generative Inference Service: OpenAI-compatible API for running models
Pre-configured and ready to run.
Why Use AI Foundation?
Zero Code Required
Provision a model and call the API. No programming, no configuration, no complexity. Perfect for testing AI models or building simple integrations.
Complete Privacy
Models run entirely on your device. No cloud API calls, no data transmission, no privacy concerns. Your data never leaves your computer.
Four Model Kinds
Support for different AI model types:
| Kind | Description | Use Case |
|---|---|---|
llm | Large Language Model | Text generation, chat, reasoning |
vlm | Vision Language Model | Multimodal (text + images) |
embed | Embedding Model | Semantic search, similarity |
onnx | ONNX Model | Image classification, predictive AI |
Device-First Performance
Take advantage of local hardware acceleration (Metal on macOS, CUDA on NVIDIA GPUs) for fast inference without cloud latency.
OpenAI-Compatible API
The Inference API follows the OpenAI chat completions format, making it drop-in compatible with existing tools and libraries.
How It Works
- Start mimOE: Run the startup script to launch the runtime
- Create Model Metadata: Register the model with its configuration
- Provision File: Download from URL or upload locally
- Run Inference: Call the OpenAI-compatible API
- All On-Device: Everything happens locally on your machine
Quick Start Path
The fastest way to get started:
- Quick Start: Install and run your first inference (recommended starting point)
- Upload a Model: Learn model provisioning options
- Inference API: Complete API guide
Examples & Tutorials
Explore practical examples that demonstrate different capabilities:
- Chat with SmolLM2: Build a conversational AI with GGUF
- Semantic Search: Text embeddings for search
- Finding Models: Discover models on Hugging Face
API Endpoints
| Service | Base URL | Description |
|---|---|---|
| Model Registry | /mimik-ai/store/v1 | Model management (CRUD, upload, download) |
| Inference | /mimik-ai/openai/v1 | OpenAI-compatible inference |
Use Cases
Development & Testing
Test AI models locally before deploying to production. Experiment with different models and prompts without cloud costs.
Privacy-Sensitive Applications
Medical records analysis, legal document processing, and personal data analysis. Ideal for anything where privacy is paramount.
Offline AI
Build applications that work without internet connectivity. Field service apps, remote locations, air-gapped environments.
Cost Optimization
Eliminate cloud API costs for high-volume inference workloads. Run thousands of inferences for free.
Edge Deployment
Develop applications that run AI directly on end-user devices such as smartphones, tablets, and IoT devices.
System Requirements
Supported Platforms
- macOS 10.15+ (Apple Silicon)
- Ubuntu 22.04+ (x86_64)
- Windows 10+ (x86_64)
mimOE itself is lightweight. RAM and disk requirements depend on the AI models you choose to run. See Finding Models for model size guidelines.
What's Next?
After mastering the AI Foundation Addon, explore:
AI Development
Learn to build custom AI applications with pre/post processing, custom mims, and AI agents:
- AI Development Overview: Glue code, agents, and multi-agent systems (coming soon)
Platform Guide
Dive deeper into the mimOE platform for advanced capabilities:
- Architecture Overview: Understanding the runtime
- JavaScript mims: Build custom mims
- WASM mims: Performance-critical workloads
Mesh Foundation
Connect devices and build distributed AI applications:
- Mesh Foundation Overview: Discover and connect devices
- Device Mesh: Build collaborative systems
Getting Help
- Community Forum: Connect with other developers
Start Now
Ready to run your first AI model on-device? Choose your path:
- New to AI on devices? → Quick Start Guide (recommended)
- Ready to explore? → Examples (hands-on tutorials)
- Need API details? → Inference API (complete guide)