diff options
Diffstat (limited to 'examples/gemm_tuner/README.md')
| -rw-r--r-- | examples/gemm_tuner/README.md | 25 |
1 files changed, 21 insertions, 4 deletions
diff --git a/examples/gemm_tuner/README.md b/examples/gemm_tuner/README.md index 789dc2bb9a..3d5b6376e1 100644 --- a/examples/gemm_tuner/README.md +++ b/examples/gemm_tuner/README.md @@ -2,10 +2,27 @@ ## Pre-requisite (Preferably) bash shell -benchmark examples +Built benchmark examples +python >= 3.6 ## 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. +The tuning consists of 2 steps: -[$SHELL] ./benchmark_gemm_examples.sh -e \<example_binary_dir\> -s \<strategy\> -g \<gemm_shape_file\> -c \<gemm_config_file\> [-o \<out_dir\>, [-i \<iteration\>]] +1. Run benchmarks: Run the runner shell script (benchmark_gemm_examples.sh) on +your target device. Note that all the built benchmark examples have to be +present on your target device prior to running. The script will run the selected +strategy, over all pre-defined tunable configurations, on a set of gemm shapes +provided by the user, and then save the benchmark results to json files in an +output directory. + +[$SHELL] ./benchmark_gemm_examples.sh -s \<strategy\> -e \<example_binary_dir\> + -g \<gemm_shape_file\> -c \<gemm_config_file\> [-o \<out_dir\>] + +2. Run analyser: Run the python script (GemmTuner.py) on your host device. +You'll need to transfer all the benchmark result json files generated from the +previous step to your host machine beforehand. Note that this requires +python >= 3.6. The script will output the best configuration, along with some +analysis statistics for each strategy, and optionally save the parsed benchmark +results into csv files (one for each strategy) for further analysis. + +python GemmTuner.py -b \<benchmark_results_dir\> [-o \<out_dir\>] |