[Docs] Add TVMScript architecture documentation#19398
[Docs] Add TVMScript architecture documentation#19398MasterJH5574 merged 1 commit intoapache:mainfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a detailed architectural overview of TVMScript, including its parser, IR builder, and printer systems, along with syntax references for TIR and Relax. The review feedback suggests improving the documentation by correcting the R.call_dps_packed signature and standardizing the naming of TIR control flow constructs for better consistency.
|
|
||
| - ``R.call_tir(func, args, out_sinfo)`` — call a TIR function | ||
| - ``R.call_packed(name, *args)`` — call a PackedFunc | ||
| - ``R.call_dps_packed(func, *args)`` — call using destination-passing style |
There was a problem hiding this comment.
The signature for R.call_dps_packed should include out_sinfo to be consistent with the R.call_tir entry above and to accurately reflect the required arguments in Relax TVMScript.
| - ``R.call_dps_packed(func, *args)`` — call using destination-passing style | |
| - ``R.call_dps_packed(func, args, out_sinfo)`` — call using destination-passing style |
| - TIR ``If`` branch (PrimExpr condition) or static eval (Python bool) | ||
| - Relax ``If`` node (plain Python ``if cond:`` syntax) | ||
| * - ``while`` | ||
| - ``T.While`` loop |
There was a problem hiding this comment.
In the TIR column, it is more accurate to refer to the construct as TIR While loop to match the naming convention used for TIR If branch in the same table, or use the actual builder function T.while_loop.
| - ``T.While`` loop | |
| - TIR While loop |
2 participants
This PR adds architecture documentation for TVMScript, the Python-based DSL used to author and inspect TVM IR.
TVMScript is used throughout the codebase (deep dive tutorials, tests, examples) but previously had no documentation explaining its own design or syntax. Users could only learn TVMScript by reading examples in TIR/Relax tutorials. So this PR adds a doc for it.