Skip to content

Commit

Permalink
Adding notes for Rune example
Browse files Browse the repository at this point in the history
  • Loading branch information
kthakore committed Sep 26, 2020
1 parent 86763cd commit 876e100
Showing 1 changed file with 49 additions and 1 deletion.
50 changes: 49 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,50 @@
# Rune
Containerization for TinyML Applications on MCU

Rune is a containerization technology for deploying TinyML applications to extremely constraint devices.


## Runefile

A `Runefile` is similar to `Dockerfile` in that it is a text document that defines capabilities, processing blocks, feature transformation, models and model outputs to assemble the `Rune`.

A simplistic example of this is would be:

*TODO: refine the below with an exact working version*

```
FROM runicos/base
CAPABILITY AUDIO audio
PROC_BLOCK runicos/fft fft
MODEL ./example.tflite model
RUN audio fft model
```

In this example a audio with fft (fast fourier transformation) block can be run with the model.

### Usage

#### Build

Using the `rune` cli you can build containers
that are tagged and available.

*List available containers*

`rune container ls`

*Build new containers*

`rune build .`

*Run the containers locally simulated*

`rune exec ${CONTAINER-ID}`




0 comments on commit 876e100

Please sign in to comment.