[Tutorial] tutorial to writing a costumized pass #1671

were · 2018-08-28T21:21:07Z

Thanks for contributing to TVM! Please refer to guideline https://docs.tvm.ai/contribute/ for useful information and tips. After the pull request is submitted, please request code reviews from others in the community.

tqchen · 2018-08-30T06:02:14Z

please request reviews

tqchen · 2018-08-31T17:33:00Z

@nishi-t @eqy please review

eqy · 2018-08-31T20:33:46Z

tutorials/language/pass.py

+=========================
+**Author**: `Jian Weng <https://were.github.io>`_
+
+TVM is a framework to abstract the heterogenity of those various machine learning


"that abstracts away the heterogeneity of machine learning accelerators"

eqy · 2018-08-31T20:34:16Z

tutorials/language/pass.py

+**Author**: `Jian Weng <https://were.github.io>`_
+
+TVM is a framework to abstract the heterogenity of those various machine learning
+accelerators. Sometimes users may want to customized some analysis and IR transformation


"customize some analysis and IR transformations"

Sorry. I did not look at this carefully.

eqy · 2018-08-31T20:34:33Z

tutorials/language/pass.py

+
+TVM is a framework to abstract the heterogenity of those various machine learning
+accelerators. Sometimes users may want to customized some analysis and IR transformation
+to adopt TVM to their own specialized hardware. This tutorial helps users write


"to adapt TVM to their own specialized hardware"

eqy · 2018-08-31T20:34:59Z

tutorials/language/pass.py

+a customized pass in TVM.
+ Prerequisites
+-------------
+Before reading this tutorial, we assume readers have already known these well:


"we assume readers already have good knowledge of these topics:"

I insist mine.

We can write "we assume readers already know these topics well"

eqy · 2018-08-31T20:36:17Z

tutorials/language/pass.py

+ Prerequisites
+-------------
+Before reading this tutorial, we assume readers have already known these well:
+- Writing an algorithm in TVM and schedule it. If not, you should go through other


"Writing an algorithm in TVM and scheduling it. Otherwise, see example tutorials such as GEMM on CPU."

How can I use the relative path to ref this link?

eqy · 2018-08-31T21:29:19Z

tutorials/language/pass.py

+#     Phase 0 generates the raw IR and loop levels; phase 1 flattens the storage; phase 2 transforms
+#     the loop levels, like unroll, vectorization and threading; phase 3 does some cleanup work.
+#
+# Thus, we believe after phase 1 is a good place to put this transformation pass.


"A good place to put this transformation pass is just after phase 1."

eqy · 2018-08-31T21:29:56Z

tutorials/language/pass.py

+#####################################################################
+# Summary
+# -------
+# This tutorial gives a quick view of writing a customized IR transformation pass:


"quick overview"

eqy · 2018-08-31T21:30:09Z

tutorials/language/pass.py

+# Summary
+# -------
+# This tutorial gives a quick view of writing a customized IR transformation pass:
+# - Use ``tvm.ir_pass.PostOrderVisit`` to gather information of each IR nodes.


"on each IR node."

eqy · 2018-08-31T21:30:32Z

tutorials/language/pass.py

+# This tutorial gives a quick view of writing a customized IR transformation pass:
+# - Use ``tvm.ir_pass.PostOrderVisit`` to gather information of each IR nodes.
+# - Use ``tvm.ir_pass.IRTransform`` to transform IR nodes.
+# - Wrap up two above to write a ``stmt->stmt`` function.


"wrap the two above in a ? stmt->stmt ..."

eqy · 2018-08-31T21:30:47Z

tutorials/language/pass.py

+# - Use ``tvm.ir_pass.PostOrderVisit`` to gather information of each IR nodes.
+# - Use ``tvm.ir_pass.IRTransform`` to transform IR nodes.
+# - Wrap up two above to write a ``stmt->stmt`` function.
+# - Use ``tvm.build_config`` to glue this function to TVM lower pass


"to a TVM lower pass."

xqdan · 2018-09-01T00:59:41Z

How can I do MergeSeq or MergeNest in python, should we expose these api to python?

were · 2018-09-01T05:07:14Z

@xqdan Can you make the question more specific?
At the first glance I even suppose this question is not related at all.

were · 2018-09-01T05:07:45Z

@eqy I resolved your requests!

xqdan · 2018-09-01T06:23:06Z

@were that's the problem when I wrote a python pass, we may need more until api for writing a pass.

were · 2018-09-01T09:42:01Z

@xqdan Can you be more specific? What util (I suppose ur 'until' is typo) do you need?

xqdan · 2018-09-01T10:27:22Z

@were I mean we may need more utility functions when writing python pass, eg. MergeNest in c++,
https://github.com/dmlc/tvm/blob/b95b5958913927b90463dddb61eb18ef6e1556f6/src/pass/ir_util.cc#L11

were · 2018-09-01T16:44:25Z

@xqdan but it is not stmt->stmt mapping at all.

were · 2018-09-01T16:44:57Z

also, i believe this c++ code can be done in equivalent python in tvm

