# flagtree_mlir

**Repository Path**: flagos-ai/flagtree_mlir

## Basic Information

- **Project Name**: flagtree_mlir
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-23
- **Last Updated**: 2026-01-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FLAGTREE-MLIR Build Guide

This document describes how to build a wheel package from a specific version of llvm-project.

## Quick Start

### 1. Clone the repository and build clang
```bash
git clone https://github.com/flagos-ai/flagtree_mlir.git
apt install clang
```

> **Note**: No need to download submodule and `git clone --recursive` unless your version is the same as ours.

### 2. Build the Wheel

```bash
cd flagtree_mlir
python -m build -w
```

After building, the `.whl` file will appear in the `./dist` directory.

### 3. Install and Test

```bash
# Install the wheel package (adjust the filename according to the actual one)
pip install ./dist/flagtree_mlir-0.1.0-cp312-cp312-linux_x86_64.whl --force-reinstall

# Test import
python -c "import flagtree_mlir"
python -c "from mlir import ir"
```

No error is expected.

## wheel Structure

Unzip the wheel package, the content is as below:

```
├── flagtree_mlir
│   ├── bin
│   ├── include
│   ├── lib
│   ├── python_packages
│   ├── share
│   └── src
├── flagtree_mlir-0.1.0.dist-info
└── mlir
    ├── _mlir_libs
    ├── dialects
    ├── extras
    └── runtime
```

## Build Configuration

Our cmake instruction is as below:

```bash
cmake -G Ninja -B build -S llvm \
    -DLLVM_ENABLE_PROJECTS="mlir;llvm;lld" \
    -DLLVM_TARGETS_TO_BUILD="host;NVPTX;AMDGPU" \
    -DCMAKE_BUILD_TYPE=Release \
    -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
    -DCMAKE_C_COMPILER=clang \
    -DCMAKE_CXX_COMPILER=clang++ \
    -DLLVM_ENABLE_LLD=ON \
    -DMLIR_ENABLE_BINDINGS_PYTHON=ON
```

> **Customization**: You can change the content of `pyproject.toml` to follow your favor.