xref: /aosp_15_r20/external/ComputeLibrary/src/gpu/cl/kernels/ClWinogradOutputTransformKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-2022 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_CL_WINOGRAD_OUTPUT_TRANSFORM_KERNEL_H
25 #define ARM_COMPUTE_CL_WINOGRAD_OUTPUT_TRANSFORM_KERNEL_H
26 
27 #include "arm_compute/core/KernelDescriptors.h"
28 #include "src/core/common/Macros.h"
29 #include "src/gpu/cl/ClCompileContext.h"
30 #include "src/gpu/cl/IClKernel.h"
31 
32 namespace arm_compute
33 {
34 namespace opencl
35 {
36 namespace kernels
37 {
38 /** Interface for the Winograd output transform kernel. */
39 class ClWinogradOutputTransformKernel : public IClKernel
40 {
41 public:
42     ClWinogradOutputTransformKernel();
43     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(ClWinogradOutputTransformKernel);
44     /** Set the input and output tensor.
45      *
46      * @note Winograd output transform supports the following configurations for NCWH data layout
47      *       F(output tile, kernel size):F(2x2, 3x3), F(2x1, 3x1), F(1x2, 1x3),
48      *                                   F(4x4, 3x3), F(4x1, 3x1), F(1x4, 1x3),
49      *                                   F(4x4, 5x5), F(4x1, 5x1), F(1x4, 1x5)
50      *
51      * @note Winograd output transform supports the following configurations for NHWC data layout
52      *       F(output tile, kernel size):F(4x4, 3x3), F(4x1, 3x1), F(1x4, 1x3),
53      *                                   F(4x4, 5x5), F(4x1, 5x1), F(1x4, 1x5)
54      *
55      *       Strides: only unit strides
56      *
57      * @param[in]  compile_context The compile context to be used.
58      * @param[in]  src             Source tensor info with shape [C, N, K, batches]. Data types supported: F16/F32.
59      * @param[in]  bias            Biases tensor info. Shared biases supported. Biases are 1D tensor with dimensions [OFM]. It can be a nullptr. Data type supported: as @p src
60      * @param[out] dst             The output tensor info. The shape for this tensor can be calculated using the utility function @p compute_winograd_output_transform_shape. Data types supported: Same as @p src
61      * @param[in]  winograd_info   Contains Winograd's information described in @ref WinogradInfo
62      * @param[in]  act_info        (Optional) Activation layer information in case of a fused activation.
63      */
64     void configure(const ClCompileContext &compile_context, ITensorInfo *src, ITensorInfo *bias, ITensorInfo *dst, const WinogradInfo &winograd_info,
65                    const ActivationLayerInfo &act_info = ActivationLayerInfo());
66     /** Static function to check if given info will lead to a valid configuration
67      *
68      * Similar to ClWinogradOutputTransformKernel::configure()
69      *
70      * @return a status
71      */
72     static Status validate(const ITensorInfo *src, const ITensorInfo *bias, const ITensorInfo *dst, const WinogradInfo &winograd_info, const ActivationLayerInfo &act_info = ActivationLayerInfo());
73 
74     // Inherited methods overridden:
75     void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override;
76 
77 private:
78     using WinogradKey = std::pair<std::pair<int, int>, std::pair<int, int>>;
79 
80     bool    _is_nhwc{ false };
81     int32_t _src_height{ 0 };
82     int32_t _dst_width{ 0 };
83     int32_t _dst_height{ 0 };
84     int32_t _num_tiles_x{ 0 };
85 };
86 } // namespace kernels
87 } // namespace opencl
88 } // namespace arm_compute
89 #endif /* ARM_COMPUTE_CL_WINOGRAD_OUTPUT_TRANSFORM_KERNEL_H */
90