aboutsummaryrefslogtreecommitdiff
path: root/examples/gemm_tuner/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/gemm_tuner/README.md')
-rw-r--r--examples/gemm_tuner/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/examples/gemm_tuner/README.md b/examples/gemm_tuner/README.md
new file mode 100644
index 0000000000..789dc2bb9a
--- /dev/null
+++ b/examples/gemm_tuner/README.md
@@ -0,0 +1,11 @@
+# Gemm Tuner
+
+## Pre-requisite
+(Preferably) bash shell
+benchmark examples
+
+## Usage
+Run gemm examples of a selected strategy, over all pre-defined tunable configurations, on a set of gemm shapes provided
+by the user. Save the benchmark results to json files in an output directory.
+
+[$SHELL] ./benchmark_gemm_examples.sh -e \<example_binary_dir\> -s \<strategy\> -g \<gemm_shape_file\> -c \<gemm_config_file\> [-o \<out_dir\>, [-i \<iteration\>]]