Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2017-2021 Arm Limited. |
| 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 | */ |
Georgios Pinitas | 2eb5d16 | 2021-07-02 09:01:49 +0100 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_CPU_SOFTMAX_KERNEL_H |
| 25 | #define ARM_COMPUTE_CPU_SOFTMAX_KERNEL_H |
Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 26 | |
| 27 | #include "src/core/common/Macros.h" |
Georgios Pinitas | 7891a73 | 2021-08-20 21:39:25 +0100 | [diff] [blame] | 28 | #include "src/cpu/ICpuKernel.h" |
Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 29 | |
| 30 | namespace arm_compute |
| 31 | { |
| 32 | namespace cpu |
| 33 | { |
| 34 | namespace kernels |
| 35 | { |
| 36 | /** Interface for the identifying the max value of 1D Logits */ |
| 37 | class CpuLogits1DMaxKernel : public ICpuKernel |
| 38 | { |
| 39 | public: |
Georgios Pinitas | 5fdde99 | 2021-06-25 05:42:57 +0100 | [diff] [blame] | 40 | CpuLogits1DMaxKernel() = default; |
Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 41 | ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuLogits1DMaxKernel); |
| 42 | /** Set the input and output tensors. |
| 43 | * |
| 44 | * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. |
| 45 | * @param[out] dst Destination tensor info. Data types supported: same as @p input |
| 46 | */ |
| 47 | void configure(const ITensorInfo *src, ITensorInfo *dst); |
Georgios Pinitas | 5fdde99 | 2021-06-25 05:42:57 +0100 | [diff] [blame] | 48 | /** Static function to check if given info will lead to a valid configuration |
Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 49 | * |
Georgios Pinitas | 5fdde99 | 2021-06-25 05:42:57 +0100 | [diff] [blame] | 50 | * Similar to CpuLogits1DMaxKernel::configure() |
Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 51 | * |
| 52 | * @return a status |
| 53 | */ |
| 54 | static Status validate(const ITensorInfo *src, const ITensorInfo *dst); |
| 55 | |
| 56 | // Inherited methods overridden: |
| 57 | void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override; |
| 58 | const char *name() const override; |
Georgios Pinitas | 5fdde99 | 2021-06-25 05:42:57 +0100 | [diff] [blame] | 59 | |
| 60 | private: |
| 61 | using SoftmaxLogits1DMaxKernelPtr = std::add_pointer<void(const ITensor *, ITensor *, const Window &)>::type; |
| 62 | |
| 63 | private: |
| 64 | SoftmaxLogits1DMaxKernelPtr _run_method{ nullptr }; |
| 65 | std::string _name{}; |
Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 66 | }; |
| 67 | |
| 68 | /** Interface for softmax computation for QASYMM8 with pre-computed max. */ |
| 69 | template <bool IS_LOG = false> |
| 70 | class CpuLogits1DSoftmaxKernel : public ICpuKernel |
| 71 | { |
| 72 | public: |
Georgios Pinitas | 5fdde99 | 2021-06-25 05:42:57 +0100 | [diff] [blame] | 73 | CpuLogits1DSoftmaxKernel() = default; |
Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 74 | ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuLogits1DSoftmaxKernel); |
| 75 | |
| 76 | /** Set the input and output tensors. |
| 77 | * |
| 78 | * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. |
| 79 | * @param[in] max Max values tensor info. Same shape as input with dimension 0 set to 1. |
| 80 | * Data types supported: same as @p input. |
| 81 | * @param[out] dst Destination tensor info. Data types supported: same as @p input. |
| 82 | * @param[in] beta A scaling factor for the exponent. |
| 83 | * |
| 84 | * @param tmp Auxiliary tensor info. Must be type F32 and same shape as the input. |
| 85 | */ |
| 86 | void configure(const ITensorInfo *src, const ITensorInfo *max, ITensorInfo *dst, const float beta, ITensorInfo *tmp); |
Georgios Pinitas | 5fdde99 | 2021-06-25 05:42:57 +0100 | [diff] [blame] | 87 | /** Static function to check if given info will lead to a valid configuration |
Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 88 | * |
Georgios Pinitas | 5fdde99 | 2021-06-25 05:42:57 +0100 | [diff] [blame] | 89 | * Similar to CpuLogits1DSoftmaxKernel::configure() |
Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 90 | * |
| 91 | * @return a status |
| 92 | */ |
| 93 | static Status validate(const ITensorInfo *src, const ITensorInfo *max, |
| 94 | const ITensorInfo *dst, const float beta, const ITensorInfo *tmp); |
| 95 | |
| 96 | // Inherited methods overridden: |
| 97 | void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override; |
| 98 | const char *name() const override; |
| 99 | |
| 100 | private: |
Georgios Pinitas | 5fdde99 | 2021-06-25 05:42:57 +0100 | [diff] [blame] | 101 | using SoftmaxLogits1DKernelPtr = std::add_pointer<void(const ITensor *, const ITensor *, void *const, ITensor *, float, bool, const Window &)>::type; |
| 102 | |
| 103 | private: |
| 104 | float _beta{ 1.0f }; |
| 105 | SoftmaxLogits1DKernelPtr _run_method{ nullptr }; |
| 106 | std::string _name{}; |
Michalis Spyrou | 373b407 | 2021-01-20 16:41:12 +0000 | [diff] [blame] | 107 | }; |
| 108 | } // namespace kernels |
| 109 | } // namespace cpu |
| 110 | } // namespace arm_compute |
Georgios Pinitas | 2eb5d16 | 2021-07-02 09:01:49 +0100 | [diff] [blame] | 111 | #endif /* ARM_COMPUTE_CPU_SOFTMAX_KERNEL_H */ |