Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 1 | /* |
Teresa Charlin | 6268742 | 2021-04-28 10:58:49 +0100 | [diff] [blame^] | 2 | * Copyright (c) 2017-2021 Arm Limited. |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +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_NEL2NORMALIZELAYER_H |
| 25 | #define ARM_COMPUTE_NEL2NORMALIZELAYER_H |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 26 | |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 27 | #include "arm_compute/runtime/IFunction.h" |
Georgios Pinitas | 658039b | 2017-09-15 16:30:50 +0100 | [diff] [blame] | 28 | #include "arm_compute/runtime/IMemoryManager.h" |
| 29 | #include "arm_compute/runtime/MemoryGroup.h" |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 30 | #include "arm_compute/runtime/NEON/functions/NEReductionOperation.h" |
| 31 | #include "arm_compute/runtime/Tensor.h" |
| 32 | |
Georgios Pinitas | 658039b | 2017-09-15 16:30:50 +0100 | [diff] [blame] | 33 | #include <memory> |
| 34 | |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 35 | namespace arm_compute |
| 36 | { |
| 37 | class ITensor; |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 38 | class NEL2NormalizeLayerKernel; |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 39 | |
| 40 | /** Basic function to perform a L2 normalization on a given axis. |
| 41 | * |
| 42 | * This function runs the following kernels: |
| 43 | * -# @ref NEReductionOperation |
Giorgio Arena | 04a8f8c | 2017-11-23 11:45:24 +0000 | [diff] [blame] | 44 | * -# @ref NEL2NormalizeLayerKernel |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 45 | */ |
Giorgio Arena | 04a8f8c | 2017-11-23 11:45:24 +0000 | [diff] [blame] | 46 | class NEL2NormalizeLayer : public IFunction |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 47 | { |
| 48 | public: |
| 49 | /** Constructor */ |
Giorgio Arena | 04a8f8c | 2017-11-23 11:45:24 +0000 | [diff] [blame] | 50 | NEL2NormalizeLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr); |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 51 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 52 | NEL2NormalizeLayer(const NEL2NormalizeLayer &) = delete; |
| 53 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 54 | NEL2NormalizeLayer &operator=(const NEL2NormalizeLayer &) = delete; |
| 55 | /** Prevent instances of this class from being moved (As this class contains non movable objects) */ |
| 56 | NEL2NormalizeLayer(NEL2NormalizeLayer &&) = delete; |
| 57 | /** Prevent instances of this class from being moved (As this class contains non movable objects) */ |
| 58 | NEL2NormalizeLayer &operator=(NEL2NormalizeLayer &&) = delete; |
| 59 | /** Default destructor */ |
| 60 | ~NEL2NormalizeLayer(); |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 61 | /** Set the input and output tensors. |
| 62 | * |
Teresa Charlin | 6268742 | 2021-04-28 10:58:49 +0100 | [diff] [blame^] | 63 | * Valid data layouts: |
| 64 | * - NHWC |
| 65 | * - NCHW |
| 66 | * |
| 67 | * Valid data type configurations: |
| 68 | * |src |dst | |
| 69 | * |:--------|:---------| |
| 70 | * |F16 |F16 | |
| 71 | * |F32 |F32 | |
| 72 | * |
Michalis Spyrou | 2897e61 | 2018-11-20 18:38:29 +0000 | [diff] [blame] | 73 | * @param[in, out] input Source tensor. Data types supported: F16/F32. (Written to only for border_size != 0) |
John Richardson | 73d4aef | 2018-05-08 14:34:33 +0100 | [diff] [blame] | 74 | * @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] | 75 | * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2 |
John Richardson | 73d4aef | 2018-05-08 14:34:33 +0100 | [diff] [blame] | 76 | * @param[in] epsilon (Optional) Lower bound value for the normalization. |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 77 | */ |
Georgios Pinitas | 16cf3c2 | 2020-09-10 20:26:48 +0100 | [diff] [blame] | 78 | void configure(ITensor *input, ITensor *output, int axis, float epsilon = 1e-6f); |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 79 | |
John Richardson | 73d4aef | 2018-05-08 14:34:33 +0100 | [diff] [blame] | 80 | /** Static function to check if given info will lead to a valid configuration of @ref NEL2NormalizeLayer. |
| 81 | * |
Michalis Spyrou | 2897e61 | 2018-11-20 18:38:29 +0000 | [diff] [blame] | 82 | * @param[in] input Source tensor info. Data types supported: F16/F32. (Written to only for border_size != 0) |
John Richardson | 73d4aef | 2018-05-08 14:34:33 +0100 | [diff] [blame] | 83 | * @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] | 84 | * @param[in] axis Axis along which to reduce. Negative values wrap around. Maximum supported actual reduction axis : 2 |
John Richardson | 73d4aef | 2018-05-08 14:34:33 +0100 | [diff] [blame] | 85 | * @param[in] epsilon (Optional) Lower bound value for the normalization. |
| 86 | * |
| 87 | * @return a status |
| 88 | */ |
Georgios Pinitas | 16cf3c2 | 2020-09-10 20:26:48 +0100 | [diff] [blame] | 89 | static Status validate(const ITensorInfo *input, const ITensorInfo *output, int axis, float epsilon = 1e-6f); |
John Richardson | 73d4aef | 2018-05-08 14:34:33 +0100 | [diff] [blame] | 90 | |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 91 | // Inherited methods overridden: |
| 92 | void run() override; |
| 93 | |
| 94 | private: |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 95 | MemoryGroup _memory_group; |
| 96 | NEReductionOperation _reduce_func; |
| 97 | std::unique_ptr<NEL2NormalizeLayerKernel> _normalize_kernel; |
| 98 | Tensor _sumsq; |
Georgios Pinitas | d976958 | 2017-08-03 10:19:40 +0100 | [diff] [blame] | 99 | }; |
| 100 | } |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 101 | #endif /* ARM_COMPUTE_NEL2NORMALIZELAYER_H */ |