1 /* 2 * Copyright (c) 2017-2020 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 */ 24 #ifndef ARM_COMPUTE_NESOFTMAXLAYERKERNEL_H 25 #define ARM_COMPUTE_NESOFTMAXLAYERKERNEL_H 26 27 #include "src/core/NEON/INEKernel.h" 28 #include "src/core/NEON/INESimpleKernel.h" 29 30 namespace arm_compute 31 { 32 class ITensor; 33 34 /** Interface for the identifying the max value of 1D Logits */ 35 class NELogits1DMaxKernel : public INESimpleKernel 36 { 37 public: name()38 const char *name() const override 39 { 40 return "NELogits1DMaxKernel"; 41 } 42 /** Default constructor */ 43 NELogits1DMaxKernel(); 44 /** Prevent instances of this class from being copied (As this class contains pointers) */ 45 NELogits1DMaxKernel(const NELogits1DMaxKernel &) = delete; 46 /** Prevent instances of this class from being copied (As this class contains pointers) */ 47 NELogits1DMaxKernel &operator=(const NELogits1DMaxKernel &) = delete; 48 /** Allow instances of this class to be moved */ 49 NELogits1DMaxKernel(NELogits1DMaxKernel &&) = default; 50 /** Allow instances of this class to be moved */ 51 NELogits1DMaxKernel &operator=(NELogits1DMaxKernel &&) = default; 52 /** Default destructor */ 53 ~NELogits1DMaxKernel() = default; 54 /** Set the input and output tensors. 55 * 56 * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 57 * @param[out] output Destination tensor. Data types supported: same as @p input 58 */ 59 void configure(const ITensor *input, ITensor *output); 60 /** Static function to check if given info will lead to a valid configuration of @ref NELogits1DMaxKernel 61 * 62 * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 63 * @param[in] output Destination tensor. Data types supported: same as @p input 64 * 65 * @return a status 66 */ 67 static Status validate(const ITensorInfo *input, const ITensorInfo *output); 68 69 // Inherited methods overridden: 70 void run(const Window &window, const ThreadInfo &info) override; 71 BorderSize border_size() const override; 72 73 private: 74 using Logits1DMaxFunction = void(const ITensor &in, ITensor &out, const Window &window); 75 76 private: 77 Logits1DMaxFunction *_func; 78 BorderSize _border_size; 79 }; 80 81 /** Interface for softmax computation for QASYMM8 with pre-computed max. */ 82 template <bool IS_LOG = false> 83 class NELogits1DSoftmaxKernel : public INEKernel 84 { 85 public: name()86 const char *name() const override 87 { 88 if(IS_LOG) 89 { 90 return "NELogits1DSoftmaxKernel"; 91 } 92 else 93 { 94 return "NELogits1DLogSoftmaxKernel"; 95 } 96 } 97 /** Default constructor */ 98 NELogits1DSoftmaxKernel(); 99 /** Prevent instances of this class from being copied (As this class contains pointers) */ 100 NELogits1DSoftmaxKernel(const NELogits1DSoftmaxKernel &) = delete; 101 /** Prevent instances of this class from being copied (As this class contains pointers) */ 102 NELogits1DSoftmaxKernel &operator=(const NELogits1DSoftmaxKernel &) = delete; 103 /** Allow instances of this class to be moved */ 104 NELogits1DSoftmaxKernel(NELogits1DSoftmaxKernel &&) = default; 105 /** Allow instances of this class to be moved */ 106 NELogits1DSoftmaxKernel &operator=(NELogits1DSoftmaxKernel &&) = default; 107 /** Default destructor */ 108 ~NELogits1DSoftmaxKernel() = default; 109 /** Set the input and output tensors. 110 * 111 * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 112 * @param[in] max Max values tensor. Same shape as input with dimension 0 set to 1. 113 * Data types supported: same as @p input. 114 * @param[out] output Destination tensor. Data types supported: same as @p input. 115 * @param[in] beta A scaling factor for the exponent. 116 * 117 * @param tmp Auxiliary tensor. Must be type F32 and same shape as the input. 118 */ 119 void configure(const ITensor *input, const ITensor *max, ITensor *output, const float beta, ITensor *tmp); 120 /** Static function to check if given info will lead to a valid configuration of @ref NELogits1DSoftmaxKernel 121 * 122 * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 123 * @param[in] max Max values tensor info. Same shape as input with dimension 0 set to 1. 124 * Data types supported: same as @p input. 125 * @param[in] output Destination tensor info. Data types supported: same as @p input. 126 * @param[in] beta A scaling factor for the exponent. 127 * @param[in] tmp Tensor info of auxiliary. Must be type F32 and same shape as the input. 128 * 129 * @return a status 130 */ 131 static Status validate(const ITensorInfo *input, const ITensorInfo *max, 132 const ITensorInfo *output, const float beta, const ITensorInfo *tmp); 133 134 // Inherited methods overridden: 135 void run(const Window &window, const ThreadInfo &info) override; 136 137 private: 138 using LogitsSoftmaxFunction = void(const ITensor &in, const ITensor &max, void *const tmp, ITensor &out, const float beta, 139 const Window &window); 140 141 LogitsSoftmaxFunction *_func; 142 const ITensor *_input; 143 const ITensor *_max; 144 ITensor *_output; 145 float _beta; 146 ITensor *_tmp; //Temporary. Used internally 147 }; 148 } // namespace arm_compute 149 #endif /*ARM_COMPUTE_NESOFTMAXLAYERKERNEL_H */ 150