Skip to content

[Docs] Add API reference for tvm.arith, tvm.testing, tvm.exec, tvm.tirx.backend and extend topi/contrib/ir/target docs #19379

Open
tlopex wants to merge 3 commits intoapache:mainfrom
tlopex:doc171
Open

[Docs] Add API reference for tvm.arith, tvm.testing, tvm.exec, tvm.tirx.backend and extend topi/contrib/ir/target docs #19379
tlopex wants to merge 3 commits intoapache:mainfrom
tlopex:doc171

Conversation

@tlopex
Copy link
Copy Markdown
Member

@tlopex tlopex commented Apr 10, 2026

as per title

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request expands the Python API documentation by adding several new modules and sub-modules, including tvm.arith, tvm.exec, tvm.testing, and various components within contrib, ir, target, tirx, and topi. Feedback focuses on maintaining alphabetical order in the main index and ensuring consistent heading styles and non-redundant titles in the newly created documentation files.


error
ir
arith
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The module arith is inserted out of alphabetical order. For better maintainability and navigation, the toctree entries should be sorted alphabetically (e.g., arith should be the first entry in this list).

Comment on lines +32 to +33
testing
exec
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

These entries are not sorted alphabetically. exec should come before testing.

Suggested change
testing
exec
exec
testing

tirx/analysis
tirx/stmt_functor
tirx/transform
tirx/backend
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The module tirx/backend is added at the end of the list, which breaks the alphabetical order. It should ideally follow tirx/analysis.

Comment on lines +18 to +31
tvm.tirx.backend
================

tvm.tirx.backend
*****************
.. automodule:: tvm.tirx.backend
:members:
:imported-members:

tvm.tirx.backend.adreno
***********************
.. automodule:: tvm.tirx.backend.adreno
:members:
:imported-members:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The heading style in this file is inconsistent with other API reference files in this directory (which typically use - for the main title and ~ for sub-sections). Additionally, the title tvm.tirx.backend is redundant as it appears twice.

Please ensure the underline length matches the title length exactly.

Suggested change
tvm.tirx.backend
================
tvm.tirx.backend
*****************
.. automodule:: tvm.tirx.backend
:members:
:imported-members:
tvm.tirx.backend.adreno
***********************
.. automodule:: tvm.tirx.backend.adreno
:members:
:imported-members:
tvm.tirx.backend
----------------
.. automodule:: tvm.tirx.backend
:members:
:imported-members:
tvm.tirx.backend.adreno
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: tvm.tirx.backend.adreno
:members:
:imported-members:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant