commit ce7c44117918ed4d01c60010565d942d2221748e
author SiCong Li <sicong.li@arm.com> Mon Aug 24 18:00:07 2020 +0100
committer SiCong Li <sicong.li@arm.com> Wed Aug 26 15:36:10 2020 +0000
tree d8e4d57fafecf269147cd923940a7bda871ce4c0
parent 96209c73b071bb65d4919fb441076f977095a31b

COMPMID-3756 Update CommonGraphOptions documentations to include tuner-mode

Signed-off-by: SiCong Li <sicong.li@arm.com>
Change-Id: I2d2fad99a7528274152e3e3ffefd3ea4d074ff71
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/3832
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Michele Di Giorgio <michele.digiorgio@arm.com>
Tested-by: Arm Jenkins <bsgcomp@arm.com>

utils/CommonGraphOptions.cpp

diff --git a/utils/CommonGraphOptions.cpp b/utils/CommonGraphOptions.cpp
index cae9872..d262ea8 100644
--- a/utils/CommonGraphOptions.cpp
+++ b/utils/CommonGraphOptions.cpp
@@ -170,7 +170,11 @@
     data_layout->set_help("Data layout to use");
     enable_tuner->set_help("Enable OpenCL dynamic tuner");
     enable_cl_cache->set_help("Enable OpenCL program caches");
-    tuner_mode->set_help("Configures the time taken by the tuner to tune. Slow tuner produces the most performant LWS configuration");
+    tuner_mode->set_help(
+        "Configures the time taken by the tuner to tune. "
+        "Exhaustive: slowest but produces the most performant LWS configuration. "
+        "Normal: slow but produces the LWS configurations on par with Exhaustive most of the time. "
+        "Rapid: fast but produces less performant LWS configurations");
     fast_math_hint->set_help("Enable fast math");
     data_path->set_help("Path where graph parameters reside");
     image->set_help("Input image for the graph");

utils/CommonGraphOptions.h

diff --git a/utils/CommonGraphOptions.h b/utils/CommonGraphOptions.h
index ab7125e..dac2e10 100644
--- a/utils/CommonGraphOptions.h
+++ b/utils/CommonGraphOptions.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2019 Arm Limited.
+ * Copyright (c) 2018-2020 Arm Limited.
  *
  * SPDX-License-Identifier: MIT
  *
@@ -55,6 +55,10 @@
  * --validation-range : The range of the images to validate from the validation file (e.g 0,9).
  *                      If not specified all the images will be validated.
  * --tuner-file       : The file to store the OpenCL dynamic tuner tuned parameters.
+ * --tuner-mode       : Select tuner mode. Supported modes: Exhaustive,Normal,Rapid
+ *                      * Exhaustive: slowest but produces the most performant LWS configuration.
+ *                      * Normal: slow but produces the LWS configurations on par with Exhaustive most of the time.
+ *                      * Rapid: fast but produces less performant LWS configurations
  *
  * Note that data, image and labels options should be provided to perform an inference run on an image.
  * Note that validation-file and validation-path should be provided to perform a graph accuracy estimation.