You may choose one of two methods to install Treelite on your system:
This is probably the most convenient method. Simply type
python3 -m pip install --user treelite treelite_runtime
to install the Treelite package. The command will locate the binary release that is compatible with your current platform. Check the installation by running
import treelite
import treelite_runtime
in an interactive Python session. This method is available for only Windows, Mac OS X, and Linux. For other operating systems, see the next section.
Note
Installing OpenMP runtime on Mac OSX
Treelite requires the presence of OpenMP runtime. To install OpenMP runtime on a Mac OSX system, run the following command:
brew install libomp
Installation consists of two steps:
Build the shared libraries from C++ code (See the note below for the list.)
Install the Python package.
Note
List of libraries created
There will be two libraries created: the main library, for producing optimized prediction subroutines; and the runtime library, for deploying these subroutines in the wild for actual prediction tasks.
Operating System |
Main library |
Runtime library |
---|---|---|
Windows |
|
|
Mac OS X |
|
|
Linux / other UNIX |
|
|
To get started, clone Treelite repo from GitHub.
git clone https://github.com/dmlc/treelite.git
cd treelite
The next step is to build the shared libraries.
The Python package is located at the python
subdirectory. There are several
ways to install the package:
1. Install system-wide, which requires root permission
# Install treelite
cd python
sudo python3 setup.py install
# Install treelite_runtime
cd ../runtime/python
sudo python3 setup.py install
You will need Python setuptools
module for this to work. It is often part of the core Python installation.
Should it be necessary, the package can be installed using pip
:
pip install -U pip setuptools
2. Install for only current user
This is useful if you do not have the administrative rights.
# Install treelite
cd python
python3 setup.py install --user
# Install treelite_runtime
cd ../runtime/python
python3 setup.py install --user
Note
Recompiling Treelite
Every time the C++ portion of Treelite gets re-compiled, the Python package must be re-installed for the new library to take effect.
3. Set the environment variable PYTHONPATH to locate Treelite package
Only set the environment variable PYTHONPATH
to tell Python where to find
the Treelite package. This is useful for developers, as any changes made
to C++ code will be immediately visible to Python side without re-running setup.py
.
export PYTHONPATH=/path/to/treelite/python:/path/to/treelite/runtime/python
python3 # enter interactive session