Tvmc python tutorial #9633

CircleSpin · 2021-12-02T02:18:43Z

Finally putting up the doc :')

Let me know of thoughts/feedback.

leandron

Thanks for this tutorial @CircleSpin! I had a first read and just spotted some minor changes in upper case acronyms and some sections that need a bit of more context to be added.

I'm happy with the sequence of steps you propose in this tutorial. I suggest we just adapt them using a real case that the user can reproduce on their own machine.

gallery/how_to/use_tvms_python_api/tvmc_python.py

mbrookhart

LGTM. Looks like you hit a flaky test?

leandron

Thanks for the fixes!

hogepodge

Should this tutorial supercede the other Python tutorial? I'm worried that people might get confused with two ways of doing things. If it shouldn't, we should clearly explain why there are two ways and what the intended outcome of each method is.

gallery/how_to/use_tvms_python_api/tvmc_python.py

hogepodge · 2021-12-03T22:22:45Z

gallery/how_to/use_tvms_python_api/tvmc_python.py

+################################################################################
+# Step 2: Compile
+# ----------------
+# Now that our model is in relay, our next step is to compile it to a desired 


Thinking out loud here, for documentation we should starting thinking about a style guide for named parts of TVM. Should it be Relay or relay? Our choice should be consistently applied throughout the project.

I've capitalized the instances here to be "Relay".

gallery/how_to/use_tvms_python_api/tvmc_python.py

CircleSpin · 2021-12-14T02:24:56Z

Hi @hogepodge,

By all means if there's another ordering of the tutorials you prefer let's go with that. This tutorial seems to do the same thing as this one https://tvm.apache.org/docs/tutorial/autotvm_relay_x86.html#sphx-glr-tutorial-autotvm-relay-x86-py but instead uses the Tvmc python API. This API shares the same backend as the command line tool and is intended to be simple and new-user friendly.

CircleSpin · 2021-12-18T05:39:35Z

Changed the location of this doc to be in the tutorial section after tvmc command line tutorial and before the autotvm python tutorial.

leandron · 2022-01-17T11:48:07Z

@CircleSpin just a friendly ping on this one. Can we rebase and re-run CI?

Context: we got a question in the forum, that could be helped by this tutorial, then I remembered about this PR.

Co-authored-by: Leandro Nunes <leandro.nunes@arm.com>

hogepodge

Aside from the redirect, we should merge this.

hogepodge · 2022-01-19T01:18:46Z

docs/conf.py

@@ -255,6 +255,7 @@ def git_describe_version(original_version):
        "introduction.py",
        "install.py",
        "tvmc_command_line_driver.py",
+        "tvmc_python.py",


+1 to this, thanks!

hogepodge · 2022-01-19T01:19:36Z

docs/legacy_redirect.py

+    [
+        "tutorials/get_started/tvmc_python.html",
+        "../../tutorial/tvmc_python.html",
+    ],


Since this a new page, a redirect isn't necessary.

jroesch · 2022-01-19T21:58:19Z

@CircleSpin will you follow up with Chris's suggestion on redirect? I am going to merge as is

hogepodge · 2022-01-19T22:03:24Z

The redirect does no harm, and this PR has been sitting for too long. Thanks for merging @jroesch and especially thanks to @CircleSpin for writing up this doc.

* finish rpc and shape_dict in tut * added more to rpc * tutorial edits * added tutorial to docs in howto * accidentally had two copies of tutorial * Update gallery/how_to/use_tvms_python_api/tvmc_python.py Co-authored-by: Leandro Nunes <leandro.nunes@arm.com> * Update gallery/how_to/use_tvms_python_api/tvmc_python.py Co-authored-by: Leandro Nunes <leandro.nunes@arm.com> * Update gallery/how_to/use_tvms_python_api/tvmc_python.py Co-authored-by: Leandro Nunes <leandro.nunes@arm.com> * Update gallery/how_to/use_tvms_python_api/tvmc_python.py Co-authored-by: Leandro Nunes <leandro.nunes@arm.com> * Apply suggestions from code review Co-authored-by: Leandro Nunes <leandro.nunes@arm.com> * Update gallery/how_to/use_tvms_python_api/tvmc_python.py Co-authored-by: Leandro Nunes <leandro.nunes@arm.com> * Update gallery/how_to/use_tvms_python_api/tvmc_python.py Co-authored-by: Leandro Nunes <leandro.nunes@arm.com> * added Leandro's suggestions * added example model at top * added example model, blacked it * trying to get docs to build * underline too short for title * forgot Jetson info, added Chris H comments * reformatting text * black * hitting code block issue, trying to debug * added spaces after the python codeblock * black * changing formatting * touching up more edits' * more touchups * changed location of file to tutorial section * changing doc location * broke the order of the docs somehow * fixed it yayy * added additional indentation * black'd Co-authored-by: CircleSpin <jocelyn@pop-os.localdomain> Co-authored-by: Leandro Nunes <leandro.nunes@arm.com>

