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 */ 24 #ifndef ARM_COMPUTE_NESOFTMAXLAYER_H 25 #define ARM_COMPUTE_NESOFTMAXLAYER_H 26 27 #include "arm_compute/core/Error.h" 28 #include "arm_compute/runtime/IFunction.h" 29 #include "arm_compute/runtime/IMemoryManager.h" 30 31 #include <memory> 32 33 namespace arm_compute 34 { 35 class ITensor; 36 class ITensorInfo; 37 38 /** Basic function to compute a SoftmaxLayer and a Log SoftmaxLayer. */ 39 template <bool IS_LOG = false> 40 class NESoftmaxLayerGeneric : public IFunction 41 { 42 public: 43 /** Constructor */ 44 NESoftmaxLayerGeneric(std::shared_ptr<IMemoryManager> memory_manager = nullptr); 45 /** Prevent instances of this class from being copied (As this class contains pointers) */ 46 NESoftmaxLayerGeneric(const NESoftmaxLayerGeneric &) = delete; 47 /** Default move constructor */ 48 NESoftmaxLayerGeneric(NESoftmaxLayerGeneric &&); 49 /** Prevent instances of this class from being copied (As this class contains pointers) */ 50 NESoftmaxLayerGeneric &operator=(const NESoftmaxLayerGeneric &) = delete; 51 /** Default move assignment operator */ 52 NESoftmaxLayerGeneric &operator=(NESoftmaxLayerGeneric &&); 53 /** Default destructor */ 54 ~NESoftmaxLayerGeneric(); 55 /** Set the input and output tensors. 56 * 57 * Valid data layouts: 58 * - All 59 * 60 * Valid data type configurations: 61 * |src |dst | 62 * |:--------------|:--------------| 63 * |QASYMM8 |QASYMM8 | 64 * |QASYMM8_SIGNED |QASYMM8_SIGNED | 65 * |F16 |F16 | 66 * |F32 |F32 | 67 * 68 * @param[in,out] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. If the width is not a 69 * multiple of the internal processing block size, @ref NEFillBorder replicates the 70 * last value of each row to the nearest multiple. 71 * @param[out] output Destination tensor. Data types supported: same as @p input. 72 * @param[in] beta (Optional) A scaling factor for the exponent. 73 * @param[in] axis (Optional) The dimension in which to apply the function. E.g. for input of shape 4x5x6 and 74 * axis=1, softmax will be applied to 4x6=24 vectors of size 5. Defaults to 0 75 */ 76 void configure(ITensor *input, ITensor *output, float beta = 1.0f, int32_t axis = 0); 77 /** Static function to check if given info will lead to a valid configuration of @ref NESoftmaxLayer 78 * 79 * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. 80 * @param[in] output Destination tensor info. Data types supported: same as @p input 81 * @param[in] beta (Optional) A scaling factor for the exponent. 82 * @param[in] axis (Optional) The dimension in which to apply the function. E.g. for input of shape 4x5x6 and 83 * axis=1, softmax will be applied to 4x6=24 vectors of size 5. Defaults to 0 84 * 85 * @return a status 86 */ 87 static Status validate(const ITensorInfo *input, const ITensorInfo *output, float beta = 1.0f, int32_t axis = 0); 88 89 // Inherited methods overridden: 90 void run() override; 91 92 private: 93 struct Impl; 94 std::unique_ptr<Impl> _impl; 95 }; 96 97 using NESoftmaxLayer = NESoftmaxLayerGeneric<false>; 98 using NELogSoftmaxLayer = NESoftmaxLayerGeneric<true>; 99 100 } // namespace arm_compute 101 #endif /* ARM_COMPUTE_NESOFTMAXLAYER_H */ 102