From bbf39653803327b1bc6a2ceb837c11b43eae34d4 Mon Sep 17 00:00:00 2001
From: Yifan Zhao <yifanz16@illinois.edu>
Date: Mon, 15 Feb 2021 16:02:59 -0600
Subject: [PATCH] Updated readme

---
 README.md | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 41c4809..872c842 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,27 @@
 # Autotuning and Predictive Autotuning
 
-Performs autotuning on program approximation knobs using an error-predictive proxy in place of the
-original program, to greatly speedup autotuning while getting results comparable in quality.
+`predtuner` performs autotuning on program approximation knobs using an error-predictive proxy
+in place of the original program, to greatly speedup autotuning while getting results
+comparable in quality.
 
 Work in progress.
 
 ## Requirements
 
-Prerequisite packages are listed in `./env.yaml`. Conda is the validated and recommended way to set
-up a working environment. If you're using conda, do
+`pip` is needed for installing this package. At the root directory of this repo, do:
 
 ```bash
-conda env create -n predtuner -f env.yaml
-conda activate predtuner
+pip install -e .
 ```
+
+`-e` can be omitted if you don't intend to modify the code in this package.
+
+## Model Data for Example / Testing
+
+`predtuner` contains 10 demo models which are also used in tests.
+
+- Download and extract [this](https://drive.google.com/file/d/1V_yd9sKcZQ7zhnO5YhRpOsaBPLEEvM9u/view?usp=sharing) file containing all 10 models, for testing purposes.
+- The example only uses VGG16-CIFAR10. If you don't need the other models, get the data for VGG16-CIFAR10 [here](https://drive.google.com/file/d/1Z84z-nsv_nbrr8t9i28UoxSJg-Sd_Ddu/view?usp=sharing).
+
+In either case, there should be a `model_params/` folder at the root of repo after extraction.
+
-- 
GitLab