CircleSpin requested review from areusch, comaniac, icemelon, jroesch, junrushao, merrymercy, tqchen, yzhliu and a team as code owners December 2, 2021 02:18

leandron reviewed Dec 2, 2021

View reviewed changes

mbrookhart approved these changes Dec 3, 2021

View reviewed changes

leandron approved these changes Dec 3, 2021

View reviewed changes

hogepodge suggested changes Dec 3, 2021

View reviewed changes

CircleSpin force-pushed the tvmc_python_tutorial branch from d752387 to 51475dd Compare December 18, 2021 05:12

CircleSpin and others added 13 commits January 18, 2022 15:01

finish rpc and shape_dict in tut

4cc90ac

added more to rpc

60d2131

tutorial edits

0ea76cf

added tutorial to docs in howto

ce6e8a6

accidentally had two copies of tutorial

b3ff2c9

Update gallery/how_to/use_tvms_python_api/tvmc_python.py

00a0fda

Co-authored-by: Leandro Nunes <leandro.nunes@arm.com>

Update gallery/how_to/use_tvms_python_api/tvmc_python.py

d83b579

Co-authored-by: Leandro Nunes <leandro.nunes@arm.com>

Update gallery/how_to/use_tvms_python_api/tvmc_python.py

9bf946f

Co-authored-by: Leandro Nunes <leandro.nunes@arm.com>

Update gallery/how_to/use_tvms_python_api/tvmc_python.py

71e5121

Co-authored-by: Leandro Nunes <leandro.nunes@arm.com>

Apply suggestions from code review

6c4642c

Co-authored-by: Leandro Nunes <leandro.nunes@arm.com>

Update gallery/how_to/use_tvms_python_api/tvmc_python.py

871da11

Co-authored-by: Leandro Nunes <leandro.nunes@arm.com>

Update gallery/how_to/use_tvms_python_api/tvmc_python.py

0eaf858

Co-authored-by: Leandro Nunes <leandro.nunes@arm.com>

added Leandro's suggestions

26135ac

CircleSpin added 17 commits January 18, 2022 15:01

added example model at top

e621327

added example model, blacked it

a92f9ed

trying to get docs to build

3123280

underline too short for title

0df1e56

forgot Jetson info, added Chris H comments

f14f400

reformatting text

9f9d404

black

8ba2d61

hitting code block issue, trying to debug

4985e15

added spaces after the python codeblock

aee6db3

black

74b3826

changing formatting

45ac07e

touching up more edits'

0285d84

more touchups

7fcc2c8

changed location of file to tutorial section

1786f4a

changing doc location

33c6ea0

broke the order of the docs somehow

68ab249

fixed it yayy

cbf6cdc

CircleSpin force-pushed the tvmc_python_tutorial branch from 2b87c16 to cbf6cdc Compare January 18, 2022 20:02

CircleSpin added 2 commits January 18, 2022 20:07

added additional indentation

846a6e1

black'd

ac778a4

hogepodge suggested changes Jan 19, 2022

View reviewed changes

jroesch merged commit 14d0187 into apache:main Jan 19, 2022

driazati mentioned this pull request Jul 14, 2022

TVM v0.9.0.rc0 Release Candidate Notes #12102

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tvmc python tutorial #9633

Tvmc python tutorial #9633

CircleSpin commented Dec 2, 2021

leandron left a comment

mbrookhart left a comment

leandron left a comment

hogepodge left a comment

hogepodge Dec 3, 2021

CircleSpin Dec 14, 2021

CircleSpin commented Dec 14, 2021

CircleSpin commented Dec 18, 2021

leandron commented Jan 17, 2022

hogepodge left a comment

hogepodge Jan 19, 2022

hogepodge Jan 19, 2022

jroesch commented Jan 19, 2022

hogepodge commented Jan 19, 2022

Tvmc python tutorial #9633

Tvmc python tutorial #9633

Conversation

CircleSpin commented Dec 2, 2021

leandron left a comment

Choose a reason for hiding this comment

mbrookhart left a comment

Choose a reason for hiding this comment

leandron left a comment

Choose a reason for hiding this comment

hogepodge left a comment

Choose a reason for hiding this comment

hogepodge Dec 3, 2021

Choose a reason for hiding this comment

CircleSpin Dec 14, 2021

Choose a reason for hiding this comment

CircleSpin commented Dec 14, 2021

CircleSpin commented Dec 18, 2021

leandron commented Jan 17, 2022

hogepodge left a comment

Choose a reason for hiding this comment

hogepodge Jan 19, 2022

Choose a reason for hiding this comment

hogepodge Jan 19, 2022

Choose a reason for hiding this comment

jroesch commented Jan 19, 2022

hogepodge commented Jan 19, 2022