xref: /aosp_15_r20/external/ComputeLibrary/src/core/CL/kernels/CLInstanceNormalizationLayerKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2019-2021 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_CLINSTANCENORMALIZATIONLAYERKERNEL_H
25 #define ARM_COMPUTE_CLINSTANCENORMALIZATIONLAYERKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 #include "arm_compute/core/KernelDescriptors.h"
30 
31 namespace arm_compute
32 {
33 // Forward declarations
34 class ICLTensor;
35 
36 /** Interface for performing an instance normalization */
37 class CLInstanceNormalizationLayerKernel : public ICLKernel
38 {
39 public:
40     /** Constructor */
41     CLInstanceNormalizationLayerKernel();
42     /** Prevent instances of this class from being copied (As this class contains pointers) */
43     CLInstanceNormalizationLayerKernel(const CLInstanceNormalizationLayerKernel &) = delete;
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     CLInstanceNormalizationLayerKernel &operator=(const CLInstanceNormalizationLayerKernel &) = delete;
46     /** Default Move Constructor. */
47     CLInstanceNormalizationLayerKernel(CLInstanceNormalizationLayerKernel &&) = default;
48     /** Default move assignment operator */
49     CLInstanceNormalizationLayerKernel &operator=(CLInstanceNormalizationLayerKernel &&) = default;
50     /** Default destructor */
51     ~CLInstanceNormalizationLayerKernel() = default;
52 
53     /** Set the input and output tensors.
54      *
55      * @param[in]      compile_context The compile context to be used.
56      * @param[in, out] input           Source tensor. Data types supported: F16/F32. Data layout supported: NCHW, NHWC
57      *                                 In case of @p output tensor = nullptr this tensor will store the result of the normalization.
58      * @param[in]      mean_var        Tensor containing the precomputed mean and variance values. Data types supported: F32.
59      * @param[out]     output          Destination tensor. Data types and data layouts supported: same as @p input.
60      * @param[in]      info            Kernel meta-data descriptor
61      */
62     void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *mean_var, ICLTensor *output, const InstanceNormalizationLayerKernelInfo &info);
63 
64     /** Static function to check if given info will lead to a valid configuration of @ref CLInstanceNormalizationLayer.
65      *
66      * @param[in] input  Source tensor info. Data types supported: F16/F32. Data layout supported: NHWC, NCHW
67      * @param[in] output Destination tensor info. Data types and data layouts supported: same as @p input.
68      * @param[in] info   Kernel meta-data descriptor
69      *
70      * @return a status
71      */
72     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const InstanceNormalizationLayerKernelInfo &info);
73 
74     // Inherited methods overridden:
75     void run(const Window &window, cl::CommandQueue &queue) override;
76 
77 private:
78     ICLTensor *_input;
79     ICLTensor *_output;
80     ICLTensor *_mean;
81     bool       _run_in_place;
82 };
83 
84 /** Interface for compute Mean and Variance per channel */
85 class CLComputeMeanVariance : public ICLKernel
86 {
87 public:
88     /** Constructor */
89     CLComputeMeanVariance();
90     /** Prevent instances of this class from being copied (As this class contains pointers) */
91     CLComputeMeanVariance(const CLComputeMeanVariance &) = delete;
92     /** Prevent instances of this class from being copied (As this class contains pointers) */
93     CLComputeMeanVariance &operator=(const CLComputeMeanVariance &) = delete;
94     /** Default Move Constructor. */
95     CLComputeMeanVariance(CLComputeMeanVariance &&) = default;
96     /** Default move assignment operator */
97     CLComputeMeanVariance &operator=(CLComputeMeanVariance &&) = default;
98     /** Default destructor */
99     ~CLComputeMeanVariance() = default;
100 
101     /** Set the input and output tensors.
102      *
103      * @param[in]      compile_context     The compile context to be used.
104      * @param[in, out] input               Source tensor. Data types supported: F16/F32. Data layout supported: NCHW, NHWC
105      *                                     In case of @p output tensor = nullptr this tensor will store the result of the normalization.
106      * @param[out]     output              Destination tensor. Data types and data layouts supported: same as @p input.
107      * @param[in]      use_mixed_precision Use mixed precision in case of FP16 execution
108      */
109     void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, bool use_mixed_precision);
110 
111     /** Static function to check if given info will lead to a valid configuration of @ref CLInstanceNormalizationLayer.
112      *
113      * @param[in] input  Source tensor info. Data types supported: F16/F32. Data layout supported: NHWC, NCHW
114      * @param[in] output Destination tensor info. Data types and data layouts supported: same as @p input.
115      *
116      * @return a status
117      */
118     static Status validate(const ITensorInfo *input, const ITensorInfo *output);
119 
120     // Inherited methods overridden:
121     void run(const Window &window, cl::CommandQueue &queue) override;
122 
123 private:
124     ICLTensor *_input;
125     ICLTensor *_output;
126 };
127 } // namespace arm_compute
128 #endif /*ARM_COMPUTE_CLINSTANCENORMALIZATIONLAYERKERNEL_H */
129