[DOC] Restore tensor method docs (ndim, numel, size, is_contiguous) - #616
Closed
tqchen wants to merge 1 commit into
Conversation
…ithout warnings PR apache#607 commit ae58d90 removed ndim/numel/size/is_contiguous from the Python API index page after a previous qualified-name attempt produced "duplicate object description" warnings. However the assumption that "the Tensor autoclass already documents them" only held for the Tensor sub-page (generated/tvm_ffi.Tensor.html); those four methods had no individual entries on the top-level index page. Fix: add a "Tensor methods" rubric with an `autosummary` block (no :toctree:) for the four qualified names (Tensor.ndim etc.). Without :toctree:, sphinx generates no stub pages, so there is no second sphinx-domain registration and no duplicate warning. The entries produce a summary table on the index page with links to the existing Tensor class page anchors (generated/tvm_ffi.Tensor.html#tvm_ffi.Tensor.*). Verification: baseline 0 warnings, after-fix 0 warnings; all four methods render on the index page with correct href anchors.
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the Python reference documentation in docs/reference/python/index.rst by adding a 'Tensor methods' rubric and autosummary for Tensor.ndim, Tensor.numel, Tensor.size, and Tensor.is_contiguous. I have no feedback to provide as there are no review comments.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
tqchen
deleted the
tvm-ffi-restore-ndim-numel-size-is-contiguous-in-docs-without-duplicate-object-description-warnings
branch
June 8, 2026 20:26
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
[DOC] Restore tensor method docs (ndim, numel, size, is_contiguous) without warnings
PR #607 commit ae58d90 removed ndim/numel/size/is_contiguous from the Python API
index page after a previous qualified-name attempt produced "duplicate object
description" warnings. However the assumption that "the Tensor autoclass already
documents them" only held for the Tensor sub-page (generated/tvm_ffi.Tensor.html);
those four methods had no individual entries on the top-level index page.
Fix: add a "Tensor methods" rubric with an
autosummaryblock (no :toctree:) forthe four qualified names (Tensor.ndim etc.). Without :toctree:, sphinx generates no
stub pages, so there is no second sphinx-domain registration and no duplicate warning.
The entries produce a summary table on the index page with links to the existing
Tensor class page anchors (generated/tvm_ffi.Tensor.html#tvm_ffi.Tensor.*).
Verification: baseline 0 warnings, after-fix 0 warnings; all four methods render on
the index page with correct href anchors.