blob: b1f340d18e67468d7db6069981032818bc16e860 [file] [log] [blame]
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001/*
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00002 * Copyright (c) 2016-2021 Arm Limited.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01003 *
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 */
Michalis Spyrouf4643372019-11-29 16:17:13 +000024#ifndef ARM_COMPUTE_TYPES_H
25#define ARM_COMPUTE_TYPES_H
Anthony Barbier6ff3b192017-09-04 18:44:23 +010026
27#include "arm_compute/core/Coordinates.h"
Georgios Pinitas4c5469b2019-05-21 13:32:43 +010028#include "arm_compute/core/QuantizationInfo.h"
Isabella Gottardi6e464c32018-01-26 12:32:45 +000029#include "arm_compute/core/Size2D.h"
Georgios Pinitas8795ffb2017-12-01 16:13:40 +000030#include "arm_compute/core/Strides.h"
Anthony Barbier6ff3b192017-09-04 18:44:23 +010031#include "arm_compute/core/TensorShape.h"
Sang-Hoon Park11fedda2020-01-15 14:44:04 +000032#include "arm_compute/core/utils/misc/Macros.h"
Georgios Pinitase8291ac2020-02-26 09:58:13 +000033#include "support/Bfloat16.h"
Georgios Pinitas583137c2017-08-31 18:12:42 +010034#include "support/Half.h"
Anthony Barbier6ff3b192017-09-04 18:44:23 +010035
Michel Iwaniec5dfeae62017-11-29 10:48:23 +000036#include <cmath>
Anthony Barbier6ff3b192017-09-04 18:44:23 +010037#include <cstddef>
38#include <cstdint>
Isabella Gottardia7acb3c2019-01-08 13:48:44 +000039#include <map>
Anthony Barbier6ff3b192017-09-04 18:44:23 +010040#include <string>
41#include <utility>
42
43namespace arm_compute
44{
Georgios Pinitas583137c2017-08-31 18:12:42 +010045/** 16-bit floating point type */
46using half = half_float::half;
47
Georgios Pinitas8795ffb2017-12-01 16:13:40 +000048/** Permutation vector */
49using PermutationVector = Strides;
Georgios Pinitas77589b52018-08-21 14:41:35 +010050/** Bidirectional strides */
51using BiStrides = Coordinates;
Georgios Pinitas8795ffb2017-12-01 16:13:40 +000052
Anthony Barbier6ff3b192017-09-04 18:44:23 +010053/** Image colour formats */
54enum class Format
55{
Daniil Efremov02bf80d2017-11-22 00:26:51 +070056 UNKNOWN, /**< Unknown image format */
57 U8, /**< 1 channel, 1 U8 per channel */
58 S16, /**< 1 channel, 1 S16 per channel */
59 U16, /**< 1 channel, 1 U16 per channel */
60 S32, /**< 1 channel, 1 S32 per channel */
61 U32, /**< 1 channel, 1 U32 per channel */
Georgios Pinitase8291ac2020-02-26 09:58:13 +000062 BFLOAT16, /**< 16-bit brain floating-point number */
Daniil Efremov02bf80d2017-11-22 00:26:51 +070063 F16, /**< 1 channel, 1 F16 per channel */
64 F32, /**< 1 channel, 1 F32 per channel */
65 UV88, /**< 2 channel, 1 U8 per channel */
66 RGB888, /**< 3 channels, 1 U8 per channel */
67 RGBA8888, /**< 4 channels, 1 U8 per channel */
68 YUV444, /**< A 3 plane of 8 bit 4:4:4 sampled Y, U, V planes */
69 YUYV422, /**< A single plane of 32-bit macro pixel of Y0, U0, Y1, V0 bytes */
70 NV12, /**< A 2 plane YUV format of Luma (Y) and interleaved UV data at 4:2:0 sampling */
71 NV21, /**< A 2 plane YUV format of Luma (Y) and interleaved VU data at 4:2:0 sampling */
72 IYUV, /**< A 3 plane of 8-bit 4:2:0 sampled Y, U, V planes */
73 UYVY422 /**< A single plane of 32-bit macro pixel of U0, Y0, V0, Y1 byte */
Anthony Barbier6ff3b192017-09-04 18:44:23 +010074};
75
76/** Available data types */
77enum class DataType
78{
Georgios Pinitas8217c8e2019-11-11 18:24:22 +000079 UNKNOWN, /**< Unknown data type */
80 U8, /**< unsigned 8-bit number */
81 S8, /**< signed 8-bit number */
82 QSYMM8, /**< quantized, symmetric fixed-point 8-bit number */
83 QASYMM8, /**< quantized, asymmetric fixed-point 8-bit number unsigned */
84 QASYMM8_SIGNED, /**< quantized, asymmetric fixed-point 8-bit number signed */
85 QSYMM8_PER_CHANNEL, /**< quantized, symmetric per channel fixed-point 8-bit number */
86 U16, /**< unsigned 16-bit number */
87 S16, /**< signed 16-bit number */
88 QSYMM16, /**< quantized, symmetric fixed-point 16-bit number */
89 QASYMM16, /**< quantized, asymmetric fixed-point 16-bit number */
90 U32, /**< unsigned 32-bit number */
91 S32, /**< signed 32-bit number */
92 U64, /**< unsigned 64-bit number */
93 S64, /**< signed 64-bit number */
Georgios Pinitase8291ac2020-02-26 09:58:13 +000094 BFLOAT16, /**< 16-bit brain floating-point number */
Georgios Pinitas8217c8e2019-11-11 18:24:22 +000095 F16, /**< 16-bit floating-point number */
96 F32, /**< 32-bit floating-point number */
97 F64, /**< 64-bit floating-point number */
98 SIZET /**< size_t */
Anthony Barbier6ff3b192017-09-04 18:44:23 +010099};
100
Daniil Efremov02bf80d2017-11-22 00:26:51 +0700101/** Available Sampling Policies */
102enum class SamplingPolicy
103{
104 CENTER, /**< Samples are taken at pixel center */
105 TOP_LEFT /**< Samples are taken at pixel top left corner */
106};
107
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100108/** Constant value of the border pixels when using BorderMode::CONSTANT */
109constexpr uint8_t CONSTANT_BORDER_VALUE = 199;
110
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +0000111/** [DataLayout enum definition] **/
112
Georgios Pinitas4074c992018-01-30 18:13:46 +0000113/** Supported tensor data layouts */
114enum class DataLayout
115{
Alex Gildayc357c472018-03-21 13:54:09 +0000116 UNKNOWN, /**< Unknown data layout */
117 NCHW, /**< Num samples, channels, height, width */
118 NHWC /**< Num samples, height, width, channels */
Georgios Pinitas4074c992018-01-30 18:13:46 +0000119};
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +0000120/** [DataLayout enum definition] **/
Georgios Pinitas4074c992018-01-30 18:13:46 +0000121
Isabella Gottardid17a6772018-02-27 17:41:55 +0000122/** Supported tensor data layout dimensions */
123enum class DataLayoutDimension
124{
Alex Gildayc357c472018-03-21 13:54:09 +0000125 CHANNEL, /**< channel */
126 HEIGHT, /**< height */
127 WIDTH, /**< width */
128 BATCHES /**< batches */
Isabella Gottardid17a6772018-02-27 17:41:55 +0000129};
130
Georgios Pinitas7900a9e2018-11-23 11:44:58 +0000131/** Available ConvolutionMethod*/
132enum class ConvolutionMethod
133{
Georgios Pinitasc0b6f762020-11-02 01:37:17 +0000134 GEMM, /**< Convolution using GEMM */
135 GEMM_CONV2D, /**< Direct 2D GEMM convolution */
136 DIRECT, /**< Direct convolution */
137 WINOGRAD, /**< Convolution using Winograd */
138 FFT /**< Convolution using FFT */
Georgios Pinitas7900a9e2018-11-23 11:44:58 +0000139};
140
Manuel Bottini05069f02019-09-26 17:18:26 +0100141/** Available DepthwiseConvolutionFunction*/
142enum class DepthwiseConvolutionFunction
143{
144 OPTIMIZED, /**< Optimized Depthwise Convolution */
145 GENERIC, /**< Generic Depthwise Convolution */
146};
147
giuros0146a49a02019-04-01 13:50:22 +0100148/** Available DeconvolutionMethod*/
149enum class DeconvolutionMethod
150{
151 GEMM, /**< Deconvolution using GEMM */
152 DIRECT, /**< Direct deconvolution */
153};
154
Manuel Bottini2732cca2019-05-28 11:44:41 +0100155/** Available FuseBatchNormalizationType*/
156enum class FuseBatchNormalizationType
157{
158 CONVOLUTION, /**< For Convolution weights */
159 DEPTHWISECONVOLUTION /**< For Depthwise Convolution weights*/
160};
161
Usama Arif89890c62019-03-19 10:57:05 +0000162/** Padding mode to use for PadLayer */
163enum class PaddingMode
164{
165 CONSTANT,
166 REFLECT,
167 SYMMETRIC
168};
169
Georgios Pinitas7900a9e2018-11-23 11:44:58 +0000170/** Supported comparison operations */
171enum class ComparisonOperation
172{
173 Equal, /**< Equal comparison ( \f$ x == y \f$ ) */
174 NotEqual, /**< NotEqual comparison ( \f$ x != y \f$ ) */
175 Greater, /**< Greater comparison ( \f$ x > y \f$ ) */
176 GreaterEqual, /**< Greater equal comparison ( \f$ x >= y \f$ ) */
177 Less, /**< Less comparison ( \f$ x < y \f$ ) */
178 LessEqual /**< Less equal comparison ( \f$ x <= y \f$ ) */
179};
180
Alex Gildayc357c472018-03-21 13:54:09 +0000181/** Container for valid region of a window */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100182struct ValidRegion
183{
Alex Gildayc357c472018-03-21 13:54:09 +0000184 /** Default constructor */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100185 ValidRegion()
186 : anchor{}, shape{}
187 {
188 }
189
Alex Gildayc357c472018-03-21 13:54:09 +0000190 /** Allow instances of this class to be copy constructed */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100191 ValidRegion(const ValidRegion &) = default;
Alex Gildayc357c472018-03-21 13:54:09 +0000192 /** Allow instances of this class to be move constructed */
193 ValidRegion(ValidRegion &&) = default;
194 /** Allow instances of this class to be copied */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100195 ValidRegion &operator=(const ValidRegion &) = default;
Alex Gildayc357c472018-03-21 13:54:09 +0000196 /** Allow instances of this class to be moved */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100197 ValidRegion &operator=(ValidRegion &&) = default;
Alex Gildayc357c472018-03-21 13:54:09 +0000198 /** Default destructor */
199 ~ValidRegion() = default;
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100200
Alex Gildayc357c472018-03-21 13:54:09 +0000201 /** Constructor for a valid region with default number of dimensions
202 *
203 * @param[in] an_anchor Anchor for the start of the valid region.
204 * @param[in] a_shape Shape of the valid region.
205 *
206 */
Diego Lopez Recasbcbc9702017-12-18 11:28:27 +0000207 ValidRegion(const Coordinates &an_anchor, const TensorShape &a_shape)
208 : anchor{ an_anchor }, shape{ a_shape }
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100209 {
Diego Lopez Recasbcbc9702017-12-18 11:28:27 +0000210 anchor.set_num_dimensions(std::max(anchor.num_dimensions(), shape.num_dimensions()));
211 }
212
Alex Gildayc357c472018-03-21 13:54:09 +0000213 /** Constructor for a valid region with specified number of dimensions
214 *
215 * @param[in] an_anchor Anchor for the start of the valid region.
216 * @param[in] a_shape Shape of the valid region.
217 * @param[in] num_dimensions Number of dimensions (must be >= number of dimensions of anchor and shape).
218 *
219 */
Diego Lopez Recasbcbc9702017-12-18 11:28:27 +0000220 ValidRegion(const Coordinates &an_anchor, const TensorShape &a_shape, size_t num_dimensions)
221 : anchor{ an_anchor }, shape{ a_shape }
222 {
223 ARM_COMPUTE_ERROR_ON(num_dimensions < std::max(anchor.num_dimensions(), shape.num_dimensions()));
224 anchor.set_num_dimensions(num_dimensions);
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100225 }
226
227 /** Return the start of the valid region for the given dimension @p d */
228 int start(unsigned int d) const
229 {
230 return anchor[d];
231 }
232
233 /** Return the end of the valid region for the given dimension @p d */
234 int end(unsigned int d) const
235 {
236 return anchor[d] + shape[d];
237 }
238
Diego Lopez Recas35ceeb22017-12-04 18:56:10 +0000239 /** Accessor to set the value of anchor and shape for one of the dimensions.
240 *
241 * @param[in] dimension Dimension for which the value is set.
242 * @param[in] start Value to be set in anchor for the dimension.
243 * @param[in] size Value to be set in shape for the dimension.
244 *
245 * @return *this.
246 */
247 ValidRegion &set(size_t dimension, int start, size_t size)
248 {
249 anchor.set(dimension, start);
250 shape.set(dimension, size);
251 return *this;
252 }
253
Alex Gildayc357c472018-03-21 13:54:09 +0000254 Coordinates anchor; /**< Anchor for the start of the valid region. */
255 TensorShape shape; /**< Shape of the valid region. */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100256};
257
258/** Methods available to handle borders */
259enum class BorderMode
260{
261 UNDEFINED, /**< Borders are left undefined */
262 CONSTANT, /**< Pixels outside the image are assumed to have a constant value */
263 REPLICATE /**< Pixels outside the image are assumed to have the same value as the closest image pixel */
264};
265
266/** Container for 2D border size */
267struct BorderSize
268{
269 /** Empty border, i.e. no border */
Pablo Marquez Tello383de022021-03-18 11:31:13 +0000270 constexpr BorderSize() noexcept
271 : top{ 0 },
272 right{ 0 },
273 bottom{ 0 },
274 left{ 0 }
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100275 {
276 }
277
278 /** Border with equal size around the 2D plane */
Pablo Marquez Tello383de022021-03-18 11:31:13 +0000279 explicit constexpr BorderSize(unsigned int size) noexcept
280 : top{ size },
281 right{ size },
282 bottom{ size },
283 left{ size }
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100284 {
285 }
286
287 /** Border with same size for top/bottom and left/right */
288 constexpr BorderSize(unsigned int top_bottom, unsigned int left_right)
289 : top{ top_bottom }, right{ left_right }, bottom{ top_bottom }, left{ left_right }
290 {
291 }
292
293 /** Border with different sizes */
294 constexpr BorderSize(unsigned int top, unsigned int right, unsigned int bottom, unsigned int left)
295 : top{ top }, right{ right }, bottom{ bottom }, left{ left }
296 {
297 }
298
299 /** Check if the entire border is zero */
300 constexpr bool empty() const
301 {
302 return top == 0 && right == 0 && bottom == 0 && left == 0;
303 }
304
305 /** Check if the border is the same size on all sides */
306 constexpr bool uniform() const
307 {
308 return top == right && top == bottom && top == left;
309 }
310
Alex Gildayc357c472018-03-21 13:54:09 +0000311 /** Scale this border size.
312 *
313 * @param[in] scale Scale to multiply border size by.
314 *
315 * @return *this.
316 */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100317 BorderSize &operator*=(float scale)
318 {
319 top *= scale;
320 right *= scale;
321 bottom *= scale;
322 left *= scale;
323
324 return *this;
325 }
326
Alex Gildayc357c472018-03-21 13:54:09 +0000327 /** Scale a copy of this border size.
328 *
329 * @param[in] scale Scale to multiply border size by.
330 *
331 * @return a scaled copy of this.
332 */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100333 BorderSize operator*(float scale)
334 {
335 BorderSize size = *this;
336 size *= scale;
337
338 return size;
339 }
340
Giorgio Arena1e2af2a2020-10-15 17:39:41 +0100341 /** Check equality with another BorderSize struct
342 *
343 * @param[in] rhs other struct to check against
344 *
345 * @return true if they are equal
346 */
347 bool operator==(const BorderSize &rhs)
348 {
349 return (top == rhs.top) && (right == rhs.right) && (bottom == rhs.bottom) && (left == rhs.left);
350 }
351
352 /** Check non-equality with another BorderSize struct
353 *
354 * @param[in] rhs other struct to check against
355 *
356 * @return true if they are different
357 */
358 bool operator!=(const BorderSize &rhs)
359 {
360 return !(*this == rhs);
361 }
362
Alex Gildayc357c472018-03-21 13:54:09 +0000363 /** Limit this border size.
364 *
365 * @param[in] limit Border size to limit this border size to.
366 */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100367 void limit(const BorderSize &limit)
368 {
369 top = std::min(top, limit.top);
370 right = std::min(right, limit.right);
371 bottom = std::min(bottom, limit.bottom);
372 left = std::min(left, limit.left);
373 }
374
Alex Gildayc357c472018-03-21 13:54:09 +0000375 unsigned int top; /**< top of the border */
376 unsigned int right; /**< right of the border */
377 unsigned int bottom; /**< bottom of the border */
378 unsigned int left; /**< left of the border */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100379};
380
Alex Gildayc357c472018-03-21 13:54:09 +0000381/** Container for 2D padding size */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100382using PaddingSize = BorderSize;
383
384/** Policy to handle overflow */
385enum class ConvertPolicy
386{
387 WRAP, /**< Wrap around */
388 SATURATE /**< Saturate */
389};
390
391/** Interpolation method */
392enum class InterpolationPolicy
393{
394 NEAREST_NEIGHBOR, /**< Output values are defined to match the source pixel whose center is nearest to the sample position */
395 BILINEAR, /**< Output values are defined by bilinear interpolation between the pixels */
396 AREA, /**< Output values are determined by averaging the source pixels whose areas fall under the area of the destination pixel, projected onto the source image */
397};
398
399/** Bilinear Interpolation method used by LKTracker */
400enum class BilinearInterpolation
401{
Alex Gildayc357c472018-03-21 13:54:09 +0000402 BILINEAR_OLD_NEW, /**< Old-new method */
403 BILINEAR_SCHARR /**< Scharr method */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100404};
405
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100406/** Rectangle type */
407struct Rectangle
408{
409 uint16_t x; /**< Top-left x coordinate */
410 uint16_t y; /**< Top-left y coordinate */
411 uint16_t width; /**< Width of the rectangle */
412 uint16_t height; /**< Height of the rectangle */
413};
414
415/** Coordinate type */
416struct Coordinates2D
417{
418 int32_t x; /**< X coordinates */
419 int32_t y; /**< Y coordinates */
420};
421
422/** Coordinate type */
423struct Coordinates3D
424{
425 uint32_t x; /**< X coordinates */
426 uint32_t y; /**< Y coordinates */
427 uint32_t z; /**< Z coordinates */
428};
429
Giuseppe Rossinid7647d42018-07-17 18:13:13 +0100430/** Padding information as a pair of unsigned int start/end */
431using PaddingInfo = std::pair<uint32_t, uint32_t>;
432
433/** List of padding information */
434using PaddingList = std::vector<PaddingInfo>;
435
giuros013175fcf2018-11-21 09:59:17 +0000436/** Information to produce a tiled version of a Tensor */
437using Multiples = std::vector<uint32_t>;
438
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100439/** Available channels */
440enum class Channel
441{
442 UNKNOWN, /** Unknown channel format */
443 C0, /**< First channel (used by formats with unknown channel types). */
444 C1, /**< Second channel (used by formats with unknown channel types). */
445 C2, /**< Third channel (used by formats with unknown channel types). */
446 C3, /**< Fourth channel (used by formats with unknown channel types). */
447 R, /**< Red channel. */
448 G, /**< Green channel. */
449 B, /**< Blue channel. */
450 A, /**< Alpha channel. */
451 Y, /**< Luma channel. */
452 U, /**< Cb/U channel. */
453 V /**< Cr/V/Value channel. */
454};
455
Georgios Pinitasd9769582017-08-03 10:19:40 +0100456/** Available reduction operations */
457enum class ReductionOperation
458{
Michalis Spyrou7930db42018-11-22 17:36:28 +0000459 ARG_IDX_MAX, /**< Index of the max value */
Manuel Bottinib412fab2018-12-10 17:40:23 +0000460 ARG_IDX_MIN, /**< Index of the min value */
461 MEAN_SUM, /**< Mean of sum */
462 PROD, /**< Product */
463 SUM_SQUARE, /**< Sum of squares */
Usama Arifa4a08ad2019-05-20 12:38:33 +0100464 SUM, /**< Sum */
465 MIN, /**< Min */
Usama Arif28f0dd92019-05-20 13:44:34 +0100466 MAX, /**< Max */
Georgios Pinitasd9769582017-08-03 10:19:40 +0100467};
468
giuros01164a2722018-11-20 18:34:46 +0000469/** Available element-wise operations */
470enum class ArithmeticOperation
471{
472 ADD, /**< (x + y) */
473 SUB, /**< (x - y) */
474 DIV, /**< (x / y) */
475 MIN, /**< Min(x, y) */
476 MAX, /**< Max(x, y) */
477 SQUARED_DIFF, /**< (x - y)^2 */
Usama Arif81e671e2019-05-13 13:33:14 +0100478 POWER, /**< x ^ y */
giuros011e6e1b82019-05-14 16:12:53 +0100479 PRELU, /**< y*x if x < 0, x otherwise */
giuros01164a2722018-11-20 18:34:46 +0000480};
481
Michalis Spyroue9362622018-11-23 17:41:37 +0000482/** Available element wise unary operations */
483enum class ElementWiseUnary
484{
Sang-Hoon Park75eea332020-11-13 13:44:13 +0000485 RSQRT, /**< Reverse square root */
486 EXP, /**< Exponential */
487 NEG, /**< Negate */
488 LOG, /**< Natural Logarithm */
489 ABS, /**< Absolute value */
490 SIN, /**< Sine */
491 ROUND, /**< Round */
492 LOGICAL_NOT, /**< Logical Not */
Michalis Spyroue9362622018-11-23 17:41:37 +0000493};
494
Manuel Bottini63bb7ca2020-12-02 13:22:14 +0000495/** Available bitwise operations */
496enum class BitwiseOperation
497{
498 AND, /**< Bitwise AND operation */
499 NOT, /**< Bitwise NOT operation */
500 OR, /**< Bitwise OR operation */
501 XOR, /**< Bitwise XOR operation */
502};
503
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100504/** The normalization type used for the normalization layer */
505enum class NormType
506{
507 IN_MAP_1D, /**< Normalization applied within the same map in 1D region */
508 IN_MAP_2D, /**< Normalization applied within the same map in 2D region */
509 CROSS_MAP /**< Normalization applied cross maps */
510};
511
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100512/** Detection window used for the object detection. The detection window keeps the following information:
513 *
514 * -# Geometry of the rectangular window (x/y of top-left corner and width/height)
515 * -# Index of the class used for evaluating which class the detection window belongs to
516 * -# Confidence value (score) obtained with the classifier
517 */
518struct DetectionWindow
519{
520 uint16_t x{ 0 }; /**< Top-left x coordinate */
521 uint16_t y{ 0 }; /**< Top-left y coordinate */
522 uint16_t width{ 0 }; /**< Width of the detection window */
523 uint16_t height{ 0 }; /**< Height of the detection window */
524 uint16_t idx_class{ 0 }; /**< Index of the class */
525 float score{ 0.f }; /**< Confidence value for the detection window */
526};
527
528/** Dimension rounding type when down-scaling on CNNs
529 * @note Used in pooling and convolution layer
530 */
531enum class DimensionRoundingType
532{
533 FLOOR, /**< Floor rounding */
534 CEIL /**< Ceil rounding */
535};
536
537/** Available pooling types */
538enum class PoolingType
539{
540 MAX, /**< Max Pooling */
Georgios Pinitascdf51452017-08-31 14:21:36 +0100541 AVG, /**< Average Pooling */
542 L2 /**< L2 Pooling */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100543};
544
Michalis Spyrou2709d612018-09-19 09:46:47 +0100545/** Available non maxima suppression types */
546enum class NMSType
547{
548 LINEAR, /**< Linear NMS */
549 GAUSSIAN, /**< Gaussian NMS */
550 ORIGINAL /**< Original NMS */
551};
552
553/** BoxWithNonMaximaSuppressionLimit Information class */
554class BoxNMSLimitInfo final
555{
556public:
557 /** Constructor
558 *
559 * @param[in] score_thresh (Optional) Score threshold.
560 * @param[in] nms (Optional) NMS value
561 * @param[in] detections (Optional) Number of detections
562 * @param[in] soft_nms_enabled (Optional) Enable SoftNMS
563 * @param[in] soft_nms_method (Optional) Soft NMS method
564 * @param[in] soft_nms_sigma (Optional) Soft NMS sigma value
565 * @param[in] soft_nms_min_score_thres (Optional) Soft NMS minimum score threshold
Manuel Bottini5209be52019-02-13 16:34:56 +0000566 * @param[in] suppress_size (Optional) Filter out boxes based on their size. Defaults to false
567 * @param[in] min_size (Optional) Smaller boxes than min_size will be filtered out. Defaults to 1
568 * @param[in] im_width (Optional) Boxes whose centers (on the x axis) is beyond im_width will be filtered. Defaults to 1
569 * @param[in] im_height (Optional) Boxes whose centers (on the y axis) is beyond im_height will be filtered. Defaults to 1
Michalis Spyrou2709d612018-09-19 09:46:47 +0100570 */
571 BoxNMSLimitInfo(float score_thresh = 0.05f, float nms = 0.3f,
572 int detections = 100, bool soft_nms_enabled = false,
573 NMSType soft_nms_method = NMSType::LINEAR,
Manuel Bottini5209be52019-02-13 16:34:56 +0000574 float soft_nms_sigma = 0.5f, float soft_nms_min_score_thres = 0.001f, bool suppress_size = false, float min_size = 1.0f, float im_width = 1.0f, float im_height = 1.0f)
Michalis Spyrou2709d612018-09-19 09:46:47 +0100575 : _score_thresh(score_thresh), _nms(nms), _detections_per_im(detections), _soft_nms_enabled(soft_nms_enabled), _soft_nms_method(soft_nms_method), _soft_nms_sigma(soft_nms_sigma),
Manuel Bottini5209be52019-02-13 16:34:56 +0000576 _soft_nms_min_score_thres(soft_nms_min_score_thres), _suppress_size(suppress_size), _min_size(min_size), _im_width(im_width), _im_height(im_height)
Michalis Spyrou2709d612018-09-19 09:46:47 +0100577 {
578 }
579 /** Get the score threshold */
580 float score_thresh() const
581 {
582 return _score_thresh;
583 }
584 /** Get the NMS */
585 float nms() const
586 {
587 return _nms;
588 }
589 /** Get the number of detections */
590 int detections_per_im() const
591 {
592 return _detections_per_im;
593 }
594 /** Check if soft NMS is enabled */
595 bool soft_nms_enabled() const
596 {
597 return _soft_nms_enabled;
598 }
599 /** Get soft NMS method */
600 NMSType soft_nms_method() const
601 {
602 return _soft_nms_method;
603 }
604 /** Get soft NMS sigma */
605 float soft_nms_sigma() const
606 {
607 return _soft_nms_sigma;
608 }
609 /** Get soft nms min score threshold */
610 float soft_nms_min_score_thres() const
611 {
612 return _soft_nms_min_score_thres;
613 }
Manuel Bottini5209be52019-02-13 16:34:56 +0000614 /** Get if NMS will suppress boxes based on their size/position */
615 bool suppress_size() const
616 {
617 return _suppress_size;
618 }
619 /** Get size suppression threshold */
620 float min_size() const
621 {
622 return _min_size;
623 }
624 /** Get image width (NMS may suppress boxes whose center sits beyond the image width) */
625 float im_width() const
626 {
627 return _im_width;
628 }
629 /** Get image height (NMS may suppress boxes whose center sits beyond the image height) */
630 float im_height() const
631 {
632 return _im_height;
633 }
Michalis Spyrou2709d612018-09-19 09:46:47 +0100634
635private:
636 float _score_thresh;
637 float _nms;
638 int _detections_per_im;
639 bool _soft_nms_enabled;
640 NMSType _soft_nms_method;
641 float _soft_nms_sigma;
642 float _soft_nms_min_score_thres;
Manuel Bottini5209be52019-02-13 16:34:56 +0000643 bool _suppress_size;
644 float _min_size;
645 float _im_width;
646 float _im_height;
Michalis Spyrou2709d612018-09-19 09:46:47 +0100647};
648
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100649/** Padding and stride information class */
650class PadStrideInfo
651{
652public:
653 /** Constructor
654 *
655 * @param[in] stride_x (Optional) Stride, in elements, across x. Defaults to 1.
656 * @param[in] stride_y (Optional) Stride, in elements, across y. Defaults to 1.
657 * @param[in] pad_x (Optional) Padding, in elements, across x. Defaults to 0.
658 * @param[in] pad_y (Optional) Padding, in elements, across y. Defaults to 0.
659 * @param[in] round (Optional) Dimensions rounding. Defaults to @ref FLOOR.
660 */
661 PadStrideInfo(unsigned int stride_x = 1, unsigned int stride_y = 1,
662 unsigned int pad_x = 0, unsigned int pad_y = 0,
663 DimensionRoundingType round = DimensionRoundingType::FLOOR)
664 : _stride(std::make_pair(stride_x, stride_y)),
Jaroslaw Rzepeckia1ed41f2017-10-13 11:13:58 +0100665 _pad_left(pad_x),
666 _pad_top(pad_y),
667 _pad_right(pad_x),
668 _pad_bottom(pad_y),
669 _round_type(round)
670 {
671 }
672 /** Constructor
673 *
674 * @param[in] stride_x Stride, in elements, across x.
675 * @param[in] stride_y Stride, in elements, across y.
676 * @param[in] pad_left Padding across x on the left, in elements.
677 * @param[in] pad_top Padding across y on the top, in elements.
678 * @param[in] pad_right Padding across x on the right, in elements.
679 * @param[in] pad_bottom Padding across y on the bottom, in elements.
680 * @param[in] round Dimensions rounding.
681 */
682 PadStrideInfo(unsigned int stride_x, unsigned int stride_y,
683 unsigned int pad_left, unsigned int pad_right,
684 unsigned int pad_top, unsigned int pad_bottom,
685 DimensionRoundingType round)
686 : _stride(std::make_pair(stride_x, stride_y)),
687 _pad_left(pad_left),
688 _pad_top(pad_top),
689 _pad_right(pad_right),
690 _pad_bottom(pad_bottom),
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100691 _round_type(round)
692 {
693 }
Alex Gildayc357c472018-03-21 13:54:09 +0000694 /** Get the stride.
695 *
696 * @return a pair: stride x, stride y.
697 */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100698 std::pair<unsigned int, unsigned int> stride() const
699 {
700 return _stride;
701 }
Alex Gildayc357c472018-03-21 13:54:09 +0000702 /** Check whether the padding is symmetric.
703 *
704 * @return True if the padding is symmetric.
705 */
Anthony Barbier21f67d62018-02-16 15:17:48 +0000706 bool padding_is_symmetric() const
707 {
708 return (_pad_left == _pad_right) && (_pad_top == _pad_bottom);
709 }
Alex Gildayc357c472018-03-21 13:54:09 +0000710 /** Get the padding.
711 *
712 * @note This should only be used when the padding is symmetric.
713 *
714 * @return a pair: padding left/right, padding top/bottom
715 */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100716 std::pair<unsigned int, unsigned int> pad() const
717 {
Jaroslaw Rzepeckia1ed41f2017-10-13 11:13:58 +0100718 //this accessor should be used only when padding is symmetric
Anthony Barbier21f67d62018-02-16 15:17:48 +0000719 ARM_COMPUTE_ERROR_ON(!padding_is_symmetric());
Jaroslaw Rzepeckia1ed41f2017-10-13 11:13:58 +0100720 return std::make_pair(_pad_left, _pad_top);
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100721 }
Jaroslaw Rzepeckia1ed41f2017-10-13 11:13:58 +0100722
Alex Gildayc357c472018-03-21 13:54:09 +0000723 /** Get the left padding */
Jaroslaw Rzepeckia1ed41f2017-10-13 11:13:58 +0100724 unsigned int pad_left() const
725 {
726 return _pad_left;
727 }
Alex Gildayc357c472018-03-21 13:54:09 +0000728 /** Get the right padding */
Jaroslaw Rzepeckia1ed41f2017-10-13 11:13:58 +0100729 unsigned int pad_right() const
730 {
731 return _pad_right;
732 }
Alex Gildayc357c472018-03-21 13:54:09 +0000733 /** Get the top padding */
Jaroslaw Rzepeckia1ed41f2017-10-13 11:13:58 +0100734 unsigned int pad_top() const
735 {
736 return _pad_top;
737 }
Alex Gildayc357c472018-03-21 13:54:09 +0000738 /** Get the bottom padding */
Jaroslaw Rzepeckia1ed41f2017-10-13 11:13:58 +0100739 unsigned int pad_bottom() const
740 {
741 return _pad_bottom;
742 }
743
Alex Gildayc357c472018-03-21 13:54:09 +0000744 /** Get the rounding type */
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100745 DimensionRoundingType round() const
746 {
747 return _round_type;
748 }
749
Alex Gildayc357c472018-03-21 13:54:09 +0000750 /** Check whether this has any padding */
Jaroslaw Rzepeckia1ed41f2017-10-13 11:13:58 +0100751 bool has_padding() const
752 {
753 return (_pad_left != 0 || _pad_top != 0 || _pad_right != 0 || _pad_bottom != 0);
754 }
755
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100756private:
757 std::pair<unsigned int, unsigned int> _stride;
Jaroslaw Rzepeckia1ed41f2017-10-13 11:13:58 +0100758 unsigned int _pad_left;
759 unsigned int _pad_top;
760 unsigned int _pad_right;
761 unsigned int _pad_bottom;
762
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100763 DimensionRoundingType _round_type;
764};
765
Michalis Spyrou6c7c38e2018-08-29 16:28:11 +0100766/** PriorBox layer info */
767class PriorBoxLayerInfo final
768{
769public:
770 /** Default Constructor */
771 PriorBoxLayerInfo()
772 : _min_sizes(),
773 _variances(),
774 _offset(),
775 _flip(true),
776 _clip(false),
777 _max_sizes(),
778 _aspect_ratios(),
779 _img_size(),
780 _steps()
781 {
782 }
783 /** Constructor
784 *
785 * @param[in] min_sizes Min sizes vector.
Michalis Spyrou721c4cb2018-09-04 15:27:25 +0100786 * @param[in] variances Variances vector.
Michalis Spyrou6c7c38e2018-08-29 16:28:11 +0100787 * @param[in] offset Offset value.
788 * @param[in] flip (Optional) Flip the aspect ratios.
789 * @param[in] clip (Optional) Clip coordinates so that they're within [0,1].
790 * @param[in] max_sizes (Optional) Max sizes vector.
791 * @param[in] aspect_ratios (Optional) Aspect ratios of the boxes.
792 * @param[in] img_size (Optional) Image size.
793 * @param[in] steps (Optional) Step values.
794 */
795 PriorBoxLayerInfo(const std::vector<float> &min_sizes, const std::vector<float> &variances, float offset, bool flip = true, bool clip = false,
Pablo Tello32521432018-11-15 14:43:10 +0000796 const std::vector<float> &max_sizes = {}, const std::vector<float> &aspect_ratios = {},
797 const Coordinates2D &img_size = Coordinates2D{ 0, 0 }, const std::array<float, 2> &steps = { { 0.f, 0.f } })
Michalis Spyrou6c7c38e2018-08-29 16:28:11 +0100798 : _min_sizes(min_sizes),
799 _variances(variances),
800 _offset(offset),
801 _flip(flip),
802 _clip(clip),
803 _max_sizes(max_sizes),
Michalis Spyrou721c4cb2018-09-04 15:27:25 +0100804 _aspect_ratios(),
Michalis Spyrou6c7c38e2018-08-29 16:28:11 +0100805 _img_size(img_size),
806 _steps(steps)
807 {
808 _aspect_ratios.push_back(1.);
809 for(unsigned int i = 0; i < aspect_ratios.size(); ++i)
810 {
811 float ar = aspect_ratios[i];
812 bool already_exist = false;
813 for(auto ar_new : _aspect_ratios)
814 {
815 if(fabs(ar - ar_new) < 1e-6)
816 {
817 already_exist = true;
818 break;
819 }
820 }
821 if(!already_exist)
822 {
823 _aspect_ratios.push_back(ar);
824 if(flip)
825 {
826 _aspect_ratios.push_back(1.f / ar);
827 }
828 }
829 }
830 }
831 /** Get min sizes. */
832 std::vector<float> min_sizes() const
833 {
834 return _min_sizes;
835 }
836 /** Get min variances. */
837 std::vector<float> variances() const
838 {
839 return _variances;
840 }
841 /** Get the step coordinates */
842 std::array<float, 2> steps() const
843 {
844 return _steps;
845 }
846 /** Get the image size coordinates */
847 Coordinates2D img_size() const
848 {
849 return _img_size;
850 }
851 /** Get the offset */
852 float offset() const
853 {
854 return _offset;
855 }
856 /** Get the flip value */
857 bool flip() const
858 {
859 return _flip;
860 }
861 /** Get the clip value */
862 bool clip() const
863 {
864 return _clip;
865 }
866 /** Get max sizes. */
867 std::vector<float> max_sizes() const
868 {
869 return _max_sizes;
870 }
871 /** Get aspect ratios. */
872 std::vector<float> aspect_ratios() const
873 {
874 return _aspect_ratios;
875 }
876
877private:
878 std::vector<float> _min_sizes;
879 std::vector<float> _variances;
880 float _offset;
881 bool _flip;
882 bool _clip;
883 std::vector<float> _max_sizes;
884 std::vector<float> _aspect_ratios;
885 Coordinates2D _img_size;
886 std::array<float, 2> _steps;
887};
888
Isabella Gottardia7acb3c2019-01-08 13:48:44 +0000889// Bounding Box [xmin, ymin, xmax, ymax]
890using BBox = std::array<float, 4>;
891// LabelBBox used for map label and bounding box
892using LabelBBox = std::map<int, std::vector<BBox>>;
893
Isabella Gottardi05e56442018-11-16 11:26:52 +0000894/** Available Detection Output code types */
895enum class DetectionOutputLayerCodeType
896{
897 CORNER, /**< Use box corners */
898 CENTER_SIZE, /**< Use box centers and size */
899 CORNER_SIZE, /**< Use box centers and size */
900 TF_CENTER /**< Use box centers and size but flip x and y co-ordinates */
901};
902
903/** Detection Output layer info */
904class DetectionOutputLayerInfo final
905{
906public:
907 /** Default Constructor */
908 DetectionOutputLayerInfo()
909 : _num_classes(),
910 _share_location(),
911 _code_type(DetectionOutputLayerCodeType::CORNER),
912 _keep_top_k(),
913 _nms_threshold(),
914 _top_k(),
915 _background_label_id(),
916 _confidence_threshold(),
917 _variance_encoded_in_target(false),
918 _eta(),
919 _num_loc_classes()
920 {
921 _num_loc_classes = _share_location ? 1 : _num_classes;
922 }
923 /** Constructor
924 *
925 * @param[in] num_classes Number of classes to be predicted.
926 * @param[in] share_location If true, bounding box are shared among different classes.
927 * @param[in] code_type Type of coding method for bbox.
928 * @param[in] keep_top_k Number of total bounding boxes to be kept per image after NMS step.
929 * @param[in] nms_threshold Threshold to be used in NMS.
930 * @param[in] top_k (Optional) Number of boxes per image with top confidence scores that are fed into the NMS algorithm. Default set to -1.
931 * @param[in] background_label_id (Optional) Background label ID. If there is no background class, set it as -1.
932 * @param[in] confidence_threshold (Optional) Only consider detections whose confidences are larger than a threshold. Default set to -FLT_MAX.
933 * @param[in] variance_encoded_in_target (Optional) If true, variance is encoded in target. Otherwise we need to adjust the predicted offset accordingly.Default set to false.
934 * @param[in] eta (Optional) Eta.
935 */
936 DetectionOutputLayerInfo(int num_classes, bool share_location, DetectionOutputLayerCodeType code_type, int keep_top_k, float nms_threshold, int top_k = -1, int background_label_id = -1,
937 float confidence_threshold = std::numeric_limits<float>::lowest(), bool variance_encoded_in_target = false, float eta = 1)
938 : _num_classes(num_classes),
939 _share_location(share_location),
940 _code_type(code_type),
941 _keep_top_k(keep_top_k),
942 _nms_threshold(nms_threshold),
943 _top_k(top_k),
944 _background_label_id(background_label_id),
945 _confidence_threshold(confidence_threshold),
946 _variance_encoded_in_target(variance_encoded_in_target),
947 _eta(eta),
948 _num_loc_classes()
949 {
950 _num_loc_classes = _share_location ? 1 : _num_classes;
951 }
952 /** Get num classes. */
953 int num_classes() const
954 {
955 return _num_classes;
956 }
957 /** Get share location. */
958 bool share_location() const
959 {
960 return _share_location;
961 }
962 /** Get detection output code type. */
963 DetectionOutputLayerCodeType code_type() const
964 {
965 return _code_type;
966 }
967 /** Get if variance encoded in target. */
968 bool variance_encoded_in_target() const
969 {
970 return _variance_encoded_in_target;
971 }
972 /** Get the number of total bounding boxes to be kept per image. */
973 int keep_top_k() const
974 {
975 return _keep_top_k;
976 }
977 /** Get nms threshold. */
978 float nms_threshold() const
979 {
980 return _nms_threshold;
981 }
982 /** Get eta. */
983 float eta() const
984 {
985 return _eta;
986 }
987 /** Get background label ID. */
988 int background_label_id() const
989 {
990 return _background_label_id;
991 }
992 /** Get confidence threshold. */
993 float confidence_threshold() const
994 {
995 return _confidence_threshold;
996 }
997 /** Get top K. */
998 int top_k() const
999 {
1000 return _top_k;
1001 }
1002 /** Get number of location classes. */
1003 int num_loc_classes() const
1004 {
1005 return _num_loc_classes;
1006 }
1007
1008private:
1009 int _num_classes;
1010 bool _share_location;
1011 DetectionOutputLayerCodeType _code_type;
1012 int _keep_top_k;
1013 float _nms_threshold;
1014 int _top_k;
1015 int _background_label_id;
1016 float _confidence_threshold;
1017 bool _variance_encoded_in_target;
1018 float _eta;
1019 int _num_loc_classes;
1020};
1021
Isabella Gottardia7acb3c2019-01-08 13:48:44 +00001022/** Detection Output layer info */
1023class DetectionPostProcessLayerInfo final
1024{
1025public:
1026 /** Default Constructor */
1027 DetectionPostProcessLayerInfo()
1028 : _max_detections(),
1029 _max_classes_per_detection(),
1030 _nms_score_threshold(),
1031 _iou_threshold(),
1032 _num_classes(),
1033 _scales_values(),
1034 _use_regular_nms(),
Giuseppe Rossinid9853782019-10-25 11:11:44 +01001035 _detection_per_class(),
1036 _dequantize_scores()
Isabella Gottardia7acb3c2019-01-08 13:48:44 +00001037 {
1038 }
1039 /** Constructor
1040 *
1041 * @param[in] max_detections Number of total detection.
1042 * @param[in] max_classes_per_detection Number of total classes to be kept after NMS step. Used in the Fast Non-Max-Suppression
1043 * @param[in] nms_score_threshold Threshold to be used in NMS
1044 * @param[in] iou_threshold Threshold to be used during the intersection over union.
1045 * @param[in] num_classes Number of classes.
1046 * @param[in] scales_values Scales values used for decode center size boxes.
Giuseppe Rossinid9853782019-10-25 11:11:44 +01001047 * @param[in] use_regular_nms (Optional) Boolean to determinate if use regular or fast nms. Defaults to false.
1048 * @param[in] detection_per_class (Optional) Number of detection per class. Used in the Regular Non-Max-Suppression. Defaults to 100.
1049 * @param[in] dequantize_scores (Optional) If the scores need to be dequantized. Defaults to true.
Isabella Gottardia7acb3c2019-01-08 13:48:44 +00001050 */
1051 DetectionPostProcessLayerInfo(unsigned int max_detections, unsigned int max_classes_per_detection, float nms_score_threshold, float iou_threshold, unsigned int num_classes,
Giuseppe Rossinid9853782019-10-25 11:11:44 +01001052 std::array<float, 4> scales_values, bool use_regular_nms = false, unsigned int detection_per_class = 100, bool dequantize_scores = true)
Isabella Gottardia7acb3c2019-01-08 13:48:44 +00001053 : _max_detections(max_detections),
1054 _max_classes_per_detection(max_classes_per_detection),
1055 _nms_score_threshold(nms_score_threshold),
1056 _iou_threshold(iou_threshold),
1057 _num_classes(num_classes),
1058 _scales_values(scales_values),
1059 _use_regular_nms(use_regular_nms),
Giuseppe Rossinid9853782019-10-25 11:11:44 +01001060 _detection_per_class(detection_per_class),
1061 _dequantize_scores(dequantize_scores)
Isabella Gottardia7acb3c2019-01-08 13:48:44 +00001062 {
1063 }
1064 /** Get max detections. */
1065 unsigned int max_detections() const
1066 {
1067 return _max_detections;
1068 }
1069 /** Get max_classes per detection. Used in the Fast Non-Max-Suppression.*/
1070 unsigned int max_classes_per_detection() const
1071 {
1072 return _max_classes_per_detection;
1073 }
1074 /** Get detection per class. Used in the Regular Non-Max-Suppression */
1075 unsigned int detection_per_class() const
1076 {
1077 return _detection_per_class;
1078 }
1079 /** Get nms threshold. */
1080 float nms_score_threshold() const
1081 {
1082 return _nms_score_threshold;
1083 }
1084 /** Get intersection over union threshold. */
1085 float iou_threshold() const
1086 {
1087 return _iou_threshold;
1088 }
1089 /** Get num classes. */
1090 unsigned int num_classes() const
1091 {
1092 return _num_classes;
1093 }
1094 /** Get if use regular nms. */
1095 bool use_regular_nms() const
1096 {
1097 return _use_regular_nms;
1098 }
1099 /** Get y scale value. */
1100 float scale_value_y() const
1101 {
1102 // Saved as [y,x,h,w]
1103 return _scales_values[0];
1104 }
1105 /** Get x scale value. */
1106 float scale_value_x() const
1107 {
1108 // Saved as [y,x,h,w]
1109 return _scales_values[1];
1110 }
1111 /** Get h scale value. */
1112 float scale_value_h() const
1113 {
1114 // Saved as [y,x,h,w]
1115 return _scales_values[2];
1116 }
1117 /** Get w scale value. */
1118 float scale_value_w() const
1119 {
1120 // Saved as [y,x,h,w]
1121 return _scales_values[3];
1122 }
Giuseppe Rossinid9853782019-10-25 11:11:44 +01001123 /** Get dequantize_scores value. */
1124 bool dequantize_scores() const
1125 {
1126 return _dequantize_scores;
1127 }
Isabella Gottardia7acb3c2019-01-08 13:48:44 +00001128
1129private:
1130 unsigned int _max_detections;
1131 unsigned int _max_classes_per_detection;
1132 float _nms_score_threshold;
1133 float _iou_threshold;
1134 unsigned int _num_classes;
1135 std::array<float, 4> _scales_values;
1136 bool _use_regular_nms;
1137 unsigned int _detection_per_class;
Giuseppe Rossinid9853782019-10-25 11:11:44 +01001138 bool _dequantize_scores;
Isabella Gottardia7acb3c2019-01-08 13:48:44 +00001139};
1140
Sang-Hoon Park0cb3da62020-01-15 12:39:56 +00001141/** Pooling Layer Information struct*/
1142struct PoolingLayerInfo
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001143{
Georgios Pinitas4c2dd542017-11-13 12:58:41 +00001144 /** Default Constructor */
1145 PoolingLayerInfo()
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001146 : pool_type(PoolingType::MAX),
1147 pool_size(Size2D()),
1148 data_layout(DataLayout::UNKNOWN),
1149 pad_stride_info(PadStrideInfo()),
1150 exclude_padding(false),
1151 is_global_pooling(false),
1152 fp_mixed_precision(false)
Georgios Pinitas4c2dd542017-11-13 12:58:41 +00001153 {
1154 }
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001155 /** Constructor
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001156 *
Sang-Hoon Park2aa7fd02019-09-18 13:39:00 +01001157 * @param[in] pool_type Pooling type @ref PoolingType.
1158 * @param[in] pool_size Pooling size, in elements, across x and y.
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001159 * @param[in] data_layout Data layout used by the layer @ref DataLayout
1160 * @param[in] pad_stride_info (Optional) Padding and stride information @ref PadStrideInfo
1161 * @param[in] exclude_padding (Optional) Strategy when accounting padding in calculations.
1162 * True will exclude padding while false will not (Used in AVG/L2 pooling to determine the pooling area).
1163 * Defaults to false;
1164 * @param[in] fp_mixed_precision (Optional) Use wider accumulators (32 bit instead of 16 for FP16) to improve accuracy.
1165 */
Georgios Pinitas4c2dd542017-11-13 12:58:41 +00001166 explicit PoolingLayerInfo(PoolingType pool_type,
1167 unsigned int pool_size,
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001168 DataLayout data_layout,
Sang-Hoon Park2aa7fd02019-09-18 13:39:00 +01001169 PadStrideInfo pad_stride_info = PadStrideInfo(),
1170 bool exclude_padding = false,
1171 bool fp_mixed_precision = false)
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001172 : pool_type(pool_type),
1173 pool_size(Size2D(pool_size, pool_size)),
1174 data_layout(data_layout),
1175 pad_stride_info(pad_stride_info),
1176 exclude_padding(exclude_padding),
1177 is_global_pooling(false),
1178 fp_mixed_precision(fp_mixed_precision)
Isabella Gottardi6e464c32018-01-26 12:32:45 +00001179 {
1180 }
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001181
1182 /** Constructor
Isabella Gottardi6e464c32018-01-26 12:32:45 +00001183 *
Sang-Hoon Park2aa7fd02019-09-18 13:39:00 +01001184 * @param[in] pool_type Pooling type @ref PoolingType.
1185 * @param[in] pool_size Pooling size, in elements, across x and y.
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001186 * @param[in] data_layout Data layout used by the layer @ref DataLayout
Sang-Hoon Park2aa7fd02019-09-18 13:39:00 +01001187 * @param[in] pad_stride_info (Optional) Padding and stride information @ref PadStrideInfo
1188 * @param[in] exclude_padding (Optional) Strategy when accounting padding in calculations.
1189 * True will exclude padding while false will not (Used in AVG/L2 pooling to determine the pooling area).
1190 * Defaults to false;
1191 * @param[in] fp_mixed_precision (Optional) Use wider accumulators (32 bit instead of 16 for FP16) to improve accuracy.
Isabella Gottardi6e464c32018-01-26 12:32:45 +00001192 */
1193 explicit PoolingLayerInfo(PoolingType pool_type,
1194 Size2D pool_size,
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001195 DataLayout data_layout,
Sang-Hoon Park2aa7fd02019-09-18 13:39:00 +01001196 PadStrideInfo pad_stride_info = PadStrideInfo(),
1197 bool exclude_padding = false,
1198 bool fp_mixed_precision = false)
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001199 : pool_type(pool_type),
1200 pool_size(pool_size),
1201 data_layout(data_layout),
1202 pad_stride_info(pad_stride_info),
1203 exclude_padding(exclude_padding),
1204 is_global_pooling(false),
1205 fp_mixed_precision(fp_mixed_precision)
Georgios Pinitas4c2dd542017-11-13 12:58:41 +00001206 {
1207 }
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001208
1209 /** Constructor
Georgios Pinitas4c2dd542017-11-13 12:58:41 +00001210 *
1211 * @note This constructor is used for global pooling
1212 *
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001213 * @param[in] pool_type Pooling type @ref PoolingType.
1214 * @param[in] data_layout Data layout used by the layer @ref DataLayout
Georgios Pinitas4c2dd542017-11-13 12:58:41 +00001215 */
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001216 explicit PoolingLayerInfo(PoolingType pool_type, DataLayout data_layout)
1217 : pool_type(pool_type),
1218 pool_size(Size2D()),
1219 data_layout(data_layout),
1220 pad_stride_info(PadStrideInfo(1, 1, 0, 0)),
1221 exclude_padding(false),
1222 is_global_pooling(true),
1223 fp_mixed_precision(false)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001224 {
1225 }
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001226
Sang-Hoon Park0cb3da62020-01-15 12:39:56 +00001227 PoolingType pool_type;
1228 Size2D pool_size;
Sang-Hoon Park11fedda2020-01-15 14:44:04 +00001229 DataLayout data_layout;
Sang-Hoon Park0cb3da62020-01-15 12:39:56 +00001230 PadStrideInfo pad_stride_info;
1231 bool exclude_padding;
1232 bool is_global_pooling;
1233 bool fp_mixed_precision;
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001234};
1235
Georgios Pinitas7b7858d2017-06-21 16:44:24 +01001236/** ROI Pooling Layer Information class */
giuros0118870812018-09-13 09:31:40 +01001237class ROIPoolingLayerInfo final
Georgios Pinitas7b7858d2017-06-21 16:44:24 +01001238{
1239public:
giuros0118870812018-09-13 09:31:40 +01001240 /** Constructor
Georgios Pinitas7b7858d2017-06-21 16:44:24 +01001241 *
giuros0118870812018-09-13 09:31:40 +01001242 * @param[in] pooled_width Pooled width of the layer.
1243 * @param[in] pooled_height Pooled height of the layer.
1244 * @param[in] spatial_scale Spatial scale to be applied to the ROI coordinates and dimensions.
1245 * @param[in] sampling_ratio Number of samples to include in each pooling region (if set to zero, a ceil(roi_dims/pooling_dims))
Georgios Pinitas7b7858d2017-06-21 16:44:24 +01001246 */
giuros0118870812018-09-13 09:31:40 +01001247 ROIPoolingLayerInfo(unsigned int pooled_width, unsigned int pooled_height, float spatial_scale, unsigned int sampling_ratio = 0)
1248 : _pooled_width(pooled_width), _pooled_height(pooled_height), _spatial_scale(spatial_scale), _sampling_ratio(sampling_ratio)
Georgios Pinitas7b7858d2017-06-21 16:44:24 +01001249 {
1250 }
Alex Gildayc357c472018-03-21 13:54:09 +00001251 /** Get the pooled width of the layer */
Georgios Pinitas7b7858d2017-06-21 16:44:24 +01001252 unsigned int pooled_width() const
1253 {
1254 return _pooled_width;
1255 }
Alex Gildayc357c472018-03-21 13:54:09 +00001256 /** Get the pooled height of the layer */
Georgios Pinitas7b7858d2017-06-21 16:44:24 +01001257 unsigned int pooled_height() const
1258 {
1259 return _pooled_height;
1260 }
Alex Gildayc357c472018-03-21 13:54:09 +00001261 /** Get the spatial scale */
Georgios Pinitas7b7858d2017-06-21 16:44:24 +01001262 float spatial_scale() const
1263 {
1264 return _spatial_scale;
1265 }
giuros0118870812018-09-13 09:31:40 +01001266 /** Get sampling ratio */
1267 unsigned int sampling_ratio() const
1268 {
1269 return _sampling_ratio;
1270 }
Georgios Pinitas7b7858d2017-06-21 16:44:24 +01001271
1272private:
1273 unsigned int _pooled_width;
1274 unsigned int _pooled_height;
1275 float _spatial_scale;
giuros0118870812018-09-13 09:31:40 +01001276 unsigned int _sampling_ratio;
Georgios Pinitas7b7858d2017-06-21 16:44:24 +01001277};
1278
Manuel Bottini5209be52019-02-13 16:34:56 +00001279/** Generate Proposals Information class */
1280class GenerateProposalsInfo
1281{
1282public:
1283 /** Constructor
1284 *
1285 * @param[in] im_width Width of the original image
1286 * @param[in] im_height Height of the original image
1287 * @param[in] im_scale Scale applied to the original image
1288 * @param[in] spatial_scale (Optional)Scale applied to the feature map. Defaults to 1.0
1289 * @param[in] pre_nms_topN (Optional)Number of the best scores to be selected from the transformations. Defaults to 6000.
1290 * @param[in] post_nms_topN (Optional)Number of the best scores to be selected from the NMS operation. Defaults to 300.
1291 * @param[in] nms_thres (Optional)NMS overlap threshold. Defaults to 0.7.
1292 * @param[in] min_size (Optional)Size used to validate the anchors produced. Defaults to 16.
1293 * @param[in] values_per_roi (Optional)Values used to represent a ROI(Region of interest). Defaults to 4.
1294 */
1295 GenerateProposalsInfo(float im_width, float im_height, float im_scale, float spatial_scale = 1.0, int pre_nms_topN = 6000, int post_nms_topN = 300, float nms_thres = 0.7, float min_size = 16.0,
1296 size_t values_per_roi = 4)
1297 : _im_height(im_height), _im_width(im_width), _im_scale(im_scale), _spatial_scale(spatial_scale), _pre_nms_topN(pre_nms_topN), _post_nms_topN(post_nms_topN), _nms_thres(nms_thres),
1298 _min_size(min_size), _values_per_roi(values_per_roi)
1299 {
1300 }
1301
1302 /* Get the original height */
1303 float im_height() const
1304 {
1305 return _im_height;
1306 }
1307 /* Get the original width */
1308 float im_width() const
1309 {
1310 return _im_width;
1311 }
1312 /* Get the image scale */
1313 float im_scale() const
1314 {
1315 return _im_scale;
1316 }
1317 /* Get the value of how many best scores to select (before NMS) */
1318 int pre_nms_topN() const
1319 {
1320 return _pre_nms_topN;
1321 }
1322 /* Get the value of how many best scores to select (after NMS) */
1323 int post_nms_topN() const
1324 {
1325 return _post_nms_topN;
1326 }
1327 /* Get the NMS overlap threshold */
1328 float nms_thres() const
1329 {
1330 return _nms_thres;
1331 }
1332 /* Get the minimal size */
1333 float min_size() const
1334 {
1335 return _min_size;
1336 }
1337 /* Get the spatial scale to be applied to the feature maps */
1338 float spatial_scale() const
1339 {
1340 return _spatial_scale;
1341 }
1342 /* Get the values used to represent a ROI(Region of interest)*/
1343 size_t values_per_roi() const
1344 {
1345 return _values_per_roi;
1346 }
1347
1348private:
1349 float _im_height;
1350 float _im_width;
1351 float _im_scale;
1352 float _spatial_scale;
1353 int _pre_nms_topN;
1354 int _post_nms_topN;
1355 float _nms_thres;
1356 float _min_size;
1357 size_t _values_per_roi;
1358};
1359
1360/** ComputeAnchors information class */
1361class ComputeAnchorsInfo
1362{
1363public:
1364 /** Constructor
1365 *
1366 * @param[in] feat_width Feature map width
1367 * @param[in] feat_height Feature map height
1368 * @param[in] spatial_scale Feature map scale
1369 * @param[in] values_per_roi (Optional)Values used to represent a ROI(Region Of Interest). Defaults to 4
1370 */
1371 ComputeAnchorsInfo(float feat_width, float feat_height, float spatial_scale, size_t values_per_roi = 4)
1372 : _feat_height(feat_height),
1373 _feat_width(feat_width),
1374 _spatial_scale(spatial_scale),
1375 _values_per_roi(values_per_roi)
1376 {
1377 }
1378
1379 /* Get the height of the feature map */
1380 float feat_height() const
1381 {
1382 return _feat_height;
1383 }
1384
1385 /* Get the width of the feature map */
1386 float feat_width() const
1387 {
1388 return _feat_width;
1389 }
1390
1391 /* Get the scale of the feature map */
1392 float spatial_scale() const
1393 {
1394 return _spatial_scale;
1395 }
1396
1397 /* Get the values used to represent a ROI(Region Of Interest)*/
1398 size_t values_per_roi() const
1399 {
1400 return _values_per_roi;
1401 }
1402
1403private:
1404 float _feat_height;
1405 float _feat_width;
1406 float _spatial_scale;
1407 size_t _values_per_roi;
1408};
1409
giuros01c04a0e82018-10-03 12:44:35 +01001410/** Bounding Box Transform information class */
giuros01d696cb62018-11-16 10:39:59 +00001411class BoundingBoxTransformInfo final
giuros01c04a0e82018-10-03 12:44:35 +01001412{
1413public:
1414 /** Constructor
1415 *
giuros01d696cb62018-11-16 10:39:59 +00001416 * @param[in] img_width Width of the original image
1417 * @param[in] img_height Height, of the original image
1418 * @param[in] scale Scale of the original image
1419 * @param[in] apply_scale (Optional)Re-apply scaling after transforming the boxes. Defaults to false
1420 * @param[in] weights (Optional)Weights [wx, wy, ww, wh] for the deltas. Defaults to all ones
1421 * @param[in] correct_transform_coords (Optional)Correct bounding box transform coordinates. Defaults to false
1422 * @param[in] bbox_xform_clip (Optional)Minimum bounding box width and height after bounding box transformation in log-space. Defaults to log(1000/16)
giuros01c04a0e82018-10-03 12:44:35 +01001423 */
giuros01d696cb62018-11-16 10:39:59 +00001424 BoundingBoxTransformInfo(float img_width, float img_height, float scale, bool apply_scale = false, const std::array<float, 4> weights = { { 1.f, 1.f, 1.f, 1.f } }, bool correct_transform_coords =
1425 false,
1426 float bbox_xform_clip =
1427 4.135166556742356f)
1428 : _img_width(img_width), _img_height(img_height), _scale(scale), _apply_scale(apply_scale), _correct_transform_coords(correct_transform_coords), _weights(weights), _bbox_xform_clip(bbox_xform_clip)
giuros01c04a0e82018-10-03 12:44:35 +01001429 {
1430 }
1431
1432 std::array<float, 4> weights() const
1433 {
1434 return _weights;
1435 }
1436
1437 float bbox_xform_clip() const
1438 {
1439 return _bbox_xform_clip;
1440 }
1441
1442 float img_height() const
1443 {
1444 return _img_height;
1445 }
1446
1447 float img_width() const
1448 {
1449 return _img_width;
1450 }
1451
1452 float scale() const
1453 {
1454 return _scale;
1455 }
1456
1457 bool apply_scale() const
1458 {
1459 return _apply_scale;
1460 }
1461
giuros01d696cb62018-11-16 10:39:59 +00001462 bool correct_transform_coords() const
1463 {
1464 return _correct_transform_coords;
1465 }
1466
giuros01c04a0e82018-10-03 12:44:35 +01001467private:
1468 float _img_width;
1469 float _img_height;
1470 float _scale;
1471 bool _apply_scale;
giuros01d696cb62018-11-16 10:39:59 +00001472 bool _correct_transform_coords;
giuros01c04a0e82018-10-03 12:44:35 +01001473 std::array<float, 4> _weights;
1474 float _bbox_xform_clip;
1475};
1476
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001477/** Activation Layer Information class */
1478class ActivationLayerInfo
1479{
1480public:
1481 /** Available activation functions */
1482 enum class ActivationFunction
1483 {
Georgios Pinitas64ebe5b2017-09-01 17:44:24 +01001484 LOGISTIC, /**< Logistic ( \f$ f(x) = \frac{1}{1 + e^{-x}} \f$ ) */
1485 TANH, /**< Hyperbolic tangent ( \f$ f(x) = a \cdot tanh(b \cdot x) \f$ ) */
1486 RELU, /**< Rectifier ( \f$ f(x) = max(0,x) \f$ ) */
1487 BOUNDED_RELU, /**< Upper Bounded Rectifier ( \f$ f(x) = min(a, max(0,x)) \f$ ) */
1488 LU_BOUNDED_RELU, /**< Lower and Upper Bounded Rectifier ( \f$ f(x) = min(a, max(b,x)) \f$ ) */
Manuel Bottini581c8982019-02-07 10:31:57 +00001489 LEAKY_RELU, /**< Leaky Rectifier ( \f$ f(x) = \begin{cases} \alpha x & \quad \text{if } x \text{ < 0}\\ x & \quad \text{if } x \geq \text{ 0 } \end{cases} \f$ ) */
Georgios Pinitas64ebe5b2017-09-01 17:44:24 +01001490 SOFT_RELU, /**< Soft Rectifier ( \f$ f(x)= log(1+e^x) \f$ ) */
Georgios Pinitasfb0fdcd2019-08-22 17:10:04 +01001491 ELU, /**< Exponential Linear Unit ( \f$ f(x) = \begin{cases} \alpha (exp(x) - 1) & \quad \text{if } x \text{ < 0}\\ x & \quad \text{if } x \geq \text{ 0 } \end{cases} \f$ ) */
Georgios Pinitas64ebe5b2017-09-01 17:44:24 +01001492 ABS, /**< Absolute ( \f$ f(x)= |x| \f$ ) */
1493 SQUARE, /**< Square ( \f$ f(x)= x^2 \f$ )*/
1494 SQRT, /**< Square root ( \f$ f(x) = \sqrt{x} \f$ )*/
Usama Arif6a98a6e2019-05-10 17:07:27 +01001495 LINEAR, /**< Linear ( \f$ f(x)= ax + b \f$ ) */
morgolock07df3d42020-02-27 11:46:28 +00001496 IDENTITY, /**< Identity ( \f$ f(x)= x \f$ ) */
1497 HARD_SWISH /**< Hard-swish ( \f$ f(x) = (x * relu6(x+3))/6 \f$ ) */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001498 };
1499
Giorgio Arena11674872018-02-07 15:38:12 +00001500 ActivationLayerInfo() = default;
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001501 /** Default Constructor
1502 *
1503 * @param[in] f The activation function to use.
1504 * @param[in] a (Optional) The alpha parameter used by some activation functions
Georgios Pinitas64ebe5b2017-09-01 17:44:24 +01001505 * (@ref ActivationFunction::BOUNDED_RELU, @ref ActivationFunction::LU_BOUNDED_RELU, @ref ActivationFunction::LINEAR, @ref ActivationFunction::TANH).
1506 * @param[in] b (Optional) The beta parameter used by some activation functions (@ref ActivationFunction::LINEAR, @ref ActivationFunction::LU_BOUNDED_RELU, @ref ActivationFunction::TANH).
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001507 */
1508 ActivationLayerInfo(ActivationFunction f, float a = 0.0f, float b = 0.0f)
Giorgio Arena11674872018-02-07 15:38:12 +00001509 : _act(f), _a(a), _b(b), _enabled(true)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001510 {
1511 }
Alex Gildayc357c472018-03-21 13:54:09 +00001512 /** Get the type of activation function */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001513 ActivationFunction activation() const
1514 {
1515 return _act;
1516 }
Alex Gildayc357c472018-03-21 13:54:09 +00001517 /** Get the alpha value */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001518 float a() const
1519 {
1520 return _a;
1521 }
Alex Gildayc357c472018-03-21 13:54:09 +00001522 /** Get the beta value */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001523 float b() const
1524 {
1525 return _b;
1526 }
Alex Gildayc357c472018-03-21 13:54:09 +00001527 /** Check if initialised */
Giorgio Arena11674872018-02-07 15:38:12 +00001528 bool enabled() const
1529 {
1530 return _enabled;
1531 }
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001532
1533private:
Usama Arif6a98a6e2019-05-10 17:07:27 +01001534 ActivationFunction _act = { ActivationLayerInfo::ActivationFunction::IDENTITY };
Giorgio Arena11674872018-02-07 15:38:12 +00001535 float _a = {};
1536 float _b = {};
1537 bool _enabled = { false };
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001538};
1539
Giorgio Arena1856ff72020-02-07 13:46:45 +00001540/** Fully connected layer info */
1541struct FullyConnectedLayerInfo
1542{
1543 DataLayout weights_trained_layout{ DataLayout::NCHW }; /**< Layout that the weights have been trained with. */
1544 bool transpose_weights{ true }; /**< Transpose weights if true. */
1545 bool are_weights_reshaped{ false }; /**< Reshape the weights tensor if false. */
1546 bool retain_internal_weights{ false }; /**< Retain internal reshaped weights. */
1547 bool fp_mixed_precision{ false }; /**< Use wider accumulators (32 bit instead of 16 for FP16) to improve accuracy. */
1548 ActivationLayerInfo activation_info{}; /**< Fused activation to apply after the matrix multiplication. */
1549
1550 /** Sets the weights trained data layout
1551 *
1552 * @param[in] layout Data layout that the weights were trained with
1553 *
1554 * @return Updated object
1555 */
1556 FullyConnectedLayerInfo &set_weights_trained_layout(DataLayout layout)
1557 {
1558 weights_trained_layout = layout;
1559 return *this;
1560 }
1561 /** Sets the transpose weights flag
1562 *
1563 * @param[in] should_transpose_weights Boolean flag indicating if weights should be transposed
1564 *
1565 * @return Updated object
1566 */
1567 FullyConnectedLayerInfo &set_transpose_weights(bool should_transpose_weights)
1568 {
1569 transpose_weights = should_transpose_weights;
1570 return *this;
1571 }
1572};
1573
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001574/** Normalization Layer Information class */
1575class NormalizationLayerInfo
1576{
1577public:
1578 /** Default Constructor
1579 *
Michele Di Giorgio9d3a8312018-11-20 12:31:24 +00001580 * @param[in] type The normalization type. Can be @ref NormType::IN_MAP_1D, @ref NormType::IN_MAP_2D or @ref NormType::CROSS_MAP
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001581 * @param[in] norm_size The normalization size is the number of elements to normalize across. Defaults to 5.
Georgios Pinitas41caa622017-11-16 14:37:08 +00001582 * @param[in] alpha (Optional) Alpha parameter used by normalization equation. Defaults to 0.0001.
1583 * @param[in] beta (Optional) Beta parameter used by normalization equation. Defaults to 0.5.
1584 * @param[in] kappa (Optional) Kappa parameter used by [Krichevksy 2012] Across Channel Local Brightness Normalization equation.
1585 * @param[in] is_scaled (Optional) Boolean that specifies if alpha will be scaled by the normalization size or not.
1586 * Should be false to follow [Krichevksy 2012].
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001587 */
Georgios Pinitas41caa622017-11-16 14:37:08 +00001588 NormalizationLayerInfo(NormType type, uint32_t norm_size = 5, float alpha = 0.0001f, float beta = 0.5f, float kappa = 1.f, bool is_scaled = true)
1589 : _type(type), _norm_size(norm_size), _alpha(alpha), _beta(beta), _kappa(kappa), _is_scaled(is_scaled)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001590 {
1591 }
Alex Gildayc357c472018-03-21 13:54:09 +00001592 /** Get the normalization type */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001593 NormType type() const
1594 {
1595 return _type;
1596 }
Alex Gildayc357c472018-03-21 13:54:09 +00001597 /** Get the normalization size */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001598 uint32_t norm_size() const
1599 {
1600 return _norm_size;
1601 }
Alex Gildayc357c472018-03-21 13:54:09 +00001602 /** Get the alpha value */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001603 float alpha() const
1604 {
1605 return _alpha;
1606 }
Alex Gildayc357c472018-03-21 13:54:09 +00001607 /** Get the beta value */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001608 float beta() const
1609 {
1610 return _beta;
1611 }
Alex Gildayc357c472018-03-21 13:54:09 +00001612 /** Get the kappa value */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001613 float kappa() const
1614 {
1615 return _kappa;
1616 }
Michele Di Giorgio9d3a8312018-11-20 12:31:24 +00001617 /** Get the is_scaled value */
1618 bool is_scaled() const
1619 {
1620 return _is_scaled;
1621 }
Alex Gildayc357c472018-03-21 13:54:09 +00001622 /** Check if normalization is cross map */
Georgios Pinitas41caa622017-11-16 14:37:08 +00001623 bool is_cross_map() const
1624 {
1625 return _type == NormType::CROSS_MAP;
1626 }
Alex Gildayc357c472018-03-21 13:54:09 +00001627 /** Check if normalization is not cross map */
Georgios Pinitas41caa622017-11-16 14:37:08 +00001628 bool is_in_map() const
1629 {
1630 return !is_cross_map();
1631 }
1632 /** Return the scaling factor of the normalization function.
1633 *
1634 * If is_scaled is set to false then [Krichevksy 2012] normalization scaling is performed,
1635 * where alpha is returned plainly, else alpha is scaled by the total number of elements used for the normalization.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001636 *
1637 * @return The normalization scaling factor.
1638 */
1639 float scale_coeff() const
1640 {
1641 const uint32_t size = (_type == NormType::IN_MAP_2D) ? _norm_size * _norm_size : _norm_size;
Georgios Pinitas41caa622017-11-16 14:37:08 +00001642 return (_is_scaled) ? (_alpha / size) : _alpha;
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001643 }
1644
1645private:
1646 NormType _type;
1647 uint32_t _norm_size;
1648 float _alpha;
1649 float _beta;
1650 float _kappa;
Georgios Pinitas41caa622017-11-16 14:37:08 +00001651 bool _is_scaled;
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001652};
1653
thecha012bfadd92020-08-12 17:25:51 +01001654class StridedSliceLayerInfo
1655{
1656public:
1657 /** Default Constructor
1658 *
1659 * @param[in] begin_mask (Optional) If the ith bit of begin_mask is set, starts[i] is ignored and the fullest possible range in that dimension is used instead.
1660 * @param[in] end_mask (Optional) If the ith bit of end_mask is set, ends[i] is ignored and the fullest possible range in that dimension is used instead.
1661 * @param[in] shrink_axis_mask (Optional) If the ith bit of shrink_axis_mask is set, it implies that the ith specification shrinks the dimensionality by 1.
1662 */
1663 StridedSliceLayerInfo(int32_t begin_mask = 0, int32_t end_mask = 0, int32_t shrink_axis_mask = 0)
1664 : _begin_mask(begin_mask), _end_mask(end_mask), _shrink_axis_mask(shrink_axis_mask)
1665 {
1666 }
1667
1668 /* Get the begin mask value */
1669 int32_t begin_mask() const
1670 {
1671 return _begin_mask;
1672 }
1673
1674 /* Get the end mask value */
1675 int32_t end_mask() const
1676 {
1677 return _end_mask;
1678 }
1679
1680 /* Get the shrink axis mask value */
1681 int32_t shrink_axis_mask() const
1682 {
1683 return _shrink_axis_mask;
1684 }
1685
1686private:
1687 int32_t _begin_mask;
1688 int32_t _end_mask;
1689 int32_t _shrink_axis_mask;
1690};
1691
Gian Marco Iodice559d7712017-08-08 08:38:09 +01001692/** Convolution Layer Weights Information class. This class stores the necessary information to compute convolution layer when the weights are already reshaped */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001693class WeightsInfo
1694{
1695public:
Gian Marco Iodice4e288692017-06-27 11:41:59 +01001696 /** Default constructor */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001697 WeightsInfo()
Michele Di Giorgiob62280a2018-05-31 17:31:05 +01001698 : _are_reshaped(false), _kernel_width(0), _kernel_height(0), _num_kernels(0), _retain_internal_weights(false)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001699 {
1700 }
1701 /** Constructor
1702 *
Michele Di Giorgiob62280a2018-05-31 17:31:05 +01001703 * @param[in] are_reshaped True if the weights have been reshaped
1704 * @param[in] kernel_width Kernel width.
1705 * @param[in] kernel_height Kernel height.
1706 * @param[in] num_kernels Number of convolution kernels.
1707 * @param[in] retain_internal_weights (Optional) True if internal reshaped weights must be retained. Used for reconfiguration purposes. Default is false.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001708 */
Michele Di Giorgiob62280a2018-05-31 17:31:05 +01001709 WeightsInfo(bool are_reshaped, unsigned int kernel_width, unsigned int kernel_height, unsigned int num_kernels, bool retain_internal_weights = false)
1710 : _are_reshaped(are_reshaped), _kernel_width(kernel_width), _kernel_height(kernel_height), _num_kernels(num_kernels), _retain_internal_weights(retain_internal_weights)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001711 {
1712 }
Gian Marco Iodice4e288692017-06-27 11:41:59 +01001713 /** Flag which specifies if the weights tensor has been reshaped.
1714 *
1715 * @return True if the weights tensors has been reshaped
1716 */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001717 bool are_reshaped() const
1718 {
1719 return _are_reshaped;
1720 };
Gian Marco Iodice559d7712017-08-08 08:38:09 +01001721 /** Return the number of convolution kernels
1722 *
1723 * @return The number of convolution kernels
1724 */
1725 unsigned int num_kernels() const
1726 {
1727 return _num_kernels;
1728 };
Gian Marco Iodice4e288692017-06-27 11:41:59 +01001729 /** Return the width and height of the kernel
1730 *
1731 * @return The width and height of the kernel
1732 */
1733 std::pair<unsigned int, unsigned int> kernel_size() const
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001734 {
Gian Marco Iodice4e288692017-06-27 11:41:59 +01001735 return std::make_pair(_kernel_width, _kernel_height);
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001736 }
Michele Di Giorgiob62280a2018-05-31 17:31:05 +01001737 bool retain_internal_weights() const
1738 {
1739 return _retain_internal_weights;
1740 }
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001741
1742private:
SiCong Liebd8fb42020-08-18 11:03:14 +01001743 bool _are_reshaped;
1744 unsigned int _kernel_width;
1745 unsigned int _kernel_height;
1746 unsigned int _num_kernels;
1747 bool _retain_internal_weights;
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001748};
1749
Gian Marco36a0a462018-01-12 10:21:40 +00001750/** GEMM reshape information class. This class stores the necessary information about matrix A and matrix B reshape.
1751 *
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00001752 * The matrix A can only be reshaped through @ref CLGEMMReshapeLHSMatrixKernel or @ref NEGEMMInterleave4x4Kernel
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001753 * Note: Optionally just for @ref CLGEMMReshapeLHSMatrixKernel is it possible to set mult_interleave4x4_height, the multiplication factor for the height of the 4x4 interleaved block
Gian Marco36a0a462018-01-12 10:21:40 +00001754 *
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00001755 * The matrix B can only be reshaped through @ref CLGEMMReshapeRHSMatrixKernel or @ref NEGEMMTranspose1xWKernel
giuros018b6b4a92018-12-18 19:01:33 +00001756 * Note: Optionally just for @ref CLGEMMReshapeRHSMatrixKernel is it possible to set mult_transpose1xW_width, the multiplication factor for the width of the 1xW transposed block
Gian Marco36a0a462018-01-12 10:21:40 +00001757 *
1758 */
1759class GEMMReshapeInfo final
1760{
1761public:
1762 /** Default constructor */
1763 GEMMReshapeInfo()
Georgios Pinitasb0f342e2019-05-21 13:32:43 +01001764 : _m(1), _n(1), _k(1), _mult_transpose1xW_width(1), _mult_interleave4x4_height(1), _depth_output_gemm3d(0), _reinterpret_input_as_3d(false), _broadcast_bias(false)
Gian Marco36a0a462018-01-12 10:21:40 +00001765 {
1766 }
1767 /** Constructor
1768 *
1769 * @param[in] m Number of matrix A rows
1770 * @param[in] n Number of matrix B columns
1771 * @param[in] k Number of matrix A columns or matrix B rows
1772 * @param[in] mult_transpose1xW_width (Optional) Multiplication factor for the width of the 1xW transposed block
1773 * @param[in] mult_interleave4x4_height (Optional) Multiplication factor for the height of the 4x4 interleaved block
Gian Marco Iodice3139f032018-11-05 14:26:32 +00001774 * @param[in] depth_output_gemm3d (Optional) Depth (third dimension) of the output tensor to be used with the GEMM3D kernel.
1775 * If 0 the output will not be reinterpreted as 3D. Default 0
Gian Marco Iodice68a3f562018-07-26 11:44:03 +01001776 * @param[in] reinterpret_input_as_3d (Optional) Reinterpret the input as 3D tensor. (i.e. this flag should be set to true when GEMM is used
Georgios Pinitasb0f342e2019-05-21 13:32:43 +01001777 * to perform 1x1 convolutions with the NHWC data layout)
1778 * @param[in] broadcast_bias (Optional) Broadcast the shape of the bias tensor from a vector to a matrix.
Gian Marco36a0a462018-01-12 10:21:40 +00001779 */
Georgios Pinitasb0f342e2019-05-21 13:32:43 +01001780 GEMMReshapeInfo(int m, int n, int k, int mult_transpose1xW_width = 1, int mult_interleave4x4_height = 1, int depth_output_gemm3d = 0, bool reinterpret_input_as_3d = false, bool broadcast_bias = false)
Gian Marco Iodice68a3f562018-07-26 11:44:03 +01001781 : _m(m), _n(n), _k(k), _mult_transpose1xW_width(mult_transpose1xW_width), _mult_interleave4x4_height(mult_interleave4x4_height), _depth_output_gemm3d(depth_output_gemm3d),
Georgios Pinitasb0f342e2019-05-21 13:32:43 +01001782 _reinterpret_input_as_3d(reinterpret_input_as_3d), _broadcast_bias(broadcast_bias)
Gian Marco36a0a462018-01-12 10:21:40 +00001783 {
1784 }
1785 /** Number of matrix A rows
1786 *
1787 * @return the number of matrix A rows
1788 */
1789 int m() const
1790 {
1791 return _m;
1792 }
1793 /** Number of matrix B columns
1794 *
1795 * @return the number of matrix B columns
1796 */
1797 int n() const
1798 {
1799 return _n;
1800 }
1801 /** Number of matrix A columns or matrix B rows
1802 *
1803 * @return the number of matrix A columns or matrix B rows
1804 */
1805 int k() const
1806 {
1807 return _k;
1808 }
1809 /** Multiplication factor for the width of the 1xW transposed block
1810 *
1811 * @return the multiplication factor for the width of the 1xW transposed block
1812 */
1813 int mult_transpose1xW_width() const
1814 {
1815 return _mult_transpose1xW_width;
1816 }
1817 /** Multiplication factor for the height of the 4x4 interleaved block
1818 *
1819 * @return the multiplication factor for the height of the 4x4 interleaved block
1820 */
1821 int mult_interleave4x4_height() const
1822 {
1823 return _mult_interleave4x4_height;
1824 }
Isabella Gottardi8e74f442018-03-01 16:42:00 +00001825 /** Depth (third dimension) of the output tensor to be used with the GEMM3D kernel
1826 *
1827 * @note GEMM3D kernel is used when the output has to be reinterpret as 3D tensor. In that case:
1828 * m = depth_output_gemm3d * output_height
1829 *
1830 * @return the depth of the output tensor to be used with the GEMM3D kernel
1831 */
1832 int depth_output_gemm3d() const
1833 {
1834 return _depth_output_gemm3d;
1835 }
Gian Marco Iodice68a3f562018-07-26 11:44:03 +01001836 /** Flag which specifies if the input tensor has to be reinterpreted as 3D
1837 *
1838 * @return True if the input tensor has to be reinterpreted as 3D tensor
1839 */
1840 bool reinterpret_input_as_3d() const
1841 {
1842 return _reinterpret_input_as_3d;
1843 };
Georgios Pinitasb0f342e2019-05-21 13:32:43 +01001844 /** Flag which specifies whether to broadcast the shape of the bias tensor.
1845 *
1846 * @return True if the shape of the bias tensor is to be broadcasted.
1847 */
1848 bool broadcast_bias() const
1849 {
1850 return _broadcast_bias;
1851 };
Gian Marco36a0a462018-01-12 10:21:40 +00001852
1853private:
SiCong Liebd8fb42020-08-18 11:03:14 +01001854 int _m;
1855 int _n;
1856 int _k;
1857 int _mult_transpose1xW_width;
1858 int _mult_interleave4x4_height;
1859 int _depth_output_gemm3d;
1860 bool _reinterpret_input_as_3d;
1861 bool _broadcast_bias;
Gian Marco36a0a462018-01-12 10:21:40 +00001862};
1863
Michalis Spyrou60c3b0e2021-04-08 12:02:58 +01001864struct ConvolutionInfo
1865{
1866 ConvolutionInfo() = default;
1867 ConvolutionInfo(const PadStrideInfo &pad_stride_info, unsigned int depth_multiplier, const ActivationLayerInfo &act_info, const Size2D &dilation)
1868 : pad_stride_info(pad_stride_info), depth_multiplier(depth_multiplier), act_info(act_info), dilation(dilation)
1869 {
1870 }
1871 PadStrideInfo pad_stride_info{}; /**< Convolution info (Pads, strides,...) */
1872 unsigned int depth_multiplier{ 1 }; /**< Multiplier to apply to input's depth to retrieve the output depth. Defaults to 1 */
1873 ActivationLayerInfo act_info{}; /**< Fused activation to apply after convolution. */
1874 Size2D dilation{ Size2D(1, 1) }; /**< Dilation, in elements, across x and y. Defaults to (1, 1). */
1875};
1876
giuros016d109962019-01-07 17:47:19 +00001877struct DepthwiseConvolutionReshapeInfo
1878{
1879 unsigned int c0{ 1 }; /**< Number of channels processed by the depth-wise convolution */
1880 bool transpose{ false }; /**< True if the block MxC0 (where M is the area of the filter i.e. KwxKh) has to be transposed */
1881};
1882
Gian Marco Iodice4b908652018-10-18 10:21:02 +01001883/** GEMMLowp output stage type */
1884enum class GEMMLowpOutputStageType
1885{
Manuel Bottini959c26d2019-12-02 16:22:35 +00001886 NONE, /**< No quantization */
1887 QUANTIZE_DOWN, /**< Quantize using an integer multiplication */
1888 QUANTIZE_DOWN_FIXEDPOINT, /**< Quantize using a fixed point multiplication */
1889 QUANTIZE_DOWN_FLOAT /**< Quantize using a floating point multiplication */
Gian Marco Iodice4b908652018-10-18 10:21:02 +01001890};
1891
1892/** GEMMLowp output stage info */
1893struct GEMMLowpOutputStageInfo
1894{
Giorgio Arena1856ff72020-02-07 13:46:45 +00001895 GEMMLowpOutputStageType type{ GEMMLowpOutputStageType::NONE }; /**< GEMMLowp output stage type */
1896 int32_t gemmlowp_offset{ 0 }; /**< GEMMLowp output stage offset used for quantizing to QASYMM8 */
1897 int32_t gemmlowp_multiplier{ 0 }; /**< GEMMLowp output stage multiplier used for quantizing to QASYMM8 */
1898 int32_t gemmlowp_shift{ 0 }; /**< GEMMLowp output stage shift used for quantizing to uint8 */
1899 int32_t gemmlowp_min_bound{ std::numeric_limits<int32_t>::lowest() }; /**< GEMMLowp min value used to saturate down the output result before converting back to QASYMM8 */
1900 int32_t gemmlowp_max_bound{ std::numeric_limits<int32_t>::max() }; /**< GEMMLowp max value used to saturate down the output result before converting back to QASYMM8 */
1901 std::vector<int32_t> gemmlowp_multipliers{}; /**< GEMMLowp output stage multiplier used for quantizing to QASYMM8 */
1902 std::vector<int32_t> gemmlowp_shifts{}; /**< GEMMLowp output stage multiplier used for quantizing to QASYMM8 */
Sheri Zhang1b14c752020-03-09 14:29:52 +00001903 float gemmlowp_real_multiplier{ 0 }; /**< GEMMLowp output stage real multiplier used for quantizing to QASYMM8 */
Giorgio Arena1856ff72020-02-07 13:46:45 +00001904 bool is_quantized_per_channel{ false }; /**< GEMMLowp quantized per-channel flag */
1905 DataType output_data_type{ DataType::UNKNOWN }; /**< Output tensor data type to use if the output is not initialized */
Gian Marco Iodice4b908652018-10-18 10:21:02 +01001906};
1907
Gian Marco Iodice5ba5e092018-12-06 17:13:09 +00001908/** GEMM LHS (Left Hand Side) matrix information */
1909struct GEMMLHSMatrixInfo
1910{
morgolockaba2f912020-05-05 16:28:19 +01001911 GEMMLHSMatrixInfo() = default;
1912 GEMMLHSMatrixInfo(unsigned int m, unsigned int k, unsigned int v, bool trans, bool inter)
1913 : m0(m), k0(k), v0(v), transpose(trans), interleave(inter)
1914 {
1915 }
Gian Marco Iodice5ba5e092018-12-06 17:13:09 +00001916 unsigned int m0{ 1 }; /**< Number of rows processed by the matrix multiplication */
1917 unsigned int k0{ 1 }; /**< Number of partial accumulations performed by the matrix multiplication */
1918 unsigned int v0{ 1 }; /**< Number of vertical blocks of size (m0xk0) stored on the same output row */
1919 bool transpose{ true }; /**< True if the (m0xk0) block has to be transposed before been stored */
1920 bool interleave{ true }; /**< True if the v0 (m0xk0) blocks have to be interleaved in the output row */
1921};
1922
Gian Marco Iodice3b0a2652018-12-07 11:18:09 +00001923/** GEMM RHS (Right Hand Side) matrix information */
1924struct GEMMRHSMatrixInfo
1925{
morgolockaba2f912020-05-05 16:28:19 +01001926 GEMMRHSMatrixInfo() = default;
Gian Marco Iodicee3a849a2020-06-10 17:59:30 +01001927 GEMMRHSMatrixInfo(unsigned int n, unsigned int k, unsigned int h, bool trans, bool inter, bool export_to_cl_img)
1928 : n0(n), k0(k), h0(h), transpose(trans), interleave(inter), export_to_cl_image(export_to_cl_img)
morgolockaba2f912020-05-05 16:28:19 +01001929 {
1930 }
Gian Marco Iodicedd717c32020-05-28 10:22:03 +01001931 unsigned int n0{ 1 }; /**< Number of columns processed by the matrix multiplication */
1932 unsigned int k0{ 1 }; /**< Number of partial accumulations performed by the matrix multiplication */
1933 unsigned int h0{ 1 }; /**< Number of horizontal blocks of size (k0xn0) stored on the same output row */
1934 bool transpose{ true }; /**< True if the (k0xn0) block has to be transposed before been stored */
1935 bool interleave{ true }; /**< True if the h0 (k0xn0) blocks have to be interleaved in the output row */
1936 bool export_to_cl_image{ false }; /**< True if the reshaped rhs has to be exported to cl_image. n0 must be equal to 4 */
Gian Marco Iodice3b0a2652018-12-07 11:18:09 +00001937};
1938
Gian Marco36a0a462018-01-12 10:21:40 +00001939/** GEMM information class. This class stores the necessary information to compute GEMM functions
1940 *
1941 * This object also contains the information about how matrix A and matrix B have been reshaped
1942 *
1943 */
Chunosov5124be52017-11-22 20:42:13 +07001944class GEMMInfo
1945{
1946public:
1947 /** Default constructor */
Georgios Pinitas37d080f2019-06-21 18:43:12 +01001948 GEMMInfo() noexcept
1949 : _is_a_reshaped(false),
1950 _is_b_reshaped(false),
1951 _reshape_b_only_on_first_run(true),
1952 _depth_output_gemm3d(0),
1953 _reinterpret_input_as_3d(false),
1954 _retain_internal_weights(false),
1955 _gemmlowp_output_stage(),
1956 _fp_mixed_precision(false),
1957 _broadcast_bias(false),
Gian Marco Iodicef3622be2019-07-29 14:27:16 +01001958 _pretranpose_B(true),
1959 _activation_info()
Chunosov5124be52017-11-22 20:42:13 +07001960 {
1961 }
1962 /** Constructor
1963 *
1964 * @param[in] is_a_reshaped True if the matrix A has been reshaped
1965 * @param[in] is_b_reshaped True if the matrix B has been reshaped
1966 * @param[in] reshape_b_only_on_first_run Reshape matrix B only for the first run
Isabella Gottardi8e74f442018-03-01 16:42:00 +00001967 * @param[in] depth_output_gemm3d (Optional) Depth (third dimension) of the output tensor to be used with the GEMM3D kernel
Gian Marco Iodice3139f032018-11-05 14:26:32 +00001968 * If 0 the output will not be reinterpreted as 3D. Default 0
Gian Marco Iodice68a3f562018-07-26 11:44:03 +01001969 * @param[in] reinterpret_input_as_3d (Optional) Reinterpret the input as 3D tensor. (i.e. this flag should be set to true when GEMM is used
1970 * to perform 1x1 convolutions with the NHWC data layout)
Michele Di Giorgioba1ffe92018-08-22 14:28:30 +01001971 * @param[in] retain_internal_weights (Optional) Retain the weights tensor from previous run
Gian Marco Iodice4b908652018-10-18 10:21:02 +01001972 * @param[in] gemmlowp_output_stage (Optional) GEMMLowp Output stage info
Vidhya Sudhan Loganathana25d16c2018-11-16 11:33:12 +00001973 * @param[in] fp_mixed_precision (Optional) Use wider accumulators (32 bit instead of 16 for FP16) to improve accuracy.
Georgios Pinitasb0f342e2019-05-21 13:32:43 +01001974 * @param[in] broadcast_bias (Optional) Broadcast the shape of the bias tensor from a vector to a matrix.
Gian Marco Iodicef3622be2019-07-29 14:27:16 +01001975 * @param[in] activation_info (Optional) Activation to apply after the matrix multiplication
Chunosov5124be52017-11-22 20:42:13 +07001976 */
Gian Marco Iodice3139f032018-11-05 14:26:32 +00001977 GEMMInfo(bool is_a_reshaped, bool is_b_reshaped, bool reshape_b_only_on_first_run, int depth_output_gemm3d = 0, bool reinterpret_input_as_3d = false, bool retain_internal_weights = false,
Gian Marco Iodicef3622be2019-07-29 14:27:16 +01001978 GEMMLowpOutputStageInfo gemmlowp_output_stage = GEMMLowpOutputStageInfo(), bool fp_mixed_precision = false, bool broadcast_bias = false,
1979 const ActivationLayerInfo &activation_info = ActivationLayerInfo()) noexcept
Georgios Pinitas37d080f2019-06-21 18:43:12 +01001980 : _is_a_reshaped(is_a_reshaped),
1981 _is_b_reshaped(is_b_reshaped),
1982 _reshape_b_only_on_first_run(reshape_b_only_on_first_run),
1983 _depth_output_gemm3d(depth_output_gemm3d),
1984 _reinterpret_input_as_3d(reinterpret_input_as_3d),
1985 _retain_internal_weights(retain_internal_weights),
1986 _gemmlowp_output_stage(gemmlowp_output_stage),
1987 _fp_mixed_precision(fp_mixed_precision),
1988 _broadcast_bias(broadcast_bias),
Gian Marco Iodicef3622be2019-07-29 14:27:16 +01001989 _pretranpose_B(reshape_b_only_on_first_run),
1990 _activation_info(activation_info)
Chunosov5124be52017-11-22 20:42:13 +07001991 {
1992 }
1993 /** Flag which specifies if the matrix A has been reshaped
1994 *
1995 * @return True if the matrix A has been reshaped
1996 */
1997 bool is_a_reshaped() const
1998 {
1999 return _is_a_reshaped;
2000 };
2001 /** Flag which specifies if the matrix B has been reshaped
2002 *
2003 * @return True if the matrix B has been reshaped
2004 */
2005 bool is_b_reshaped() const
2006 {
2007 return _is_b_reshaped;
2008 };
2009 /** Flag which specifies if the reshape of matrix B should executed only for the first
2010 *
2011 * @note This flag could be set to TRUE when GEMM is used to accelerate convolution layer
2012 *
2013 * @return True if the reshaped of matrix B happens only for the first run
2014 */
2015 bool reshape_b_only_on_first_run() const
2016 {
2017 return _reshape_b_only_on_first_run;
2018 };
Isabella Gottardi8e74f442018-03-01 16:42:00 +00002019 /** Depth of the output when GEMM output is reinterpreted as 3D tensor
Gian Marco36a0a462018-01-12 10:21:40 +00002020 *
Isabella Gottardi8e74f442018-03-01 16:42:00 +00002021 * @return the depth of the output tensor
Gian Marco36a0a462018-01-12 10:21:40 +00002022 */
Isabella Gottardi8e74f442018-03-01 16:42:00 +00002023 int depth_output_gemm3d() const
Gian Marco36a0a462018-01-12 10:21:40 +00002024 {
Isabella Gottardi8e74f442018-03-01 16:42:00 +00002025 return _depth_output_gemm3d;
2026 };
Gian Marco Iodice68a3f562018-07-26 11:44:03 +01002027 /** Flag which specifies if the input tensor has to be reinterpreted as 3D
2028 *
2029 * @return True if the input tensor has to be reinterpreted as 3D tensor
2030 */
2031 bool reinterpret_input_as_3d() const
2032 {
2033 return _reinterpret_input_as_3d;
2034 };
Michele Di Giorgioba1ffe92018-08-22 14:28:30 +01002035 /** Flag which specifies if the weights tensor has to be retained from previous run
2036 *
2037 * @return True if the weights tensor has to be retained
2038 */
2039 bool retain_internal_weights() const
2040 {
2041 return _retain_internal_weights;
2042 };
Gian Marco Iodice4b908652018-10-18 10:21:02 +01002043 /** GEMMLowp output stage
2044 *
2045 * @return the GEMMLowp output stage info
2046 */
2047 GEMMLowpOutputStageInfo gemmlowp_output_stage() const
2048 {
2049 return _gemmlowp_output_stage;
2050 };
Georgios Pinitasdbdea0d2019-10-16 19:21:40 +01002051 /** Sets GEMMLowp output stage
2052 *
2053 * @param[in] output_stage Output stage to set
2054 */
2055 void set_gemmlowp_output_stage(GEMMLowpOutputStageInfo &output_stage)
2056 {
2057 _gemmlowp_output_stage = output_stage;
2058 };
Vidhya Sudhan Loganathana25d16c2018-11-16 11:33:12 +00002059 /** Flag which specifies if a wider accumulator should be used.
2060 *
2061 * @return True if a wider accumulator has to be used
2062 */
2063 bool fp_mixed_precision() const
2064 {
2065 return _fp_mixed_precision;
2066 };
Georgios Pinitasb0f342e2019-05-21 13:32:43 +01002067 /** Flag which specifies whether to broadcast the shape of the bias tensor.
2068 *
2069 * @return True if the shape of the bias tensor is to be broadcasted.
2070 */
2071 bool broadcast_bias() const
2072 {
2073 return _broadcast_bias;
2074 };
Georgios Pinitas37d080f2019-06-21 18:43:12 +01002075 /** Flag which specifies whether b should be pre-transposed if supported.
2076 *
2077 * @return True if b should be pre-transposed else false.
2078 */
2079 bool pretranpose_B() const
2080 {
2081 return _pretranpose_B;
2082 };
2083 /** Set pre-transpose b flag
2084 *
2085 * @param[in] flag Flag to set
2086 */
2087 void set_pretranpose_B(bool flag)
2088 {
2089 _pretranpose_B = flag;
2090 }
Gian Marco Iodicef3622be2019-07-29 14:27:16 +01002091 /** Activation layer to apply after the matrix multiplication
2092 *
2093 * @return ActivationLayerInfo object
2094 */
2095 ActivationLayerInfo activation_info() const
2096 {
2097 return _activation_info;
2098 }
SiCongLi2e5fd632020-03-02 15:39:15 +00002099 /** Set activation layer info
2100 *
2101 * @param[in] activation_info ActivationLayerInfo object to set
2102 */
2103 void set_activation_info(const ActivationLayerInfo &activation_info)
2104 {
2105 _activation_info = activation_info;
2106 }
Chunosov5124be52017-11-22 20:42:13 +07002107
2108private:
Georgios Pinitas37d080f2019-06-21 18:43:12 +01002109 bool _is_a_reshaped;
2110 bool _is_b_reshaped;
2111 bool _reshape_b_only_on_first_run;
2112 int _depth_output_gemm3d;
2113 bool _reinterpret_input_as_3d;
2114 bool _retain_internal_weights;
2115 GEMMLowpOutputStageInfo _gemmlowp_output_stage;
2116 bool _fp_mixed_precision;
2117 bool _broadcast_bias;
2118 bool _pretranpose_B;
Gian Marco Iodicef3622be2019-07-29 14:27:16 +01002119 ActivationLayerInfo _activation_info;
Chunosov5124be52017-11-22 20:42:13 +07002120};
2121
Gian Marco Iodice247f52c2018-03-22 11:24:56 +00002122/** Winograd information */
2123struct WinogradInfo
2124{
2125 /** Default constructor
2126 *
2127 * @param[in] output_tile_sz Width and height of the output tile
2128 * @param[in] kernel_sz Width and height of the kernel
2129 * @param[in] input_dims Width and height of the input tensor before the convolution is applied
2130 * @param[in] conv_info Convolution info (Pads, strides)
2131 * @param[in] data_layout Data layout to use for the output tensor once the convolution has been applied
2132 */
2133 WinogradInfo(Size2D output_tile_sz, Size2D kernel_sz, Size2D input_dims, PadStrideInfo conv_info, DataLayout data_layout)
2134 : output_tile_size(output_tile_sz), kernel_size(kernel_sz), input_dimensions(input_dims), convolution_info(conv_info), output_data_layout(data_layout)
2135 {
2136 }
2137
2138 Size2D output_tile_size{}; /**< Width and height of the output tile */
2139 Size2D kernel_size{}; /**< Width and height of the kernel*/
2140 Size2D input_dimensions{}; /**< Width and height of the input tensor before the convolution is applied */
2141 PadStrideInfo convolution_info{}; /**< Convolution info (Pads, strides,...) */
2142 DataLayout output_data_layout{ DataLayout::NCHW }; /**< Data layout to use for the output tensor once the convolution has been applied (NCHW or NHWC) */
2143};
2144
Anthony Barbier6ff3b192017-09-04 18:44:23 +01002145/** IO formatting information class*/
2146struct IOFormatInfo
2147{
2148 /** Precision type used when printing floating point numbers */
2149 enum class PrecisionType
2150 {
2151 Default, /**< Default precision to the one that the current stream has */
2152 Custom, /**< Custom precision specified by the user using the precision parameter */
2153 Full /**< The maximum precision of the floating point representation */
2154 };
2155
2156 /** Specifies the area to be printed, used by Tensor objects */
2157 enum class PrintRegion
2158 {
2159 ValidRegion, /**< Prints the valid region of the Tensor object */
2160 NoPadding, /**< Prints the Tensor object without the padding */
2161 Full /**< Print the tensor object including padding */
2162 };
2163
Alex Gildayc357c472018-03-21 13:54:09 +00002164 /** Construct a set of IO formatting information.
2165 *
2166 * @param[in] print_region Area to be printed. Used by Tensor objects. Default: ValidRegion.
2167 * @param[in] precision_type Precision type for floating point numbers. Default: stream default.
2168 * @param[in] precision Precision value for float point numbers. Default: 10.
2169 * @param[in] align_columns Whether to align columns when printed. Default: true.
2170 * @param[in] element_delim Delimeter between elements. Default: " ".
2171 * @param[in] row_delim Delimenter between rows. Default: "\n".
2172 */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01002173 IOFormatInfo(PrintRegion print_region = PrintRegion::ValidRegion,
2174 PrecisionType precision_type = PrecisionType::Default,
2175 unsigned int precision = 10,
2176 bool align_columns = true,
2177 std::string element_delim = " ",
2178 std::string row_delim = "\n")
2179 : print_region(print_region),
2180 precision_type(precision_type),
2181 precision(precision),
2182 element_delim(element_delim),
2183 row_delim(row_delim),
2184 align_columns(align_columns)
2185 {
2186 }
2187
Alex Gildayc357c472018-03-21 13:54:09 +00002188 /** Area to be printed by Tensor objects */
2189 PrintRegion print_region;
2190 /** Floating point precision type */
Anthony Barbier6ff3b192017-09-04 18:44:23 +01002191 PrecisionType precision_type;
Alex Gildayc357c472018-03-21 13:54:09 +00002192 /** Floating point precision */
2193 unsigned int precision;
2194 /** Element delimeter */
2195 std::string element_delim;
2196 /** Row delimeter */
2197 std::string row_delim;
2198 /** Align columns */
2199 bool align_columns;
Anthony Barbier6ff3b192017-09-04 18:44:23 +01002200};
Georgios Pinitasd8734b52017-12-22 15:27:52 +00002201} // namespace arm_compute
Michalis Spyrouf4643372019-11-29 16:17:13 +00002202#endif /* ARM_COMPUTE_TYPES_H */