Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2018 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 | */ |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 24 | #ifndef __ARM_COMPUTE_GRAPH_GRAPH_BUILDER_H__ |
| 25 | #define __ARM_COMPUTE_GRAPH_GRAPH_BUILDER_H__ |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 26 | |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 27 | #include "arm_compute/graph/ITensorAccessor.h" |
| 28 | #include "arm_compute/graph/Types.h" |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 29 | |
| 30 | namespace arm_compute |
| 31 | { |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 32 | namespace graph |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 33 | { |
| 34 | // Forward declaration |
| 35 | class Graph; |
| 36 | |
| 37 | /** Graph builder class |
| 38 | * |
| 39 | * Builds and compiles a graph |
| 40 | */ |
| 41 | class GraphBuilder final |
| 42 | { |
| 43 | public: |
| 44 | /** Adds a Const node to the graph |
| 45 | * |
| 46 | * @param[in] g Graph to add the node to |
| 47 | * @param[in] params Common node parameters |
| 48 | * @param[in] desc Tensor descriptor of the node |
| 49 | * @param[in] accessor (Optional) Accessor of the const node data |
| 50 | * |
| 51 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 52 | */ |
| 53 | static NodeID add_const_node(Graph &g, NodeParams params, TensorDescriptor desc, ITensorAccessorUPtr accessor = nullptr); |
| 54 | /** Adds an input layer node to the graph |
| 55 | * |
| 56 | * @param[in] g Graph to add the node to |
| 57 | * @param[in] params Common node parameters |
| 58 | * @param[in] desc Tensor descriptor of the Tensor |
| 59 | * @param[in] accessor (Optional) Accessor of the input node data |
| 60 | * |
| 61 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 62 | */ |
| 63 | static NodeID add_input_node(Graph &g, NodeParams params, TensorDescriptor desc, ITensorAccessorUPtr accessor = nullptr); |
| 64 | /** Adds an output layer node to the graph |
| 65 | * |
| 66 | * @param[in] g Graph to add the node to |
| 67 | * @param[in] params Common node parameters |
| 68 | * @param[in] input Input to the output node as a NodeID-Index pair |
| 69 | * @param[in] accessor (Optional) Accessor of the output node data |
| 70 | * |
| 71 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 72 | */ |
| 73 | static NodeID add_output_node(Graph &g, NodeParams params, NodeIdxPair input, ITensorAccessorUPtr accessor = nullptr); |
| 74 | /** Adds an activation layer node to the graph |
| 75 | * |
| 76 | * @param[in] g Graph to add the node to |
| 77 | * @param[in] params Common node parameters |
| 78 | * @param[in] input Input to the activation layer node as a NodeID-Index pair |
| 79 | * @param[in] act_info Activation layer information |
| 80 | * |
| 81 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 82 | */ |
| 83 | static NodeID add_activation_node(Graph &g, NodeParams params, NodeIdxPair input, ActivationLayerInfo act_info); |
| 84 | /** Adds a batch normalization layer node to the graph |
| 85 | * |
| 86 | * @param[in] g Graph to add the node to |
| 87 | * @param[in] params Common node parameters |
| 88 | * @param[in] input Input to the batch normalization layer node as a NodeID-Index pair |
| 89 | * @param[in] epsilon Epsilon parameter |
| 90 | * @param[in] mean_accessor Const Node ID that contains the mean values |
| 91 | * @param[in] var_accessor Const Node ID that contains the variance values |
| 92 | * @param[in] beta_accessor Const Node ID that contains the beta values. Can be EmptyNodeID |
| 93 | * @param[in] gamma_accessor Const Node ID that contains the gamma values. Can be EmptyNodeID |
| 94 | * |
| 95 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 96 | */ |
| 97 | static NodeID add_batch_normalization_node(Graph &g, NodeParams params, NodeIdxPair input, float epsilon, |
| 98 | ITensorAccessorUPtr mean_accessor = nullptr, ITensorAccessorUPtr var_accessor = nullptr, |
| 99 | ITensorAccessorUPtr beta_accessor = nullptr, ITensorAccessorUPtr gamma_accessor = nullptr); |
Georgios Pinitas | 087eaf6 | 2018-05-16 15:52:35 +0100 | [diff] [blame] | 100 | /** Adds an channel shuffle layer node to the graph |
| 101 | * |
| 102 | * @param[in] g Graph to add the node to |
| 103 | * @param[in] params Common node parameters |
| 104 | * @param[in] input Input to the activation layer node as a NodeID-Index pair |
| 105 | * @param[in] num_groups Number of groups |
| 106 | * |
| 107 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 108 | */ |
| 109 | static NodeID add_channel_shuffle_node(Graph &g, NodeParams params, NodeIdxPair input, unsigned int num_groups); |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 110 | /** Adds a convolution layer node to the graph |
| 111 | * |
Giorgio Arena | 59631a1 | 2018-05-02 13:59:04 +0100 | [diff] [blame] | 112 | * TODO (COMPMID-1113): Add a graph descriptor for convolution layer node |
| 113 | * |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 114 | * @param[in] g Graph to add the node to |
| 115 | * @param[in] params Common node parameters |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 116 | * @param[in] input Input to the convolution layer node as a NodeID-Index pair |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 117 | * @param[in] kernel_spatial_extend Spatial extend of convolution kernels |
| 118 | * @param[in] depth Number of convolution kernels |
| 119 | * @param[in] conv_info Convolution layer information |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 120 | * @param[in] num_groups (Optional) Number of groups for a grouped convolution. Defaults to 1 |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 121 | * @param[in] method (Optional) Convolution method to use |
Giorgio Arena | 59631a1 | 2018-05-02 13:59:04 +0100 | [diff] [blame] | 122 | * @param[in] fast_math_hint (Optional) Fast math hint |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 123 | * @param[in] weights_accessor (Optional) Accessor of the weights node data |
| 124 | * @param[in] bias_accessor (Optional) Accessor of the bias node data |
Giorgio Arena | bb54e4e | 2018-04-05 17:20:34 +0100 | [diff] [blame] | 125 | * @param[in] weights_quant_info (Optional) Weights quantization info |
| 126 | * @param[in] out_quant_info (Optional) Output quantization info |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 127 | * |
| 128 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 129 | */ |
| 130 | static NodeID add_convolution_node(Graph &g, NodeParams params, NodeIdxPair input, |
| 131 | Size2D kernel_spatial_extend, unsigned int depth, PadStrideInfo conv_info, |
Giorgio Arena | 59631a1 | 2018-05-02 13:59:04 +0100 | [diff] [blame] | 132 | unsigned int num_groups = 1, ConvolutionMethod method = ConvolutionMethod::DEFAULT, FastMathHint fast_math_hint = FastMathHint::DISABLED, |
Giorgio Arena | bb54e4e | 2018-04-05 17:20:34 +0100 | [diff] [blame] | 133 | ITensorAccessorUPtr weights_accessor = nullptr, ITensorAccessorUPtr bias_accessor = nullptr, |
| 134 | const QuantizationInfo weights_quant_info = QuantizationInfo(), |
| 135 | const QuantizationInfo out_quant_info = QuantizationInfo()); |
Georgios Pinitas | 087eaf6 | 2018-05-16 15:52:35 +0100 | [diff] [blame] | 136 | /** Adds a deconvolution layer node to the graph |
| 137 | * |
| 138 | * @param[in] g Graph to add the node to |
| 139 | * @param[in] params Common node parameters |
| 140 | * @param[in] input Input to the convolution layer node as a NodeID-Index pair |
| 141 | * @param[in] kernel_spatial_extend Spatial extend of convolution kernels |
| 142 | * @param[in] depth Number of convolution kernels |
| 143 | * @param[in] deconv_info Convolution layer information |
| 144 | * @param[in] inner_border Inner border (right, top) |
| 145 | * @param[in] weights_accessor (Optional) Accessor of the weights node data |
| 146 | * @param[in] bias_accessor (Optional) Accessor of the bias node data |
| 147 | * |
| 148 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 149 | */ |
| 150 | static NodeID add_deconvolution_node(Graph &g, NodeParams params, NodeIdxPair input, |
| 151 | Size2D kernel_spatial_extend, unsigned int depth, PadStrideInfo deconv_info, Size2D inner_border, |
| 152 | ITensorAccessorUPtr weights_accessor = nullptr, ITensorAccessorUPtr bias_accessor = nullptr); |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 153 | /** Adds a depth concatenate node to the graph |
| 154 | * |
| 155 | * @param[in] g Graph to add the node to |
| 156 | * @param[in] params Common node parameters |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 157 | * @param[in] inputs Inputs to the depth concatenate layer node as a NodeID-Index pair |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 158 | * |
| 159 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 160 | */ |
| 161 | static NodeID add_depth_concatenate_node(Graph &g, NodeParams params, std::vector<NodeIdxPair> inputs); |
| 162 | /** Adds a depth-wise convolution layer node to the graph |
| 163 | * |
| 164 | * @param[in] g Graph to add the node to |
| 165 | * @param[in] params Common node parameters |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 166 | * @param[in] input Input to the depthwise convolution layer node as a NodeID-Index pair |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 167 | * @param[in] kernel_spatial_extend Spatial extend of convolution kernels |
| 168 | * @param[in] conv_info Convolution layer information |
| 169 | * @param[in] method (Optional) Convolution method to use |
| 170 | * @param[in] weights_accessor (Optional) Accessor of the weights node data |
| 171 | * @param[in] bias_accessor (Optional) Accessor of the bias node data |
Giorgio Arena | bb54e4e | 2018-04-05 17:20:34 +0100 | [diff] [blame] | 172 | * @param[in] quant_info (Optional) Weights quantization info |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 173 | * |
| 174 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 175 | */ |
| 176 | static NodeID add_depthwise_convolution_node(Graph &g, NodeParams params, NodeIdxPair input, |
| 177 | Size2D kernel_spatial_extend, PadStrideInfo conv_info, |
| 178 | DepthwiseConvolutionMethod method = DepthwiseConvolutionMethod::DEFAULT, |
Giorgio Arena | bb54e4e | 2018-04-05 17:20:34 +0100 | [diff] [blame] | 179 | ITensorAccessorUPtr weights_accessor = nullptr, ITensorAccessorUPtr bias_accessor = nullptr, const QuantizationInfo quant_info = QuantizationInfo()); |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 180 | /** Adds an element-wise layer node to the graph |
| 181 | * |
| 182 | * @param[in] g Graph to add the node to |
| 183 | * @param[in] params Common node parameters |
| 184 | * @param[in] input0 First input to the element-wise operation layer node as a NodeID-Index pair |
| 185 | * @param[in] input1 Second input to the element-wise operation layer node as a NodeID-Index pair |
| 186 | * @param[in] operation Element-wise operation to perform |
| 187 | * |
| 188 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 189 | */ |
| 190 | static NodeID add_elementwise_node(Graph &g, NodeParams params, NodeIdxPair input0, NodeIdxPair input1, EltwiseOperation operation); |
Georgios Pinitas | 087eaf6 | 2018-05-16 15:52:35 +0100 | [diff] [blame] | 191 | /** Adds a Dummy node to the graph |
| 192 | * |
| 193 | * @note this node if for debugging purposes. Just alters the shape of the graph pipeline as requested. |
| 194 | * |
| 195 | * @param[in] g Graph to add the node to |
| 196 | * @param[in] params Common node parameters |
| 197 | * @param[in] input Input to the dummy node as a NodeID-Index pair |
| 198 | * @param[in] shape Output shape |
| 199 | * |
| 200 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 201 | */ |
| 202 | static NodeID add_dummy_node(Graph &g, NodeParams params, NodeIdxPair input, TensorShape shape); |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 203 | /** Adds a flatten layer node to the graph |
| 204 | * |
| 205 | * @param[in] g Graph to add the node to |
| 206 | * @param[in] params Common node parameters |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 207 | * @param[in] input Input to the flatten layer node as a NodeID-Index pair |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 208 | * |
| 209 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 210 | */ |
| 211 | static NodeID add_flatten_node(Graph &g, NodeParams params, NodeIdxPair input); |
| 212 | /** Adds a fully connected layer node to the graph |
| 213 | * |
| 214 | * @param[in] g Graph to add the layer to |
| 215 | * @param[in] params Common node parameters |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 216 | * @param[in] input Input to the fully connected layer node as a NodeID-Index pair |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 217 | * @param[in] num_outputs Number of output neurons |
| 218 | * @param[in] weights_accessor (Optional) Accessor of the weights node data |
| 219 | * @param[in] bias_accessor (Optional) Accessor of the bias node data |
| 220 | * |
| 221 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 222 | */ |
| 223 | static NodeID add_fully_connected_layer(Graph &g, NodeParams params, NodeIdxPair input, unsigned int num_outputs, |
| 224 | ITensorAccessorUPtr weights_accessor = nullptr, ITensorAccessorUPtr bias_accessor = nullptr); |
| 225 | /** Adds a normalization layer node to the graph |
| 226 | * |
| 227 | * @param[in] g Graph to add the node to |
| 228 | * @param[in] params Common node parameters |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 229 | * @param[in] input Input to the normalization layer node as a NodeID-Index pair |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 230 | * @param[in] norm_info Normalization layer information |
| 231 | * |
| 232 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 233 | */ |
| 234 | static NodeID add_normalization_node(Graph &g, NodeParams params, NodeIdxPair input, NormalizationLayerInfo norm_info); |
| 235 | /** Adds a pooling layer node to the graph |
| 236 | * |
| 237 | * @param[in] g Graph to add the node to |
| 238 | * @param[in] params Common node parameters |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 239 | * @param[in] input Input to the pooling layer node as a NodeID-Index pair |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 240 | * @param[in] pool_info Pooling layer information |
| 241 | * |
| 242 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 243 | */ |
| 244 | static NodeID add_pooling_node(Graph &g, NodeParams params, NodeIdxPair input, PoolingLayerInfo pool_info); |
| 245 | /** Adds a reshape layer node to the graph |
| 246 | * |
| 247 | * @param[in] g Graph to add the node to |
| 248 | * @param[in] params Common node parameters |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 249 | * @param[in] input Input to the reshape layer node as a NodeID-Index pair |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 250 | * @param[in] shape Output reshaped shape |
| 251 | * |
| 252 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 253 | */ |
| 254 | static NodeID add_reshape_node(Graph &g, NodeParams params, NodeIdxPair input, TensorShape shape); |
Georgios Pinitas | 087eaf6 | 2018-05-16 15:52:35 +0100 | [diff] [blame] | 255 | /** Adds a resize layer node to the graph |
| 256 | * |
| 257 | * @param[in] g Graph to add the node to |
| 258 | * @param[in] params Common node parameters |
| 259 | * @param[in] input Input to the reshape layer node as a NodeID-Index pair |
| 260 | * @param[in] policy Interpolation policy |
| 261 | * @param[in] width_scale Width scaling factor |
| 262 | * @param[in] height_scale Height scaling factor |
| 263 | * |
| 264 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 265 | */ |
| 266 | static NodeID add_resize_node(Graph &g, NodeParams params, NodeIdxPair input, InterpolationPolicy policy, float width_scale, float height_scale); |
Isabella Gottardi | 88d5b22 | 2018-04-06 12:24:55 +0100 | [diff] [blame] | 267 | /** Adds a scale layer node to the graph |
| 268 | * This layer computes a product of the input with a scale (read from mul_accessor) and it applies an offset (read from add_accessor). |
| 269 | * output = input * mul_w + add_w |
| 270 | * |
| 271 | * @param[in] g Graph to add the layer to |
| 272 | * @param[in] params Common node parameters |
| 273 | * @param[in] input Input to the fully connected layer node as a NodeID-Index pair |
| 274 | * @param[in] mul_accessor (Optional) Accessor of the mul node data |
| 275 | * @param[in] add_accessor (Optional) Accessor of the add node data |
| 276 | * |
| 277 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 278 | */ |
| 279 | static NodeID add_scale_layer(Graph &g, const NodeParams ¶ms, NodeIdxPair input, |
| 280 | ITensorAccessorUPtr mul_accessor = nullptr, ITensorAccessorUPtr add_accessor = nullptr); |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 281 | /** Adds a softmax node to the graph |
| 282 | * |
| 283 | * @param[in] g Graph to add the node to |
| 284 | * @param[in] params Common node parameters |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 285 | * @param[in] input Input to the softmax layer node as a NodeID-Index pair |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 286 | * @param[in] beta Beta parameter |
| 287 | * |
| 288 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 289 | */ |
| 290 | static NodeID add_softmax_node(Graph &g, NodeParams params, NodeIdxPair input, float beta = 1.f); |
Georgios Pinitas | ee33ea5 | 2018-03-08 16:01:29 +0000 | [diff] [blame] | 291 | /** Adds a split node to the graph |
| 292 | * |
| 293 | * @param[in] g Graph to add the node to |
| 294 | * @param[in] params Common node parameters |
| 295 | * @param[in] input Input to the split layer node as a NodeID-Index pair |
| 296 | * @param[in] num_splits Number of different splits |
| 297 | * @param[in] axis (Optional) Split axis. Defaults to 0 |
| 298 | * |
| 299 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 300 | */ |
| 301 | static NodeID add_split_node(Graph &g, NodeParams params, NodeIdxPair input, unsigned int num_splits, unsigned int axis = 0); |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 302 | }; |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 303 | } // namespace graph |
Georgios Pinitas | d8734b5 | 2017-12-22 15:27:52 +0000 | [diff] [blame] | 304 | } // namespace arm_compute |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 305 | #endif /* __ARM_COMPUTE_GRAPH_GRAPH_BUILDER_H__ */ |