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_CLBATCHNORMALIZATIONLAYERKERNEL_H 25 #define ARM_COMPUTE_CLBATCHNORMALIZATIONLAYERKERNEL_H 26 27 #include "src/core/CL/ICLKernel.h" 28 29 namespace arm_compute 30 { 31 class ICLTensor; 32 33 /** Interface for the BatchNormalization layer kernel. 34 */ 35 class CLBatchNormalizationLayerKernel : public ICLKernel 36 { 37 public: 38 /** Constructor */ 39 CLBatchNormalizationLayerKernel(); 40 /** Prevent instances of this class from being copied (As this class contains pointers) */ 41 CLBatchNormalizationLayerKernel(const CLBatchNormalizationLayerKernel &) = delete; 42 /** Prevent instances of this class from being copied (As this class contains pointers) */ 43 CLBatchNormalizationLayerKernel &operator=(const CLBatchNormalizationLayerKernel &) = delete; 44 /** Default Move Constructor. */ 45 CLBatchNormalizationLayerKernel(CLBatchNormalizationLayerKernel &&) = default; 46 /** Default move assignment operator */ 47 CLBatchNormalizationLayerKernel &operator=(CLBatchNormalizationLayerKernel &&) = default; 48 /** Default destructor */ 49 ~CLBatchNormalizationLayerKernel() = default; 50 51 /** Set the input and output tensors. 52 * 53 * @note If the output tensor is a nullptr, the batch normalization function will be performed in-place 54 * 55 * @param[in, out] input Source tensor. In case of @p output tensor = nullptr, this tensor will store the result. 56 * 3 lower dimensions represent a single input with dimensions [width, height, FM]. 57 * The rest are optional and used for representing batches. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. 58 * @param[out] output Destination tensor. Output will have the same number of dimensions as input. Data type supported: same as @p input 59 * @param[in] mean Mean values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 60 * @param[in] var Variance values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 61 * @param[in] beta (Optional) Beta values tensor info. 1 dimension with size equal to the feature maps [FM]. If not provided, default value for beta is 0. Data types supported: Same as @p input 62 * @param[in] gamma (Optional) Gamma values tensor info. 1 dimension with size equal to the feature maps [FM]. If not provided, default value for gamma is 1. Data types supported: Same as @p input 63 * @param[in] epsilon (Optional) Small value to avoid division with zero. Default value is 0.001f. 64 * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Only RELU, BOUNDED_RELU and LU_BOUNDED_RELU supported. 65 */ 66 void configure(ICLTensor *input, ICLTensor *output, const ICLTensor *mean, const ICLTensor *var, const ICLTensor *beta = nullptr, const ICLTensor *gamma = nullptr, float epsilon = 0.001f, 67 ActivationLayerInfo act_info = ActivationLayerInfo()); 68 /** Set the input and output tensors. 69 * 70 * @note If the output tensor is a nullptr, the batch normalization function will be performed in-place 71 * 72 * @param[in] compile_context The compile context to be used. 73 * @param[in, out] input Source tensor. In case of @p output tensor = nullptr, this tensor will store the result. 74 * 3 lower dimensions represent a single input with dimensions [width, height, FM]. 75 * The rest are optional and used for representing batches. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. 76 * @param[out] output Destination tensor. Output will have the same number of dimensions as input. Data type supported: same as @p input 77 * @param[in] mean Mean values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 78 * @param[in] var Variance values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 79 * @param[in] beta (Optional) Beta values tensor info. 1 dimension with size equal to the feature maps [FM]. If not provided, default value for beta is 0. Data types supported: Same as @p input 80 * @param[in] gamma (Optional) Gamma values tensor info. 1 dimension with size equal to the feature maps [FM]. If not provided, default value for gamma is 1. Data types supported: Same as @p input 81 * @param[in] epsilon (Optional) Small value to avoid division with zero. Default value is 0.001f. 82 * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Only RELU, BOUNDED_RELU and LU_BOUNDED_RELU supported. 83 */ 84 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const ICLTensor *mean, const ICLTensor *var, const ICLTensor *beta = nullptr, 85 const ICLTensor *gamma = nullptr, float epsilon = 0.001f, ActivationLayerInfo act_info = ActivationLayerInfo()); 86 /** Static function to check if given info will lead to a valid configuration of @ref CLBatchNormalizationLayerKernel 87 * 88 * @param[in] input Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result. 89 * 3 lower dimensions represent a single input with dimensions [width, height, FM]. 90 * The rest are optional and used for representing batches. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. 91 * @param[in] output Destination tensor info. Output will have the same number of dimensions as input. Data type supported: same as @p input 92 * @param[in] mean Mean values tensor info. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 93 * @param[in] var Variance values tensor info. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 94 * @param[in] beta (Optional) Beta values tensor info. 1 dimension with size equal to the feature maps [FM]. If not provided, default value for beta is 0. Data types supported: Same as @p input 95 * @param[in] gamma (Optional) Gamma values tensor info. 1 dimension with size equal to the feature maps [FM]. If not provided, default value for gamma is 1. Data types supported: Same as @p input 96 * @param[in] epsilon (Optional) Small value to avoid division with zero. Default value is 0.001f. 97 * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Only RELU, BOUNDED_RELU and LU_BOUNDED_RELU supported. 98 * 99 * @return a status 100 */ 101 static Status validate(const ITensorInfo *input, const ITensorInfo *output, 102 const ITensorInfo *mean, const ITensorInfo *var, 103 const ITensorInfo *beta = nullptr, const ITensorInfo *gamma = nullptr, 104 float epsilon = 0.001f, ActivationLayerInfo act_info = ActivationLayerInfo()); 105 106 // Inherited methods overridden: 107 void run(const Window &window, cl::CommandQueue &queue) override; 108 109 private: 110 ICLTensor *_input; 111 ICLTensor *_output; 112 const ICLTensor *_mean; 113 const ICLTensor *_var; 114 const ICLTensor *_beta; 115 const ICLTensor *_gamma; 116 float _epsilon; 117 bool _run_in_place; 118 }; 119 } // namespace arm_compute 120 #endif /*ARM_COMPUTE_CLBATCHNORMALIZATIONLAYERKERNEL_H */ 121