This is an automated email from the ASF dual-hosted git repository.
tlopex 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 68429af88b [DOCS] Add PyPI install guidance and update install command
(#19883)
68429af88b is described below
commit 68429af88bdb889ebf1583b643b1114559db641b
Author: Shushi Hong <[email protected]>
AuthorDate: Wed Jun 24 23:08:39 2026 -0400
[DOCS] Add PyPI install guidance and update install command (#19883)
This PR updates the TVM installation documentation
---
docs/install/index.rst | 14 ++++++++++----
docs/install/{index.rst => pypi.rst} | 27 ++++++++++++++-------------
docs/tirx/install.rst | 2 +-
3 files changed, 25 insertions(+), 18 deletions(-)
diff --git a/docs/install/index.rst b/docs/install/index.rst
index 8e4af2821e..48be303498 100644
--- a/docs/install/index.rst
+++ b/docs/install/index.rst
@@ -23,13 +23,19 @@ Installing TVM
.. toctree::
:maxdepth: 1
+ pypi
from_source
docker
-Visit the :ref:`install TVM from source <install-from-source>` page to install
TVM from the source code. Installing
-from source gives you the maximum flexibility to configure the build
effectively from the official source releases.
-If you are interested in deploying to mobile or embedded devices, you do not
need to
-install the entire TVM stack on your device. Instead, you only need the
runtime.
+For most Python users, the quickest way to get started is to
+:ref:`install the Apache TVM wheel from PyPI <install-from-pypi>`.
+
+Visit the :ref:`install TVM from source <install-from-source>` page to install
+TVM from the source code. Installing from source gives you the maximum
+flexibility to configure the build effectively from the official source
+releases. If you are interested in deploying to mobile or embedded devices,
+you do not need to install the entire TVM stack on your device. Instead, you
+only need the runtime.
If you would like to quickly try out TVM or run some demo and tutorials, you
can :ref:`install from Docker <docker-images>`.
diff --git a/docs/install/index.rst b/docs/install/pypi.rst
similarity index 56%
copy from docs/install/index.rst
copy to docs/install/pypi.rst
index 8e4af2821e..095835312f 100644
--- a/docs/install/index.rst
+++ b/docs/install/pypi.rst
@@ -15,21 +15,22 @@
specific language governing permissions and limitations
under the License.
-.. _installation:
+.. _install-from-pypi:
-Installing TVM
-==============
+Install from PyPI
+=================
-.. toctree::
- :maxdepth: 1
+For most Python users, the quickest way to get started is to install the Apache
+TVM wheel from PyPI:
- from_source
- docker
+.. code-block:: bash
-Visit the :ref:`install TVM from source <install-from-source>` page to install
TVM from the source code. Installing
-from source gives you the maximum flexibility to configure the build
effectively from the official source releases.
-If you are interested in deploying to mobile or embedded devices, you do not
need to
-install the entire TVM stack on your device. Instead, you only need the
runtime.
+ pip install apache-tvm
-If you would like to quickly try out TVM or run some demo and tutorials, you
-can :ref:`install from Docker <docker-images>`.
+This installs the Python package, including modules such as ``tvm.tirx``, and
+is suitable for trying tutorials that do not require a custom build.
+
+For more details on installing the TIRx compiler and optional kernel library,
+visit the :doc:`TIRx installation </tirx/install>` page. If you need to
+customize TVM's build configuration, visit the
+:ref:`install TVM from source <install-from-source>` page instead.
diff --git a/docs/tirx/install.rst b/docs/tirx/install.rst
index 3c273ba21e..ddc185cc7e 100644
--- a/docs/tirx/install.rst
+++ b/docs/tirx/install.rst
@@ -39,7 +39,7 @@ Install the Apache TVM wheel (the TIRx compiler is the
``tvm.tirx`` module):
.. code-block:: bash
- pip install apache-tvm==0.25.0
+ pip install apache-tvm
Verify:
