Skip to content

Commit

Permalink
[#68736] README: Describe RuntimeBuilder scenarios
Browse files Browse the repository at this point in the history
Signed-off-by: Mikolaj Klikowicz <mklikowicz@antmicro.com>
  • Loading branch information
mikolaj-klikowicz authored and glatosinski committed Nov 14, 2024
1 parent ccdf163 commit aa6faf9
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,17 @@ kenning optimize test report \
The model performance report in Markdown will be available under `reports/stm32-renode-tflite-magic-wand/report.md`.
The HTML version of the report will be accessible from `reports/stm32-renode-tflite-magic-wand/report/report.html`.

The above two steps (`west build` and `kenning ...`) can be also performed by Kenning automatically using `ZephyrRuntimeBuilder` block, e.g. as in the scenario located in `kenning-scenarios/renode-zephyr-auto-tflite-magic-wand-inference.json`:

```bash
kenning optimize test report \
--json-cfg kenning-scenarios/renode-zephyr-auto-tflite-magic-wand-inference.json \
--measurements results.json --verbosity INFO \
--report-path reports/stm32-renode-auto-tflite-magic-wand/report.md \
--to-html \
--verbosity INFO
```

#### Using microTVM

To build the `kenning-zephyr-runtime` app to work with microTVM runtime, set `-DEXTRA_CONF_FILE` to `tvm.conf`, e.g. by executing:
Expand All @@ -251,6 +262,17 @@ kenning optimize test report \
--verbosity INFO
```

The above two steps (`west build` and `kenning ...`) can be also performed by Kenning automatically using `ZephyrRuntimeBuilder` block:

```bash
kenning optimize test report \
--json-cfg kenning-scenarios/renode-zephyr-auto-tvm-magic-wand-inference.json \
--measurements results.json --verbosity INFO \
--report-path reports/stm32-renode-auto-tvm-magic-wand/report.md \
--to-html \
--verbosity INFO
```

##### Building runtime with microTVM backend using custom model

This step requires Kenning to be installed.
Expand Down Expand Up @@ -307,6 +329,17 @@ kenning optimize test report \
--verbosity INFO
```

The above two steps (`west build` and `kenning ...`) can be also performed by Kenning automatically using `ZephyrRuntimeBuilder`:

```bash
kenning optimize test report \
--json-cfg kenning-scenarios/renode-zephyr-auto-tvm-llext-magic-wand-inference.json \
--measurements results.json --verbosity INFO \
--report-path reports/stm32-renode-auto-tvm-llext-magic-wand/report.md \
--to-html \
--verbosity INFO
```

## Evaluating a model in Kenning using actual hardware

Kenning can evaluate the runtime running on a physical device.
Expand Down

0 comments on commit aa6faf9

Please sign in to comment.