1 /* 2 * Copyright (c) 2017-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_CLBATCHNORMALIZATIONLAYER_H 25 #define ARM_COMPUTE_CLBATCHNORMALIZATIONLAYER_H 26 27 #include "arm_compute/runtime/IFunction.h" 28 29 #include "arm_compute/core/Types.h" 30 31 #include <memory> 32 33 namespace arm_compute 34 { 35 class CLCompileContext; 36 class ICLTensor; 37 class ITensorInfo; 38 class CLBatchNormalizationLayerKernel; 39 40 /** Basic function to run @ref CLNormalizationLayerKernel and simulate a batch normalization layer. 41 * 42 * Batch normalization is calculated by: 43 * @f[ out_i = \gamma * (\frac{in_i - \mu_{B}}{\sqrt{\sigma^2_{B} + \epsilon}}) + \beta \equiv BN_{\gamma,\beta}(in_i) @f] 44 * 45 */ 46 class CLBatchNormalizationLayer : public IFunction 47 { 48 public: 49 /** Default constructor */ 50 CLBatchNormalizationLayer(); 51 /** Prevent instances of this class from being copied */ 52 CLBatchNormalizationLayer(const CLBatchNormalizationLayer &) = delete; 53 /** Prevent instances of this class from being copied */ 54 CLBatchNormalizationLayer &operator=(const CLBatchNormalizationLayer &) = delete; 55 /** Prevent instances of this class to be moved */ 56 CLBatchNormalizationLayer(CLBatchNormalizationLayer &&) = delete; 57 /** Prevent instances of this class to be moved */ 58 CLBatchNormalizationLayer &operator=(CLBatchNormalizationLayer &&) = delete; 59 /** Default destructor */ 60 ~CLBatchNormalizationLayer(); 61 /** Set the input and output tensors. 62 * 63 * Valid data layouts: 64 * - NHWC 65 * - NCHW 66 * 67 * Valid data type configurations: 68 * |src |dst | 69 * |:--------------|:--------------| 70 * |F32 |F32 | 71 * |F16 |F16 | 72 * 73 * @note If the output tensor is a nullptr or is equal to the input, the batch normalization function will be performed in-place 74 * 75 * @param[in, out] input Source tensor. In case of @p output tensor = nullptr, this tensor will store the result. 76 * 3 lower dimensions represent a single input with dimensions [width, height, FM]. 77 * The rest are optional and used for representing batches. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. 78 * @param[out] output Destination tensor. Output will have the same number of dimensions as input. Data type supported: same as @p input 79 * @param[in] mean Mean values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 80 * @param[in] var Variance values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 81 * @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 82 * @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 83 * @param[in] epsilon (Optional) Small value to avoid division with zero. Default value is 0.001f. 84 * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Only RELU, BOUNDED_RELU and LU_BOUNDED_RELU supported. 85 */ 86 void configure(ICLTensor *input, ICLTensor *output, const ICLTensor *mean, const ICLTensor *var, const ICLTensor *beta = nullptr, const ICLTensor *gamma = nullptr, float epsilon = 0.001f, 87 ActivationLayerInfo act_info = ActivationLayerInfo()); 88 /** Set the input and output tensors. 89 * 90 * @note If the output tensor is a nullptr or is equal to the input, the batch normalization function will be performed in-place 91 * 92 * @param[in] compile_context The compile context to be used. 93 * @param[in, out] input Source tensor. In case of @p output tensor = nullptr, this tensor will store the result. 94 * 3 lower dimensions represent a single input with dimensions [width, height, FM]. 95 * The rest are optional and used for representing batches. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. 96 * @param[out] output Destination tensor. Output will have the same number of dimensions as input. Data type supported: same as @p input 97 * @param[in] mean Mean values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 98 * @param[in] var Variance values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 99 * @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 100 * @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 101 * @param[in] epsilon (Optional) Small value to avoid division with zero. Default value is 0.001f. 102 * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Only RELU, BOUNDED_RELU and LU_BOUNDED_RELU supported. 103 */ 104 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const ICLTensor *mean, const ICLTensor *var, const ICLTensor *beta = nullptr, 105 const ICLTensor *gamma = nullptr, 106 float epsilon = 0.001f, ActivationLayerInfo act_info = ActivationLayerInfo()); 107 /** Static function to check if given info will lead to a valid configuration of @ref CLBatchNormalizationLayer 108 * 109 * @param[in] input Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result. 110 * 3 lower dimensions represent a single input with dimensions [width, height, FM]. 111 * The rest are optional and used for representing batches. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. 112 * @param[in] output Destination tensor info. Output will have the same number of dimensions as input. Data type supported: same as @p input 113 * @param[in] mean Mean values tensor info. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 114 * @param[in] var Variance values tensor info. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 115 * @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 116 * @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 117 * @param[in] epsilon (Optional) Small value to avoid division with zero. Default value is 0.001f. 118 * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Only RELU, BOUNDED_RELU and LU_BOUNDED_RELU supported. 119 * 120 * @return a status 121 */ 122 static Status validate(const ITensorInfo *input, const ITensorInfo *output, 123 const ITensorInfo *mean, const ITensorInfo *var, 124 const ITensorInfo *beta = nullptr, const ITensorInfo *gamma = nullptr, 125 float epsilon = 0.001f, ActivationLayerInfo act_info = ActivationLayerInfo()); 126 127 // Inherited methods overridden: 128 void run() override; 129 130 private: 131 std::unique_ptr<CLBatchNormalizationLayerKernel> _norm_kernel; /**< BatchNormalization layer kernel to run */ 132 }; 133 } // namespace arm_compute 134 #endif /* ARM_COMPUTE_CLBATCHNORMALIZATIONLAYER_H */ 135