This page gives some general instructions and tips to build and develop Analytics Zoo for Python developers.

You are very welcome to add customized functionalities to Analytics Zoo to meet your own demands. You are also highly encouraged to contribute to Analytics Zoo for extra features so that other community users would get benefits as well.

Download Analytics Zoo Source Code

Analytics Zoo source code is available at GitHub:

git clone

By default, git clone will download the development version of Analytics Zoo. If you want a release version, you can use the command git checkout to change the specified version.

Build whl package for pip install

If you have modified some Python code and want to newly generate the whl package for pip install, you can run the following script:

bash analytics-zoo/pyzoo/dev/ linux default


After running the above command, you will find a whl file under the folder analytics-zoo/pyzoo/dist/. You can then directly pip install it to your local Python environment:

pip install analytics-zoo/pyzoo/dist/analytics_zoo-VERSION-py2.py3-none-PLATFORM_x86_64.whl

See here for more remarks related to pip install.

See here for more instructions to run analytics-zoo after pip install.

Run in IDE

You need to do the following preparations before starting the Integrated Development Environment (IDE) to successfully run an Analytics Zoo Python program in the IDE:

export BIGDL_CLASSPATH=analytics-zoo/dist/lib/analytics-zoo-*-jar-with-dependencies.jar
export PYTHONPATH=analytics-zoo/pyzoo:analytics-zoo/dist/conf/spark-analytics-zoo.conf:$PYTHONPATH

If you download BigDL from GitHub, you also need to add BigDL/pyspark to PYTHONPATH: