This is an automated email from the ASF dual-hosted git repository.
mshr pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tvm.git
The following commit(s) were added to refs/heads/main by this push:
new 73a188fb5b Add Windows-specific build notes to installation guide
(#18705)
73a188fb5b is described below
commit 73a188fb5bfc68bf72ca7aa4951f26a0e3323d40
Author: AshwiniBokka <[email protected]>
AuthorDate: Sun Feb 8 21:55:06 2026 +0530
Add Windows-specific build notes to installation guide (#18705)
## Summary
Adds Windows-specific build notes to the TVM installation documentation
(`docs/install/from_source.rst`).
## Changes
- Added "Windows-Specific Build Notes" section after "Step 5. Extra
Python Dependencies"
- Covers common Windows issues and solutions based on contributor
experience
## Content Includes:
1. **File Encoding**: UTF-8 without BOM (prevents `SyntaxError: invalid
non-printable character U+FEFF` in CI)
2. **Path Conventions**: Forward vs backslash usage in Python/CMake
3. **CUDA Configuration**: Environment setup for CUDA builds on Windows
4. **CMake & Compiler**: Visual Studio generator setup and Python path
configuration
5. **Common Issues**: Solutions for frequent Windows build problems
6. **Development Tips**: Git configuration for line endings, VS Code
settings
7. **WSL2 Alternative**: Linux-like environment option for Windows users
## Motivation
As a Windows contributor to TVM, I encountered several platform-specific
issues that could be prevented with better documentation. These notes
will help future Windows users:
- Avoid BOM character errors that cause CI failures
- Configure paths correctly for TVM's build system
- Set up CUDA development environment on Windows
- Troubleshoot common Windows-specific build failures
## Testing
- Verified RST syntax and formatting
- Checked logical placement within document flow
- Content based on actual Windows development experience with TVM
## Related
- Previous contribution: #18697 (improved tutorial error handling)
- Addresses undocumented Windows-specific considerations in build
process
---
docs/install/from_source.rst | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/docs/install/from_source.rst b/docs/install/from_source.rst
index ee81f84778..9dd310e43b 100644
--- a/docs/install/from_source.rst
+++ b/docs/install/from_source.rst
@@ -232,6 +232,18 @@ The following commands can be used to install the extra
Python dependencies:
pip3 install tornado psutil 'xgboost>=1.1.0' cloudpickle
+.. _windows-build-notes:
+
+Windows-Specific Build Notes
+----------------------------
+
+If you're building TVM on Windows, note these platform-specific considerations:
+
+Path Conventions
+................
+- Use forward slashes (``/``) in Python/CMake paths, not Windows backslashes
+- Example: ``python cmake/config.cmake`` not ``python cmake\\config.cmake``
+
Advanced Build Configuration
----------------------------
@@ -275,6 +287,21 @@ You can then run the following command to build
cmake --build build --config Release -- /m
+CUDA Configuration
+..................
+For CUDA support on Windows:
+
+.. code-block:: batch
+
+ set CUDA_PATH=C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.8
+ set PATH=%CUDA_PATH%\bin;%PATH%
+ cmake .. -DUSE_CUDA=ON
+
+CMake & Compiler Setup
+......................
+- Specify generator: ``cmake -G "Visual Studio 16 2019" -A x64 ..``
+- Ensure Python is in PATH or specify:
``-DPython_EXECUTABLE=C:\Python39\python.exe``
+
Building ROCm support
~~~~~~~~~~~~~~~~~~~~~
