Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Matthew Bentham | f1aeab9 | 2023-05-30 13:35:34 +0000 | [diff] [blame] | 2 | * Copyright (c) 2017-2020, 2023 Arm Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_NEBATCHNORMALIZATIONLAYERKERNEL_H |
| 25 | #define ARM_COMPUTE_NEBATCHNORMALIZATIONLAYERKERNEL_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
SiCong Li | 9129549 | 2023-07-21 18:16:13 +0100 | [diff] [blame] | 27 | #include "arm_compute/function_info/ActivationLayerInfo.h" |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 28 | #include "src/core/NEON/INEKernel.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 29 | |
| 30 | namespace arm_compute |
| 31 | { |
Georgios Pinitas | 980a916 | 2020-06-03 20:16:46 +0100 | [diff] [blame] | 32 | // Forward declarations |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 33 | class ITensor; |
| 34 | |
| 35 | /** Interface for the batch normalization layer kernel. |
| 36 | */ |
| 37 | class NEBatchNormalizationLayerKernel : public INEKernel |
| 38 | { |
| 39 | public: |
Anthony Barbier | e8a4983 | 2018-01-18 10:04:05 +0000 | [diff] [blame] | 40 | const char *name() const override |
| 41 | { |
| 42 | return "NEBatchNormalizationLayerKernel"; |
| 43 | } |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 44 | /** Default constructor */ |
| 45 | NEBatchNormalizationLayerKernel(); |
| 46 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 47 | NEBatchNormalizationLayerKernel(const NEBatchNormalizationLayerKernel &) = delete; |
| 48 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 49 | NEBatchNormalizationLayerKernel &operator=(const NEBatchNormalizationLayerKernel &) = delete; |
| 50 | /** Default Move Constructor. */ |
| 51 | NEBatchNormalizationLayerKernel(NEBatchNormalizationLayerKernel &&) = default; |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 52 | /** Default move assignment operator */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 53 | NEBatchNormalizationLayerKernel &operator=(NEBatchNormalizationLayerKernel &&) = default; |
| 54 | /** Default destructor */ |
| 55 | ~NEBatchNormalizationLayerKernel() = default; |
| 56 | /** Set the input and output tensors. |
| 57 | * |
Georgios Pinitas | 409ee0a | 2017-08-18 10:16:09 +0100 | [diff] [blame] | 58 | * @note If the output tensor is a nullptr, the batch normalization function will be performed in-place |
| 59 | * |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 60 | * @param[in, out] input Source tensor. In case of @p output tensor = nullptr, this tensor will store the result. |
| 61 | * 3 lower dimensions represent a single input with dimensions [width, height, FM]. |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 62 | * The rest are optional and used for representing batches. Data types supported: F16/F32. |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 63 | * @param[out] output Destination tensor. Output will have the same number of dimensions as input. Data type supported: same as @p input |
| 64 | * @param[in] mean Mean values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input |
| 65 | * @param[in] var Variance values tensor. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input |
Michele Di Giorgio | 4d33630 | 2018-03-02 09:43:54 +0000 | [diff] [blame] | 66 | * @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 |
| 67 | * @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 |
| 68 | * @param[in] epsilon (Optional) Small value to avoid division with zero. Default value is 0.001f. |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 69 | * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Only RELU, BOUNDED_RELU and LU_BOUNDED_RELU supported. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 70 | */ |
Michele Di Giorgio | 4d33630 | 2018-03-02 09:43:54 +0000 | [diff] [blame] | 71 | void configure(ITensor *input, ITensor *output, const ITensor *mean, const ITensor *var, const ITensor *beta = nullptr, const ITensor *gamma = nullptr, float epsilon = 0.001f, |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 72 | ActivationLayerInfo act_info = ActivationLayerInfo()); |
Ioan-Cristian Szabo | 303be90 | 2017-11-27 16:31:10 +0000 | [diff] [blame] | 73 | /** Static function to check if given info will lead to a valid configuration of @ref NEBatchNormalizationLayerKernel |
| 74 | * |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 75 | * @param[in] input Source tensor info. 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]. |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 77 | * The rest are optional and used for representing batches. Data types supported: F16/F32. |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 78 | * @param[in] output Destination tensor info. Output will have the same number of dimensions as input. Data type supported: same as @p input |
| 79 | * @param[in] mean Mean values tensor info. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input |
| 80 | * @param[in] var Variance values tensor info. 1 dimension with size equal to the feature maps [FM]. Data types supported: Same as @p input |
Michele Di Giorgio | 4d33630 | 2018-03-02 09:43:54 +0000 | [diff] [blame] | 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. |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 84 | * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Only RELU, BOUNDED_RELU and LU_BOUNDED_RELU supported. |
Ioan-Cristian Szabo | 303be90 | 2017-11-27 16:31:10 +0000 | [diff] [blame] | 85 | * |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 86 | * @return a status |
Ioan-Cristian Szabo | 303be90 | 2017-11-27 16:31:10 +0000 | [diff] [blame] | 87 | */ |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 88 | static Status validate(const ITensorInfo *input, const ITensorInfo *output, |
| 89 | const ITensorInfo *mean, const ITensorInfo *var, |
Michele Di Giorgio | 4d33630 | 2018-03-02 09:43:54 +0000 | [diff] [blame] | 90 | const ITensorInfo *beta = nullptr, const ITensorInfo *gamma = nullptr, |
| 91 | float epsilon = 0.001f, ActivationLayerInfo act_info = ActivationLayerInfo()); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 92 | |
| 93 | // Inherited methods overridden: |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 94 | void run(const Window &window, const ThreadInfo &info) override; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 95 | |
| 96 | private: |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 97 | /** Configure execution function in case of non-fused activation **/ |
| 98 | void configure_non_fused(); |
| 99 | /** Configure execution function in case of fused activation **/ |
| 100 | void configure_fused(); |
Vidhya Sudhan Loganathan | 7485d5a | 2018-07-04 09:34:00 +0100 | [diff] [blame] | 101 | |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 102 | /** Template function to run batch normalization on fp32 |
| 103 | * |
Georgios Pinitas | 980a916 | 2020-06-03 20:16:46 +0100 | [diff] [blame] | 104 | * @tparam T Specialization data type |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 105 | * @tparam fused_activation Boolean that flags if its a fused activation or not |
| 106 | * @tparam F Activation function functor to run |
| 107 | * |
| 108 | * @param[in] window Region on which to execute the kernel. (Must be a valid region of the window returned by window()). |
| 109 | */ |
Georgios Pinitas | 980a916 | 2020-06-03 20:16:46 +0100 | [diff] [blame] | 110 | template <typename T, bool fused_activation, typename F> |
| 111 | void batch_normalization_nchw(const Window &window); |
Michele Di Giorgio | 0cbb927 | 2018-03-01 16:56:48 +0000 | [diff] [blame] | 112 | /** Template function to run batch normalization on fp32 on tensors with NHWC format |
| 113 | * |
Georgios Pinitas | 980a916 | 2020-06-03 20:16:46 +0100 | [diff] [blame] | 114 | * @tparam T Specialization data type |
Michele Di Giorgio | 0cbb927 | 2018-03-01 16:56:48 +0000 | [diff] [blame] | 115 | * @tparam fused_activation Boolean that flags if its a fused activation or not |
| 116 | * @tparam F Activation function functor to run |
| 117 | * |
| 118 | * @param[in] window Region on which to execute the kernel. (Must be a valid region of the window returned by window()). |
| 119 | */ |
Georgios Pinitas | 980a916 | 2020-06-03 20:16:46 +0100 | [diff] [blame] | 120 | template <typename T, bool fused_activation, typename F> |
| 121 | void batch_normalization_nhwc(const Window &window); |
Georgios Pinitas | 57c033b | 2018-02-15 12:29:44 +0000 | [diff] [blame] | 122 | /** Common signature for all the batch normalization functions |
| 123 | * |
| 124 | * @param[in] window Region on which to execute the kernel. |
| 125 | */ |
| 126 | using BatchNormFunctionPtr = void (NEBatchNormalizationLayerKernel::*)(const Window &window); |
| 127 | |
| 128 | private: |
| 129 | BatchNormFunctionPtr _func; |
| 130 | ITensor *_input; |
| 131 | ITensor *_output; |
| 132 | const ITensor *_mean; |
| 133 | const ITensor *_var; |
| 134 | const ITensor *_gamma; |
| 135 | const ITensor *_beta; |
| 136 | float _epsilon; |
| 137 | ActivationLayerInfo _act_info; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 138 | }; |
Gian Marco Iodice | 356f643 | 2017-09-22 11:32:21 +0100 | [diff] [blame] | 139 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 140 | #endif /*ARM_COMPUTE_NEBATCHNORMALIZATIONLAYERKERNEL_H */ |