[GitHub] [tvm] tqchen commented on a change in pull request #7164: [µTVM] Add documentation

2021-01-05 Thread GitBox 


tqchen commented on a change in pull request #7164:
URL: https://github.com/apache/tvm/pull/7164#discussion_r552277964



##
File path: docs/microtvm/index.rst
##
@@ -0,0 +1,72 @@
+..  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.
+
+.. _microtvm-index:
+
+microTVM: TVM on bare-metal
+
+
+microTVM runs TVM models on bare-metal (i.e. IoT) devices. microTVM depends 
only on the C standard
+library, and doesn't require an operating system to execute. microTVM is 
currently under heavy
+development.
+
+.. figure:: 
https://raw.githubusercontent.com/tvmai/web-data/main/images/dev/microtvm_workflow.svg
+   :align: center
+   :width: 85%
+
+microTVM is:
+
+* an extension to TVM's compiler to allow it to target microcontrollers
+* a way to run the TVM RPC server on-device, to allow autotuning
+* a minimal C runtime that supports standalone model inference on bare metal 
devices.
+
+Supported Hardware
+~~~
+
+microTVM currently tests against Cortex-M microcontrollers with the Zephyr 
RTOS; however, it is
+flexible and portable to other processors such as RISC-V and does not require 
Zephyr. The current
+demos run against QEMU and the following hardware:
+
+* `STM Nucleo-F746ZG 
`_
+* `nRF 5340 Preview Development Kit 
`_
+
+
+Getting Started with microTVM
+~
+
+Before working with microTVM, we recommend you have a supported development 
board. Then, follow these
+tutorials to get started with microTVM:
+
+1. :doc:`Start the microTVM Reference VM 
`. The microTVM tutorials

Review comment:
   see
   - 
https://github.com/apache/tvm/blob/main/tutorials/get_started/cross_compilation_and_rpc.py#L18
   - https://raw.githubusercontent.com/apache/tvm/main/docs/deploy/index.rst 
