[Docs] Align documentation with tirx/s_tir namespace split#18953
[Docs] Align documentation with tirx/s_tir namespace split#18953tlopex wants to merge 4 commits intoapache:mainfrom
Conversation
|
cc @tqchen |
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to reflect the architectural split of the tir module into tirx (core IR and lowering) and s_tir (scheduling and tuning). It replaces internal terminology with more descriptive terms like 'TensorIR' and 'TIR' across several architecture and runtime guides. A suggestion was made to clarify the TVMScript entry point description to better explain how users interact with these modules.
| In TVMScript, both modules are accessed via | ||
| ``from tvm.script import tirx as T``. |
There was a problem hiding this comment.
For better clarity, this sentence could be rephrased to emphasize that tirx is the user-facing entry point in TVMScript. The current phrasing 'both modules are accessed via' might be slightly confusing as it's not immediately clear how s_tir components are accessed through the tirx import.
| In TVMScript, both modules are accessed via | |
| ``from tvm.script import tirx as T``. | |
| In TVMScript, the `tirx` Python module is the main entrypoint for | |
| writing TensorIR functions, and is typically imported as `T`: ``from tvm.script import tirx as T``. |
Since we've split the old
tirnamespace intotirx(core IR / lowering) ands_tir(schedule primitives / auto-tuning), some outdated documentation need to be updated. The global rename still leaves a few concept-level references using "tirx" in prose (for example, "Relax and tirx programs"). Since "tirx" now refers only to one part of the old TensorIR stack, these higher-level references should use "TensorIR" instead, so they correctly cover bothtirxands_tir.In this PR, we
docs/deep_dive/tensor_ir/index.rstanddocs/arch/index.rst(newtvm/s_tirsection, updatedtvm/tirxsection).docs/arch/index.rstanddocs/arch/pass_infra.rstto use "TensorIR" instead of "tirx" where referring to the concept rather than the namespace.docs/arch/runtimes/vulkan.rstto use "TIR" instead of "tirx" in debug shader description.tvm/dlight→tvm/s_tir/dlightsection path and "tirx schedules" → "s_tir schedules" indocs/arch/index.rst.abstraction.rstandtir_creation.py(labels kept as_tir-abstraction,_tir-creation).tir_transformation.py(kept as "Transformation").exclude-memberschange intirx/tirx.rst(kept original list).