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_CPPTOPKV_H 25 #define ARM_COMPUTE_CPPTOPKV_H 26 27 #include "arm_compute/runtime/CPP/ICPPSimpleFunction.h" 28 29 #include "arm_compute/core/Types.h" 30 31 namespace arm_compute 32 { 33 class ITensor; 34 35 /** Basic function to run @ref CPPTopKVKernel */ 36 class CPPTopKV : public ICPPSimpleFunction 37 { 38 public: 39 /** Set the input and output of the kernel. 40 * 41 * @param[in] predictions A batch_size x classes tensor. Data types supported: F16/S32/F32/QASYMM8/QASYMM8_SIGNED 42 * @param[in] targets A batch_size 1D tensor of class ids. Data types supported: U32 43 * @param[out] output Computed precision at @p k as a bool 1D tensor. Data types supported: U8 44 * @param[in] k Number of top elements to look at for computing precision. 45 */ 46 void configure(const ITensor *predictions, const ITensor *targets, ITensor *output, const unsigned int k); 47 48 /** Static function to check if given info will lead to a valid configuration of @ref CPPTopKVKernel 49 * 50 * @param[in] predictions A batch_size x classes tensor info. Data types supported: F16/S32/F32/QASYMM8/QASYMM8_SIGNED 51 * @param[in] targets A batch_size 1D tensor info of class ids. Data types supported: U32 52 * @param[in] output Computed precision at @p k as a bool 1D tensor info. Data types supported: U8 53 * @param[in] k Number of top elements to look at for computing precision. 54 * 55 * @return a status 56 */ 57 static Status validate(const ITensorInfo *predictions, const ITensorInfo *targets, ITensorInfo *output, const unsigned int k); 58 }; 59 } // namespace arm_compute 60 #endif /* ARM_COMPUTE_CPPTOPKV_H */ 61