Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 1 | /* |
Teresa Charlin | 6268742 | 2021-04-28 10:58:49 +0100 | [diff] [blame] | 2 | * Copyright (c) 2017-2021 Arm Limited. |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +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_CLL2NORMALIZELAYER_H |
| 25 | #define ARM_COMPUTE_CLL2NORMALIZELAYER_H |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 26 | |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 27 | #include "arm_compute/core/Types.h" |
| 28 | #include "arm_compute/runtime/CL/CLTensor.h" |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 29 | #include "arm_compute/runtime/CL/functions/CLReductionOperation.h" |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 30 | #include "arm_compute/runtime/CL/ICLSimpleFunction.h" |
Georgios Pinitas | 8a94e7c | 2017-09-15 19:06:47 +0100 | [diff] [blame] | 31 | #include "arm_compute/runtime/IMemoryManager.h" |
Georgios Pinitas | 26014cf | 2019-09-09 19:00:57 +0100 | [diff] [blame] | 32 | #include "arm_compute/runtime/MemoryGroup.h" |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 33 | |
| 34 | #include <cstdint> |
Georgios Pinitas | 8a94e7c | 2017-09-15 19:06:47 +0100 | [diff] [blame] | 35 | #include <memory> |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 36 | |
| 37 | namespace arm_compute |
| 38 | { |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 39 | class CLCompileContext; |
| 40 | class CLL2NormalizeLayerKernel; |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 41 | class ICLTensor; |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 42 | class ITensorInfo; |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 43 | |
John Richardson | 62385bc | 2018-04-20 13:11:36 +0100 | [diff] [blame] | 44 | /** Basic function to perform a L2 normalization on a given axis. |
| 45 | * |
| 46 | * This function runs the following kernels: |
| 47 | * -# @ref CLReductionOperation |
| 48 | * -# @ref CLL2NormalizeLayerKernel |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 49 | */ |
Giorgio Arena | 04a8f8c | 2017-11-23 11:45:24 +0000 | [diff] [blame] | 50 | class CLL2NormalizeLayer : public IFunction |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 51 | { |
| 52 | public: |
| 53 | /** Constructor */ |
Giorgio Arena | 04a8f8c | 2017-11-23 11:45:24 +0000 | [diff] [blame] | 54 | CLL2NormalizeLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr); |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 55 | /** Default Destructor */ |
| 56 | ~CLL2NormalizeLayer(); |
| 57 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 58 | CLL2NormalizeLayer(const CLL2NormalizeLayer &) = delete; |
| 59 | /** Default move constructor */ |
| 60 | CLL2NormalizeLayer(CLL2NormalizeLayer &&) = default; |
| 61 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 62 | CLL2NormalizeLayer &operator=(const CLL2NormalizeLayer &) = delete; |
| 63 | /** Default move assignment operator */ |
| 64 | CLL2NormalizeLayer &operator=(CLL2NormalizeLayer &&) = default; |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 65 | |
| 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 | * |
Michalis Spyrou | 5538d34 | 2018-11-14 08:10:13 +0000 | [diff] [blame] | 78 | * @param[in] input Source tensor. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. |
John Richardson | 62385bc | 2018-04-20 13:11:36 +0100 | [diff] [blame] | 79 | * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input. |
Manuel Bottini | 4b5c588 | 2019-05-14 10:38:30 +0100 | [diff] [blame] | 80 | * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2 |
John Richardson | 62385bc | 2018-04-20 13:11:36 +0100 | [diff] [blame] | 81 | * @param[in] epsilon (Optional) Lower bound value for the normalization. |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 82 | */ |
Manuel Bottini | 4b5c588 | 2019-05-14 10:38:30 +0100 | [diff] [blame] | 83 | void configure(ICLTensor *input, ICLTensor *output, int axis, float epsilon = 1e-12f); |
Manuel Bottini | 2b84be5 | 2020-04-08 10:15:51 +0100 | [diff] [blame] | 84 | /** Set the input and output tensors. |
| 85 | * |
| 86 | * @param[in] compile_context The compile context to be used. |
| 87 | * @param[in] input Source tensor. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. |
| 88 | * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input. |
| 89 | * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2 |
| 90 | * @param[in] epsilon (Optional) Lower bound value for the normalization. |
| 91 | */ |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 92 | void configure( |
| 93 | const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, int axis, float epsilon = 1e-12f); |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 94 | |
John Richardson | 62385bc | 2018-04-20 13:11:36 +0100 | [diff] [blame] | 95 | /** Static function to check if given info will lead to a valid configuration of @ref CLL2NormalizeLayer. |
| 96 | * |
Michalis Spyrou | 5538d34 | 2018-11-14 08:10:13 +0000 | [diff] [blame] | 97 | * @param[in] input Source tensor info. Data types supported: F16/F32. Data layouts supported: NCHW/NHWC. |
John Richardson | 62385bc | 2018-04-20 13:11:36 +0100 | [diff] [blame] | 98 | * @param[in] output Destination tensor info. Data types and data layouts supported: Same as @p input. |
Manuel Bottini | 4b5c588 | 2019-05-14 10:38:30 +0100 | [diff] [blame] | 99 | * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2 |
John Richardson | 62385bc | 2018-04-20 13:11:36 +0100 | [diff] [blame] | 100 | * @param[in] epsilon (Optional) Lower bound value for the normalization. |
| 101 | * |
| 102 | * @return a status |
| 103 | */ |
Manuel Bottini | 4b5c588 | 2019-05-14 10:38:30 +0100 | [diff] [blame] | 104 | static Status validate(const ITensorInfo *input, const ITensorInfo *output, int axis, float epsilon = 1e-12f); |
John Richardson | 62385bc | 2018-04-20 13:11:36 +0100 | [diff] [blame] | 105 | |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 106 | // Inherited methods overridden: |
| 107 | void run() override; |
| 108 | |
| 109 | private: |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 110 | MemoryGroup _memory_group; |
| 111 | CLReductionOperation _reduce_func; |
| 112 | std::unique_ptr<CLL2NormalizeLayerKernel> _normalize_kernel; |
| 113 | CLTensor _sumsq; |
Michalis Spyrou | 04f089c | 2017-08-08 17:42:38 +0100 | [diff] [blame] | 114 | }; |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 115 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 116 | #endif /*ARM_COMPUTE_CLL2NORMALIZELAYER_H */ |