[Docs] Reorganize development guide content#19606
Conversation
There was a problem hiding this comment.
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.
| # cp cross_build/lib/libtvm_ffi.so tvm_runtime_package/python/tvm/ | ||
| # cp cross_build/lib/libtvm_runtime*.so tvm_runtime_package/python/tvm/ |
There was a problem hiding this comment.
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.
| # 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/ |
| # Build any target-specific runtime libraries that your deployment needs, such | ||
| # as ``tvm_runtime_opencl`` for OpenCL. |
There was a problem hiding this comment.
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.
| # 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. |
| # # Optional example when USE_OPENCL is enabled: | ||
| # # cmake --build . --target tvm_runtime_opencl -j |
There was a problem hiding this comment.
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.
| # # Optional example when USE_OPENCL is enabled: | |
| # # cmake --build . --target tvm_runtime_opencl -j | |
| # # OpenCL support is included in the main runtime target. |
| report, include the following details when starting a new discussion or | ||
| filing an issue: | ||
|
|
||
| - The TVM version or git commit hash. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Thanks, that makes sense. Would update the doc once you finish
This PR removes the old “Development Guides” bucket and folds its remaining pages into more appropriate parts of the documentation.