From a184b919fc9960e3b66fbd8c21d796a5eca1fca0 Mon Sep 17 00:00:00 2001
From: hsharif3 <hsharif3@illinois.edu>
Date: Wed, 24 Mar 2021 22:25:00 +0000
Subject: [PATCH] Unifrying Keras Frontends and Benchmarks in README

---
 hpvm/test/dnn_benchmarks/keras/README.md | 47 +++++++++++++++++++++---
 1 file changed, 42 insertions(+), 5 deletions(-)

diff --git a/hpvm/test/dnn_benchmarks/keras/README.md b/hpvm/test/dnn_benchmarks/keras/README.md
index aeccada727..c9be006c00 100644
--- a/hpvm/test/dnn_benchmarks/keras/README.md
+++ b/hpvm/test/dnn_benchmarks/keras/README.md
@@ -1,11 +1,51 @@
-# Keras Benchmarks
+
+
+# Keras Frontend 
+
+Install Keras Frontend after moving to directory `/hpvm/hpvm/projects/keras`
+
+## Requirements 
+
+* python == 3.6.x
+* pip >= 18
+
+If your system uses a different Python version, we recommend using the conda environment `keras_python36.yml`. Install this using:
+
+```
+conda env create -f keras_python36.yml --name keras_python36
+```
+
+Activate the conda environment before installing the pip package (below) using:
+
+```
+conda activate keras_python36
+```
+
+**NOTE:** This step must be performed each time (for each shell process) the frontend is to be used.
 
 
 ## Installing the Keras Frontend Package
 
-Instructions for Installing the Keras Frontend are [here](https://gitlab.engr.illinois.edu/llvm/hpvm/-/blob/approx_hpvm_reorg_keras/hpvm/projects/keras/README.md)
+At the root of this project (`/projects/keras/`) install the Keras frontend pip package as:
+
+```
+pip3 install -e ./
+```
+
+**NOTE:** If you are using the conda environment, activate it prior to this step.
+
+## Suppported Operations
+
+List of supported operations and limitations detailed in https://gitlab.engr.illinois.edu/llvm/hpvm/-/blob/approx_hpvm_reorg_keras/hpvm/projects/keras/docs/Support.md
+
 
 
+
+
+# Keras Benchmarks
+
+Run the Keras benchmarks under `hpvm/hpvm/test/dnn_benchmarks/keras`
+
 ## Download CNN Model Files 
 
 Prior to running the benchmarks, ensure you download the CNN model data (inputs and weights) if not done in automatic build script.
@@ -136,9 +176,6 @@ python test_benchmarks.py
 ```
 
 
-## Suppported Operations
-
-List of supported operations and limitations detailed in https://gitlab.engr.illinois.edu/llvm/hpvm/-/blob/approx_hpvm_reorg_keras/hpvm/projects/keras/docs/Support.md
 
 
 
-- 
GitLab