Compute Library
 21.05
FusedConvolutionBatchNormalizationNode.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 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_FUSED_CONVOLUTION_BATCH_NORMALIZATION_NODE_H
25 #define ARM_COMPUTE_GRAPH_FUSED_CONVOLUTION_BATCH_NORMALIZATION_NODE_H
26 
28 
29 namespace arm_compute
30 {
31 namespace graph
32 {
33 /** Batch Normalization node */
35 {
36 public:
37  /** Constructor
38  *
39  * @param[in] epsilon Epsilon parameter.
40  * @param[in] info Convolution layer attributes.
41  * @param[in] num_groups (Optional) Number of groups (Defaults to 1)
42  * @param[in] method (Optional) Convolution method to use
43  * @param[in] fast_math_hint (Optional) Fast math hint
44  * @param[in] fused_activation (Optional) Fused activation layer. Disabled if not specified
45  */
47  unsigned int num_groups = 1,
51 
52  /** Epsilon parameter accessor
53  *
54  * @return Epsilon parameter
55  */
56  float epsilon() const;
57 
58  /** Returns fused activation
59  *
60  * @return Fused activation
61  */
63 
64  /** Sets fused activation
65  *
66  * @param[in] fused_activation Fused activation to set
67  */
69 
70  /** Computes convolution output descriptor
71  *
72  * @param[in] input_descriptor Input descriptor
73  * @param[in] weights_descriptor Weights descriptor
74  * @param[in] info Convolution operation attributes
75  *
76  * @return Output descriptor
77  */
78  static TensorDescriptor compute_output_descriptor(const TensorDescriptor &input_descriptor,
79  const TensorDescriptor &weights_descriptor,
80  const PadStrideInfo &info);
81 
82  /** Sets the convolution layer method to use
83  *
84  * @param[in] method Method to use for convolution
85  */
87 
88  /** Number of groups in convolution accessor
89  *
90  * @return Number of groups in convolution
91  */
92  unsigned int num_groups() const;
93 
94  /** Convolution layer method accessor
95  *
96  * @note This is an indication on which convolution layer implementation to use,
97  * if it fails to be created the library's heuristic approach will be used
98  *
99  * @return Convolution layer method to be used by the node
100  */
102 
103  /** Sets the fast math fast hint
104  *
105  * @param[in] hint Hint to use for convolution
106  */
107  void set_fast_math_hint(FastMathHint hint);
108 
109  /** Fast math hint accessor
110  *
111  * @return Fast math hint to be used by the node
112  */
114 
115  /** Convolution metadata accessor
116  *
117  * @return Convolution information
118  */
120 
121  // Inherited overridden methods:
122  NodeType type() const override;
123  bool forward_descriptors() override;
124  TensorDescriptor configure_output(size_t idx) const override;
125  void accept(INodeVisitor &v) override;
126 
127 public:
129 
130 private:
131  float _epsilon;
132 
133  PadStrideInfo _info;
134  unsigned int _num_groups;
135  ConvolutionMethod _method;
136  FastMathHint _fast_math_hint;
137  ActivationLayerInfo _fused_activation;
138 };
139 
140 } // namespace graph
141 } // namespace arm_compute
142 #endif /* ARM_COMPUTE_GRAPH_BATCH_NORMALIZATION_LAYER_NODE_H */
void set_fast_math_hint(FastMathHint hint)
Sets the fast math fast hint.
TensorDescriptor configure_output(size_t idx) const override
Calculates output configuration.
bool forward_descriptors() override
Forwards descriptor information to outputs if possible.
Activation Layer Information class.
Definition: Types.h:1478
Copyright (c) 2017-2021 Arm Limited.
Fast math disabled for Convolution layer.
unsigned int num_groups() const
Number of groups in convolution accessor.
Node interface.
Definition: INode.h:45
ConvolutionMethod convolution_method() const
Convolution layer method accessor.
NodeType
Supported nodes.
Definition: Types.h:148
Padding and stride information class.
Definition: Types.h:650
ActivationLayerInfo fused_activation() const
Returns fused activation.
FastMathHint
Enable or disable fast math for Convolution layer.
Definition: Types.h:141
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
static TensorDescriptor compute_output_descriptor(const TensorDescriptor &input_descriptor, const TensorDescriptor &weights_descriptor, const PadStrideInfo &info)
Computes convolution output descriptor.
ConvolutionMethod
Supported Convolution layer methods.
Definition: Types.h:124
FusedConvolutionBatchNormalizationNode(float epsilon, PadStrideInfo info, unsigned int num_groups=1, ConvolutionMethod method=ConvolutionMethod::Default, FastMathHint fast_math_hint=FastMathHint::Disabled, ActivationLayerInfo fused_activation=ActivationLayerInfo())
Constructor.
Default approach using internal heuristics.
void set_convolution_method(ConvolutionMethod method)
Sets the convolution layer method to use.
Node visitor interface.
Definition: INodeVisitor.h:34
void set_fused_activation(ActivationLayerInfo fused_activation)
Sets fused activation.