Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Michele Di Giorgio | d9eaf61 | 2020-07-08 11:12:57 +0100 | [diff] [blame] | 2 | * Copyright (c) 2017-2020 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_NESOFTMAXLAYER_H |
| 25 | #define ARM_COMPUTE_NESOFTMAXLAYER_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/NEON/kernels/NEFillBorderKernel.h" |
| 28 | #include "arm_compute/core/NEON/kernels/NESoftmaxLayerKernel.h" |
| 29 | #include "arm_compute/runtime/IFunction.h" |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 30 | #include "arm_compute/runtime/MemoryGroup.h" |
SiCong Li | 96209c7 | 2020-08-21 12:28:30 +0100 | [diff] [blame] | 31 | #include "arm_compute/runtime/NEON/functions/NEPermute.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 32 | #include "arm_compute/runtime/Tensor.h" |
| 33 | |
| 34 | namespace arm_compute |
| 35 | { |
| 36 | class ITensor; |
| 37 | |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 38 | /** Basic function to compute a SoftmaxLayer and a Log SoftmaxLayer. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 39 | * |
| 40 | * Softmax is calculated by : |
Sang-Hoon Park | a0205b9 | 2020-07-07 09:36:09 +0100 | [diff] [blame] | 41 | * @f[ out = exp((x - max(x)) * beta) / sum(exp((x - max(x)) * beta)) @f] |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 42 | * |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 43 | * Log Softmax is calculated by : |
Sang-Hoon Park | a0205b9 | 2020-07-07 09:36:09 +0100 | [diff] [blame] | 44 | * @f[ out = (x - max(x) * beta) - log(\sum{e^{x - max(x) * beta}}) @f] |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 45 | * |
SiCong Li | 96209c7 | 2020-08-21 12:28:30 +0100 | [diff] [blame] | 46 | * This function runs the following function/kernels: |
| 47 | * -# If axis is not 0: |
| 48 | * -# @ref NEPermute |
Diego Lopez Recas | 35ceeb2 | 2017-12-04 18:56:10 +0000 | [diff] [blame] | 49 | * -# @ref NEFillBorderKernel |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 50 | * -# @ref NELogits1DMaxKernel |
Diego Lopez Recas | 35ceeb2 | 2017-12-04 18:56:10 +0000 | [diff] [blame] | 51 | * -# @ref NELogits1DSoftmaxKernel |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 52 | */ |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 53 | template <bool IS_LOG = false> |
| 54 | class NESoftmaxLayerGeneric : public IFunction |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 55 | { |
| 56 | public: |
| 57 | /** Constructor */ |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 58 | NESoftmaxLayerGeneric(std::shared_ptr<IMemoryManager> memory_manager = nullptr); |
Manuel Bottini | 678d83a | 2019-01-07 16:05:36 +0000 | [diff] [blame] | 59 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 60 | NESoftmaxLayerGeneric(const NESoftmaxLayerGeneric &) = delete; |
Manuel Bottini | 678d83a | 2019-01-07 16:05:36 +0000 | [diff] [blame] | 61 | /** Default move constructor */ |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 62 | NESoftmaxLayerGeneric(NESoftmaxLayerGeneric &&) = default; |
Manuel Bottini | 678d83a | 2019-01-07 16:05:36 +0000 | [diff] [blame] | 63 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 64 | NESoftmaxLayerGeneric &operator=(const NESoftmaxLayerGeneric &) = delete; |
Manuel Bottini | 678d83a | 2019-01-07 16:05:36 +0000 | [diff] [blame] | 65 | /** Default move assignment operator */ |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 66 | NESoftmaxLayerGeneric &operator=(NESoftmaxLayerGeneric &&) = default; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 67 | /** Set the input and output tensors. |
| 68 | * |
morgolock | 9c7fed8 | 2020-08-05 12:30:56 +0100 | [diff] [blame] | 69 | * @param[in,out] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. If the width is not a |
| 70 | * multiple of the internal processing block size, @ref NEFillBorderKernel replicates the |
| 71 | * last value of each row to the nearest multiple. |
| 72 | * @param[out] output Destination tensor. Data types supported: same as @p input. |
| 73 | * @param[in] beta (Optional) A scaling factor for the exponent. |
SiCong Li | 96209c7 | 2020-08-21 12:28:30 +0100 | [diff] [blame] | 74 | * @param[in] axis (Optional) The dimension in which to apply the function. E.g. for input of shape 4x5x6 and |
| 75 | * axis=1, softmax will be applied to 4x6=24 vectors of size 5. Defaults to 0 |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 76 | */ |
morgolock | 9c7fed8 | 2020-08-05 12:30:56 +0100 | [diff] [blame] | 77 | void configure(ITensor *input, ITensor *output, float beta = 1.0f, int32_t axis = 0); |
Michalis Spyrou | afa5d81 | 2017-11-30 14:25:57 +0000 | [diff] [blame] | 78 | /** Static function to check if given info will lead to a valid configuration of @ref NESoftmaxLayer |
| 79 | * |
morgolock | 9c7fed8 | 2020-08-05 12:30:56 +0100 | [diff] [blame] | 80 | * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. |
| 81 | * @param[in] output Destination tensor info. Data types supported: same as @p input |
| 82 | * @param[in] beta (Optional) A scaling factor for the exponent. |
SiCong Li | 96209c7 | 2020-08-21 12:28:30 +0100 | [diff] [blame] | 83 | * @param[in] axis (Optional) The dimension in which to apply the function. E.g. for input of shape 4x5x6 and |
| 84 | * axis=1, softmax will be applied to 4x6=24 vectors of size 5. Defaults to 0 |
morgolock | 9c7fed8 | 2020-08-05 12:30:56 +0100 | [diff] [blame] | 85 | * |
Michalis Spyrou | afa5d81 | 2017-11-30 14:25:57 +0000 | [diff] [blame] | 86 | * @return a status |
| 87 | */ |
morgolock | 9c7fed8 | 2020-08-05 12:30:56 +0100 | [diff] [blame] | 88 | static Status validate(const ITensorInfo *input, const ITensorInfo *output, float beta = 1.0f, int32_t axis = 0); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 89 | |
| 90 | // Inherited methods overridden: |
| 91 | void run() override; |
| 92 | |
| 93 | private: |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 94 | MemoryGroup _memory_group; |
SiCong Li | 96209c7 | 2020-08-21 12:28:30 +0100 | [diff] [blame] | 95 | NEPermute _permute_input; |
| 96 | NEPermute _permute_output; |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 97 | NELogits1DMaxKernel _max_kernel; |
| 98 | NELogits1DSoftmaxKernel<IS_LOG> _softmax_kernel; |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 99 | NEFillBorderKernel _fill_border_kernel; |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 100 | Tensor _max; |
| 101 | Tensor _tmp; |
SiCong Li | 96209c7 | 2020-08-21 12:28:30 +0100 | [diff] [blame] | 102 | Tensor _input_permuted; |
| 103 | Tensor _output_permuted; |
| 104 | bool _needs_permute; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 105 | }; |
Sang-Hoon Park | d24affe | 2019-10-08 18:07:23 +0100 | [diff] [blame] | 106 | |
| 107 | using NESoftmaxLayer = NESoftmaxLayerGeneric<false>; |
| 108 | using NELogSoftmaxLayer = NESoftmaxLayerGeneric<true>; |
| 109 | |
Manuel Bottini | 678d83a | 2019-01-07 16:05:36 +0000 | [diff] [blame] | 110 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 111 | #endif /* ARM_COMPUTE_NESOFTMAXLAYER_H */ |