This is an automated email from the ASF dual-hosted git repository.
ruihangl 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 c7af8e46e9 [DOC] Update installation docs with missing dependencies
(#18194) (#18808)
c7af8e46e9 is described below
commit c7af8e46e9577447e1c5d496752577d6914b659c
Author: AshwiniBokka <[email protected]>
AuthorDate: Thu Feb 26 21:31:47 2026 +0530
[DOC] Update installation docs with missing dependencies (#18194) (#18808)
Fixes #18194
Based on user report, the installation documentation was missing:
1. System dependencies (zlib1g-dev, libxml2-dev)
2. Cython in Python dependencies
3. Post-build installation step (cd python && pip install -e .)
This PR adds these missing steps to `from_source.rst`:
- Added 'System Dependencies' section with Ubuntu commands
- Added Cython to the necessary dependencies
- Added 'Installing the Python Package' section after build
Changes:
- 24 insertions, 1 deletion
- Only 1 file changed (docs/install/from_source.rst)
This addresses all 4 issues reported by the user in #18194.
---
docs/install/from_source.rst | 22 ++++++++++++++++------
1 file changed, 16 insertions(+), 6 deletions(-)
diff --git a/docs/install/from_source.rst b/docs/install/from_source.rst
index 3a496b83d5..a016f5ab19 100644
--- a/docs/install/from_source.rst
+++ b/docs/install/from_source.rst
@@ -43,7 +43,18 @@ Apache TVM requires the following dependencies:
- Python (>= 3.8)
- (Optional) Conda (Strongly Recommended)
-To easiest way to manage dependency is via conda, which maintains a set of
toolchains
+System Dependencies (Non-Conda)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+If you are not using Conda, TVM requires several system libraries. On
Ubuntu/Debian systems, install them with:
+
+.. code:: bash
+
+ sudo apt update
+ sudo apt install zlib1g-dev libxml2-dev
+
+For other operating systems, please refer to your package manager
documentation.
+
+The easiest way to manage dependency is via conda, which maintains a set of
toolchains
including LLVM across platforms. To create the environment of those build
dependencies,
one may simply use:
@@ -60,7 +71,6 @@ one may simply use:
# enter the build environment
conda activate tvm-build-venv
-
Step 2. Get Source from GitHub
------------------------------
You can also choose to clone the source repo from GitHub.
@@ -211,13 +221,16 @@ Please note that the commands above verify the presence
of an actual device on t
Step 5. Extra Python Dependencies
---------------------------------
Building from source does not ensure the installation of all necessary Python
dependencies.
+
+Python Dependencies
+~~~~~~~~~~~~~~~~~~~
The following commands can be used to install the extra Python dependencies:
* Necessary dependencies:
.. code:: bash
- pip3 install numpy
+ pip3 install numpy cython
* If you want to use RPC Tracker
@@ -231,9 +244,6 @@ 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
----------------------------
