From 69874483f46e66fb7fd192501f29c61fe28ab1cd Mon Sep 17 00:00:00 2001 From: Chris Hoge Date: Tue, 21 Jul 2020 16:41:29 -0700 Subject: [PATCH] Update installation doc with minor improvements (#6104) Make some minor improvements to the install from source doc about flags to enable, package managers, and virtual environments. --- docs/install/from_source.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/install/from_source.rst b/docs/install/from_source.rst index 12403a0..51ab887 100644 --- a/docs/install/from_source.rst +++ b/docs/install/from_source.rst @@ -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 ` to easily install and manage dependencies. We use cmake to build the library. @@ -85,8 +86,9 @@ 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. @@ -94,7 +96,6 @@ The configuration of TVM can be modified by `config.cmake`. - Since LLVM takes long time to build from source, you can download pre-built version of LLVM from `LLVM Download Page `_. - - 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. @@ -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: @@ -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 -- 2.7.4