Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 1 | /* |
Pablo Marquez Tello | fe7ae81 | 2021-03-03 12:12:35 +0000 | [diff] [blame] | 2 | * Copyright (c) 2019-2021 Arm Limited. |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +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_CLINSTANCENORMALIZATIONLAYER_H |
| 25 | #define ARM_COMPUTE_CLINSTANCENORMALIZATIONLAYER_H |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 26 | |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 27 | #include "arm_compute/core/Error.h" |
Pablo Marquez Tello | fe7ae81 | 2021-03-03 12:12:35 +0000 | [diff] [blame] | 28 | #include "arm_compute/runtime/CL/CLTensor.h" |
| 29 | #include "arm_compute/runtime/IFunction.h" |
| 30 | |
| 31 | #include <memory> |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 32 | |
| 33 | namespace arm_compute |
| 34 | { |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 35 | class CLCompileContext; |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 36 | class ICLTensor; |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 37 | class ITensorInfo; |
Pablo Marquez Tello | fe7ae81 | 2021-03-03 12:12:35 +0000 | [diff] [blame] | 38 | class ICLKernel; |
| 39 | class CLRuntimeContext; |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 40 | |
| 41 | /** Basic function to perform a Instance normalization. |
| 42 | * |
| 43 | * This function runs the following kernels: |
| 44 | * -# @ref CLInstanceNormalizationLayerKernel |
| 45 | */ |
Pablo Marquez Tello | fe7ae81 | 2021-03-03 12:12:35 +0000 | [diff] [blame] | 46 | class CLInstanceNormalizationLayer : public IFunction |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 47 | { |
| 48 | public: |
Pablo Marquez Tello | fe7ae81 | 2021-03-03 12:12:35 +0000 | [diff] [blame] | 49 | /** Constructor |
| 50 | * |
| 51 | * @param[in] ctx Runtime context to be used by the function |
| 52 | */ |
| 53 | CLInstanceNormalizationLayer(CLRuntimeContext *ctx = nullptr); |
| 54 | |
| 55 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 56 | CLInstanceNormalizationLayer(const CLInstanceNormalizationLayer &) = delete; |
| 57 | /** Default move constructor */ |
| 58 | CLInstanceNormalizationLayer(CLInstanceNormalizationLayer &&) = default; |
| 59 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 60 | CLInstanceNormalizationLayer &operator=(const CLInstanceNormalizationLayer &) = delete; |
| 61 | /** Default move assignment operator */ |
| 62 | CLInstanceNormalizationLayer &operator=(CLInstanceNormalizationLayer &&) = default; |
| 63 | /** Default destructor */ |
| 64 | ~CLInstanceNormalizationLayer(); |
| 65 | |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 66 | /** Set the input and output tensors. |
| 67 | * |
Teresa Charlin | 6268742 | 2021-04-28 10:58:49 +0100 | [diff] [blame] | 68 | * Valid data layouts: |
| 69 | * - NHWC |
| 70 | * - NCHW |
| 71 | * |
| 72 | * Valid data type configurations: |
| 73 | * |src |dst | |
| 74 | * |:--------|:---------| |
| 75 | * |F16 |F16 | |
| 76 | * |F32 |F32 | |
| 77 | * |
Georgios Pinitas | 55a687d | 2020-01-30 12:00:23 +0000 | [diff] [blame] | 78 | * @param[in, out] input Source tensor. In case of @p output tensor = nullptr this tensor will store the result of the normalization. |
| 79 | * Data types supported: F16/F32. Data layout supported: NHWC, NCHW |
| 80 | * @param[out] output Destination tensor. Data types and data layouts supported: same as @p input. |
| 81 | * @param[in] gamma (Optional) The scale scalar value applied to the normalized tensor. Defaults to 1.0 |
| 82 | * @param[in] beta (Optional) The offset scalar value applied to the normalized tensor. Defaults to 0.0 |
| 83 | * @param[in] epsilon (Optional) Lower bound value for the normalization. Defaults to 1e-12 |
| 84 | * @param[in] use_mixed_precision (Optional) Use mixed precision in case of FP16 execution |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 85 | */ |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 86 | void configure(ICLTensor *input, |
| 87 | ICLTensor *output, |
| 88 | float gamma = 1.0f, |
| 89 | float beta = 0.0f, |
| 90 | float epsilon = 1e-12f, |
| 91 | bool use_mixed_precision = true); |
Manuel Bottini | 2b84be5 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 92 | /** Set the input and output tensors. |
| 93 | * |
| 94 | * @param[in] compile_context The compile context to be used. |
| 95 | * @param[in, out] input Source tensor. In case of @p output tensor = nullptr this tensor will store the result of the normalization. |
| 96 | * Data types supported: F16/F32. Data layout supported: NHWC, NCHW |
| 97 | * @param[out] output Destination tensor. Data types and data layouts supported: same as @p input. |
| 98 | * @param[in] gamma (Optional) The scale scalar value applied to the normalized tensor. Defaults to 1.0 |
| 99 | * @param[in] beta (Optional) The offset scalar value applied to the normalized tensor. Defaults to 0.0 |
| 100 | * @param[in] epsilon (Optional) Lower bound value for the normalization. Defaults to 1e-12 |
| 101 | * @param[in] use_mixed_precision (Optional) Use mixed precision in case of FP16 execution |
| 102 | */ |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 103 | void configure(const CLCompileContext &compile_context, |
| 104 | ICLTensor *input, |
| 105 | ICLTensor *output, |
| 106 | float gamma = 1.0f, |
| 107 | float beta = 0.0f, |
| 108 | float epsilon = 1e-12f, |
| 109 | bool use_mixed_precision = true); |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 110 | |
| 111 | /** Static function to check if given info will lead to a valid configuration of @ref CLInstanceNormalizationLayer. |
| 112 | * |
Georgios Pinitas | 55a687d | 2020-01-30 12:00:23 +0000 | [diff] [blame] | 113 | * @param[in] input Source tensor info. Data types supported: F16/F32. Data layout supported: NHWC, NCHW |
| 114 | * @param[in] output Destination tensor info. Data types and data layouts supported: same as @p input. |
| 115 | * @param[in] gamma (Optional) The scale scalar value applied to the normalized tensor. Defaults to 1.0 |
| 116 | * @param[in] beta (Optional) The offset scalar value applied to the normalized tensor. Defaults to 0.0 |
| 117 | * @param[in] epsilon (Optional) Lower bound value for the normalization. Defaults to 1e-12 |
| 118 | * @param[in] use_mixed_precision (Optional) Use mixed precision in case of FP16 execution |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 119 | * |
| 120 | * @return a status |
| 121 | */ |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 122 | static Status validate(const ITensorInfo *input, |
| 123 | const ITensorInfo *output, |
| 124 | float gamma = 1.0f, |
| 125 | float beta = 0.0f, |
| 126 | float epsilon = 1e-12f, |
| 127 | bool use_mixed_precision = true); |
| 128 | void run() override; |
Pablo Marquez Tello | fe7ae81 | 2021-03-03 12:12:35 +0000 | [diff] [blame] | 129 | |
| 130 | private: |
| 131 | std::unique_ptr<ICLKernel> _inst_norm_kernel; /**< Kernel to run */ |
| 132 | std::unique_ptr<ICLKernel> _mean_var_kernel; /**< Kernel to run */ |
| 133 | CLTensor _mean_var_tensor; |
| 134 | CLRuntimeContext *_ctx; /**< Context to use */ |
Manuel Bottini | 79f88e6 | 2019-09-18 15:02:53 +0100 | [diff] [blame] | 135 | }; |
| 136 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 137 | #endif /* ARM_COMPUTE_CLINSTANCENORMALIZATIONLAYER_H */ |