• 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_CLYOLOLAYERKERNEL_H
25 #define ARM_COMPUTE_CLYOLOLAYERKERNEL_H
26 
27 #include "src/core/CL/ICLKernel.h"
28 
29 namespace arm_compute
30 {
31 class ICLTensor;
32 
33 /** Interface for the YOLO layer kernel that performs partial activation.
34  *  For each box, activate only:
35  *    - x and y position (channel 0 and 1 of each box)
36  *    - objectiveness    (channel 4 of each box)
37  *    - classes          (channel 5 to (classes - 5) of each box)
38  */
39 class CLYOLOLayerKernel : public ICLKernel
40 {
41 public:
42     /** Default constructor */
43     CLYOLOLayerKernel();
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     CLYOLOLayerKernel(const CLYOLOLayerKernel &) = delete;
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     CLYOLOLayerKernel &operator=(const CLYOLOLayerKernel &) = delete;
48     /** Allow instances of this class to be moved */
49     CLYOLOLayerKernel(CLYOLOLayerKernel &&) = default;
50     /** Allow instances of this class to be moved */
51     CLYOLOLayerKernel &operator=(CLYOLOLayerKernel &&) = default;
52     /** Default destructor */
53     ~CLYOLOLayerKernel() = default;
54     /** Set the input and output tensor.
55      *
56      * @note If the output tensor is a nullptr, the activation function will be performed in-place
57      *
58      * @param[in, out] input       Source tensor. In case of @p output tensor = nullptr, this tensor will store the result
59      *                             of the activation function. Data types supported: F16/F32.
60      * @param[out]     output      Destination tensor. Data type supported: same as @p input
61      * @param[in]      act_info    Activation layer information.
62      * @param[in]      num_classes Number of classes to activate (must be submultiple of @p input channels)
63      */
64     void configure(ICLTensor *input, ICLTensor *output, const ActivationLayerInfo &act_info, int32_t num_classes);
65     /** Set the input and output tensor.
66      *
67      * @note If the output tensor is a nullptr, the activation function will be performed in-place
68      *
69      * @param[in]      compile_context The compile context to be used.
70      * @param[in, out] input           Source tensor. In case of @p output tensor = nullptr, this tensor will store the result
71      *                                 of the activation function. Data types supported: F16/F32.
72      * @param[out]     output          Destination tensor. Data type supported: same as @p input
73      * @param[in]      act_info        Activation layer information.
74      * @param[in]      num_classes     Number of classes to activate (must be submultiple of @p input channels)
75      */
76     void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const ActivationLayerInfo &act_info, int32_t num_classes);
77     /** Static function to check if given info will lead to a valid configuration of @ref CLYOLOLayerKernel
78      *
79      * @param[in] input       Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result
80      *                        of the activation function. Data types supported: F16/F32.
81      * @param[in] output      Destination tensor info. Data type supported: same as @p input
82      * @param[in] act_info    Activation layer information.
83      * @param[in] num_classes Number of classes to activate (must be submultiple of @p input channels)
84      *
85      * @return a status
86      */
87     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ActivationLayerInfo &act_info, int32_t num_classes);
88 
89     // Inherited methods overridden:
90     void run(const Window &window, cl::CommandQueue &queue) override;
91 
92 private:
93     ICLTensor *_input;
94     ICLTensor *_output;
95     bool       _run_in_place;
96 };
97 } // namespace arm_compute
98 #endif /*ARM_COMPUTE_CLYOLOLAYERKERNEL_H */
99