Skip to content

[Docs] Reorganize development guide content#19606

Open
tlopex wants to merge 2 commits into
apache:mainfrom
tlopex:fix227-docs-dev-guides
Open

[Docs] Reorganize development guide content#19606
tlopex wants to merge 2 commits into
apache:mainfrom
tlopex:fix227-docs-dev-guides

Conversation

@tlopex
Copy link
Copy Markdown
Member

@tlopex tlopex commented May 25, 2026

This PR removes the old “Development Guides” bucket and folds its remaining pages into more appropriate parts of the documentation.

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 reorganizes and updates the TVM documentation, specifically integrating the RPC setup guide directly into the cross-compilation and RPC tutorial, updating the TVM errors troubleshooting page, and adjusting index links. The reviewer pointed out several inaccuracies in the tutorial's instructions regarding TVM's build output structure and target names, particularly that OpenCL support is built directly into the main runtime library rather than as a separate target, and that the runtime library is compiled directly into the build directory as libtvm_runtime.so rather than a lib/ subdirectory.

Comment on lines +308 to +309
# cp cross_build/lib/libtvm_ffi.so tvm_runtime_package/python/tvm/
# cp cross_build/lib/libtvm_runtime*.so tvm_runtime_package/python/tvm/
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

In TVM, compiled libraries are output directly to the build directory (e.g., cross_build/), not to a lib/ subdirectory. Additionally, there is no libtvm_ffi.so library in TVM; the runtime library is named libtvm_runtime.so. We should update these commands to copy libtvm_runtime.so from the correct path.

Suggested change
# cp cross_build/lib/libtvm_ffi.so tvm_runtime_package/python/tvm/
# cp cross_build/lib/libtvm_runtime*.so tvm_runtime_package/python/tvm/
# cp cross_build/libtvm_runtime.so tvm_runtime_package/python/tvm/

Comment on lines +282 to +283
# Build any target-specific runtime libraries that your deployment needs, such
# as ``tvm_runtime_opencl`` for OpenCL.
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

In TVM, OpenCL support is compiled directly into the main libtvm_runtime.so library when USE_OPENCL is enabled in config.cmake. There is no separate tvm_runtime_opencl library target. We should update this text to reflect that OpenCL support is built directly into the main runtime library.

Suggested change
# Build any target-specific runtime libraries that your deployment needs, such
# as ``tvm_runtime_opencl`` for OpenCL.
# OpenCL support is built directly into the main runtime library.

Comment on lines +296 to +297
# # Optional example when USE_OPENCL is enabled:
# # cmake --build . --target tvm_runtime_opencl -j
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

Since OpenCL support is built directly into the main runtime target, there is no separate tvm_runtime_opencl target in TVM's CMake configuration. We should update this comment to clarify that OpenCL support is included in the main runtime target.

Suggested change
# # Optional example when USE_OPENCL is enabled:
# # cmake --build . --target tvm_runtime_opencl -j
# # OpenCL support is included in the main runtime target.

Comment thread docs/errors.rst
report, include the following details when starting a new discussion or
filing an issue:

- The TVM version or git commit hash.
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.

Just a quick comment that we may have to provide a script for collecting environment so users don't have to manually collect them.
I've prototyped it based on pytorch's collect_env.py.
https://github.com/mshr-h/tvm-collect-env

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks, that makes sense. Would update the doc once you finish

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.

2 participants