xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/graph/nodes/ConvolutionLayerNode.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-2019, 2021 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_GRAPH_CONVOLUTION_LAYER_NODE_H
25 #define ARM_COMPUTE_GRAPH_CONVOLUTION_LAYER_NODE_H
26 
27 #include "arm_compute/graph/INode.h"
28 
29 namespace arm_compute
30 {
31 namespace graph
32 {
33 /** Convolution Layer node */
34 class ConvolutionLayerNode final : public INode
35 {
36 public:
37     /** Constructor
38      *
39      * @param[in] info           Convolution layer attributes
40      * @param[in] num_groups     (Optional) Number of groups (Defaults to 1)
41      * @param[in] method         (Optional) Convolution method to use
42      * @param[in] fast_math_hint (Optional) Fast math hint
43      * @param[in] out_quant_info (Optional) Output quantization info
44      */
45     ConvolutionLayerNode(PadStrideInfo     info,
46                          unsigned int      num_groups     = 1,
47                          ConvolutionMethod method         = ConvolutionMethod::Default,
48                          FastMathHint      fast_math_hint = FastMathHint::Disabled,
49                          QuantizationInfo  out_quant_info = QuantizationInfo());
50     /** Sets the convolution layer method to use
51      *
52      * @param[in] method Method to use for convolution
53      */
54     void set_convolution_method(ConvolutionMethod method);
55     /** Convolution layer method accessor
56      *
57      * @note This is an indication on which convolution layer implementation to use,
58      *       if it fails to be created the library's heuristic approach will be used
59      *
60      * @return Convolution layer method to be used by the node
61      */
62     ConvolutionMethod convolution_method() const;
63     /** Sets the fast math fast hint
64      *
65      * @param[in] hint Hint to use for convolution
66      */
67     void set_fast_math_hint(FastMathHint hint);
68     /** Fast math hint accessor
69      *
70      * @return Fast math hint to be used by the node
71      */
72     FastMathHint fast_math_hint() const;
73     /** Convolution metadata accessor
74      *
75      * @return Convolution information
76      */
77     PadStrideInfo convolution_info() const;
78     /** Number of groups in convolution accessor
79      *
80      * @return Number of groups in convolution
81      */
82     unsigned int num_groups() const;
83     /** Returns fused activation
84      *
85      * @return Fused activation
86      */
87     ActivationLayerInfo fused_activation() const;
88     /** Sets fused activation
89      *
90      * @param[in] fused_activation Fused activation to set
91      */
92     void set_fused_activation(ActivationLayerInfo fused_activation);
93     /** Sets convolution info
94      *
95      * @param[in] info Convolution info to set
96      */
97     void set_convolution_info(PadStrideInfo info);
98     /** Computes convolution output descriptor
99      *
100      * @param[in] input_descriptor   Input descriptor
101      * @param[in] weights_descriptor Weights descriptor
102      * @param[in] info               Convolution operation attributes
103      *
104      * @return Output descriptor
105      */
106     static TensorDescriptor compute_output_descriptor(const TensorDescriptor &input_descriptor,
107                                                       const TensorDescriptor &weights_descriptor,
108                                                       const PadStrideInfo    &info);
109 
110     // Inherited overridden methods:
111     NodeType         type() const override;
112     bool             forward_descriptors() override;
113     TensorDescriptor configure_output(size_t idx) const override;
114     void accept(INodeVisitor &v) override;
115 
116 public:
117     static constexpr NodeType node_type = NodeType::ConvolutionLayer;
118 
119 private:
120     PadStrideInfo       _info;
121     unsigned int        _num_groups;
122     ConvolutionMethod   _method;
123     FastMathHint        _fast_math_hint;
124     QuantizationInfo    _out_quant_info;
125     ActivationLayerInfo _fused_activation;
126 };
127 } // namespace graph
128 } // namespace arm_compute
129 #endif /* ARM_COMPUTE_GRAPH_CONVOLUTION_LAYER_NODE_H */
130