Skip to content

Commit

Permalink
Update installation doc with minor improvements (apache#6104)
Browse files Browse the repository at this point in the history
Make some minor improvements to the install from source doc
about flags to enable, package managers, and virtual environments.
  • Loading branch information
hogepodge authored and Trevor Morris committed Sep 2, 2020
1 parent 6ec9fbe commit 54bdfac
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions docs/install/from_source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ The minimal building requirements are
- CMake 3.5 or higher
- We highly recommend to build with LLVM to enable all the features.
- If you want to use CUDA, CUDA toolkit version >= 8.0 is required. If you are upgrading from an older version, make sure you purge the older version and reboot after installation.
- On macOS, you may want to install `Homebrew <https://brew.sh>` to easily install and manage dependencies.


We use cmake to build the library.
Expand All @@ -85,16 +86,16 @@ The configuration of TVM can be modified by `config.cmake`.
- Edit ``build/config.cmake`` to customize the compilation options

- On macOS, for some versions of Xcode, you need to add ``-lc++abi`` in the LDFLAGS or you'll get link errors.
- Change ``set(USE_CUDA OFF)`` to ``set(USE_CUDA ON)`` to enable CUDA backend. So do other backends and libraries
(OpenCL, RCOM, METAL, VULKAN, ...).
- Change ``set(USE_CUDA OFF)`` to ``set(USE_CUDA ON)`` to enable CUDA backend. Do the same for other backends and libraries
you want to build for (OpenCL, RCOM, METAL, VULKAN, ...).
- To help with debugging, ensure the embedded graph runtime and debugging functions are enabled with ``set(USE_GRAPH_RUNTIME ON)`` and ``set(USE_GRAPH_RUNTIME_DEBUG ON)``

- TVM optionally depends on LLVM. LLVM is required for CPU codegen that needs LLVM.

- LLVM 4.0 or higher is needed for build with LLVM. Note that version of LLVM from default apt may lower than 4.0.
- Since LLVM takes long time to build from source, you can download pre-built version of LLVM from
`LLVM Download Page <http://releases.llvm.org/download.html>`_.


- Unzip to a certain location, modify ``build/config.cmake`` to add ``set(USE_LLVM /path/to/your/llvm/bin/llvm-config)``
- You can also directly set ``set(USE_LLVM ON)`` and let cmake search for a usable version of LLVM.

Expand Down Expand Up @@ -154,6 +155,11 @@ Python Package Installation
TVM package
~~~~~~~~~~~

Depending on your development environment, you may want to use a virtual environment and package manager, such
as ``virtualenv`` or ``conda``, to manage your python packages and dependencies.

to install and maintain your python development environment.

The python package is located at `tvm/python`
There are two ways to install the package:

Expand Down Expand Up @@ -187,6 +193,10 @@ Method 2
Python dependencies
~~~~~~~~~~~~~~~~~~~

Note that the ``--user`` flag is not necessary if you're installing to a managed local environment,
like ``virtualenv``.

* Necessary dependencies:

.. code:: bash
Expand Down

0 comments on commit 54bdfac

Please sign in to comment.