Skip to content

Commit

Permalink
Update README.md (#62)
Browse files Browse the repository at this point in the history
add info for pip install and performance tracking.
  • Loading branch information
yinying-lisa-li authored Jul 10, 2024
1 parent 466aed6 commit 2f8cf9d
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ a declarative language-based mechanism for collecting and expressing
critical aspects of a target architecture in a way that can be reasoned
about and leveraged by all passes in both MLIR and LLVM.

## Installing the MPACT compiler

To install the MPACT compiler through [PyPI](https://pypi.org/project/mpact/), please use the following command:

```shell
pip install mpact
```

## Building the MPACT compiler

To build and run the MPACT compiler from source (for developers),
Expand Down Expand Up @@ -96,6 +104,10 @@ And the following to run all benchmarks
cmake --build build --target benchmark-mpact
```

## Performance

Performance of critical kernels for ML models are tracked for each commit. Any regression > 120% will be notified. Graphs could be found in the [github page](https://mpact-org.github.io/mpact-compiler/dev/bench/).

## Notes

1. Shells other than bash/sh/etc. require a different `activate` script, as shown. Because the python environment has to be set up for every session, we recommend putting it in your .*sh startup file.
Expand Down

0 comments on commit 2f8cf9d

Please sign in to comment.