Releasing iree-turbine packages¶

This project hosts the https://pypi.org/project/iree-turbine/ package, which depends on the https://pypi.org/project/iree-base-compiler/ and https://pypi.org/project/iree-base-runtime/ packages. Releases can either be conducted independently, or they can be coordinated across projects by initiating a release here.

Promoting a nightly release allows for a consistent process across multiple projects while building locally lets release engineers take more explicit control over the process, while risking human error.

Promoting a nightly release¶

To promote a nightly release:

cd build_tools/
python -m venv .venv
source .venv/bin/activate
pip install -r ./requirements-packaging.txt

# NOTE: choose the nightly version to promote here!
./pypi_deploy.sh 3.1.0rc20241204

Building locally¶

To build locally:

Start with a clean test directory¶

rm -rf wheelhouse/

Building Artifacts¶

Build a dev release (e.g. 3.1.0.dev+6879a433eecc1e0b2cdf6c6dbcad901c77d97ac8):

python ./build_tools/compute_local_version.py -dev --write-json
python ./build_tools/build_release.py

Build a release candidate (e.g. 3.1.0rc20241204):

python ./build_tools/compute_local_version.py -rc --write-json
python ./build_tools/build_release.py

Build an official release (e.g. 3.1.0):

python ./build_tools/compute_local_version.py -stable --write-json
python ./build_tools/build_release.py

This will download all deps, including wheels for all supported platforms and Python versions for iree-base-compiler and iree-base-runtime. All wheels will be placed in the wheelhouse/ directory.

If you just want to build without downloading wheels, run

python ./build_tools/build_release.py --no-download
# Note that the test scripts referenced below won't work with this.

Testing¶

./build_tools/post_build_release_test.sh

This will

Set up a python virtual environment using your default python version
Install wheels from the wheelhouse/ directory
Run pytest tests

Push¶

From the testing venv, verify that everything is sane:

pip freeze

Push IREE deps (if needed/updated):

twine upload wheelhouse/iree_base_compiler-* wheelhouse/iree_base_runtime-*

Push built wheels:

twine upload wheelhouse/iree_turbine-*

Install from PyPI and Sanity Check¶

From the testing venv:

./build_tools/post_pypi_release_test.sh