xqdan · 2018-09-02T00:53:46Z

@were consider you want to insert two new stmts before a stmt, and one new stmt after it, how do you do that? that's usual requirement when you writing a pass.

xqdan · 2018-09-02T00:59:29Z

@were actually it's stmt -> stmt, because stmt can be big, can be small, the whole AST can be a stmt, which also can be divided into small ones

anything we have had in c++, we can register them to python, you need not to implement again in python.

were · 2018-09-02T17:22:19Z

@xqdan Eazy! You can just go to the node before which you want to inject to statement and transform it to a block statement.

were · 2018-09-03T05:35:47Z

@tqchen My changes have been approved.

yzhliu · 2018-09-04T05:22:25Z

@were could you help to retrigger the CI?

were · 2018-09-04T17:03:34Z

@yzhliu I have done.

tqchen · 2018-09-04T18:59:48Z

tutorials/language/pass.py

@@ -0,0 +1,153 @@
+"""


pass -> low_level_custom_pass.py

tqchen · 2018-09-04T19:00:51Z

tutorials/language/pass.py

@@ -0,0 +1,153 @@
+"""
+Writing a Customized Pass
+=========================


Let us put it under tutorials/dev

were · 2018-09-04T19:49:27Z

@tqchen Done.

tqchen · 2018-09-04T20:06:26Z

need to update ordering here
https://github.com/dmlc/tvm/blob/master/docs/conf.py#L196
and add a file like https://github.com/dmlc/tvm/blob/master/tutorials/autotvm/README.txt

were · 2018-09-04T21:52:18Z

@tqchen Done.

tqchen · 2018-09-05T05:45:29Z

Thanks @were @eqy @xqdan , this is now merged.

were mentioned this pull request Aug 30, 2018

[DOC][Tutorial] How to write a pass in python #1308

Closed

tqchen added the status: need review label Aug 30, 2018

eqy reviewed Aug 31, 2018

View reviewed changes

were force-pushed the tutorial branch from 119147e to 035e8fd Compare September 1, 2018 00:23

eqy approved these changes Sep 3, 2018

View reviewed changes

tqchen requested changes Sep 4, 2018

View reviewed changes

tutorials/language/pass.py Outdated

@@ -0,0 +1,153 @@

"""

Copy link

Member

tqchen Sep 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pass -> low_level_custom_pass.py

tqchen requested changes Sep 4, 2018

View reviewed changes

were force-pushed the tutorial branch 2 times, most recently from f126cd1 to edbd878 Compare September 4, 2018 19:49

Jian Weng added 4 commits September 4, 2018 12:51

tvm pass tutorial

5ab146d

fix comment typo

1a42325

unproficient usage of doxygen

cc1f8a7

i hope this time it works?

7803acc

Jian Weng added 7 commits September 4, 2018 12:51

at least let me know what the problem is

b3ee1f8

is it safe to copy it from git log?

938fecb

wo bei bu ke jian zi fu keng le!

cc00ca3

where does this eof come from

6103ee2

xiu gai cuo ci

fe17c1b

move it to dev/low_level_custom_pass.py

0b929c9

remove the old one

edbd878

Jian Weng added 2 commits September 4, 2018 14:54

update config and add readme

407247a

forgotten comma

bf41d7c

tqchen approved these changes Sep 5, 2018

View reviewed changes

tqchen merged commit d173e63 into apache:master Sep 5, 2018

ZhennanQin pushed a commit to ZhennanQin/tvm that referenced this pull request Sep 6, 2018

[Tutorial] tutorial to writing a costumized pass (apache#1671)

134b4b9

kevinthesun pushed a commit to kevinthesun/tvm that referenced this pull request Sep 6, 2018

[Tutorial] tutorial to writing a costumized pass (apache#1671)

0eb217e

were deleted the tutorial branch September 10, 2018 01:38

FrozenGene pushed a commit to FrozenGene/tvm that referenced this pull request Dec 27, 2018

[Tutorial] tutorial to writing a costumized pass (apache#1671)

f788ff5

[Tutorial] tutorial to writing a costumized pass #1671

[Tutorial] tutorial to writing a costumized pass #1671

Conversation

were commented Aug 28, 2018

tqchen commented Aug 30, 2018

tqchen commented Aug 31, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xqdan commented Sep 1, 2018

were commented Sep 1, 2018

were commented Sep 1, 2018

xqdan commented Sep 1, 2018

were commented Sep 1, 2018

xqdan commented Sep 1, 2018

were commented Sep 1, 2018

were commented Sep 1, 2018

xqdan commented Sep 2, 2018 • edited Loading

xqdan commented Sep 2, 2018 • edited Loading

were commented Sep 2, 2018

were commented Sep 3, 2018

yzhliu commented Sep 4, 2018

were commented Sep 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

were commented Sep 4, 2018

tqchen commented Sep 4, 2018

were commented Sep 4, 2018

tqchen commented Sep 5, 2018

xqdan commented Sep 2, 2018 •

edited

Loading

xqdan commented Sep 2, 2018 •

edited

Loading