Compute Library
 21.11
ICLTuner.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2020 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_ICLTUNER_H
25 #define ARM_COMPUTE_ICLTUNER_H
26 
28 
29 namespace arm_compute
30 {
31 class ICLKernel;
32 
33 /** Basic interface for tuning the OpenCL kernels */
34 class ICLTuner
35 {
36 public:
37  /** Virtual destructor */
38  virtual ~ICLTuner() = default;
39  /** Tune OpenCL kernel statically
40  *
41  * @note Tuning is performed using only kernel and tensor metadata,
42  * thus can be performed when memory is not available
43  *
44  * @param[in] kernel Kernel to tune
45  */
46  virtual void tune_kernel_static(ICLKernel &kernel) = 0;
47  /** Tune OpenCL kernel dynamically
48  *
49  * @note Tuning requires memory to be available on all kernel tensors and objects in order to be performed
50  *
51  * @param[in] kernel Kernel to tune
52  */
53  virtual void tune_kernel_dynamic(ICLKernel &kernel) = 0;
54  /** Tune OpenCL kernel dynamically
55  *
56  * @param[in] kernel Kernel to tune
57  * @param[in, out] tensors Tensors for the kernel to use
58  */
59  virtual void tune_kernel_dynamic(ICLKernel &kernel, ITensorPack &tensors) = 0;
60 };
61 } // namespace arm_compute
62 #endif /*ARM_COMPUTE_ICLTUNER_H */
virtual void tune_kernel_dynamic(ICLKernel &kernel)=0
Tune OpenCL kernel dynamically.
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:68
virtual ~ICLTuner()=default
Virtual destructor.
Copyright (c) 2017-2021 Arm Limited.
virtual void tune_kernel_static(ICLKernel &kernel)=0
Tune OpenCL kernel statically.
Tensor packing service.
Definition: ITensorPack.h:39
Basic interface for tuning the OpenCL kernels.
Definition: ICLTuner.h:34