From e232d64994cf776498ae67a17870a37590e84d3b Mon Sep 17 00:00:00 2001
From: hsharif3 <hsharif3@illinois.edu>
Date: Fri, 26 Mar 2021 06:34:34 +0000
Subject: [PATCH] Update CNN_Models.md

---
 hpvm/docs/CNN_Models.md        | 15 +++++++++++++++
 hpvm/docs/CNN_WeightFormats.md | 13 -------------
 2 files changed, 15 insertions(+), 13 deletions(-)
 create mode 100644 hpvm/docs/CNN_Models.md
 delete mode 100644 hpvm/docs/CNN_WeightFormats.md

diff --git a/hpvm/docs/CNN_Models.md b/hpvm/docs/CNN_Models.md
new file mode 100644
index 0000000000..b128be8de1
--- /dev/null
+++ b/hpvm/docs/CNN_Models.md
@@ -0,0 +1,15 @@
+
+# CNN Model Weights 
+
+The CNN weights (and input) files can be downloaded from here: https://databank.illinois.edu/datasets/IDB-6565690
+
+The extracted `model_params` directory is to be copied to `hpvm/hpvm/test/dnn_benchmarks/model_params` - the CNN benchmark expect the model weights at this specific location. The automatic HPVM install (`install.sh`) does the data download, extraction, and copying automatically.
+
+We support CNN weights in 3 formats:
+
+* `.h5` file format: The entire CNN model is stored as a single `.h5` file. The Keras models are shipped as `.h5` files. These can be found under `model_params/keras`
+
+* `.pth.tar` file format: The PyTorch models are shipped as `pth.tar` files and can be found under `model_params/pytorch`
+
+* `.bin` serialized binary file format: This format is used by the HPVM binaries. Convolution, Dense, and BatchNormalization parameters for each layer are stored as individual files. The weights are serialized FP32 values layed out serially in `NCHW` format. Our frontends (Keras and PyTorch) convert `.h5` and `pth.tar` files into `.bin` files in the frontend translation phase. The `.bin` weights can be found under the respective subdirectory for each benchmark under `model_params/`
+
diff --git a/hpvm/docs/CNN_WeightFormats.md b/hpvm/docs/CNN_WeightFormats.md
deleted file mode 100644
index ebffa68372..0000000000
--- a/hpvm/docs/CNN_WeightFormats.md
+++ /dev/null
@@ -1,13 +0,0 @@
-
-# CNN Weight Formats 
-
-We support CNN weights in 3 formats:
-
-* `.h5` file format:
-
-
-* `.pth.tar` file format:
-
-
-
-* `.bin` serialized binary file format:
-- 
GitLab