(`:ref:`tutorial-cross-compilation-and-rpc`_
   - https://tvm.apache.org/docs/deploy/





This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [tvm] tqchen commented on a change in pull request #7164: [µTVM] Add documentation

2021-01-05 Thread GitBox 


tqchen commented on a change in pull request #7164:
URL: https://github.com/apache/tvm/pull/7164#discussion_r552275670



##
File path: docs/dev/index.rst
##
@@ -396,3 +396,11 @@ Security
:maxdepth: 1
 
security
+
+
+microTVM
+-

Review comment:
   length matching
   
   





This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [tvm] tqchen commented on a change in pull request #7164: [µTVM] Add documentation

2021-01-05 Thread GitBox 


tqchen commented on a change in pull request #7164:
URL: https://github.com/apache/tvm/pull/7164#discussion_r552275237



##
File path: tutorials/micro/micro_tflite.py
##
@@ -15,83 +15,110 @@
 # specific language governing permissions and limitations
 # under the License.
 """
-Micro TVM with TFLite Models
+microTVM with TFLite Models
 

Review comment:
   length matching
   
   





This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [tvm] tqchen commented on a change in pull request #7164: [µTVM] Add documentation

2021-01-05 Thread GitBox 


tqchen commented on a change in pull request #7164:
URL: https://github.com/apache/tvm/pull/7164#discussion_r552275015



##
File path: docs/microtvm/index.rst
##
@@ -0,0 +1,72 @@
+..  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.
+
+.. _microtvm-index:
+
+microTVM: TVM on bare-metal
+
+
+microTVM runs TVM models on bare-metal (i.e. IoT) devices. microTVM depends 
only on the C standard
+library, and doesn't require an operating system to execute. microTVM is 
currently under heavy
+development.
+
+.. figure:: 
https://raw.githubusercontent.com/tvmai/web-data/main/images/dev/microtvm_workflow.svg
+   :align: center
+   :width: 85%
+
+microTVM is:
+
+* an extension to TVM's compiler to allow it to target microcontrollers
+* a way to run the TVM RPC server on-device, to allow autotuning
+* a minimal C runtime that supports standalone model inference on bare metal 
devices.
+
+Supported Hardware
+~~~

Review comment:
   length matching
   
   





This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [tvm] tqchen commented on a change in pull request #7164: [µTVM] Add documentation

2021-01-05 Thread GitBox 


tqchen commented on a change in pull request #7164:
URL: https://github.com/apache/tvm/pull/7164#discussion_r552274489



##
File path: tutorials/micro/README.txt
##
@@ -1,4 +1,4 @@
 .. _tutorial-micro:
 
-Micro TVM 
+microTVM
 -

Review comment:
   length matching

##
File path: docs/microtvm/index.rst
##
@@ -0,0 +1,72 @@
+..  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.
+
+.. _microtvm-index:
+
+microTVM: TVM on bare-metal
+

Review comment:
   length matching





This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [tvm] tqchen commented on a change in pull request #7164: [µTVM] Add documentation

2021-01-05 Thread GitBox 


tqchen commented on a change in pull request #7164:
URL: https://github.com/apache/tvm/pull/7164#discussion_r552274427



##
File path: tutorials/micro/micro_tflite.py
##
@@ -15,83 +15,110 @@
 # specific language governing permissions and limitations
 # under the License.
 """
-Micro TVM with TFLite Models
+microTVM with TFLite Models
 

Review comment:
   length matching





This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [tvm] tqchen commented on a change in pull request #7164: [µTVM] Add documentation

2021-01-05 Thread GitBox 


tqchen commented on a change in pull request #7164:
URL: https://github.com/apache/tvm/pull/7164#discussion_r551977702



##
File path: docs/microtvm/index.rst
##
@@ -0,0 +1,72 @@
+..  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.
+
+.. _microtvm-index:
+
+microTVM: TVM on bare-metal
+
+
+microTVM runs TVM models on bare-metal (i.e. IoT) devices. microTVM depends 
only on the C standard
+library, and doesn't require an operating system to execute. microTVM is 
currently under heavy
+development.
+
+.. figure:: 
https://raw.githubusercontent.com/tvmai/web-data/main/images/dev/microtvm_workflow.svg
+   :align: center
+   :width: 85%
+
+microTVM is:
+
+* an extension to TVM's compiler to allow it to target microcontrollers
+* a way to run the TVM RPC server on-device, to allow autotuning
+* a minimal C runtime that supports standalone model inference on bare metal 
devices.
+
+Supported Hardware
+~~~
+
+microTVM currently tests against Cortex-M microcontrollers with the Zephyr 
RTOS; however, it is
+flexible and portable to other processors such as RISC-V and does not require 
Zephyr. The current
+demos run against QEMU and the following hardware:
+
+* `STM Nucleo-F746ZG 
`_
+* `nRF 5340 Preview Development Kit 
`_
+
+
+Getting Started with microTVM
+~

Review comment:
   rst requires the underline to have the same length as the title to avoid 
warning

##
File path: docs/microtvm/index.rst
##
@@ -0,0 +1,72 @@
+..  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.
+
+.. _microtvm-index:
+
+microTVM: TVM on bare-metal
+
+
+microTVM runs TVM models on bare-metal (i.e. IoT) devices. microTVM depends 
only on the C standard
+library, and doesn't require an operating system to execute. microTVM is 
currently under heavy
+development.
+
+.. figure:: 
https://raw.githubusercontent.com/tvmai/web-data/main/images/dev/microtvm_workflow.svg
+   :align: center
+   :width: 85%
+
+microTVM is:
+
+* an extension to TVM's compiler to allow it to target microcontrollers
+* a way to run the TVM RPC server on-device, to allow autotuning
+* a minimal C runtime that supports standalone model inference on bare metal 
devices.
+
+Supported Hardware
+~~~
+
+microTVM currently tests against Cortex-M microcontrollers with the Zephyr 
RTOS; however, it is
+flexible and portable to other processors such as RISC-V and does not require 
Zephyr. The current
+demos run against QEMU and the following hardware:
+
+* `STM Nucleo-F746ZG 
`_
+* `nRF 5340 Preview Development Kit 
`_
+
+
+Getting Started with microTVM
+~
+
+Before working with microTVM, we recommend you have a supported development 
board. Then, follow these
+tutorials to get started with microTVM:
+
+1. :doc:`Start the microTVM Reference VM 
`. The microTVM tutorials

Review comment:
   consider use label and reference. 
   
https://stackoverflow.com/questions/15394347/adding-a-cross-reference-to-a-subheading-or-anchor-in-another-page

##
File path: docs/microtvm/index.rst
##
@@ -0,0 +1,72 @@
+..

[GitHub] [tvm] tqchen commented on a change in pull request #7164: [µTVM] Add documentation

2020-12-31 Thread GitBox 


tqchen commented on a change in pull request #7164:
URL: https://github.com/apache/tvm/pull/7164#discussion_r550499883



##
File path: docs/dev/index.rst
##
@@ -396,3 +396,11 @@ Security
:maxdepth: 1
 
security
+
+
+microTVM
+-
+.. toctree::

Review comment:
   The main reason is that many figures are binaries, updating figures 
would corresponds to the diff of binaries. Adding binaries as part of the repo 
would make the git history itself inevitably large. 
   
   





This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

[GitHub] [tvm] tqchen commented on a change in pull request #7164: [µTVM] Add documentation

2020-12-26 Thread GitBox 


tqchen commented on a change in pull request #7164:
URL: https://github.com/apache/tvm/pull/7164#discussion_r548999206



##
File path: docs/dev/index.rst
##
@@ -396,3 +396,11 @@ Security
:maxdepth: 1
 
security
+
+
+microTVM
+-
+.. toctree::

Review comment:
   as a general principle we don't check in figures. Please checkin figures 
to another repo and then reference from the docs e.g. 
https://raw.githubusercontent.com/tlc-pack/web-data/main/images/design/tvm_static_overview.svg





This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org