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