Infrastructure for MLGO - a Machine Learning Guided Compiler Optimizations Framework.

MLGO is a framework for integrating ML techniques systematically in LLVM. It replaces human-crafted optimization heuristics in LLVM with machine learned models. The MLGO framework currently supports two optimizations:

inlining-for-size(LLVM RFC);
register-allocation-for-performance(LLVM RFC)

The compiler components are both available in the main LLVM repository. This repository contains the training infrastructure and related tools for MLGO.

We currently use two different ML algorithms: Policy Gradient and Evolution Strategies to train policies. Currently, this repository only support Policy Gradient training. The release of Evolution Strategies training is on our roadmap.

Check out this demo for an end-to-end demonstration of how to train your own inlining-for-size policy from the scratch with Policy Gradient, or check out this demo for a demonstration of how to train your own regalloc-for-performance policy.

For more details about MLGO, please refer to our paper MLGO: a Machine Learning Guided Compiler Optimizations Framework.

For more details about how to contribute to the project, please refer to contributions.

Pretrained models

We occasionally release pretrained models that may be used as-is with LLVM. Models are released as github releases, and are named as [task]-[major-version].[minor-version].The versions are semantic: the major version corresponds to breaking changes on the LLVM/compiler side, and the minor version corresponds to model updates that are independent of the compiler.

When building LLVM, there is a flag -DLLVM_INLINER_MODEL_PATH which you may set to the path to your inlining model. If the path is set to download, then cmake will download the most recent (compatible) model from github to use. Other values for the flag could be:

# Model is in /tmp/model, i.e. there is a file /tmp/model/saved_model.pb along
# with the rest of the tensorflow saved_model files produced from training.
-DLLVM_INLINER_MODEL_PATH=/tmp/model

# Download the most recent compatible model
-DLLVM_INLINER_MODEL_PATH=download

Prerequisites

Currently, the assumptions for the system are:

Recent Ubuntu distro, e.g. 20.04
python 3.8.x/3.9.x/3.10.x
for local training, which is currently the only supported mode, we recommend a high-performance workstation (e.g. 96 hardware threads).

Training assumes a clang build with ML 'development-mode'. Please refer to:

LLVM documentation
the build bot script

The model training - specific prerequisites are:

Pipenv:

pip3 install pipenv

The actual dependencies:

pipenv sync --system

Note that the above command will only work from the root of the repository since it needs to have Pipfile.lock in the working directory at the time of execution.

If you plan on doing development work, make sure you grab the development and CI categories of packages as well:

pipenv sync --system --categories "dev-packages ci"

Optionally, to run tests (run_tests.sh), you also need:

sudo apt-get install virtualenv

Note that the same tensorflow package is also needed for building the 'release' mode for LLVM.

Docs

An end-to-end demo using Fuchsia as a codebase from which we extract a corpus and train a model.

How to add a feature guide. Extensibility model.

Release files for ml-compiler-opt 0.0.1.dev202306280007

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ml-compiler-opt 0.0.1.dev202306280007
File	Size	Uploaded
ml-compiler-opt-0.0.1.dev202306280007.tar.gz	135.7 kB	Jun 28, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for ml-compiler-opt 0.0.1.dev202306280007
File	Interpreter	ABI	Platform	Reset
ml_compiler_opt-0.0.1.dev202306280007-py3-none-any.whl 213.3 kB Jun 28, 2023	Python 3	none	any	Details

Total release size: 349.0 kB

Release files / ml-compiler-opt-0.0.1.dev202306280007.tar.gz

Download URL	ml-compiler-opt-0.0.1.dev202306280007.tar.gz
Size	135.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`073acf4f72d9d620f759ac832963085aea188d1b8e0a86184cbe2b7b0b147138`
BLAKE2b-256 checksum How to use checksums	`8ced2a31bd5e82900cc79bf90c79f2bfb09eb78add09b9f51d2a7b44240e4487`
Upload date	Jun 28, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.10.12`

Release files / ml_compiler_opt-0.0.1.dev202306280007-py3-none-any.whl

Download URL	ml_compiler_opt-0.0.1.dev202306280007-py3-none-any.whl
Size	213.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7e5670ef886f683adf91cec2b09bc958f7d9478b0c80b58e02f5540fbda9cc1d`
BLAKE2b-256 checksum How to use checksums	`e5981ad67bd8e99d23332422e53bf4e01eafbe41131ca289f8d6cff62e4270b6`
Upload date	Jun 28, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.10.12`