Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
zhanghb97 committed Oct 25, 2023
1 parent 19cfc6c commit 7b2e447
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# BUDDY MLIR

MLIR-Based Ideas Landing Project ([Project page](https://buddy-compiler.github.io/)).
An MLIR-based compiler framework designed for a co-design ecosystem from DSL (domain-specific languages) to DSA (domain-specific architectures).
([Project page](https://buddy-compiler.github.io/)).

## Getting Started

Expand Down Expand Up @@ -55,7 +56,7 @@ $ cmake -G Ninja ../llvm \
-DLLVM_ENABLE_ASSERTIONS=ON \
-DCMAKE_BUILD_TYPE=RELEASE \
-DMLIR_ENABLE_BINDINGS_PYTHON=ON \
-DPython3_EXECUTABLE=[path_to_python_executable]
-DPython3_EXECUTABLE=$(which python3)
```

If your target machine has lld installed, you can use the following configuration:
Expand Down Expand Up @@ -95,7 +96,7 @@ $ cmake -G Ninja .. \
-DLLVM_ENABLE_ASSERTIONS=ON \
-DCMAKE_BUILD_TYPE=RELEASE \
-DBUDDY_MLIR_ENABLE_PYTHON_PACKAGES=ON \
-DPython3_EXECUTABLE=[path_to_python_executable]
-DPython3_EXECUTABLE=$(which python3)
```

If you want to add domain-specific framework support, please add the following cmake options:
Expand Down Expand Up @@ -151,10 +152,6 @@ This program should be a drop-in replacement for `mlir-lsp-server`, supporting n

After modification, your editor should have correct completion and error prompts for new dialects such as `rvv` and `gemmini`.

### AutoConfig Mechanism

The `AutoConfig` mechanism is designed to detect the target hardware and configure the toolchain automatically.

## Examples

The purpose of the examples is to give users a better understanding of how to use the passes and the interfaces in buddy-mlir. Currently, we provide three types of examples.
Expand All @@ -164,3 +161,19 @@ The purpose of the examples is to give users a better understanding of how to us
- Testing and demonstrating examples.

For more details, please see the [documentation of the examples](./examples/README.md).

## How to Cite

If you find our project and research useful or refer to it in your own work, please cite our paper as follows:

```
@article{zhang2023compiler,
title={Compiler Technologies in Deep Learning Co-Design: A Survey},
author={Zhang, Hongbin and Xing, Mingjie and Wu, Yanjun and Zhao, Chen},
journal={Intelligent Computing},
year={2023},
publisher={AAAS}
}
```

For direct access to the paper, please visit [Compiler Technologies in Deep Learning Co-Design: A Survey](https://spj.science.org/doi/10.34133/icomputing.0040).

0 comments on commit 7b2e447

Please sign in to comment.