BUILD.md

Building from Source

To build the project, you need CMake to configure the project.

./configure

When several python virtual environments are installed, it may be useful to point to the correct intended version of python (see ./configure --help for options)

The configure script creates a virtual environment. You can source the right environment variables using

source ./scripts/python_env.sh

Now you can build the package as follows:

cmake -H. -Bbuild
make -C build -j3

This build directory does not have to be identical to the build directory created by ./configure as it is here.

CMake POST_BUILD hooks on shared libraries targets will handle installing the dev tree into your virtualenv.

Running Unit Tests

You can run all the unit tests not marked as slow using the following command.

pytest -rfs -m "no slow" <project_source_directory>/coremltools/test

Shortcut targets to rebuild and run all the tests exist as well. This takes time, so the recommended workflow is to run only relevant tests until you're confident in a change.

make -j3 -C build pytest_no_slow
make -j3 -C build pytest

See pytest documentation to learn more about how to run a single unit test.

Building wheels

If you would like a wheel to install outside of the virtualenv (or in it), use make -C build dist and find the resulting wheels in build/dist/*.whl.

If you want to build a wheel for distribution or testing, there is a script that automates all of the steps necessary for building a wheel, scripts/make_wheel.sh, that can be used instead (but make sure to install the wheel before running unit tests, if you plan to run the tests).

Building Documentation

First install all external dependencies.

pip install Sphinx==1.8.5 sphinx-rtd-theme==0.4.3 numpydoc==0.9.1
pip install -e git+git://github.com/michaeljones/sphinx-to-github.git#egg=sphinx-to-github

You also must have the coremltools package install, see the Building section. Then from the root of the repository:

cd docs
make html
open _build/html/index.html