diff --git a/hpvm/projects/keras/README.md b/hpvm/projects/keras/README.md index 575f3d5fb9c113ba01ae499492257cf9e601e80f..e5709e45d62d4da7acee5121a4f2db5690ecef2e 100644 --- a/hpvm/projects/keras/README.md +++ b/hpvm/projects/keras/README.md @@ -17,19 +17,23 @@ To check installed pip version: pip -V ``` -### Importing Conda Environment: +### Importing and Creating the Required Conda Environment: ``` conda env create -f keras_environment.yml --name ${KERAS_ENV_NAME} ``` Note: pip version MUST be > 19.3 +This is a **one-time** installation step. + ### Activating Conda Environment: ``` conda activate ${KERAS_ENV_NAME} ``` +**NOTE:** This step must be performed each time (for each shell process) the frontend is to be used. + ### Building and Installing Frontend: ``` @@ -37,6 +41,7 @@ python setup.py build python setup.py install ``` +**NOTE:** This step must be performed each time (for each shell process) the frontend is to be used. ## Running Benchmaks @@ -67,6 +72,7 @@ python src/${BENCH_NAME}.py [hpvm_reload|keras_reload] [frontend] ``` + **Parameters:** `hpvm_reload` : Reloads HPVM weights ('.bin' binary format used in `model_params` found here: https://gitlab.engr.illinois.edu/llvm/hpvm/-/tree/approx_hpvm_reorg_keras/hpvm/test/dnn_benchmarks/model_params) from directory path specified in the [Benchmark class constructor](https://gitlab.engr.illinois.edu/llvm/hpvm/-/blob/approx_hpvm_reorg_keras/hpvm/projects/keras/src/Benchmark.py#L17).