xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/graph/nodes/FullyConnectedLayerNode.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-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_FULLY_CONNECTED_LAYER_NODE_H
25 #define ARM_COMPUTE_GRAPH_FULLY_CONNECTED_LAYER_NODE_H
26 
27 #include "arm_compute/graph/INode.h"
28 
29 namespace arm_compute
30 {
31 namespace graph
32 {
33 /** Fully Connected Layer node */
34 class FullyConnectedLayerNode final : public INode
35 {
36 public:
37     /** Constructor
38      *
39      * @param[in] num_outputs    Number of neurons in the layer
40      * @param[in] out_quant_info (Optional) Output quantization info
41      * @param[in] fc_info        (Optional) Additional information about the fully connected layer
42      * @param[in] fast_math_hint (Optional) Fast math hint
43      */
44     FullyConnectedLayerNode(unsigned int            num_outputs,
45                             QuantizationInfo        out_quant_info = QuantizationInfo(),
46                             FullyConnectedLayerInfo fc_info        = FullyConnectedLayerInfo(),
47                             FastMathHint            fast_math_hint = FastMathHint::Disabled);
48     /** Sets the fast math fast hint
49      *
50      * @param[in] hint Hint to use for fullyconnected layer
51      */
52     void set_fast_math_hint(FastMathHint hint);
53     /** Fast math hint accessor
54      *
55      * @return Fast math hint to be used by the node
56      */
57     FastMathHint fast_math_hint() const;
58     /** Sets fused activation
59      *
60      * @param[in] fused_activation Fused activation to set
61      */
62     void set_fused_activation(ActivationLayerInfo fused_activation);
63     /** Computes weights descriptor
64      *
65      * @warning Works for inputs with 1D batch space
66      *
67      * @param[in] input_descriptor   Input descriptor
68      * @param[in] num_outputs        Number of output neurons
69      * @param[in] fc_info            (Optional) Additional information about the fully connected layer
70      * @param[in] weights_quant_info (Optional) Weights quantization info
71      *
72      * @return Weights descriptor
73      */
74     static TensorDescriptor compute_weights_descriptor(const TensorDescriptor &input_descriptor,
75                                                        unsigned int            num_outputs,
76                                                        FullyConnectedLayerInfo fc_info            = FullyConnectedLayerInfo(),
77                                                        const QuantizationInfo &weights_quant_info = QuantizationInfo());
78     /** Computes fully connected layer output descriptor
79      *
80      * @warning Works for inputs with 1D batch space
81      *
82      * @param[in] input_descriptor Input descriptor
83      * @param[in] num_outputs      Number of output neurons
84      * @param[in] out_quant_info   (Optional) Weights quantization info
85      *
86      * @return Output descriptor
87      */
88     static TensorDescriptor compute_output_descriptor(const TensorDescriptor &input_descriptor,
89                                                       unsigned int            num_outputs,
90                                                       const QuantizationInfo &out_quant_info = QuantizationInfo());
91     /** Fully connected layer addition information
92      *
93      * @return Additional information about the fully connected layer
94      */
95     FullyConnectedLayerInfo info() const;
96 
97     // Inherited overridden methods:
98     NodeType         type() const override;
99     bool             forward_descriptors() override;
100     TensorDescriptor configure_output(size_t idx) const override;
101     void accept(INodeVisitor &v) override;
102 
103     static constexpr NodeType node_type = NodeType::FullyConnectedLayer;
104 
105 private:
106     unsigned int            _num_outputs;
107     QuantizationInfo        _out_quant_info;
108     FullyConnectedLayerInfo _info;
109     FastMathHint            _fast_math_hint;
110 };
111 } // namespace graph
112 } // namespace arm_compute
113 #endif /* ARM_COMPUTE_GRAPH_FULLY_CONNECTED_LAYER_NODE_H */
114