arm_compute/core/CL/kernels/CLBatchNormalizationLayerKernel.h

   1 /*
   2  * Copyright (c) 2017-2018 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 "arm_compute/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: QS8/QS16/F16/F32.
  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     Beta values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input
  62      * @param[in]      gamma    Gamma values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input
  63      * @param[in]      epsilon  Small value to avoid division with zero.
  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, const ICLTensor *gamma, float epsilon,
  67                    ActivationLayerInfo act_info = ActivationLayerInfo());
  68     /** Static function to check if given info will lead to a valid configuration of @ref CLBatchNormalizationLayerKernel
  69      *
  70      * @param[in] input    Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result.
  71      *                     3 lower dimensions represent a single input with dimensions [width, height, FM].
  72      *                     The rest are optional and used for representing batches. Data types supported: QS8/QS16/F16/F32.
  73      * @param[in] output   Destination tensor info. Output will have the same number of dimensions as input. Data type supported: same as @p input
  74      * @param[in] mean     Mean values tensor info. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input
  75      * @param[in] var      Variance values tensor info. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input
  76      * @param[in] beta     Beta values tensor info. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input
  77      * @param[in] gamma    Gamma values tensor info. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input
  78      * @param[in] epsilon  Small value to avoid division with zero.
  79      * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Only RELU, BOUNDED_RELU and LU_BOUNDED_RELU supported.
  80      *
  81      * @return a status
  82      */
  83     static Status validate(const ITensorInfo *input, const ITensorInfo *output,
  84                            const ITensorInfo *mean, const ITensorInfo *var,
  85                            const ITensorInfo *beta, const ITensorInfo *gamma,
  86                            float epsilon, ActivationLayerInfo act_info);
  87
  88     // Inherited methods overridden:
  89     void run(const Window &window, cl::CommandQueue &queue) override;
  90
  91 private:
  92     ICLTensor       *_input;
  93     ICLTensor       *_output;
  94     const ICLTensor *_mean;
  95     const ICLTensor *_var;
  96     const ICLTensor *_beta;
  97     const ICLTensor *_gamma;
  98     float            _epsilon;
  99     bool             _run_in_place;
 100 };
 101 } // namespace arm_compute
 102 #endif /*__ARM_COMPUTE_CLBATCHNORMALIZATIONLAYERKERNEL_H__ */