An out-of-tree MLIR dialect

This is an example of an out-of-tree MLIR dialect along with a finch opt-like tool to operate on that dialect.

How to Install

0. Git clone llvm repository (at commit point bb59eb8ed534da2bd03117cfde594321add4d60c)

git clone https://github.com/llvm/llvm-project.git
git checkout bb59eb8ed534da2bd03117cfde594321add4d60c
cd llvm-project

1. Install prerequisites for mlir python bindings

# Create python virtual environment
# Make sure your 'python' is what you expect.
which python
python -m venv ~/.venv/mlirdev
source ~/.venv/mlirdev/bin/activate

python -m pip install --upgrade pip
python -m pip install -r mlir/python/requirements.txt

2. Build MLIR

mkdir build
cd build
cmake -G Ninja ../llvm \                                                                                                                                                  
   -DLLVM_ENABLE_PROJECTS=mlir \
   -DLLVM_BUILD_EXAMPLES=ON \
   -DLLVM_TARGETS_TO_BUILD="Native" \
   -DCMAKE_BUILD_TYPE=Release \
   -DLLVM_ENABLE_ASSERTIONS=ON \
   -DMLIR_ENABLE_BINDINGS_PYTHON=ON \
   -DPython3_EXECUTABLE=<YOUR PYTHON PATH (e.g., /Users/jaeyeonwon/.venv/mlirdev/bin/python)>

# Build and Check mlir (I got 88% passed)
cmake --build . --target check-mlir

3. Add PYTHONPATH

# Add below line to .bashrc or .zshrc
export PYTHONPATH=$LLVM_BUILD_DIR/tools/mlir/python_packages/mlir_core:$PYTHONPATH

4. Build Finch-mlir

https://github.com/finch-tensor/Finch-mlir.git
cd Finch-mlir
mkdir build && cd build
LLVM_BUILD_DIR=<YOUR LLVM BUILD PATH (e.g., /Users/jaeyeonwon/llvm-project/build>
cmake -G Ninja .. -DMLIR_DIR=$LLVM_BUILD_DIR/lib/cmake/mlir -DLLVM_EXTERNAL_LIT=$LLVM_BUILD_DIR/bin/llvm-lit

# Build and Check finch-mlir
cmake --build . --target check-finch