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_GCBATCHNORMALIZATIONLAYER_H 25 #define ARM_COMPUTE_GCBATCHNORMALIZATIONLAYER_H 26 27 #include "arm_compute/runtime/IFunction.h" 28 29 #include "arm_compute/core/GLES_COMPUTE/kernels/GCBatchNormalizationLayerKernel.h" 30 #include "arm_compute/core/Types.h" 31 32 namespace arm_compute 33 { 34 class IGCTensor; 35 36 /** Basic function to run @ref GCBatchNormalizationLayerKernel and simulate a batch normalization layer. 37 * 38 * Batch normalization is calculated by: 39 * @f[ out_i = \gamma * (\frac{in_i - \mu_{B}}{\sqrt{\sigma^2_{B} + \epsilon}}) + \beta \equiv BN_{\gamma,\beta}(in_i) @f] 40 * 41 * @deprecated This function is deprecated and is intended to be removed in 21.05 release 42 * 43 */ 44 class GCBatchNormalizationLayer : public IFunction 45 { 46 public: 47 /** Default constructor */ 48 GCBatchNormalizationLayer(); 49 /** Set the input and output tensors. 50 * 51 * @param[in] input Source tensor. 3 lower dimensions represent a single input with dimensions [width, height, FM]. 52 * The rest are optional and used for representing batches. Data types supported: F16/F32. 53 * @param[out] output Destination tensor. Output will have the same number of dimensions as input. Data type supported: same as @p input 54 * @param[in] mean Mean values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 55 * @param[in] var Variance values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 56 * @param[in] beta Beta values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 57 * @param[in] gamma Gamma values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input 58 * @param[in] epsilon Small value to avoid division with zero. 59 * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Only RELU, BOUNDED_RELU and LU_BOUNDED_RELU supported. 60 */ 61 void configure(const IGCTensor *input, IGCTensor *output, const IGCTensor *mean, const IGCTensor *var, const IGCTensor *beta, const IGCTensor *gamma, float epsilon, 62 ActivationLayerInfo act_info = ActivationLayerInfo()); 63 64 // Inherited methods overridden: 65 void run() override; 66 67 private: 68 GCBatchNormalizationLayerKernel _norm_kernel; /**< BatchNormalization layer kernel to run */ 69 }; 70 } 71 #endif /* ARM_COMPUTE_GCBATCHNORMALIZATIONLAYER_H */ 72