Skip to content

README.md

Latest commit

 

History

History
83 lines (58 loc) · 2.76 KB

README.md

File metadata and controls

83 lines (58 loc) · 2.76 KB
Raw

setup-mlir

This repository provides an action for setting up MLIR in GitHub Actions and installation scripts for setting up MLIR locally.

The MLIR binaries are built and distributed in the portable-mlir-toolchain repository.

List of available LLVM versions:

  • 21.1.8
  • 22.1.0
  • 22.1.1
  • 22.1.2
  • 22.1.3
  • 22.1.4
  • 22.1.5
  • 22.1.6
  • 22.1.7

List of available LLVM commit hashes:

  • 8f264586d7521b0e305ca7bb78825aa3382ffef7
  • 113f01aa82d055410f22a9d03b3468fa68600589
  • f8cb7987c64dcffb72414a40560055cb717dbf74

For more information on the available LLVM versions and commit hashes, see version-manifest.json.

GitHub Actions

- name: Set up MLIR
  uses: munich-quantum-software/setup-mlir@v1.3.1
  with:
    llvm-version: 22.1.0

This extracts a pre-built MLIR installation, adds the binaries to $PATH, and defines $LLVM_DIR and $MLIR_DIR.

Debug Builds (Windows Only)

On Windows, you can optionally install debug builds:

- name: Set up MLIR (Debug)
  uses: munich-quantum-software/setup-mlir@v1.3.1
  with:
    llvm-version: 22.1.0
    debug: true

Installation Scripts

If you want to use the pre-built MLIR installations locally, we also provide installation scripts. The scripts require the LLVM version or commit hash (e.g., 22.1.0 or f8cb798) and the desired installation directory to be passed. The scripts automatically download and use a platform-specific zstd binary for decompression, so only tar needs to be installed on the host system.

Note

tar is included by default in Windows 10 and Windows 11. If you're using an older version, you can install it, for example, via Chocolatey: choco install tar.

On Linux and macOS, use the following Bash command:

curl -LsSf https://github.com/munich-quantum-software/setup-mlir/releases/latest/download/setup-mlir.sh | bash -s -- -v 22.1.0 -p /path/to/installation

On Windows, use the following PowerShell command:

powershell -ExecutionPolicy ByPass -c "& ([scriptblock]::Create((irm https://github.com/munich-quantum-software/setup-mlir/releases/latest/download/setup-mlir.ps1))) -llvm_version 22.1.0 -install_prefix /path/to/installation"

Debug Builds (Windows Only)

On Windows, you can optionally install debug builds by adding the -use_debug flag:

powershell -ExecutionPolicy ByPass -c "& ([scriptblock]::Create((irm https://github.com/munich-quantum-software/setup-mlir/releases/latest/download/setup-mlir.ps1))) -llvm_version 22.1.0 -install_prefix /path/to/installation -use_debug"