Clean up uTVM demo runtime, add ONNX model test and tutorial

apps/microtvm/README.md

@@ -15,14 +15,17 @@
 <!--- specific language governing permissions and limitations -->
 <!--- under the License. -->
 
-# microTVM Reference Virtual Machines
+# microTVM
 
+microTVM is the effort that allows TVM to build and execute models on bare-metal microcontrollers.
 
-microTVM is the effort to allow TVM to build and execute models on bare-metal microcontrollers.
-These Virtual Machines are used to reproduce results and bugs when using microTVM with real
-physical hardware. Note that they are not used to run Continuous Integration regression tests--
-those are instead run by the QEMU container (they run against an emulator, rather than real
-hardware).
+The `pyproject.toml` file in this directory can be used to create a
+[Poetry](https://python-poetry.org/) Python environment with all of the required
+dependencies installed for running microTVM. To use it, run:
+
+```
+$ poetry lock && poetry install
+$ poetry shell
+```
 
 
-See the "microTVM Reference Virtual Machines" tutorial for information on how to use these.

apps/microtvm/reference-vm/zephyr/pyproject.toml → apps/microtvm/pyproject.toml

@@ -15,6 +15,9 @@
 # specific language governing permissions and limitations
 # under the License.
 
+# This `pyproject.toml` file is used to allow MicroTVM
+# to run within a Poetry-managed environment.
+
 [tool.black]
 line-length = 100
 target-version = ['py36']
@@ -47,12 +50,12 @@ exclude = '''
 )
 '''
 [tool.poetry]
-name = "tvm"
+name = "microtvm"
 version = "0.1.0"
 description = ""
-authors = ["Your Name <you@example.com>"]
+authors = []
 packages = [
-    { include = "tvm", from = "../../../../python" },
+    { include = "tvm", from = "../../python" },
 ]
 
 [tool.poetry.dependencies]
@@ -67,7 +70,6 @@ typed_ast = "^1.4"
 pyyaml = "^5.4.1"
 pyserial = "^3.5"
 
-
 # AutoTVM
 xgboost = {version = "^1.1", optional = true}
 

apps/microtvm/zephyr/README.md

@@ -0,0 +1,19 @@
+<!--- Licensed to the Apache Software Foundation (ASF) under one -->
+<!--- or more contributor license agreements.  See the NOTICE file -->
+<!--- distributed with this work for additional information -->
+<!--- regarding copyright ownership.  The ASF licenses this file -->
+<!--- to you under the Apache License, Version 2.0 (the -->
+<!--- "License"); you may not use this file except in compliance -->
+<!--- with the License.  You may obtain a copy of the License at -->
+
+<!---   http://www.apache.org/licenses/LICENSE-2.0 -->
+
+<!--- Unless required by applicable law or agreed to in writing, -->
+<!--- software distributed under the License is distributed on an -->
+<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!--- KIND, either express or implied.  See the License for the -->
+<!--- specific language governing permissions and limitations -->
+<!--- under the License. -->
+
+This directory code to interface microTVM with the [Zephyr RTOS](https://zephyrproject.org/).
+

tests/micro/qemu/zephyr-runtime/CMakeLists.txt → apps/microtvm/zephyr/demo_runtime/CMakeLists.txt

@@ -9,7 +9,6 @@ set(QEMU_PIPE "\${QEMU_PIPE}")  # QEMU_PIPE is set by the calling TVM instance.
 find_package(Zephyr HINTS $ENV{ZEPHYR_BASE})
 project(microtvm_zephyr_runtime)
 
-
 set(CMAKE_VERBOSE_MAKEFILE ON)
 file(GLOB TVM_SOURCES ${CMAKE_SOURCE_DIR}/__tvm*.c)
 target_sources(app PRIVATE src/main.c ${TVM_SOURCES})

apps/microtvm/zephyr/demo_runtime/README.md

@@ -0,0 +1,21 @@
+<!--- Licensed to the Apache Software Foundation (ASF) under one -->
+<!--- or more contributor license agreements.  See the NOTICE file -->
+<!--- distributed with this work for additional information -->
+<!--- regarding copyright ownership.  The ASF licenses this file -->
+<!--- to you under the Apache License, Version 2.0 (the -->
+<!--- "License"); you may not use this file except in compliance -->
+<!--- with the License.  You may obtain a copy of the License at -->
+
+<!---   http://www.apache.org/licenses/LICENSE-2.0 -->
+
+<!--- Unless required by applicable law or agreed to in writing, -->
+<!--- software distributed under the License is distributed on an -->
+<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
+<!--- KIND, either express or implied.  See the License for the -->
+<!--- specific language governing permissions and limitations -->
+<!--- under the License. -->
+
+This directory contains a Zephyr-based "demo" runtime environment that
+pulls together the microTVM runtime dependencies into a single application
+that can communicate with a Python-based host program via the UART, using
+TVM's RPC protocol.

apps/microtvm/zephyr/demo_runtime/boards/nrf5340dk_nrf5340_cpuapp.conf

@@ -0,0 +1,31 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This file is specific to the nRF5340 DK board.
+
+# For intrinsics used by generated optimized operators.
+CONFIG_CMSIS_DSP=y
+
+# Required for Cortex-M33 devices.
+CONFIG_MAIN_STACK_SIZE=1536
+
+# For random number generation.
+CONFIG_ENTROPY_GENERATOR=y
+CONFIG_TEST_RANDOM_GENERATOR=y
+
+# For debugging.
+CONFIG_LED=y

apps/microtvm/zephyr/demo_runtime/boards/nucleo_f746zg.conf

@@ -0,0 +1,30 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# This file is specific to the nRF5340 DK board.
+
+# For intrinsics used by generated optimized operators.
+CONFIG_CMSIS_DSP=y
+
+# Required for Cortex-M33 devices.
+CONFIG_MAIN_STACK_SIZE=50
+
+# For random number generation.
+CONFIG_ENTROPY_GENERATOR=y
+
+# For debugging.
+CONFIG_LED=y

tests/micro/qemu/zephyr-runtime/sample.yaml → apps/microtvm/zephyr/demo_runtime/boards/qemu_x86.conf

@@ -15,8 +15,9 @@
 # specific language governing permissions and limitations
 # under the License.
 
-sample:
-  description: uTVM RPC Server unit test
-  name: utvm rpc server
-common:
-    tags: introduction
+# This file is specific to the QEMU-emulated microTVM board.
+
+# For TVMPlatformGenerateRandom(). Remember, these values do not need to be truly random.
+CONFIG_TEST_RANDOM_GENERATOR=y
+CONFIG_TIMER_RANDOM_GENERATOR=y
+

tests/micro/qemu/zephyr-runtime/crt/crt_config.h → apps/microtvm/zephyr/demo_runtime/crt/crt_config.h

@@ -59,6 +59,6 @@
 /*! \brief Number of pages on device. */
 #define TVM_CRT_MAX_PAGES 300
 
-//#define TVM_CRT_FRAMER_ENABLE_LOGS
+// #define TVM_CRT_FRAMER_ENABLE_LOGS
 
 #endif  // TVM_RUNTIME_CRT_CONFIG_H_

tests/micro/qemu/zephyr-runtime/prj.conf → apps/microtvm/zephyr/demo_runtime/prj.conf

@@ -15,6 +15,10 @@
 # specific language governing permissions and limitations
 # under the License.
 
+# The settings in this file are generic for all boards, and are merged
+# with the settings in the file boards/<BOARD>.conf by the Zephyr build
+# process.
+
 # For UART implementation in main().
 CONFIG_RING_BUFFER=y
 CONFIG_UART_CONSOLE=n
@@ -30,6 +34,3 @@ CONFIG_FPU=y
 # For TVMPlatformAbort().
 CONFIG_REBOOT=y
 
-# For TVMPlatformGenerateRandom(). Remember, these values do not need to be truly random.
-CONFIG_TEST_RANDOM_GENERATOR=y
-CONFIG_TIMER_RANDOM_GENERATOR=y