xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/graph/nodes/DepthwiseConvolutionLayerNode.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_DEPTHWISE_CONVOLUTION_LAYER_NODE_H
25 #define ARM_COMPUTE_GRAPH_DEPTHWISE_CONVOLUTION_LAYER_NODE_H
26 
27 #include "arm_compute/graph/INode.h"
28 
29 namespace arm_compute
30 {
31 namespace graph
32 {
33 /** Depthwise Convolution Layer node */
34 class DepthwiseConvolutionLayerNode final : public INode
35 {
36 public:
37     /** Constructor
38      *
39      * @param[in] info             Convolution layer attributes
40      * @param[in] depth_multiplier (Optional) Depth multiplier parameter.
41      * @param[in] method           (Optional) Depthwise convolution method to use
42      * @param[in] out_quant_info   (Optional) Output quantization info
43      */
44     DepthwiseConvolutionLayerNode(PadStrideInfo              info,
45                                   int                        depth_multiplier = 1,
46                                   DepthwiseConvolutionMethod method           = DepthwiseConvolutionMethod::Default,
47                                   QuantizationInfo           out_quant_info   = QuantizationInfo());
48     /** Sets the depthwise convolution method to use
49      *
50      * @param[in] method Depthwise convolution method to use
51      */
52     void set_depthwise_convolution_method(DepthwiseConvolutionMethod method);
53     /** Depthwise convolution layer method accessor
54      *
55      * @note This is an indication on which depthwise implementation to use,
56      *       if it fails to be created the generic approach will be used
57      *
58      * @return Depthwise convolution layer method do be used by the node
59      */
60     DepthwiseConvolutionMethod depthwise_convolution_method() const;
61     /** Depth multiplier accessor
62      *
63      * @return Depth multiplier
64      */
65     int depth_multiplier() const;
66     /** Convolution metadata accessor
67      *
68      * @return Convolution information
69      */
70     PadStrideInfo convolution_info() const;
71     /** Returns fused activation
72      *
73      * @return Fused activation
74      */
75     ActivationLayerInfo fused_activation() const;
76     /** Sets fused activation
77      *
78      * @param[in] fused_activation Fused activation to set
79      */
80     void set_fused_activation(ActivationLayerInfo fused_activation);
81     /** Sets convolution info
82      *
83      * @param[in] info Convolution info to set
84      */
85     void set_convolution_info(PadStrideInfo info);
86     /** Computes depthwise convolution output descriptor
87      *
88      * @param[in] input_descriptor   Input descriptor
89      * @param[in] weights_descriptor Weights descriptor
90      * @param[in] info               Convolution operation attributes
91      * @param[in] depth_multiplier   (Optional) Depth multiplier parameter.
92      *
93      * @return Output descriptor
94      */
95     static TensorDescriptor compute_output_descriptor(const TensorDescriptor &input_descriptor,
96                                                       const TensorDescriptor &weights_descriptor,
97                                                       const PadStrideInfo    &info,
98                                                       int                     depth_multiplier = 1);
99 
100     // Inherited overridden methods:
101     NodeType         type() const override;
102     bool             forward_descriptors() override;
103     TensorDescriptor configure_output(size_t idx) const override;
104     void accept(INodeVisitor &v) override;
105 
106 public:
107     static constexpr NodeType node_type = NodeType::DepthwiseConvolutionLayer;
108 
109 private:
110     PadStrideInfo              _info;
111     int                        _depth_multiplier;
112     DepthwiseConvolutionMethod _method;
113     QuantizationInfo           _out_quant_info;
114     ActivationLayerInfo        _fused_activation;
115 };
116 } // namespace graph
117 } // namespace arm_compute
118 #endif /* ARM_COMPUTE_GRAPH_DEPTHWISE_CONVOLUTION_LAYER_NODE_H */
119