Add MicroTVM tutorial using the STM32F746 discovery board #5655

tom-gall · 2020-05-22T19:42:22Z

Add MicroTVM tutorial using the STM32F746 discovery board
with a sample tflite model

Signed-off-by: Tom Gall [email protected]

Thanks for contributing to TVM! Please refer to guideline https://tvm.apache.org/docs/contribute/ for useful information and tips. After the pull request is submitted, please request code reviews from Reviewers by @ them in the pull request thread.

with a sample tflite model Signed-off-by: Tom Gall <[email protected]>

tom-gall · 2020-05-22T21:30:25Z

@areusch @u99127

tqchen · 2020-06-02T19:22:52Z

@tom-gall please look into the CI failure

areusch · 2020-06-02T19:31:36Z

Hey Tom, to get this to build further along in the CI, I think you can add the following line to docs/conf.py:

'../tutorials/micro'

I added this around line 168 and it kept building

tutorials/micro/README.txt

Signed-off-by: Tom Gall <[email protected]>

comment out portion of tutorial that will not run without a physical board available Signed-off-by: Tom Gall <[email protected]>

The block is commented out since it can only run on device Signed-off-by: Tom Gall <[email protected]>

tqchen · 2020-06-10T02:17:37Z

@tom-gall please followup on @liangfu 's comment

liangfu

Thanks @tom-gall for your valuable contribution on the uTVM tutorial. I've rendered your tutorial and it's not displayed correctly as expected. Please try generate the html by running

make html

in the <tvm_root>/docs directory, so that you could preview the rendered html (in <tvm_root>/docs/_build/html) and fix the syntax errors.

tutorials/micro/micro_tflite.py

docs/conf.py

tutorials/micro/micro_tflite.py

liangfu · 2020-06-10T10:09:26Z

tutorials/micro/micro_tflite.py

+# install tflite
+# .. code-block:: bash
+#
+#   pip install tflite=2.1.0 --user


Please follow RST syntax to put the extra indentation, otherwise it's not rendered as code.

Please try reproduce the the rendered html by running

make html

in <tvm_root>/docs directory, so that the tutorial could be more reader friendly.

Interestingly make html dies with an exception :

python3 -m sphinx -b html -d _build/doctrees . _build/html
Running Sphinx v3.1.0
loading pickled environment... done
[autosummary] generating autosummary for: api/links.rst, api/python/autotvm.rst, api/python/contrib.rst, api/python/driver.rst, api/python/error.rst, api/python/graph_runtime.rst, api/python/index.rst, api/python/ir.rst, api/python/micro.rst, api/python/ndarray.rst, ..., vta/index.rst, vta/install.rst, vta/tutorials/autotvm/tune_relay_vta.rst, vta/tutorials/frontend/deploy_classification.rst, vta/tutorials/frontend/deploy_detection.rst, vta/tutorials/index.rst, vta/tutorials/matrix_multiply.rst, vta/tutorials/optimize/convolution_opt.rst, vta/tutorials/optimize/matrix_multiply_opt.rst, vta/tutorials/vta_get_started.rst
generating gallery...
generating gallery for tutorials... [ 33%] relay_quick_start.py
Extension error:
Handler <function generate_gallery_rst at 0x7f23e55b04d0> for event 'builder-inited' threw an exception
make: *** [Makefile:70: html] Error 2

I'm using ./tests/scripts/task_sphinx_precheck.sh which seems to generate less than perfect html when viewed elsewhere. I'm less than confident that the html generated is acceptable :-/

I was able to get this to work by deleting the other tutorials. I haven't seen that specific exception, though. I did build your tutorial locally and I think it looks okay now. i'll add a couple of small nitpicks which you could fix if you want to be a perfectionist about it.

tutorials/micro/micro_tflite.py

Within docs/conf.py place the microTVM tutorial prior to the VTA tutorials Within the micro_tflite - rework section headers - reorder code so model prep code is all in one place as well as code for running on device - address indentation feedback - remove '' '' usage which I mistakenly thought was getting around a sphinx issue involving ** Signed-off-by: Tom Gall <[email protected]>

…assContext Change to pull example model from github with download_testdata Add 2.5K tflite model Couple of small changes following https://sphinx-gallery.github.io/stable/syntax.html Signed-off-by: Tom Gall <[email protected]>

