aboutsummaryrefslogtreecommitdiff
path: root/tests/ImageCSVFileGenerator/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tests/ImageCSVFileGenerator/README.md')
-rw-r--r--tests/ImageCSVFileGenerator/README.md13
1 files changed, 13 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>