1 /* 2 * Copyright (c) 2019-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_CPPTOPKVERNEL_H 25 #define ARM_COMPUTE_CPPTOPKVERNEL_H 26 27 #include "arm_compute/core/CPP/ICPPKernel.h" 28 29 namespace arm_compute 30 { 31 class ITensor; 32 33 /** CPP kernel to perform tensor TopKV operation. */ 34 class CPPTopKVKernel : public ICPPKernel 35 { 36 public: name()37 const char *name() const override 38 { 39 return "CPPTopKVKernel"; 40 } 41 /** Default constructor */ 42 CPPTopKVKernel(); 43 /** Prevent instances of this class from being copied (As this class contains pointers) */ 44 CPPTopKVKernel(const CPPTopKVKernel &) = delete; 45 /** Prevent instances of this class from being copied (As this class contains pointers) */ 46 CPPTopKVKernel &operator=(const CPPTopKVKernel &) = delete; 47 /** Allow instances of this class to be moved */ 48 CPPTopKVKernel(CPPTopKVKernel &&) = default; 49 /** Allow instances of this class to be moved */ 50 CPPTopKVKernel &operator=(CPPTopKVKernel &&) = default; 51 /** Default destructor */ 52 ~CPPTopKVKernel() = default; 53 54 /** Set the input and output of the kernel. 55 * 56 * @param[in] predictions A batch_size x classes tensor. Data types supported: F16/S32/F32/QASYMM8/QASYMM8_SIGNED 57 * @param[in] targets A batch_size 1D tensor of class ids. Data types supported: U32 58 * @param[out] output Computed precision at @p k as a bool 1D tensor. Data types supported: U8 59 * @param[in] k Number of top elements to look at for computing precision. 60 */ 61 void configure(const ITensor *predictions, const ITensor *targets, ITensor *output, const unsigned int k); 62 63 /** Static function to check if given info will lead to a valid configuration of @ref CPPTopKVKernel 64 * 65 * @param[in] predictions A batch_size x classes tensor info. Data types supported: F16/S32/F32/QASYMM8/QASYMM8_SIGNED 66 * @param[in] targets A batch_size 1D tensor info of class ids. Data types supported: U32 67 * @param[in] output Computed precision at @p k as a bool 1D tensor info. Data types supported: U8 68 * @param[in] k Number of top elements to look at for computing precision. 69 * 70 * @return a status 71 */ 72 static Status validate(const ITensorInfo *predictions, const ITensorInfo *targets, ITensorInfo *output, const unsigned int k); 73 74 // Inherited methods overridden: 75 void run(const Window &window, const ThreadInfo &info) override; 76 bool is_parallelisable() const override; 77 78 private: 79 /** Template function to run the topKV operation. */ 80 template <typename T> 81 void run_topkv(); 82 83 const ITensor *_predictions; 84 const ITensor *_targets; 85 ITensor *_output; 86 87 unsigned int _k; 88 unsigned int _batch_size; 89 unsigned int _num_classes; 90 }; 91 } // namespace arm_compute 92 #endif /*ARM_COMPUTE_CPPTOPKVKERNEL_H */ 93