tqchen

We cannot check in binary files into the codebase, please place the model elsewhere where we can download via download_testdata

Signed-off-by: Tom Gall <[email protected]>

…abling FuseOps Signed-off-by: Tom Gall <[email protected]>

Change download_testdata back to pull model from linaro server Signed-off-by: Tom Gall <[email protected]>

tqchen

my parts of comments has been addressed. @liangfu @areusch please followup and https://tvm.apache.org/docs/contribute/code_review.html#approve-and-request-changes-explicitly

areusch · 2020-06-19T17:06:18Z

tutorials/micro/micro_tflite.py

+# install tflite
+# .. code-block:: bash
+#
+#   pip install tflite=2.1.0 --user


I was able to get this to work by deleting the other tutorials. I haven't seen that specific exception, though. I did build your tutorial locally and I think it looks okay now. i'll add a couple of small nitpicks which you could fix if you want to be a perfectionist about it.

tutorials/micro/micro_tflite.py

tqchen · 2020-06-20T16:07:36Z

@tom-gall please followup on @areusch 's last comments

Signed-off-by: Tom Gall <[email protected]>

tqchen · 2020-06-24T22:44:30Z

Thanks @tom-gall @areusch @liangfu !

* Add MicroTVM tutorial using the STM32F746 discovery board with a sample tflite model Signed-off-by: Tom Gall <[email protected]> * Fix: add a reference to the new turtorials/micro directory Signed-off-by: Tom Gall <[email protected]> * fix: Cosmetic, align Micro TVM text with divider Signed-off-by: Tom Gall <[email protected]> * Fixes to remove warnings, spaces for readability, code blocks Signed-off-by: Tom Gall <[email protected]> * remove use of dload in favor of requests for obtaining the TFLite model Signed-off-by: Tom Gall <[email protected]> * add setup for CMSIS_ST_PATH comment out portion of tutorial that will not run without a physical board available Signed-off-by: Tom Gall <[email protected]> * Fix warning due to ** in python but part of a comment block The block is commented out since it can only run on device Signed-off-by: Tom Gall <[email protected]> * Numerous reworks to address feedback. Within docs/conf.py place the microTVM tutorial prior to the VTA tutorials Within the micro_tflite - rework section headers - reorder code so model prep code is all in one place as well as code for running on device - address indentation feedback - remove '' '' usage which I mistakenly thought was getting around a sphinx issue involving ** Signed-off-by: Tom Gall <[email protected]> * Change disable_vectorize to use current approach with tvm.transform.PassContext Change to pull example model from github with download_testdata Add 2.5K tflite model Couple of small changes following https://sphinx-gallery.github.io/stable/syntax.html Signed-off-by: Tom Gall <[email protected]> * remove use of relay.build_config in favor of PassContext Signed-off-by: Tom Gall <[email protected]> * Couple of minor 4 space fix ups Signed-off-by: Tom Gall <[email protected]> * Change to use tvm.transform.PassContext for disable_victorize and disabling FuseOps Signed-off-by: Tom Gall <[email protected]> * Remove binary module from repo Change download_testdata back to pull model from linaro server Signed-off-by: Tom Gall <[email protected]> * Couple of small cosmetic changes. (spaces and extra lines) Signed-off-by: Tom Gall <[email protected]> * Convert link to tf docs to examine a tf lite model to use RST syntax Signed-off-by: Tom Gall <[email protected]>

Add MicroTVM tutorial using the STM32F746 discovery board

a92508d

with a sample tflite model Signed-off-by: Tom Gall <[email protected]>

tqchen added the status: need review label Jun 2, 2020

liangfu reviewed Jun 3, 2020

View reviewed changes

tutorials/micro/README.txt Outdated Show resolved Hide resolved

tom-gall added 6 commits June 4, 2020 16:06

Fix: add a reference to the new turtorials/micro directory

53a1302

Signed-off-by: Tom Gall <[email protected]>

fix: Cosmetic, align Micro TVM text with divider

cab1b71

Signed-off-by: Tom Gall <[email protected]>

Fixes to remove warnings, spaces for readability, code blocks

5b11e06

Signed-off-by: Tom Gall <[email protected]>

