blob: 2f63084056ade3ee9d7f0790735bd70fdfd5d9e5 [file] [log] [blame]
giuros011bf5e282018-12-21 14:57:48 +00001/*
Michele Di Giorgiod9eaf612020-07-08 11:12:57 +01002 * Copyright (c) 2019-2020 Arm Limited.
giuros011bf5e282018-12-21 14:57:48 +00003 *
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 */
Michalis Spyrouf4643372019-11-29 16:17:13 +000024#ifndef ARM_COMPUTE_CPPTOPKV_H
25#define ARM_COMPUTE_CPPTOPKV_H
giuros011bf5e282018-12-21 14:57:48 +000026
27#include "arm_compute/runtime/CPP/ICPPSimpleFunction.h"
28
29#include "arm_compute/core/Types.h"
30
31namespace arm_compute
32{
33class ITensor;
34
35/** Basic function to run @ref CPPTopKVKernel */
36class CPPTopKV : public ICPPSimpleFunction
37{
38public:
39 /** Set the input and output of the kernel.
40 *
Sheri Zhang05b243a2020-03-16 14:07:51 +000041 * @param[in] predictions A batch_size x classes tensor. Data types supported: F16/S32/F32/QASYMM8/QASYMM8_SIGNED
Michele Di Giorgiof22f6722020-07-03 16:29:24 +010042 * @param[in] targets A batch_size 1D tensor of class ids. Data types supported: U32
giuros011bf5e282018-12-21 14:57:48 +000043 * @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 *
Sheri Zhang05b243a2020-03-16 14:07:51 +000050 * @param[in] predictions A batch_size x classes tensor info. Data types supported: F16/S32/F32/QASYMM8/QASYMM8_SIGNED
Michele Di Giorgiof22f6722020-07-03 16:29:24 +010051 * @param[in] targets A batch_size 1D tensor info of class ids. Data types supported: U32
giuros011bf5e282018-12-21 14:57:48 +000052 * @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
Michalis Spyrouf4643372019-11-29 16:17:13 +000060#endif /* ARM_COMPUTE_CPPTOPKV_H */