iree-embedded 0.1.1

Safe no_std Rust API for ML inference on Cortex-M via the IREE runtime.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# iree-embedded

[![CI](https://github.com/tallamjr/iree-embedded/actions/workflows/runtime.yml/badge.svg)](https://github.com/tallamjr/iree-embedded/actions/workflows/runtime.yml)
[![crates.io](https://img.shields.io/crates/v/iree-embedded.svg)](https://crates.io/crates/iree-embedded)
[![docs.rs](https://docs.rs/iree-embedded/badge.svg)](https://docs.rs/iree-embedded)
[![license](https://img.shields.io/crates/l/iree-embedded.svg)](#licence)

A safe, `no_std` Rust API for machine-learning inference on Cortex-M
microcontrollers, built on [IREE](https://iree.dev)'s bare-metal C runtime.

IREE is an ahead-of-time compiler plus a small runtime: a model is compiled
once on a host into a self-contained artefact, and the device only loads and
executes it. This crate wraps the _runtime_ half in six RAII types
(`Arena`, `Instance`, `Device`, `Context`, `Tensor`, `Error`) so leaks and
double-frees become compile-time impossibilities and every fallible call
returns a `Result` carrying the real IREE status message.

```rust,no_run
use iree_embedded::{Arena, Context, Device, Instance, Tensor, link_kernels, singleton};

// VMFB is the embedded compiled model (include_vmfb!).
let arena = Arena::new(singleton!([u8; 56 * 1024] = [0; 56 * 1024]));
let instance = Instance::new(&arena)?;
let device = Device::local_sync_static(&arena, &[link_kernels!(my_model_library_query)])?;
let ctx = Context::new(&instance, &device, VMFB, &arena)?;
let out = ctx.invoke(ctx.resolve("module.main")?, &[&input], &arena)?;
```

## Runtime dependency

This crate links the IREE C runtime, which is **not** built by `cargo` itself.
`iree-embedded-sys`'s build script downloads the matching prebuilt runtime for
your target from the project's GitHub releases, or uses a local build when
`IREE_RUNTIME_DIR` / `IREE_SRC_DIR` are set. See the
[repository](https://github.com/tallamjr/iree-embedded) for details and a
complete `no_std` firmware example (live keyword spotting on a BBC micro:bit
v2).

## Licence

Licensed under either of
[Apache-2.0](https://github.com/tallamjr/iree-embedded/blob/master/LICENSE-APACHE)
or [MIT](https://github.com/tallamjr/iree-embedded/blob/master/LICENSE-MIT) at
your option.