remove use of dload in favor of requests for obtaining the TFLite model

273a97a

Signed-off-by: Tom Gall <[email protected]>

add setup for CMSIS_ST_PATH

de42e52

comment out portion of tutorial that will not run without a physical board available Signed-off-by: Tom Gall <[email protected]>

Fix warning due to ** in python but part of a comment block

7130b22

The block is commented out since it can only run on device Signed-off-by: Tom Gall <[email protected]>

tqchen assigned liangfu Jun 10, 2020

liangfu requested changes Jun 10, 2020

View reviewed changes

areusch reviewed Jun 10, 2020

View reviewed changes

tutorials/micro/micro_tflite.py Outdated Show resolved Hide resolved

tutorials/micro/micro_tflite.py Outdated Show resolved Hide resolved

tutorials/micro/micro_tflite.py Show resolved Hide resolved

tutorials/micro/micro_tflite.py Show resolved Hide resolved

tom-gall added 2 commits June 10, 2020 17:02

tqchen requested changes Jun 12, 2020

View reviewed changes

tom-gall added 4 commits June 12, 2020 11:26

remove use of relay.build_config in favor of PassContext

6db4e6c

Signed-off-by: Tom Gall <[email protected]>

Couple of minor 4 space fix ups

8e3ca48

Signed-off-by: Tom Gall <[email protected]>

Change to use tvm.transform.PassContext for disable_victorize and dis…

742279e

…abling FuseOps Signed-off-by: Tom Gall <[email protected]>

Remove binary module from repo

c0d0173

Change download_testdata back to pull model from linaro server Signed-off-by: Tom Gall <[email protected]>

tqchen approved these changes Jun 18, 2020

View reviewed changes

areusch approved these changes Jun 19, 2020

View reviewed changes

liangfu approved these changes Jun 20, 2020

View reviewed changes

tom-gall added 2 commits June 24, 2020 13:56

Couple of small cosmetic changes. (spaces and extra lines)

7728108

Signed-off-by: Tom Gall <[email protected]>

Convert link to tf docs to examine a tf lite model to use RST syntax

83c8d14

Signed-off-by: Tom Gall <[email protected]>

areusch approved these changes Jun 24, 2020

View reviewed changes

tqchen approved these changes Jun 24, 2020

View reviewed changes

tqchen merged commit 7a9346a into apache:master Jun 24, 2020

tqchen added status: accepted and removed status: need review labels Jun 24, 2020

ZihengJiang mentioned this pull request Sep 25, 2020

TVM v0.7 Release Note Candidate #6486

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add MicroTVM tutorial using the STM32F746 discovery board #5655

Add MicroTVM tutorial using the STM32F746 discovery board #5655

tom-gall commented May 22, 2020

tom-gall commented May 22, 2020 •

edited

Loading

tqchen commented Jun 2, 2020

areusch commented Jun 2, 2020 •

edited

Loading

tqchen commented Jun 10, 2020

liangfu left a comment

liangfu Jun 10, 2020

tom-gall Jun 10, 2020

areusch Jun 19, 2020

tqchen left a comment

tqchen left a comment

areusch Jun 19, 2020

tqchen commented Jun 20, 2020

tqchen commented Jun 24, 2020

Add MicroTVM tutorial using the STM32F746 discovery board #5655

Add MicroTVM tutorial using the STM32F746 discovery board #5655

Conversation

tom-gall commented May 22, 2020

tom-gall commented May 22, 2020 • edited Loading

tqchen commented Jun 2, 2020

areusch commented Jun 2, 2020 • edited Loading

tqchen commented Jun 10, 2020

liangfu left a comment

Choose a reason for hiding this comment

liangfu Jun 10, 2020

Choose a reason for hiding this comment

tom-gall Jun 10, 2020

Choose a reason for hiding this comment

areusch Jun 19, 2020

Choose a reason for hiding this comment

tqchen left a comment

Choose a reason for hiding this comment

tqchen left a comment

Choose a reason for hiding this comment

areusch Jun 19, 2020

Choose a reason for hiding this comment

tqchen commented Jun 20, 2020

tqchen commented Jun 24, 2020

tom-gall commented May 22, 2020 •

edited

Loading

areusch commented Jun 2, 2020 •

edited

Loading