Skip to content

Commit 7c0351d

Browse files
committed
Added info about requirements and usage in README
1 parent 42a81c1 commit 7c0351d

2 files changed

Lines changed: 25 additions & 9 deletions

File tree

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,41 @@ We have adpated an example "label_image" provided by Tensorflow to "label_image_
1515

1616
To cross-compile"label_image_secda" binary for PYNQ-Z1 simply use the following commands:
1717
* cd tensorflow/
18-
* ./make_label_image_secda.sh [vm|vm2|sa]
19-
* cp ./out/label_image_secda_[vm|vm2|sa] TO_PYNQ_DEVICE
18+
* ./make_label_image_secda.sh [vm|sa]
19+
* cp ./out/label_image_secda_[vm|sa] TO_PYNQ_DEVICE
2020

2121
**Usage**
22-
* In-Construction
22+
* sudo ./label_image_secda_[vm|sa] -m[path/to/tflite/model.tflite] -i[path/to/input/image.bmp] -l[path/to/labels.txt] -t [1|2] -n [number of runs] -o [profile] -x [store_profile]
23+
* "-m" path to tflite model [path/to/tflite/model.tflite]
24+
* "-i" path to input image (.bmp required) [path/to/input/image.bmp]
25+
* "-l" path to class labels.txt [path/to/labels.txt]
26+
* "-t" threads used [1|2]
27+
* "-n" number of inference runs to perform [0-100]
28+
* "-o" to profile inference times [0|1]
29+
* "-x" to profile & save profiled information (saves to current directory) [0|1]
30+
* Example: sudo ./label_image_secda_vm -mtmp/mobilenetv1.tflite -itmp/grace_hopper.bmp -ltmp/labels.txt -t 1 -n 1 -o 1 -x 0
2331

2432
**Requirements**
25-
* In-Construction
26-
33+
* To cross compile make sure you have to have the relavant utilites and arm-linux-gnueabihf-gcc compiler
34+
* Cross compilation was tested/recommended for Ubuntu 18.04
35+
* Get compilers for PYNQ by following:
36+
* sudo apt-get install libc6-armel-cross libc6-dev-armel-cross binutils-arm-linux-gnueabi libncurses5-dev build-essential bison flex libssl-dev bc
37+
* sudo apt-get install gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf
38+
2739

2840
## Accelerator Designs & Synthesis
29-
* In-Construction
41+
* We provide pre-compiled binaries/bitmaps for the PYNQ Z1 along with archived Vivado and Vivado HLS project folders (check release) to enable synthesis from scratch
42+
* We also provide source code for both accelerators
43+
* For more information please check out the [accelerator source-code](accelerators/)
3044

3145

3246
## Testbench Simulation
33-
* In-Construction
47+
* To perform Testbench simulation we provide arhcived Vivado HLS project folder (check release) which contains everything required to perform testbench simulation once openned in Vivado HLS
3448

49+
**Requirements**
50+
* Vivado HLS 2019.2
51+
* Vivado 2019.2
3552

36-
## End-to-end Simulation
3753
## End-to-end Simulation
3854
TFLite-SECDA End-to-end simulation enables us to performance inference on TFLite CNN models while simulating and profiling our GEMM accelerators. For the purpose of ease of installation we provide a fully contained docker image.
3955

0 commit comments

Comments
 (0)