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 | */ |
| 24 | #ifndef __ARM_COMPUTE_GRAPH2_GRAPH_BUILDER_H__ |
| 25 | #define __ARM_COMPUTE_GRAPH2_GRAPH_BUILDER_H__ |
| 26 | |
| 27 | #include "arm_compute/graph2/ITensorAccessor.h" |
| 28 | #include "arm_compute/graph2/Types.h" |
| 29 | |
| 30 | namespace arm_compute |
| 31 | { |
| 32 | namespace graph2 |
| 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); |
| 100 | /** Adds a convolution 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 batch normalization layer node as a NodeID-Index pair |
| 105 | * @param[in] kernel_spatial_extend Spatial extend of convolution kernels |
| 106 | * @param[in] depth Number of convolution kernels |
| 107 | * @param[in] conv_info Convolution layer information |
| 108 | * @param[in] method (Optional) Convolution method to use |
| 109 | * @param[in] weights_accessor (Optional) Accessor of the weights node data |
| 110 | * @param[in] bias_accessor (Optional) Accessor of the bias node data |
| 111 | * |
| 112 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 113 | */ |
| 114 | static NodeID add_convolution_node(Graph &g, NodeParams params, NodeIdxPair input, |
| 115 | Size2D kernel_spatial_extend, unsigned int depth, PadStrideInfo conv_info, |
| 116 | ConvolutionMethod method = ConvolutionMethod::DEFAULT, |
| 117 | ITensorAccessorUPtr weights_accessor = nullptr, ITensorAccessorUPtr bias_accessor = nullptr); |
| 118 | /** Adds a depth concatenate node to the graph |
| 119 | * |
| 120 | * @param[in] g Graph to add the node to |
| 121 | * @param[in] params Common node parameters |
| 122 | * @param[in] inputs Input to the batch normalization layer node as a NodeID-Index pair |
| 123 | * |
| 124 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 125 | */ |
| 126 | static NodeID add_depth_concatenate_node(Graph &g, NodeParams params, std::vector<NodeIdxPair> inputs); |
| 127 | /** Adds a depth-wise convolution layer node to the graph |
| 128 | * |
| 129 | * @param[in] g Graph to add the node to |
| 130 | * @param[in] params Common node parameters |
| 131 | * @param[in] input Input to the batch normalization layer node as a NodeID-Index pair |
| 132 | * @param[in] kernel_spatial_extend Spatial extend of convolution kernels |
| 133 | * @param[in] conv_info Convolution layer information |
| 134 | * @param[in] method (Optional) Convolution method to use |
| 135 | * @param[in] weights_accessor (Optional) Accessor of the weights node data |
| 136 | * @param[in] bias_accessor (Optional) Accessor of the bias node data |
| 137 | * |
| 138 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 139 | */ |
| 140 | static NodeID add_depthwise_convolution_node(Graph &g, NodeParams params, NodeIdxPair input, |
| 141 | Size2D kernel_spatial_extend, PadStrideInfo conv_info, |
| 142 | DepthwiseConvolutionMethod method = DepthwiseConvolutionMethod::DEFAULT, |
| 143 | ITensorAccessorUPtr weights_accessor = nullptr, ITensorAccessorUPtr bias_accessor = nullptr); |
| 144 | /** Adds an element-wise layer node to the graph |
| 145 | * |
| 146 | * @param[in] g Graph to add the node to |
| 147 | * @param[in] params Common node parameters |
| 148 | * @param[in] input0 First input to the element-wise operation layer node as a NodeID-Index pair |
| 149 | * @param[in] input1 Second input to the element-wise operation layer node as a NodeID-Index pair |
| 150 | * @param[in] operation Element-wise operation to perform |
| 151 | * |
| 152 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 153 | */ |
| 154 | static NodeID add_elementwise_node(Graph &g, NodeParams params, NodeIdxPair input0, NodeIdxPair input1, EltwiseOperation operation); |
| 155 | /** Adds a flatten layer node to the graph |
| 156 | * |
| 157 | * @param[in] g Graph to add the node to |
| 158 | * @param[in] params Common node parameters |
| 159 | * @param[in] input Input to the batch normalization layer node as a NodeID-Index pair |
| 160 | * |
| 161 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 162 | */ |
| 163 | static NodeID add_flatten_node(Graph &g, NodeParams params, NodeIdxPair input); |
| 164 | /** Adds a fully connected layer node to the graph |
| 165 | * |
| 166 | * @param[in] g Graph to add the layer to |
| 167 | * @param[in] params Common node parameters |
| 168 | * @param[in] input Input to the batch normalization layer node as a NodeID-Index pair |
| 169 | * @param[in] num_outputs Number of output neurons |
| 170 | * @param[in] weights_accessor (Optional) Accessor of the weights node data |
| 171 | * @param[in] bias_accessor (Optional) Accessor of the bias node data |
| 172 | * |
| 173 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 174 | */ |
| 175 | static NodeID add_fully_connected_layer(Graph &g, NodeParams params, NodeIdxPair input, unsigned int num_outputs, |
| 176 | ITensorAccessorUPtr weights_accessor = nullptr, ITensorAccessorUPtr bias_accessor = nullptr); |
| 177 | /** Adds a normalization layer node to the graph |
| 178 | * |
| 179 | * @param[in] g Graph to add the node to |
| 180 | * @param[in] params Common node parameters |
| 181 | * @param[in] input Input to the batch normalization layer node as a NodeID-Index pair |
| 182 | * @param[in] norm_info Normalization layer information |
| 183 | * |
| 184 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 185 | */ |
| 186 | static NodeID add_normalization_node(Graph &g, NodeParams params, NodeIdxPair input, NormalizationLayerInfo norm_info); |
| 187 | /** Adds a pooling layer node to the graph |
| 188 | * |
| 189 | * @param[in] g Graph to add the node to |
| 190 | * @param[in] params Common node parameters |
| 191 | * @param[in] input Input to the batch normalization layer node as a NodeID-Index pair |
| 192 | * @param[in] pool_info Pooling layer information |
| 193 | * |
| 194 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 195 | */ |
| 196 | static NodeID add_pooling_node(Graph &g, NodeParams params, NodeIdxPair input, PoolingLayerInfo pool_info); |
| 197 | /** Adds a reshape layer node to the graph |
| 198 | * |
| 199 | * @param[in] g Graph to add the node to |
| 200 | * @param[in] params Common node parameters |
| 201 | * @param[in] input Input to the batch normalization layer node as a NodeID-Index pair |
| 202 | * @param[in] shape Output reshaped shape |
| 203 | * |
| 204 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 205 | */ |
| 206 | static NodeID add_reshape_node(Graph &g, NodeParams params, NodeIdxPair input, TensorShape shape); |
| 207 | /** Adds a softmax node to the graph |
| 208 | * |
| 209 | * @param[in] g Graph to add the node to |
| 210 | * @param[in] params Common node parameters |
| 211 | * @param[in] input Input to the batch normalization layer node as a NodeID-Index pair |
| 212 | * @param[in] beta Beta parameter |
| 213 | * |
| 214 | * @return Node ID of the created node, EmptyNodeID in case of error |
| 215 | */ |
| 216 | static NodeID add_softmax_node(Graph &g, NodeParams params, NodeIdxPair input, float beta = 1.f); |
| 217 | }; |
| 218 | } // namespace graph2 |
| 219 | } // namespace arm_compute |
| 220 | #endif /* __ARM_COMPUTE_GRAPH2_GRAPH_BUILDER_H__ */ |