Add README.md to tflite_run (#1110)

A brief description for tflite_run

Signed-off-by: Hanjoung Lee <hanjoung.lee@samsung.com>

diff --git a/tools/tflite_run/README.md b/tools/tflite_run/README.md
new file mode 100644 (file)
index 0000000..61a5a9c
--- /dev/null
+++ b/tools/tflite_run/README.md
@@ -0,0 +1,75 @@
+# tflite_run
+
+A simple Tensorflow Lite runner. It measures the elapsed time and optionally dump the output data and compare them.
+
+## Usage
+
+### Simple run
+
+This will run with random input data
+
+```
+$ ./tflite_run model.tflite
+```
+
+### Specifying input data
+
+```
+$ ./tflite_run model.tflite
+```
+
+Output would look like:
+
+```
+input tensor indices = [0,]
+Input image size is smaller than the size required by the model. Input will not be set.
+output tensor indices = [308(max:984),]
+Prepare takes 0.00126718 seconds
+Invoke takes 7.09527 seconds
+```
+
+### Dump the outputs
+
+Dump the output tensors to a file.
+
+```
+$ ./tflite_run model.tflite --dump golden
+```
+
+The output tensors are written to name "golden".
+
+### Compare with the saved outputs
+
+The result from `tflite_run` and binary file are compared with `--compare` option.
+
+```
+$ ls golden
+golden
+$ ./tflite_run model.tflite --compare golden
+```
+
+The output would look like:
+
+```
+input tensor indices = [0,]
+Input image size is smaller than the size required by the model. Input will not be set.
+output tensor indices = [308(max:984),]
+Prepare takes 0.00126718 seconds
+Invoke takes 7.09527 seconds
+========================================
+Comparing the results with "golden2".
+========================================
+  Tensor #308: UNMATCHED
+    1 diffs are detected
+    Max absolute diff at [0, 0]
+       expected: 99
+       obtained: 0.000139008
+       absolute diff: 98.9999
+    Max relative diff at [0, 1007]
+       expected: 7.01825e-33
+       obtained: 0.000139011
+       relative diff: 1
+         (tolerance level = 8.38861e+06)
+```
+
+If `--compare` option is on, the exit code will be depend on its compare result. 0 for matched, other number for unmatched.