This is an automated email from the ASF dual-hosted git repository. tqchen pushed a commit to branch script/canonical-parser-df in repository https://gitbox.apache.org/repos/asf/tvm.git
commit 9315f37d738fb6803d60ff18810383c890bb8d7b Author: Tianqi Chen <[email protected]> AuthorDate: Tue Sep 22 23:16:39 2026 +0000 [FR] Document canonical script APIs without duplicate indexing --- docs/arch/tvmscript.rst | 49 ------------------------- docs/reference/api/python/script/ir_builder.rst | 3 ++ docs/reference/api/python/script/parser.rst | 3 ++ docs/reference/api/python/script/script.rst | 15 ++++++++ docs/tirx/api/script.rst | 6 +-- python/tvm/relax/script/builder/__init__.py | 2 + python/tvm/relax/script/builder/ir.py | 2 + python/tvm/script/ir_builder/ir/ir.py | 1 + python/tvm/tirx/op.py | 16 ++++++++ 9 files changed, 45 insertions(+), 52 deletions(-) diff --git a/docs/arch/tvmscript.rst b/docs/arch/tvmscript.rst index d8e6d10429..01a8b32fb3 100644 --- a/docs/arch/tvmscript.rst +++ b/docs/arch/tvmscript.rst @@ -596,52 +596,3 @@ boolean type. Both branches are required. else: result = R.multiply(x, x) return result - - -Source Code Map ---------------- - -.. list-table:: - :header-rows: 1 - :widths: 50 50 - - * - Path - - Contents - * - ``python/tvm/script/parser/frontend.py`` - - Source acquisition, decorators/helpers, definition context, callable recomposition - * - ``python/tvm/script/parser/transpile.py`` - - Python AST transformation and lexical syntax lowering - * - ``python/tvm/script/parser/expression.py`` and ``python/tvm/script/parser/protocol.py`` - - Expression-string rewriting and registered callable syntax policies - * - ``python/tvm/script/parser/jit.py`` - - JIT argument validation, specialization inputs, and caching - * - ``python/tvm/script/parser/ir.py`` - - Public ``I`` namespace and module-level entry points - * - ``python/tvm/script/ir_builder/base.py`` - - IRBuilder context, frame stack, and source-span support - * - ``python/tvm/script/ir_builder/construction.py`` - - Runtime function declarations, specialization context, and construction state - * - ``python/tvm/script/ir_builder/parser_support.py`` and ``python/tvm/script/ir_builder/type_var_frame.py`` - - Shared parser-facing builder support and function-local symbolic identity - * - ``python/tvm/tirx/script/`` and ``python/tvm/relax/script/`` - - Public dialect namespaces exposed through ``tvm.script`` - * - ``python/tvm/tirx/script/builder/`` - - TIR frame types and concrete construction operations - * - ``python/tvm/relax/script/builder/`` - - Relax frame types and concrete construction operations - * - ``python/tvm/script/ir_builder/ir/`` - - IRModule construction and module-owned global information - * - ``src/script/printer/`` - - Shared C++ printer: Doc tree, IRDocsifier, Python code generation - * - ``src/tirx/script/printer/`` and ``src/relax/script/printer/`` - - Dialect-specific IR-to-Doc converters - * - ``src/script/ir_builder/`` - - Shared C++ builder context and module construction - * - ``src/tirx/script/builder/`` and ``src/relax/script/builder/`` - - C++ dialect construction frames and operations - * - ``include/tvm/script/printer/`` - - Shared C++ printer interfaces - * - ``include/tvm/script/ir_builder/`` - - Shared C++ builder and module-frame interfaces - * - ``include/tvm/tirx/script/builder/`` and ``include/tvm/relax/script/builder/`` - - C++ dialect builder interfaces diff --git a/docs/reference/api/python/script/ir_builder.rst b/docs/reference/api/python/script/ir_builder.rst index 201090a0e4..a6076eab59 100644 --- a/docs/reference/api/python/script/ir_builder.rst +++ b/docs/reference/api/python/script/ir_builder.rst @@ -23,17 +23,20 @@ tvm.script.ir_builder .. automodule:: tvm.script.ir_builder :members: :imported-members: + :exclude-members: Any tvm.script.ir_builder.ir ************************ .. automodule:: tvm.script.ir_builder.ir :members: :imported-members: + :exclude-members: GenericConst, Range, StringImm, StringType tvm.script.ir_builder.relax *************************** .. automodule:: tvm.script.ir_builder.relax :members: + :exclude-members: ExternFunc, ShapeExpr, TupleGetItem, Range tvm.script.ir_builder.relax.distributed *************************************** diff --git a/docs/reference/api/python/script/parser.rst b/docs/reference/api/python/script/parser.rst index 583b27b276..238d7d3c69 100644 --- a/docs/reference/api/python/script/parser.rst +++ b/docs/reference/api/python/script/parser.rst @@ -24,6 +24,9 @@ tvm.script.parser :members: :imported-members: +The dialect aliases below share the public construction namespaces documented +in :doc:`script`. Parser entry points above use the canonical frontend. + tvm.script.parser.ir ******************** .. automodule:: tvm.script.parser.ir diff --git a/docs/reference/api/python/script/script.rst b/docs/reference/api/python/script/script.rst index 5e819bd1bb..35443462f9 100644 --- a/docs/reference/api/python/script/script.rst +++ b/docs/reference/api/python/script/script.rst @@ -23,13 +23,28 @@ tvm.script .. automodule:: tvm.script :members: :imported-members: + :exclude-members: Any tvm.script.relax **************** .. automodule:: tvm.script.relax :members: + :exclude-members: ExternFunc, ShapeExpr, TupleGetItem, Range + +.. autofunction:: tvm.script.relax.function + +.. autofunction:: tvm.script.relax.macro tvm.script.tirx *************** .. automodule:: tvm.script.tirx :members: + :exclude-members: Range, meta_var, Var, Call, CommReducer, Reduce, SMEMPool, TMEMPool, FloatImm, IntImm, Cast, Add, Sub, Mul, Div, Mod, FloorDiv, FloorMod, LShift, RShift, BitwiseAnd, BitwiseOr, BitwiseXor, BitwiseNot, Min, Max, EQ, NE, LT, LE, GT, GE, And, Or, Not, Select, Ramp, Broadcast, Shuffle, CallEffectKind, IterVar + +.. autofunction:: tvm.script.tirx.prim_func + +.. autofunction:: tvm.script.tirx.jit + +.. autofunction:: tvm.script.tirx.inline + +.. autofunction:: tvm.script.tirx.macro diff --git a/docs/tirx/api/script.rst b/docs/tirx/api/script.rst index f30d508095..8d905e11f5 100644 --- a/docs/tirx/api/script.rst +++ b/docs/tirx/api/script.rst @@ -30,10 +30,10 @@ authoring layers and TIRx IR, see :ref:`tirx-programming-model`. Parser entry points ------------------- -.. automodule:: tvm.tirx.script.parser.entry - :members: +.. automodule:: tvm.script.tirx + :members: prim_func, jit, inline, macro + :undoc-members: :no-index: - :exclude-members: TIRInline Core IR builder --------------- diff --git a/python/tvm/relax/script/builder/__init__.py b/python/tvm/relax/script/builder/__init__.py index 6ae73e36b7..0916172af1 100644 --- a/python/tvm/relax/script/builder/__init__.py +++ b/python/tvm/relax/script/builder/__init__.py @@ -215,6 +215,7 @@ def frame_result(completed_frame, name): def function(is_pure=True, is_private=False, *, local=False, reference=None, span=None): """Start a function frame. + Parameters ---------- is_pure: bool @@ -249,6 +250,7 @@ def decl_function(is_pure=True, is_private=False, *, local=False, span=None): def arg(name, ty, *, span=None): """Add a parameter to the last function frame. + Parameters ---------- name: str diff --git a/python/tvm/relax/script/builder/ir.py b/python/tvm/relax/script/builder/ir.py index 2a2c207ba9..15d0598904 100644 --- a/python/tvm/relax/script/builder/ir.py +++ b/python/tvm/relax/script/builder/ir.py @@ -252,6 +252,7 @@ def to_vdevice(data: Expr, dst_vdevice: py_str | VDevice) -> Expr: def function(is_pure: bool = True, is_private: bool = False) -> frame.FunctionFrame: """Start a function frame. + Parameters ---------- is_pure: bool @@ -272,6 +273,7 @@ def function(is_pure: bool = True, is_private: bool = False) -> frame.FunctionFr def arg(name: py_str, ty: Type) -> Var: """Add a parameter to the last function frame. + Parameters ---------- name: str diff --git a/python/tvm/script/ir_builder/ir/ir.py b/python/tvm/script/ir_builder/ir/ir.py index d568450338..4befa2d6fd 100644 --- a/python/tvm/script/ir_builder/ir/ir.py +++ b/python/tvm/script/ir_builder/ir/ir.py @@ -230,6 +230,7 @@ def vdevice(target=None, vdevice_id: int = 0, memory_scope: str = "global") -> " def lookup_vdevice(target_kind: str | None = None, device_index: int = -1) -> "VDevice": """Retrieve a virtual device from the globalinfo vdevice list. + Parameters ---------- target_kind: str diff --git a/python/tvm/tirx/op.py b/python/tvm/tirx/op.py index 2369f9d5b5..115f739b07 100644 --- a/python/tvm/tirx/op.py +++ b/python/tvm/tirx/op.py @@ -2980,10 +2980,14 @@ def TVMBackendFreeWorkspace(device_type, device_id, ptr): def anylist_getitem(list_handle, index): """Returns an item from any list. + + Parameters + ---------- list_handle: Var The handle to anylist index : int The index + Returns ------- call : Expr @@ -2994,10 +2998,14 @@ def anylist_getitem(list_handle, index): def anylist_resetitem(list_handle, index): """Reset an item from any list. + + Parameters + ---------- list_handle: Var The handle to anylist index : int The index + Returns ------- call : Expr @@ -3008,6 +3016,9 @@ def anylist_resetitem(list_handle, index): def anylist_setitem_call_packed(list_handle, index, func_name, *args): """Set anylist item by result of packed call. + + Parameters + ---------- list_handle: Var The handle to anylist index : int @@ -3016,6 +3027,7 @@ def anylist_setitem_call_packed(list_handle, index, func_name, *args): The name of the function to be called. args: Extra arguments + Returns ------- call : Expr @@ -3028,6 +3040,9 @@ def anylist_setitem_call_packed(list_handle, index, func_name, *args): def anylist_setitem_call_cpacked(list_handle, index, func_name, *args): """Set anylist item by result of packed call. + + Parameters + ---------- list_handle: Var The handle to anylist index : int @@ -3036,6 +3051,7 @@ def anylist_setitem_call_cpacked(list_handle, index, func_name, *args): The name of the function to be called. args: Extra arguments + Returns ------- call : Expr
