From dc5d34319a673f6cbcd346a0c7046fb7fd0106ec Mon Sep 17 00:00:00 2001 From: Vidhya Sudhan Loganathan Date: Mon, 29 Apr 2019 11:44:11 +0100 Subject: COMPMID-2144 : Update documentation for the new OpenCL tuner Change-Id: I9af45c25b80339daba52a45ca394bb9dbf80bade Signed-off-by: Vidhya Sudhan Loganathan Reviewed-on: https://review.mlplatform.org/c/1034 Tested-by: Arm Jenkins Comments-Addressed: Arm Jenkins Reviewed-by: Gian Marco Iodice --- docs/01_library.dox | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/01_library.dox') diff --git a/docs/01_library.dox b/docs/01_library.dox index 67adf9cc4d..359ca4794a 100644 --- a/docs/01_library.dox +++ b/docs/01_library.dox @@ -461,7 +461,7 @@ However, there is no universal rule regarding which LWS is best for a given kern When the @ref CLTuner is enabled ( Target = 2 for the graph examples), the first time an OpenCL kernel is executed the Compute Library will try to run it with a variety of LWS values and will remember which one performed best for subsequent runs. At the end of the run the @ref graph::Graph will try to save these tuning parameters to a file. -However this process takes quite a lot of time, which is why it cannot be enabled all the time. +However this process takes quite a lot of time, which is why it cannot be enabled all the time. @ref CLTuner supports three modes of tuning with different trade-offs between the time taken to tune and the kernel execution time achieved using the best LWS found. In the Exhaustive mode, it searches all the supported values of LWS. This mode takes the longest time to tune and is the most likely to find the optimal LWS. Normal mode searches a subset of LWS values to yield a good approximation of the optimal LWS. It takes less time to tune than Exhaustive mode. Rapid mode takes the shortest time to tune and finds an LWS value that is at least as good or better than the default LWS value. The mode affects only the search for the optimal LWS and has no effect when the LWS value is imported from a file. But, when the @ref CLTuner is disabled ( Target = 1 for the graph examples), the @ref graph::Graph will try to reload the file containing the tuning parameters, then for each executed kernel the Compute Library will use the fine tuned LWS if it was present in the file or use a default LWS value if it's not. -- cgit v1.2.1