aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorConor Kennedy <conor.kennedy@arm.com>2019-05-13 09:03:22 +0100
committerconor.kennedy <conor.kennedy@arm.com>2019-05-13 09:27:01 +0000
commit0e26cb574782197d1ac54e3c023325abd9abfe2b (patch)
tree09e7252e846d2e147340b99c3de9b5b3a24c7ddd
parentcd05f3e6208d5296ae507036fe4f6df55362c5a0 (diff)
downloadarmnn-0e26cb574782197d1ac54e3c023325abd9abfe2b.tar.gz
IVGCVSW-3070 Add Documentation for ImageTensorGenerator & ImageCSVFileGenerator
Signed-off-by: Conor Kennedy <conor.kennedy@arm.com> Change-Id: I071225a812e6f85b6abe83172be71913186523f4
-rw-r--r--tests/ImageCSVFileGenerator/README.md13
-rw-r--r--tests/ImageTensorGenerator/README.md13
2 files changed, 26 insertions, 0 deletions
diff --git a/tests/ImageCSVFileGenerator/README.md b/tests/ImageCSVFileGenerator/README.md
new file mode 100644
index 0000000000..98857cb90a
--- /dev/null
+++ b/tests/ImageCSVFileGenerator/README.md
@@ -0,0 +1,13 @@
+# The ImageCSVFileGenerator
+
+The `ImageCSVFileGenerator` is a program for creating a CSV file that contains a list of .raw tensor files. These
+.raw tensor files can be generated using the`ImageTensorGenerator`.
+
+|Cmd:|||
+| ---|---|---|
+| -h | --help | Display help messages |
+| -i | --indir | Directory that .raw files are stored in |
+| -o | --outfile | Output CSV file path |
+
+Example usage: <br>
+<code>./ImageCSVFileGenerator -i /path/to/directory/ -o /output/path/csvfile.csv</code>
diff --git a/tests/ImageTensorGenerator/README.md b/tests/ImageTensorGenerator/README.md
new file mode 100644
index 0000000000..50e68aa1e7
--- /dev/null
+++ b/tests/ImageTensorGenerator/README.md
@@ -0,0 +1,13 @@
+# The ImageTensorGenerator
+
+The `ImageTensorGenerator` is a program for generating a .raw tensor file from a .jpg image.
+
+|Cmd:|||
+| ---|---|---|
+| -h | --help | Display help messages |
+| -i | --infile | Input image file to generate tensor from |
+| -l | --layout | Output data layout, "NHWC" or "NCHW". Default value: NHWC |
+| -o | --outfile | Output raw tensor file path |
+
+Example usage: <br>
+<code>./ImageTensorGenerator -i /path/to/image/dog.jpg -l NHWC -o /output/path/dog.raw</code>