• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2018-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_CLYOLOLAYER_H
25 #define ARM_COMPUTE_CLYOLOLAYER_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLTensor;
34 class ITensorInfo;
35 
36 /** Basic function to run @ref CLYOLOLayerKernel that performs a partial activation on the input
37  *
38  *  For each box, activate only:
39  *    - x and y position (channel 0 and 1 of each box)
40  *    - objectiveness    (channel 4 of each box)
41  *    - classes          (channel 5 to (classes - 5) of each box)
42  */
43 class CLYOLOLayer : public ICLSimpleFunction
44 {
45 public:
46     /** Set the input and output tensor.
47      *
48      * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place
49      *
50      * @param[in, out] input       Source tensor. In case of @p output tensor = nullptr, this tensor will store the result
51      *                             of the activation function. Data types supported: F16/F32.
52      * @param[out]     output      Destination tensor. Data type supported: same as @p input
53      * @param[in]      act_info    Activation layer parameters.
54      * @param[in]      num_classes Number of classes to activate (must be submultiple of @p input channels)
55      */
56     void configure(ICLTensor *input, ICLTensor *output, const ActivationLayerInfo &act_info, int32_t num_classes);
57     /** Set the input and output tensor.
58      *
59      * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place
60      *
61      * @param[in]      compile_context The compile context to be used.
62      * @param[in, out] input           Source tensor. In case of @p output tensor = nullptr, this tensor will store the result
63      *                                 of the activation function. Data types supported: F16/F32.
64      * @param[out]     output          Destination tensor. Data type supported: same as @p input
65      * @param[in]      act_info        Activation layer parameters.
66      * @param[in]      num_classes     Number of classes to activate (must be submultiple of @p input channels)
67      */
68     void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const ActivationLayerInfo &act_info, int32_t num_classes);
69     /** Static function to check if given info will lead to a valid configuration of @ref CLYOLOLayer
70      *
71      * @param[in] input       Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result
72      *                        of the activation function. Data types supported: F16/F32.
73      * @param[in] output      Destination tensor info. Data type supported: same as @p input
74      * @param[in] act_info    Activation layer information.
75      * @param[in] num_classes Number of classes to activate (must be submultiple of @p input channels)
76      *
77      * @return a status
78      */
79     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ActivationLayerInfo &act_info, int32_t num_classes);
80 };
81 } // namespace arm_compute
82 #endif /* ARM_COMPUTE_CLYOLOLAYER_H */
83