From 2f8cf9d04b426ca4895c17f39dd1a1df4632af9a Mon Sep 17 00:00:00 2001
From: Yinying Li <yinyingli@google.com>
Date: Wed, 10 Jul 2024 21:11:30 +0000
Subject: [PATCH] Update README.md (#62)

add info for pip install and performance tracking.
---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 9c764b7..1488ef8 100644
--- a/README.md
+++ b/README.md
@@ -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),
@@ -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.