-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
49 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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}` | ||
|
||
|
||
|
||
|