Check if an AI model fits on a microcontroller — before you flash it.
Project description
mcufit
Check if an AI model fits on a microcontroller — before you flash it.
🌐 Try it in your browser · 📦 pip install mcufit
You trained a model. You have a board. Will it run, or will it crash with a
cryptic allocation failure after an hour of toolchain setup? Today the
official answer from the TensorFlow Lite Micro docs is that arena size
"may need to be determined by experimentation." mcufit replaces the
experimentation with an answer in one second:
$ mcufit check wake_word.tflite --board esp32-s3
Model: wake_word.tflite (int8, 14 layers, 340 KB)
Board: ESP32-S3 DevKit (362 KB usable SRAM · 8 MB flash)
✅ FITS
RAM ████████████░░░░░░░░ ~289 KB arena / 362 KB (80%)
Flash ██░░░░░░░░░░░░░░░░░░ 490 KB total / 8 MB (6%)
Peak memory moment: layer 9 (DEPTHWISE_CONV_2D) — 118 KB live tensors
• Leaves ~73 KB RAM for your application, sensor buffers, and network stack.
No hardware required. No vendor lock-in. Works with any .tflite model and
any board in the database (ESP32, RP2040, STM32, Teensy, Arduino, ...).
Install
pip install mcufit
Commands
| Command | What it does |
|---|---|
mcufit check model.tflite -b esp32-s3 |
Fit verdict for one board (exit code 1 if it doesn't fit — CI-friendly) |
mcufit check model.tflite -b esp32-s3 --exact |
Same, measured by the real TFLM runtime (see Exact mode) |
mcufit setup-exact |
One-time build of the TFLM runtime for --exact |
mcufit check model.tflite -b rp2040 --json |
Same, as JSON for scripts and CI |
mcufit compare model.tflite |
Verdict matrix across every board in the database |
mcufit inspect model.tflite |
Layer-by-layer memory profile — see where the peak is |
mcufit boards |
List all known boards |
.onnx models work everywhere .tflite does (install with
pip install 'mcufit[onnx]'), with two caveats: verdicts are estimates
(ONNX runtimes manage memory differently than TFLM) and exact mode stays
.tflite-only. Fit verdicts also include a rough speed figure
(~ms/inference) derived from the model's multiply-accumulate count and the
board's clock — an order-of-magnitude sanity check, not a benchmark.
Guard your model in CI
A model that grows past the board's RAM should fail the pull request, not the field deployment. One step in any GitHub workflow:
- uses: avionicharshit-byte/mcufit@main
with:
model: models/wake_word.tflite
board: esp32-s3
# exact: "true" # optional: measured numbers via host-built TFLM
The action exits non-zero when the model no longer fits, with the full verdict in the job log.
How it works
The RAM bottleneck on microcontrollers is the tensor arena: every
intermediate activation tensor that is alive at the same moment must fit in
SRAM simultaneously. mcufit:
- Parses the
.tfliteflatbuffer directly — layers, tensor shapes, dtypes, and which tensors are baked-in weights (flash) vs. runtime activations (RAM). - Computes tensor lifetimes across the execution schedule and finds the peak of simultaneously-live activation memory — the same quantity TFLite Micro's memory planner must pack into the arena.
- Adds honest overhead for interpreter structures and a safety margin for per-op scratch buffers that static analysis cannot see, and labels the result as an estimate.
- Compares against a curated board database that accounts for the RAM your RTOS/Wi-Fi stack already eats before your app gets any.
Exact mode
Static analysis is instant but approximate. For exact-to-the-byte numbers,
mcufit can run your model through the real TFLite Micro interpreter
compiled for your machine and read the recorded allocations — the same
numbers the device would report, with zero hardware:
mcufit setup-exact # one-time build (~5 min)
mcufit check model.tflite -b esp32-s3 --exact # measured, not estimated
On the person-detection reference model: static analysis estimates ~74 KB,
exact mode measures 89,248 bytes — the difference is per-operator buffers
that only the real runtime knows about. Requires git, a C++ toolchain, and
GNU make >= 3.82 (brew install make on macOS).
Supported boards
31 boards across 7 vendor groups (run mcufit boards for the full table):
| Vendor | Boards |
|---|---|
| Arduino | Uno R3/R4, Mega 2560, Nano 33 BLE Sense, Nano 33 IoT, Portenta H7 |
| Espressif | ESP32, S2, S3, C3, C6, P4, ESP8266, ESP32-CAM, M5Stack Core2 |
| Raspberry Pi | Pico, Pico W, Pico 2 |
| STM32 | F103 Blue Pill, F411 BlackPill, F407 Discovery, F746 Discovery, H743 Nucleo |
| Seeed Studio | XIAO ESP32S3 Sense, XIAO nRF52840 Sense, Wio Terminal |
| Teensy | 4.0, 4.1 |
| Other | SparkFun Edge, BBC micro:bit v2, nRF52832 DK |
Adding a board is a 10-line PR to
boards.yaml — contributions very
welcome.
Roadmap
- Exact mode: measured arena numbers via host-compiled TFLM (
--exact) - Exact mode in the browser: the site measures with TFLM compiled to WebAssembly (32-bit, like the target MCUs), falling back to static estimates
- ONNX model support (
pip install 'mcufit[onnx]'— estimates only; exact mode stays .tflite) - Rough latency estimation per board (MAC count / board throughput — order-of-magnitude only)
- GitHub Action to guard model size in CI (see above)
- Quantization preview: int8 projection simulated on the transformed graph, not naive /4 math
- Web UI: mcufit in the browser — same package, running via Pyodide
Why this exists
Pre-deployment arena estimation has been requested in the TensorFlow repos since 2019 (and again in 2024) and never shipped. In a TFLM maintainer's own words (March 2024):
"We don't have a python based tool for determining arena size, but we do have a C++ one. [...] This would be fairly easy to estimate via Python. However, there are additional allocations from each operator [...]"
That Python tool is what mcufit is — including a labelled safety margin
for exactly those per-operator allocations, until measurement mode makes
them exact. Vendor tools (STM32Cube.AI, eIQ, ...) answer the question only
for their own silicon; mcufit is the neutral, open version.
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mcufit-0.3.0.tar.gz.
File metadata
- Download URL: mcufit-0.3.0.tar.gz
- Upload date:
- Size: 721.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a424db1ecf16b405bee8d5b70a62b63b34a7b2e0aa0d432b8377d3e1def28c3e
|
|
| MD5 |
dfdb568373072a890f7e952f02c0039a
|
|
| BLAKE2b-256 |
a2a19c90f97822f6b0c153b07a7fdfeca16c5ffa8383a71690e9d8ea4d907509
|
File details
Details for the file mcufit-0.3.0-py3-none-any.whl.
File metadata
- Download URL: mcufit-0.3.0-py3-none-any.whl
- Upload date:
- Size: 31.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/7.0.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
31e722305e843e21030d2cf50d324c547c82a2491a2df790bc54405685eb1b9f
|
|
| MD5 |
24e892400b8b0c02ff9e5d1ba0425643
|
|
| BLAKE2b-256 |
1479f79726d8dec601ab53e8b0e1d198f3d122e96fd06f099122acda804299b7
|