[Hexagon] Update Readme #11283

mehrdadh · 2022-05-12T00:53:43Z

Update readme for hexagon testing.

csullivan

Looks great to me!

csullivan · 2022-05-12T20:22:56Z

tests/python/contrib/test_hexagon/README.md

+
+First build Hexagon API application under `apps/hexagon_api`. This step will generate `tvm_rpc_android` and `libtvm_runtime.so` to run on Android. Also, it generates `libtvm_runtime.a` `libtvm_runtime.so`, `libhexagon_rpc_skel.so` and `libhexagon_rpc_sim.so` to run on Hexagon device or Hexagon simulator.
+
+**Note:** To get the most updated instructions, please take a look at [task_build_hexagon_api.sh](https://github.com/apache/tvm/blob/main/tests/scripts/task_build_hexagon_api.sh).


This link is broken in the markdown preview. Probably just because this is not merged, but mentioning just in case.

if you mean task_build_hexagon_api.sh, it should work

csullivan · 2022-05-12T20:23:15Z

tests/python/contrib/test_hexagon/README.md

+./tests/scripts/task_build_hexagon_api.sh 
+```
+
+Now that you have built required tools, you can jump to [run test examples](#run-tests).


Also broken

this should work too, it works for me

adstraw

Good stuff overall! Just needs a few minor tweaks. Thanks for documenting this.

adstraw · 2022-05-12T20:29:30Z

tests/python/contrib/test_hexagon/README.md

+HexagonLauncherRPC is a class to handle interactions with an Android phone which includes Hexagon DSP or Hexagon simulator to run a TVMModule(function/operation/graph) on Hexagon. HexagonLauncherRPC reuses [minRPC](https://github.com/apache/tvm/tree/main/src/runtime/minrpc) implementation to set up an RPC connection from host (your local machine) to Hexagon target, and it is passed through Android RPC server.
+
+## Build Required Tools/Libraries
+To build TVM for Hexagon and run tests you need to run multiple steps which includes preparing required tools, setup environment variables and build various versions of TVM. Alternatively, you can skip these instructions and use docker image which has pre-installed required tools. We highly recommend to use docker, specially if this is your first time working with Hexagon. For instructions on using docker image follow ["use hexagon docker image"](#use-hexagon-docker-image).


Just a few nits:

specially -> especially

"setting up environment variables and building various ..."

adstraw · 2022-05-12T20:30:40Z

tests/python/contrib/test_hexagon/README.md

+
+First, ensure to export Clang libraries to `LD_LIBRARY_PATH` and Hexagon toolchain to `HEXAGON_TOOLCHAIN`:
+```bash
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:"path to `llvm-clang/lib` sub-directory"


Are there any requirements on version? Might document below.

adstraw · 2022-05-12T20:31:05Z

tests/python/contrib/test_hexagon/README.md

+```bash
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:"path to `llvm-clang/lib` sub-directory"
+
+export HEXAGON_TOOLCHAIN="Path to Hexagon toolchain. It can be the Hexagon toolchain included in the SDK, for example `HEXAGON_SDK_PATH/tools/HEXAGON_Tools/x.y.z/Tools`.  The `x.y.z` in the path is the toolchain version number, which is specific to the version of the SDK."


Might discuss how / where to download the SDK below.

added a link

adstraw · 2022-05-12T20:32:18Z

tests/python/contrib/test_hexagon/README.md

+        -DUSE_OUTPUT_BINARY_DIR="path to `build/hexagon_api_output` which is a sub-directory of `tvm`" ..
+
+make -j2
+```


I feel like it would be better just to refer folks to the shell script to avoid having to update in two places.

Do you think shell script is readable enough?

Yes, it's readable. What I am suggesting is that we remove the inline bash script from the readme and simply link to task_build_hexagon_api.sh. This way we don't have to encode and update the same thing twice: once in the readme and again in the script.

adstraw · 2022-05-12T20:32:44Z

tests/python/contrib/test_hexagon/README.md

+        -DUSE_HEXAGON=ON ..
+
+make -j2
+```


Same as above.

adstraw · 2022-05-12T20:33:55Z

tests/python/contrib/test_hexagon/README.md

+
+```bash
+# Log in to docker image
+cd tvm


Instead of cd tvm I would say (outside of the script section) that this works "from your TVM home dir"

adstraw · 2022-05-12T20:35:09Z

tests/python/contrib/test_hexagon/README.md

+export HEXAGON_TOOLCHAIN="Path to Hexagon toolchain. It can be the Hexagon toolchain included in the HexagonSDK, for example `HEXAGON_SDK_PATH/tools/HEXAGON_Tools/x.y.z/Tools`.  The `x.y.z` in the path is the toolchain version number, which is specific to the version of the SDK."
+
+export PYTHONPATH=$PYTHONPATH:"path to `tvm/python`"
+```


Repeat from above? Necessary?

it is because we also need these at runtime

adstraw · 2022-05-12T20:38:08Z

tests/python/contrib/test_hexagon/README.md

+cd tvm
+./docker/bash.sh ci_hexagon
+```
+


Docker Noob question: No need to rebuild at this point right? Might be worth mentioning that here.

adstraw · 2022-05-12T20:38:27Z

tests/python/contrib/test_hexagon/README.md

+```bash
+# Run RPC Tracker in the background
+export TVM_TRACKER_HOST="0.0.0.0"
+export TVM_TRACKER_PORT=9192


Is it safe to hard code 9192?

adstraw · 2022-05-12T20:51:12Z

tests/python/contrib/test_hexagon/README.md

+# Build Hexagon API
+cd ..
+./tests/scripts/task_build_hexagon_api.sh 
+```


Might be good to put this in a checked in shell script as well. And... would be great if the script took the -j argument from the command line.

yeah, let's add that in a separate PR

adstraw · 2022-05-12T20:54:02Z

tests/python/contrib/test_hexagon/README.md

+./docker/bash.sh ci_hexagon
+
+# Build TVM
+./tests/scripts/task_config_build_hexagon.sh 


Should this read

rm -rf build ./tests/scripts/task_config_build_hexagon.sh build

mehrdadh

thanks @adstraw and @csullivan for detailed review. PTAL!

mehrdadh · 2022-05-12T20:59:16Z

tests/python/contrib/test_hexagon/README.md

+
+First build Hexagon API application under `apps/hexagon_api`. This step will generate `tvm_rpc_android` and `libtvm_runtime.so` to run on Android. Also, it generates `libtvm_runtime.a` `libtvm_runtime.so`, `libhexagon_rpc_skel.so` and `libhexagon_rpc_sim.so` to run on Hexagon device or Hexagon simulator.
+
+**Note:** To get the most updated instructions, please take a look at [task_build_hexagon_api.sh](https://github.com/apache/tvm/blob/main/tests/scripts/task_build_hexagon_api.sh).


if you mean task_build_hexagon_api.sh, it should work

mehrdadh · 2022-05-12T21:00:33Z

tests/python/contrib/test_hexagon/README.md

+./tests/scripts/task_build_hexagon_api.sh 
+```
+
+Now that you have built required tools, you can jump to [run test examples](#run-tests).


this should work too, it works for me

mehrdadh · 2022-05-12T21:03:58Z

tests/python/contrib/test_hexagon/README.md

+HexagonLauncherRPC is a class to handle interactions with an Android phone which includes Hexagon DSP or Hexagon simulator to run a TVMModule(function/operation/graph) on Hexagon. HexagonLauncherRPC reuses [minRPC](https://github.com/apache/tvm/tree/main/src/runtime/minrpc) implementation to set up an RPC connection from host (your local machine) to Hexagon target, and it is passed through Android RPC server.
+
+## Build Required Tools/Libraries
+To build TVM for Hexagon and run tests you need to run multiple steps which includes preparing required tools, setup environment variables and build various versions of TVM. Alternatively, you can skip these instructions and use docker image which has pre-installed required tools. We highly recommend to use docker, specially if this is your first time working with Hexagon. For instructions on using docker image follow ["use hexagon docker image"](#use-hexagon-docker-image).


mehrdadh · 2022-05-12T21:04:30Z

tests/python/contrib/test_hexagon/README.md

+
+First, ensure to export Clang libraries to `LD_LIBRARY_PATH` and Hexagon toolchain to `HEXAGON_TOOLCHAIN`:
+```bash
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:"path to `llvm-clang/lib` sub-directory"


mehrdadh · 2022-05-12T21:10:18Z

tests/python/contrib/test_hexagon/README.md

+```bash
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:"path to `llvm-clang/lib` sub-directory"
+
+export HEXAGON_TOOLCHAIN="Path to Hexagon toolchain. It can be the Hexagon toolchain included in the SDK, for example `HEXAGON_SDK_PATH/tools/HEXAGON_Tools/x.y.z/Tools`.  The `x.y.z` in the path is the toolchain version number, which is specific to the version of the SDK."


added a link

mehrdadh · 2022-05-12T21:13:28Z

tests/python/contrib/test_hexagon/README.md

+./docker/bash.sh ci_hexagon
+
+# Build TVM
+./tests/scripts/task_config_build_hexagon.sh 


mehrdadh · 2022-05-12T21:18:16Z

tests/python/contrib/test_hexagon/README.md

+export HEXAGON_TOOLCHAIN="Path to Hexagon toolchain. It can be the Hexagon toolchain included in the HexagonSDK, for example `HEXAGON_SDK_PATH/tools/HEXAGON_Tools/x.y.z/Tools`.  The `x.y.z` in the path is the toolchain version number, which is specific to the version of the SDK."
+
+export PYTHONPATH=$PYTHONPATH:"path to `tvm/python`"
+```


it is because we also need these at runtime

mehrdadh · 2022-05-12T21:19:22Z

tests/python/contrib/test_hexagon/README.md

+cd tvm
+./docker/bash.sh ci_hexagon
+```
+


mehrdadh · 2022-05-12T21:20:05Z

tests/python/contrib/test_hexagon/README.md

+```bash
+# Run RPC Tracker in the background
+export TVM_TRACKER_HOST="0.0.0.0"
+export TVM_TRACKER_PORT=9192


mehrdadh · 2022-05-12T21:28:23Z

tests/python/contrib/test_hexagon/README.md

+# Build Hexagon API
+cd ..
+./tests/scripts/task_build_hexagon_api.sh 
+```


yeah, let's add that in a separate PR

adstraw

LGTM. This doc would be easier to maintain if it simply linked to the relevant shell scripts rather than re-encoding them in here in the readme. However, it's more readable this way. So, I am OK with it as-is. Just a suggestion.

mehrdadh · 2022-05-13T16:16:55Z

@adstraw thanks for the review and great suggestions. I have another PR #11304 to fix ci.py for hexagon. We can update this readme nonce that is merged.

* move conv2d readme * Update README

mehrdadh added 2 commits May 11, 2022 16:40

move conv2d readme

8d4fa99

Update README

0c72555

github-actions bot requested review from csullivan and kparzysz-quic May 12, 2022 16:17

csullivan approved these changes May 12, 2022

View reviewed changes

adstraw suggested changes May 12, 2022

View reviewed changes

adstraw reviewed May 12, 2022

View reviewed changes

address comments

4ab157e

mehrdadh commented May 12, 2022

View reviewed changes

adstraw approved these changes May 13, 2022

View reviewed changes

mehrdadh merged commit 2ba4588 into apache:main May 13, 2022

mehrdadh deleted the hexagon/update_doc branch May 13, 2022 16:17

mehrdadh added a commit to mehrdadh/tvm that referenced this pull request May 16, 2022

[Hexagon] Update Readme (apache#11283)

4b99f29

* move conv2d readme * Update README

shtinsa pushed a commit to Deelvin/tvm that referenced this pull request May 17, 2022

[Hexagon] Update Readme (apache#11283)

2bbbd18

* move conv2d readme * Update README

shingjan pushed a commit to shingjan/tvm that referenced this pull request May 17, 2022

[Hexagon] Update Readme (apache#11283)

97c0156

* move conv2d readme * Update README

driazati mentioned this pull request Jul 14, 2022

TVM v0.9.0.rc0 Release Candidate Notes #12102

Closed


		First build Hexagon API application under `apps/hexagon_api`. This step will generate `tvm_rpc_android` and `libtvm_runtime.so` to run on Android. Also, it generates `libtvm_runtime.a` `libtvm_runtime.so`, `libhexagon_rpc_skel.so` and `libhexagon_rpc_sim.so` to run on Hexagon device or Hexagon simulator.

		Note: To get the most updated instructions, please take a look at [task_build_hexagon_api.sh](https://github.com/apache/tvm/blob/main/tests/scripts/task_build_hexagon_api.sh).

[Hexagon] Update Readme #11283

[Hexagon] Update Readme #11283

Uh oh!

Conversation

mehrdadh commented May 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

csullivan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adstraw left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adstraw May 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mehrdadh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mehrdadh commented May 12, 2022 •

edited

Loading

adstraw May 12, 2022 •

edited

Loading