blob: 91ef5bf6a254ad6de81bf92e7b97fa44112d64d1 [file] [log] [blame]
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00001///
Gian Marco Iodice716b1be2021-02-10 17:33:27 +00002/// Copyright (c) 2017-2021 Arm Limited.
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00003///
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///
Anthony Barbier3762e742018-03-02 11:49:33 +000024namespace arm_compute
25{
Anthony Barbier6ff3b192017-09-04 18:44:23 +010026/** @mainpage Introduction
27
28@tableofcontents
29
30The Computer Vision and Machine Learning library is a set of functions optimised for both ARM CPUs and GPUs using SIMD technologies.
31
32Several builds of the library are available using various configurations:
Georgios Pinitas45514032020-12-30 00:03:09 +000033 - OS: Linux, Android, macOS or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010034 - Architecture: armv7a (32bit) or arm64-v8a (64bit)
Anthony Barbier20dbb822017-12-13 21:19:39 +000035 - Technology: NEON / OpenCL / GLES_COMPUTE / NEON and OpenCL and GLES_COMPUTE
Anthony Barbier6ff3b192017-09-04 18:44:23 +010036 - Debug / Asserts / Release: Use a build with asserts enabled to debug your application and enable extra validation. Once you are sure your application works as expected you can switch to a release build of the library for maximum performance.
37
38@section S0_1_contact Contact / Support
39
Michele Di Giorgioeca54a02021-02-16 15:37:59 +000040Please create an issue on <a href="https://github.com/ARM-software/ComputeLibrary/issues">Github</a>.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010041
42In order to facilitate the work of the support team please provide the build information of the library you are using. To get the version of the library you are using simply run:
43
44 $ strings android-armv7a-cl-asserts/libarm_compute.so | grep arm_compute_version
45 arm_compute_version=v16.12 Build options: {'embed_kernels': '1', 'opencl': '1', 'arch': 'armv7a', 'neon': '0', 'asserts': '1', 'debug': '0', 'os': 'android', 'Werror': '1'} Git hash=f51a545d4ea12a9059fe4e598a092f1fd06dc858
46
Anthony Barbier14c86a92017-12-14 16:27:41 +000047@section S0_2_prebuilt_binaries Pre-built binaries
48
49For each release we provide some pre-built binaries of the library [here](https://github.com/ARM-software/ComputeLibrary/releases)
50
51These binaries have been built using the following toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +010052 - Linux armv7a: gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
53 - Linux arm64-v8a: gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
54 - Android armv7a: clang++ / libc++ NDK r18b
55 - Android am64-v8a: clang++ / libc++ NDK r18b
Anthony Barbier14c86a92017-12-14 16:27:41 +000056
57@warning Make sure to use a compatible toolchain to build your application or you will get some std::bad_alloc errors at runtime.
58
Anthony Barbier6ff3b192017-09-04 18:44:23 +010059@section S1_file_organisation File organisation
60
61This archive contains:
62 - The arm_compute header and source files
63 - The latest Khronos OpenCL 1.2 C headers from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a>
64 - The latest Khronos cl2.hpp from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a> (API version 2.1 when this document was written)
Anthony Barbier20dbb822017-12-13 21:19:39 +000065 - The latest Khronos OpenGL ES 3.1 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos OpenGL ES registry</a>
66 - The latest Khronos EGL 1.5 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos EGL registry</a>
67 - The sources for a stub version of libOpenCL.so, libGLESv1_CM.so, libGLESv2.so and libEGL.so to help you build your application.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010068 - An examples folder containing a few examples to compile and link against the library.
69 - A @ref utils folder containing headers with some boiler plate code used by the examples.
70 - This documentation.
71
Michele Di Giorgio552e11d2020-09-23 15:08:38 +010072 For detailed information about file organization, please refer to Files -> File List section of this documentation.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010073
74@section S2_versions_changelog Release versions and changelog
75
76@subsection S2_1_versions Release versions
77
78All releases are numbered vYY.MM Where YY are the last two digits of the year, and MM the month number.
79If there is more than one release in a month then an extra sequential number is appended at the end:
80
81 v17.03 (First release of March 2017)
82 v17.03.1 (Second release of March 2017)
83 v17.04 (First release of April 2017)
84
85@note We're aiming at releasing one major public release with new features per quarter. All releases in between will only contain bug fixes.
86
87@subsection S2_2_changelog Changelog
88
Georgios Pinitas40f51a62020-11-21 03:04:18 +000089v21.02 Public major release
Sheri Zhangda6a6eb2021-01-06 11:15:06 +000090 - Various bug fixes.
91 - Various optimisations.
Georgios Pinitas45514032020-12-30 00:03:09 +000092 - Upgrade C++ standard to C++14
93 - Add macOS support
Sheri Zhangda6a6eb2021-01-06 11:15:06 +000094 - Add SVE/SVE2 support for:
95 - @ref NEScaleKernel
96 - @ref NEActivationLayer
97 - @ref NEArithmeticAddition
98 - @ref NEBatchNormalizationLayerKernel
Michalis Spyrou373b4072021-01-20 16:41:12 +000099 - NELogits1DSoftmaxKernel
100 - NELogits1DMaxKernel
Sang-Hoon Park7249f152021-01-22 11:55:03 +0000101 - NEElementwiseUnaryKernel
Sheri Zhangdda69142021-02-01 19:06:57 +0000102 - Remove padding from OpenCL kernels:
103 - @ref CLDirectConvolutionLayerKernel
104 - @ref CLArgMinMaxLayerKernel
105 - @ref CLPadLayerKernel
106 - @ref CLROIAlignLayerKernel
107 - @ref CLRangeKernel
108 - @ref CLScaleKernel
109 - @ref CLSelectKernel
110 - @ref CLBitwiseKernel
111 - ClFloorKernel
112 - @ref CLTransposeKernel
Sheri Zhangda6a6eb2021-01-06 11:15:06 +0000113 - Remove functions:
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000114 - NELocallyConnectedLayer / CLLocallyConnectedLayer
Georgios Pinitasf7c5a412020-12-03 14:38:33 +0000115 - NEIm2Col
116 - NECol2Im
117 - NEGEMMInterleave4x4
118 - NEGEMMTranspose1xW
Georgios Pinitas8c3c0e72020-12-03 20:11:53 +0000119 - NEComputeAllAnchors / CLComputeAllAnchors
Georgios Pinitasec2256b2020-12-03 18:51:58 +0000120 - NEGEMMAssemblyDispatch
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000121 - NEUpsampleLayer / CLUpsampleLayer
Sheri Zhangda6a6eb2021-01-06 11:15:06 +0000122 - Remove kernels:
Georgios Pinitasd308df32020-12-01 16:56:36 +0000123 - NEGEMMMatrixVectorMultiplyKernel
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000124 - NELocallyConnectedMatrixMultiplyKernel / CLLocallyConnectedMatrixMultiplyKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000125 - NEUpsampleLayerKernel / CLUpsampleLayerKernel
Gian Marco Iodicef5aad512021-02-08 17:34:40 +0000126 - Extend OpenCL tuner with workgroup batch size support
127 - Experimental extension for the OpenCL tuner to tune the batches of work groups distribute to compute units
Gian Marco Iodice716b1be2021-02-10 17:33:27 +0000128 - Add functionality to load the OpenCL GEMM heuristics at runtime
129 - The GEMM heuristic file (MLGO) can be used to update the default GEMM heuristics available for OpenCL
Georgios Pinitas40f51a62020-11-21 03:04:18 +0000130
SiCong Li96209c72020-08-21 12:28:30 +0100131v20.11 Public major release
morgolock70b1eb82020-11-24 13:54:19 +0000132 - Various bug fixes.
133 - Various optimisations.
134 - Performance regressions can be noted when executing Depthwise Convolution on Neon with a depth multiplier > 1 for quantized data type.
morgolock0e728492020-11-20 11:03:33 +0000135 This is planned to be resolved in 21.02 release.
morgolock70b1eb82020-11-24 13:54:19 +0000136 - Added new data type QASYMM8_SIGNED support for @ref NEROIAlignLayer.
SiCong Li903f8cc2020-08-27 10:17:10 +0100137 - Added new data type S32 support for:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000138 - NEArithmeticSubtraction
139 - NEArithmeticSubtractionKernel
SiCong Libb88f892020-08-28 11:18:47 +0100140 - @ref NEPixelWiseMultiplication
141 - @ref NEPixelWiseMultiplicationKernel
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000142 - NEElementwiseDivision
143 - NEDivisionOperationKernel
SiCong Li96209c72020-08-21 12:28:30 +0100144 - Interface change
145 - Properly support softmax axis to have the same meaning as other major frameworks. That is, axis now defines the dimension
146 on which Softmax/Logsoftmax is performed. E.g. for input of shape 4x5x6 and axis=1, softmax will be applied to 4x6=24 vectors of size 5.
147 The supported value range of axis is [-rank, rank).
148 This change applies to the following functions:
149 - @ref NESoftmaxLayer
150 - @ref NELogSoftmaxLayer
151 - @ref CLSoftmaxLayer
152 - @ref CLLogSoftmaxLayer
153 - @ref GCSoftmaxLayer
Sheri Zhang824061d2020-10-26 15:46:37 +0000154 - New OpenCL kernels / functions:
155 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
morgolock0e728492020-11-20 11:03:33 +0000156 - @ref CLLogicalNot
157 - @ref CLLogicalAnd
158 - @ref CLLogicalOr
159 - New NEON kernels / functions:
160 - @ref NELogicalNot
161 - @ref NELogicalAnd
162 - @ref NELogicalOr
Sheri Zhang824061d2020-10-26 15:46:37 +0000163 - Removed padding from NEON kernels:
Sheri Zhanged367132020-10-08 15:46:16 +0100164 - @ref NEComplexPixelWiseMultiplicationKernel
165 - @ref NENonMaximaSuppression3x3Kernel
166 - @ref NERemapKernel
167 - @ref NEGEMMInterleave4x4Kernel
168 - @ref NEDirectConvolutionLayerKernel
169 - @ref NEScaleKernel
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000170 - NELocallyConnectedMatrixMultiplyKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100171 - @ref NEGEMMLowpOffsetContributionKernel
172 - @ref NEGEMMTranspose1xWKernel
Michele Di Giorgio19289042021-02-03 16:05:00 +0000173 - NEPoolingLayerKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100174 - @ref NEConvolutionKernel
175 - @ref NEDepthwiseConvolutionLayerNativeKernel
176 - @ref NEGEMMLowpMatrixMultiplyKernel
177 - @ref NEGEMMMatrixMultiplyKernel
178 - @ref NEDirectConvolutionLayerOutputStageKernel
179 - @ref NEReductionOperationKernel
180 - @ref NEGEMMLowpMatrixAReductionKernel
181 - @ref NEGEMMLowpMatrixBReductionKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000182 - Removed padding from OpenCL kernels:
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000183 - CLBatchConcatenateLayerKernel
Michele Di Giorgio1e0208a2021-01-22 15:42:59 +0000184 - CLElementwiseOperationKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000185 - @ref CLBatchNormalizationLayerKernel
Michele Di Giorgioe1314662021-02-01 17:09:32 +0000186 - CLPoolingLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000187 - @ref CLWinogradInputTransformKernel
188 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
189 - @ref CLGEMMLowpMatrixAReductionKernel
190 - @ref CLGEMMLowpMatrixBReductionKernel
191 - @ref CLGEMMLowpOffsetContributionOutputStageKernel
192 - @ref CLGEMMLowpOffsetContributionKernel
193 - @ref CLWinogradOutputTransformKernel
194 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
195 - @ref CLFuseBatchNormalizationKernel
196 - @ref CLDepthwiseConvolutionLayerNativeKernel
197 - @ref CLDepthConvertLayerKernel
Sheri Zhang7e20e292021-02-02 11:49:34 +0000198 - CLCopyKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000199 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000200 - CLActivationLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000201 - @ref CLWinogradFilterTransformKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000202 - CLWidthConcatenateLayerKernel
203 - CLWidthConcatenate4TensorsKernel
204 - CLWidthConcatenate2TensorsKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000205 - @ref CLLogits1DMaxShiftExpSumKernel
206 - @ref CLLogits1DNormKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000207 - CLHeightConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000208 - @ref CLGEMMMatrixMultiplyKernel
209 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
210 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
211 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000212 - CLDepthConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000213 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
214 - Removed OpenCL kernels / functions:
215 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
216 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel
217 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel
morgolock00c76012020-11-06 10:40:12 +0000218 - Deprecated OpenCL kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together):
Georgios Pinitas2d221392020-09-03 15:16:37 +0100219 - CLLocallyConnectedLayer
220 - CLLocallyConnectedMatrixMultiplyKernel
morgolock00c76012020-11-06 10:40:12 +0000221 - CLAbsoluteDifference
222 - CLAbsoluteDifferenceKernel
223 - CLAccumulate
224 - CLAccumulateKernel
225 - CLAccumulateSquared
226 - CLAccumulateSquaredKernel
227 - CLAccumulateWeighted
228 - CLAccumulateWeightedKernel
229 - CLAccumulateWeightedFP16Kernel
230 - CLBox3x3
231 - CLBox3x3Kernel
232 - CLBox3x3FP16Kernel
233 - CLCannyEdge
234 - CLChannelCombine
235 - CLChannelCombineKernel
236 - CLChannelExtract
237 - CLChannelExtractKernel
238 - CLColorConvert
239 - CLColorConvertKernel
240 - CLConvolution3x3
241 - CLConvolutionRectangle
242 - CLConvolutionRectangleKernel
243 - CLConvolutionSquare
244 - CLConvolutionKernel
245 - CLDerivative
246 - CLDerivativeKernel
247 - CLDilate
248 - CLDilateKernel
249 - CLEqualizeHistogram
250 - CLErode
251 - CLErodeKernel
252 - CLFastCorners
253 - CLFastCornersKernel
254 - CLGaussian3x3
255 - CLGaussian3x3Kernel
256 - CLGaussian5x5
257 - CLGaussian5x5HorKernel
258 - CLGaussian5x5VertKernel
259 - CLGaussianPyramid
260 - CLGaussianPyramidHalf
261 - CLGaussianPyramidOrb
262 - CLHarrisCorners
263 - CLHarrisScoreKernel
264 - CLHarrisScoreFP16Kernel
265 - CLHistogram
266 - CLHistogramKernel
267 - CLHOGOrientationBinningKernel
268 - CLHOGBlockNormalizationKernel
269 - CLHOGDetectorKernel
270 - CLHOGNonMaximaSuppressionKernel
271 - CLHOGDescriptor
272 - CLHOGDetector
273 - CLHOGGradient
274 - CLHOGMultiDetection
275 - CLHOGOrientationBinningKernel
276 - CLHOGBlockNormalizationKernel
277 - CLHOGDetectorKernel
278 - CLIntegralImage
279 - CLIntegralImageKernel
280 - CLLaplacianReconstruct
281 - CLLaplacianPyramid
282 - CLMagnitude
283 - CLMagnitudePhaseKernel
284 - CLMedian3x3
285 - CLMedian3x3Kernel
286 - CLMinMaxLocation
287 - CLMinMaxLocationKernel
288 - CLNonLinearFilter
289 - CLNonLinearFilterKernel
290 - CLNonMaximaSuppression3x3
291 - CLNonMaximaSuppression3x3FP16Kernel
292 - CLNonMaximaSuppression3x3Kernel
293 - CLOpticalFlow
294 - CLPhase
295 - CLRemap
296 - CLRemapKernel
297 - CLScharr3x3
298 - CLScharr3x3Kernel
299 - CLSobel3x3
300 - CLSobel3x3Kernel
301 - CLSobel5x5
302 - CLSobel5x5HorKernel
303 - CLSobel5x5VertKernel
304 - CLSobel7x7
305 - CLSobel7x7HorKernel
306 - CLSobel7x7VertKernel
307 - CLThreshold
308 - CLThresholdKernel
309 - CLWarpAffine
310 - CLWarpAffineKernel
311 - CLWarpPerspective
312 - CLWarpPerspectiveKernel
313 - Deprecated NEON kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together):
Georgios Pinitas2d221392020-09-03 15:16:37 +0100314 - NELocallyConnectedLayer
315 - NELocallyConnectedMatrixMultiplyKernel
morgolock0c862652020-11-06 08:59:45 +0000316 - NEAbsoluteDifference
317 - NEAbsoluteDifferenceKernel
318 - NEAccumulate
319 - NEAccumulateKernel
320 - NEAccumulateSquared
321 - NEAccumulateSquaredKernel
322 - NEAccumulateWeighted
323 - NEAccumulateWeightedKernel
324 - NEAccumulateWeightedFP16Kernel
325 - NEBox3x3
326 - NEBox3x3Kernel
327 - NEBox3x3FP16Kernel
328 - NECannyEdge
329 - NEChannelCombine
330 - NEChannelCombineKernel
331 - NEChannelExtract
332 - NEChannelExtractKernel
333 - NEColorConvert
334 - NEColorConvertKernel
335 - NEConvolution3x3
336 - NEConvolutionRectangle
337 - NEConvolutionRectangleKernel
338 - NEConvolutionSquare
339 - NEConvolutionKernel
340 - NEDerivative
341 - NEDerivativeKernel
342 - NEDilate
343 - NEDilateKernel
344 - NEEqualizeHistogram
345 - NEErode
346 - NEErodeKernel
347 - NEFastCorners
348 - NEFastCornersKernel
349 - NEGaussian3x3
350 - NEGaussian3x3Kernel
351 - NEGaussian5x5
352 - NEGaussian5x5HorKernel
353 - NEGaussian5x5VertKernel
354 - NEGaussianPyramid
355 - NEGaussianPyramidHalf
356 - NEGaussianPyramidOrb
357 - NEHarrisCorners
358 - NEHarrisScoreKernel
359 - NEHarrisScoreFP16Kernel
360 - NEHistogram
361 - NEHistogramKernel
362 - NEHOGOrientationBinningKernel
363 - NEHOGBlockNormalizationKernel
364 - NEHOGDetectorKernel
365 - NEHOGNonMaximaSuppressionKernel
366 - NEHOGDescriptor
367 - NEHOGDetector
368 - NEHOGGradient
369 - NEHOGMultiDetection
370 - NEHOGOrientationBinningKernel
371 - NEHOGBlockNormalizationKernel
372 - NEHOGDetectorKernel
373 - NEIntegralImage
374 - NEIntegralImageKernel
375 - NELaplacianReconstruct
376 - NELaplacianPyramid
377 - NEMagnitude
378 - NEMagnitudePhaseKernel
379 - NEMedian3x3
380 - NEMedian3x3Kernel
381 - NEMinMaxLocation
382 - NEMinMaxLocationKernel
383 - NENonLinearFilter
384 - NENonLinearFilterKernel
385 - NENonMaximaSuppression3x3
386 - NENonMaximaSuppression3x3FP16Kernel
387 - NENonMaximaSuppression3x3Kernel
388 - NEOpticalFlow
389 - NEPhase
390 - NERemap
391 - NERemapKernel
392 - NEScharr3x3
393 - NEScharr3x3Kernel
394 - NESobel3x3
395 - NESobel3x3Kernel
396 - NESobel5x5
397 - NESobel5x5HorKernel
398 - NESobel5x5VertKernel
399 - NESobel7x7
400 - NESobel7x7HorKernel
401 - NESobel7x7VertKernel
402 - NEThreshold
403 - NEThresholdKernel
404 - NEWarpAffine
405 - NEWarpAffineKernel
406 - NEWarpPerspective
407 - NEWarpPerspectiveKernel
morgolockd6ee9ed2020-11-19 10:07:14 +0000408 - Deprecated GLES kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together):
409 - GCAbsoluteDifference
410 - GCActivationLayer
411 - GCArithmeticAddition
412 - GCBatchNormalizationLayer
413 - GCConcatenateLayer
414 - GCConvolutionLayer
415 - GCDepthwiseConvolutionLayer
416 - GCDirectConvolutionLayer
417 - GCDropoutLayer
418 - GCFillBorder
419 - GCFullyConnectedLayer
420 - GCGEMM
421 - GCGEMMInterleave4x4
422 - GCGEMMTranspose1xW
423 - GCNormalizationLayer
424 - GCNormalizePlanarYUVLayer
425 - GCPixelWiseMultiplication
426 - GCPoolingLayer
427 - GCScale
428 - GCSoftmaxLayer
429 - GCTensorShift
430 - GCTranspose
431
SiCong Li96209c72020-08-21 12:28:30 +0100432
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100433v20.08 Public major release
434 - Various bug fixes.
435 - Various optimisations.
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100436 - Added new data type QASYMM8_SIGNED support for:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100437 - @ref CLArgMinMaxLayer
438 - @ref CLArgMinMaxLayerKernel
439 - Added new data type U8 support for:
440 - @ref NECropKernel
Sheri Zhang7e20e292021-02-02 11:49:34 +0000441 - CLCropKernel
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100442 - Added aligh_corner support for nearest neighbor interpolation in:
443 - @ref NEScaleKernel
444 - @ref CLScaleKernel
445 - New OpenCL kernels / functions:
446 - @ref CLMaxUnpoolingLayerKernel
447 - New NEON kernels / functions:
448 - @ref NEMaxUnpoolingLayerKernel
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100449 - New graph example:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100450 - graph_yolov3_output_detector
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100451 - GEMMTuner improvements:
452 - Added fp16 support
453 - Output json files for easier integration
454 - Enabled tuning for export_to_cl_image_rhs option for RHS tensors
455 - More robust script for running benchmarks
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100456 - Removed padding from:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100457 - @ref NEPixelWiseMultiplicationKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000458 - NEHeightConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100459 - @ref NEThresholdKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000460 - NEBatchConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100461 - @ref NETransposeKernel
462 - @ref NEBatchNormalizationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000463 - NEArithmeticSubtractionKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100464 - @ref NEBoundingBoxTransformKernel
Michalis Spyrou373b4072021-01-20 16:41:12 +0000465 - NELogits1DMaxKernel
466 - NELogits1DSoftmaxKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100467 - @ref NEROIPoolingLayerKernel
468 - @ref NEROIAlignLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000469 - NEYOLOLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000470 - NEUpsampleLayerKernel
Georgios Pinitas70eb53b2021-01-06 19:42:21 +0000471 - NEFloorKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000472 - NEWidthConcatenateLayerKernel
473 - NEDepthConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100474 - @ref NENormalizationLayerKernel
475 - @ref NEL2NormalizeLayerKernel
476 - @ref NEFillArrayKernel
477 - @ref NEDepthConvertLayerKernel
478 - @ref NERangeKernel
479 - @ref NEPriorBoxLayer
Sheri Zhanged367132020-10-08 15:46:16 +0100480 - Removed OpenCL kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100481 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
482 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Sang-Hoon Parka45abfd2020-08-17 13:50:15 +0100483 - Removed NEON kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100484 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
485 - NEGEMMMatrixAccumulateBiasesKernel
SiCong Lid004a7a2020-05-28 15:26:41 +0100486 - Deprecated functions / interfaces:
487 - Non-descriptor based interfaces for @ref NEThreshold, @ref CLThreshold
Sang-Hoon Park97c1a672020-08-18 11:44:13 +0100488 - Non-descriptor based interfaces for @ref NEScale, @ref CLScale and @ref GCScale
SiCong Lid004a7a2020-05-28 15:26:41 +0100489 - In @ref NESoftmaxLayer, @ref NELogSoftmaxLayer, @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer :
morgolock9c7fed82020-08-05 12:30:56 +0100490 The default "axis" value for @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer is changed from 1 to 0.
491 Only axis 0 is supported.
492 The default "axis" value for @ref NESoftmaxLayer, @ref NELogSoftmaxLayer is changed from 1 to 0.
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100493 Only axis 0 is supported.
Sang-Hoon Parka0205b92020-07-07 09:36:09 +0100494 - The support for quantized data types has been removed from @ref CLLogSoftmaxLayer due to implementation complexity.
Gian Marco Iodice547b2e72020-08-12 10:25:29 +0100495 - Removed padding requirement for the input (e.g. LHS of GEMM) and output in @ref CLGEMMMatrixMultiplyNativeKernel, @ref CLGEMMMatrixMultiplyReshapedKernel, @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel and @ref CLIm2ColKernel (NHWC only)
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100496 - This change allows to use @ref CLGEMMConvolutionLayer without extra padding for the input and output.
497 - Only the weights/bias of @ref CLGEMMConvolutionLayer could require padding for the computation.
498 - Only on Arm Mali Midgard GPUs, @ref CLGEMMConvolutionLayer could require padding since @ref CLGEMMMatrixMultiplyKernel is called and currently requires padding.
Gian Marco Iodice547b2e72020-08-12 10:25:29 +0100499 - Added support for exporting the OpenCL buffer object to the OpenCL image object in @ref CLGEMMMatrixMultiplyReshapedKernel and @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel.
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100500 - This support allows to export the OpenCL buffer used for the reshaped RHS matrix to the OpenCL image object.
501 - The padding requirement for the OpenCL image object is considered into the @ref CLGEMMReshapeRHSMatrixKernel.
502 - The reshaped RHS matrix stores the weights when GEMM is used to accelerate @ref CLGEMMConvolutionLayer.
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100503
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000504v20.05 Public major release
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000505 - Various bug fixes.
506 - Various optimisations.
Michele Di Giorgio36a551f2020-04-23 11:55:29 +0100507 - Updated recommended NDK version to r18b.
508 - Updated recommended gcc version to Linaro 6.3.1.
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000509 - Added Bfloat16 type support
510 - Added Bfloat16 support in:
511 - @ref NEWeightsReshapeKernel
512 - @ref NEConvolutionLayerReshapeWeights
513 - @ref NEIm2ColKernel
Georgios Pinitasf7c5a412020-12-03 14:38:33 +0000514 - NEIm2Col
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000515 - @ref NEDepthConvertLayerKernel
516 - @ref NEDepthConvertLayer
517 - @ref NEGEMMConvolutionLayer
Georgios Pinitasec2256b2020-12-03 18:51:58 +0000518 - NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000519 - Added new data type QASYMM8_SIGNED support for:
520 - @ref CLDirectConvolutionLayer
521 - @ref CLDeconvolutionLayer
522 - @ref CLDirectDeconvolutionLayer
523 - @ref CLGEMMDeconvolutionLayer
524 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
525 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
526 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
527 - @ref CLReductionOperation
528 - @ref CLReduceMean
Sheri Zhang359c48e2020-04-30 22:53:39 +0100529 - @ref NEScale
530 - @ref NEScaleKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000531 - NEUpsampleLayer
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000532 - @ref NECast
533 - @ref NEReductionOperation
534 - @ref NEReduceMean
535 - @ref NEArgMinMaxLayer
536 - @ref NEDeconvolutionLayer
537 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
538 - @ref CPPBoxWithNonMaximaSuppressionLimit
539 - @ref CPPDetectionPostProcessLayer
540 - @ref CPPPermuteKernel
541 - @ref CPPPermute
542 - @ref CPPTopKVKernel
543 - @ref CPPTopKV
Sheri Zhang359c48e2020-04-30 22:53:39 +0100544 - @ref CPPUpsample
545 - @ref CPPUpsampleKernel
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100546 - New OpenCL kernels / functions:
547 - @ref CLQLSTMLayer
548 - @ref CLQLSTMLayerNormalizationKernel
549 - New NEON kernels / functions:
550 - @ref NEQLSTMLayer
551 - @ref NEQLSTMLayerNormalizationKernel
552 - Added HARD_SWISH support in:
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000553 - CLActivationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000554 - NEActivationLayerKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000555 - Deprecated OpenCL kernels / functions:
556 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
557 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
558 - Deprecated NEON kernels / functions:
559 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
560 - Removed CPP kernels / functions:
561 - CPPFlipWeightsKernel
Manuel Bottini387259a2020-05-21 17:14:36 +0100562 - Removed PoolingLayerInfo constructors without Data Layout.
563 - Removed CLDepthwiseConvolutionLayer3x3
564 - Removed NEDepthwiseConvolutionLayerOptimized
Manuel Bottini075253a2020-05-22 12:57:18 +0100565 - Added support for Winograd 3x3,4x4 on NEON FP16:
566 - @ref NEWinogradConvolutionLayer
567 - @ref NEWinogradLayerTransformInputKernel
568 - @ref NEWinogradLayerTransformOutputKernel
569 - @ref NEWinogradLayerTransformWeightsKernel
570 - Added CLCompileContext
571 - Added NEON GEMM kernel with 2D window support
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000572
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000573v20.02.1 Maintenance release
574 - Added Android-NN build script.
575
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000576v20.02 Public major release
577 - Various bug fixes.
578 - Various optimisations.
579 - Added new data type QASYMM8_SIGNED support for:
580 - @ref CLDepthwiseConvolutionLayer
Manuel Bottini387259a2020-05-21 17:14:36 +0100581 - CLDepthwiseConvolutionLayer3x3
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000582 - @ref CLGEMMConvolutionLayer
583 - @ref CLGEMMLowpMatrixMultiplyCore
584 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
585 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
586 - @ref NEActivationLayer
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000587 - NEComparisonOperationKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000588 - @ref NEConvolutionLayer
589 - @ref NEDepthwiseConvolutionLayer
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100590 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000591 - @ref NEDirectConvolutionLayerOutputStageKernel
592 - @ref NEElementwiseComparison
593 - @ref NEElementwiseMax
594 - @ref NEElementwiseMin
595 - @ref NEElementwiseSquaredDiff
596 - @ref NEFullyConnectedLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +0100597 - NEGEMMMatrixVectorMultiplyKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000598 - @ref NEPixelWiseMultiplication
599 - @ref NEPoolingLayer
600 - @ref NEPReluLayer
601 - Added support for QSYMM8_PER_CHANNEL in:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100602 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000603 - Added support for split sizes in:
604 - @ref CLSplit
605 - @ref NESplit
606 - New OpenCL kernels / functions:
607 - @ref CLFill
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100608 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000609 - New NEON kernels / functions:
610 - @ref NEFill
611 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
612 - Deprecated NEON functions / interfaces:
Manuel Bottini387259a2020-05-21 17:14:36 +0100613 - CLDepthwiseConvolutionLayer3x3
614 - NEDepthwiseConvolutionLayerOptimized
615 - PoolingLayerInfo constructors without Data Layout.
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000616 - Added support for quantization with multiplier greater than 1 on NEON and CL.
617 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
618 - Added the ability to build bootcode for bare metal.
619 - Added support for generating synthetic QASYMM8 graphs.
620 - Added support for F16 datatype in VGG16.
621 - Removed pre-built binaries for GLES.
622
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000623v19.11.1 Public maintenance release
624 - Fix offset calculation in NEReductionOperationKernel.
625 - Fix data layout in NEScaleKernel for nhwc.
626 - Retain configuration step data layout to avoid side-effects.
627 - Perform sqrt in double domain for L2 pooling.
628 - Fix output shape calculation for Reduce Mean
629 - Restrict cases where optimized NEPadLayer runs.
630
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100631v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000632 - Various bug fixes.
633 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000634 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000635 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100636 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
637 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000638 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100639 - CLDepthwiseVectorToTensorKernel
640 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000641 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100642 - NEDepthwiseWeightsReshapeKernel
643 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000644 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100645 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100646 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000647 - New OpenCL kernels / functions:
648 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
649 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
650 OpenCL kernels / functions)
651 - @ref CLLogSoftmaxLayer
652 - New NEON kernels / functions:
653 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
Georgios Pinitas8c3c0e72020-12-03 20:11:53 +0000654 - @ref NEComputeAllAnchorsKernel / NEComputeAllAnchors
SiCong Lica1f98c2019-11-28 11:06:11 +0000655 - @ref NEDetectionPostProcessLayer
656 - @ref NEGenerateProposalsLayer
657 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
658 - @ref NELogSoftmaxLayer
659 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
660 - Added QASYMM8 support for:
661 - @ref CLGenerateProposalsLayer
662 - @ref CLROIAlignLayer
663 - @ref CPPBoxWithNonMaximaSuppressionLimit
664 - Added QASYMM16 support for:
665 - @ref CLBoundingBoxTransform
666 - Added FP16 support for:
667 - @ref CLGEMMMatrixMultiplyReshapedKernel
668 - Added new data type QASYMM8_PER_CHANNEL support for:
669 - @ref CLDequantizationLayer
670 - @ref NEDequantizationLayer
671 - Added new data type QSYMM8_PER_CHANNEL support for:
672 - @ref CLConvolutionLayer
673 - @ref NEConvolutionLayer
674 - @ref CLDepthwiseConvolutionLayer
675 - @ref NEDepthwiseConvolutionLayer
676 - Added FP16 mixed-precision support for:
677 - @ref CLGEMMMatrixMultiplyReshapedKernel
Michele Di Giorgioe1314662021-02-01 17:09:32 +0000678 - CLPoolingLayerKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000679 - Added FP32 and FP16 ELU activation for:
680 - @ref CLActivationLayer
681 - @ref NEActivationLayer
682 - Added asymmetric padding support for:
683 - @ref CLDirectDeconvolutionLayer
684 - @ref CLGEMMDeconvolutionLayer
685 - @ref NEDeconvolutionLayer
686 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000687 - Replaced the calls to NECopyKernel and NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
688 - Replaced the calls to CLCopyKernel and CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
SiCong Lica1f98c2019-11-28 11:06:11 +0000689 - Improved performance for CL Inception V3 - FP16.
690 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
691 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
692 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
693 - Optimized @ref CLPadLayer.
694 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
695 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100696
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000697v19.08.1 Public maintenance release
698 - Fix offset calculation in NEReductionOperationKernel.
699 - Fix data layout in NEScaleKernel for nhwc.
700 - Retain configuration step data layout to avoid side-effects.
701 - Perform sqrt in double domain for L2 pooling.
702 - Fix output shape calculation for Reduce Mean
703 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
704
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100705v19.08 Public major release
706 - Various bug fixes.
707 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100708 - Deprecated NEON functions
709 - NEDepthConcatenateLayer
710 - NEWidthConcatenateLayer
711 - Deprecated OpenCL kernels / functions
712 - CLDepthConcatenateLayer
713 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
714 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
715 - CLWidthConcatenateLayer
716 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100717 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100718 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100719 - @ref NEElementwisePower
720 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100721 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100722 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100723 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100724 - @ref NESinLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000725 - NEBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100726 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
727 - @ref NEDepthwiseConvolutionLayerNativeKernel
728 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
729 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
730 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
731 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100732 - @ref CLAbsLayer
733 - @ref CLElementwisePower
734 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100735 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100736 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100737 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100738 - @ref CLSinLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000739 - CLBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100740 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
741 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100742 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100743 - @ref CLGEMMMatrixMultiplyNativeKernel
744 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
745 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
746 - New examples:
747 - neon_opticalflow
748 - cl_cache
749 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100750 - Added support for FP16 in @ref NEDeconvolutionLayer
751 - Added support for FP16 in @ref CLDeconvolutionLayer
752 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100753 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
754 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
755 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
756 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
757 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
758 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini387259a2020-05-21 17:14:36 +0100759 - The CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
760 - The NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100761 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
762 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100763 - Optimized the NEON assembly kernel for GEMMLowp. The new implementation fuses the output stage and quantization with the matrix multiplication kernel
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100764
Michalis Spyroua9c44722019-04-05 17:18:36 +0100765v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100766 - Various bug fixes.
767 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100768 - New Neon kernels / functions:
769 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100770 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100771 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100772 - @ref NEDepthwiseConvolutionAssemblyDispatch
773 - @ref NEFFTDigitReverseKernel
774 - @ref NEFFTRadixStageKernel
775 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100776 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000777 - NEHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100778 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100779 - @ref NEFFT1D
780 - @ref NEFFT2D
781 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100782 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100783 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Sheri Zhang7e20e292021-02-02 11:49:34 +0000784 - CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100785 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100786 - @ref CLFFTDigitReverseKernel
787 - @ref CLFFTRadixStageKernel
788 - @ref CLFFTScaleKernel
789 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
790 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000791 - CLHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100792 - @ref CLDirectDeconvolutionLayer
793 - @ref CLFFT1D
794 - @ref CLFFT2D
795 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100796 - @ref CLGEMMDeconvolutionLayer
797 - New OpenGLES kernels / functions:
798 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100799 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100800 - GCDepthConcatenateLayer
801 - NEWidthConcatenateLayer
802 - NEDepthConcatenateLayer
803 - CLWidthConcatenateLayer
804 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100805 - CLGEMMInterleave4x4
806 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100807 - Support different quantization info in CLConcatLayer.
808 - Add checks on different input/output quantization info were not supported.
809 - Tensors have different quantization information.
810 - Add FP16 support checks.
811 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
812 - New graph examples:
813 - graph_convolution
814 - graph_fully_connected
815 - graph_depthwise_convolution
816 - Deepspeech v0.4.1
817 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
818 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
819 - Add support for QASYMM8 NEDeconvolution.
820 - Add support for DequantizationLayer for NEON/CL.
821 - Add support for dilation in CLDepthwiseConvolution.
822 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
823 - Optimize CLDeconvolution.
824 - Add StackLayer to the graph API.
825 - Add support for "reflect" padding mode in NEPad.
826 - Winograd 7x7 NHWC on OpenCL.
827 - Rework CL ML layers to run exclusively on CL.
828 - Support different quantization info in PoolingLayer.
829 - Implement and test import memory interfaces.
830 - Added new tests and removed old ones.
831 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100832
giuros01a69a88b2019-01-31 16:29:19 +0000833v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000834 - Various bug fixes.
835 - Various optimisations.
836 - New Neon kernels / functions:
837 - @ref NETileKernel / @ref NETile
838 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000839 - NEElementwiseOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000840 - @ref NEElementwiseMax
841 - @ref NEElementwiseMin
842 - @ref NEElementwiseSquaredDiff
843 - @ref NESelectKernel / @ref NESelect
844 - @ref NESplit
845 - @ref NESlice
846 - @ref NEUnstack
847 - @ref NEStridedSliceKernel / @ref NEStridedSlice
Sang-Hoon Park7249f152021-01-22 11:55:03 +0000848 - NEElementwiseUnaryKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000849 - @ref NERsqrtLayer
850 - @ref NEExpLayer
851 - @ref NEReverseKernel / @ref NEReverse
852 - @ref NEArgMinMaxLayer
853 - @ref NEStackLayerKernel / @ref NEStackLayer
854 - @ref NERangeKernel / @ref NERange
855 - @ref NEPadLayer
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000856 - NEMemsetKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000857 - @ref NEGatherKernel / @ref NEGather
858 - @ref NEElementwiseComparison
859 - @ref NEElementwiseComparisonStatic
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000860 - NEComparisonOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000861 - @ref NEElementwiseDivision
862 - New OpenCL kernels / functions:
863 - @ref CLSelectKernel / @ref CLSelect
864 - @ref CLTileKernel / @ref CLTile
865 - @ref CLComparisonKernel / @ref CLComparison
866 - @ref CLArgMinMaxLayer
867 - @ref CLElementwiseMax
868 - @ref CLElementwiseMin
869 - @ref CLElementwiseSquaredDiff
870 - @ref CLStackLayerKernel / @ref CLStackLayer
871 - @ref CLReverse / @ref CLReverseKernel
872 - @ref CLRsqrtLayer
873 - @ref CLExpLayer
Michele Di Giorgioc9c89052021-01-26 10:20:17 +0000874 - CLElementWiseUnaryLayerKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000875 - @ref CLGEMMReshapeLHSMatrixKernel
876 - @ref CLGEMMReshapeRHSMatrixKernel
877 - @ref CLGEMMMatrixMultiplyReshapedKernel
878 - @ref CLRangeKernel / @ref CLRange
879 - @ref CLUnstack
880 - @ref CLGatherKernel / @ref CLGather
881 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
882 - New CPP kernels / functions:
883 - @ref CPPDetectionOutputLayer
884 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000885 - Added new examples:
886 - graph_ssd_mobilenet.cpp
887 - graph_mobilenet_v2.cpp
888 - graph_resnet12.cpp
889 - graph_srcnn955.cpp
890 - graph_vgg_vdsr.cpp
891 - graph_inception_resnet_v1.cpp
892 - Add 4D tensors support to
893 - @ref NESoftmaxLayer
894 - Fused activation in @ref CLWinogradConvolutionLayer
895 - Extented @ref NEPermute to support more cases
896 - Added NEON/SVE GEMM Hybrid kernels
897 - Added u8 and s8 hybrid assembly kernels
898 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
899 - Improved @ref CLTuner
900 - Fused the bias addition within @ref CLGEMM
901 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
902 - Added NHWC data layout support to:
903 - @ref NEScale for F16
904 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
905 - @ref NEL2NormalizeLayer for FP32/FP16
906 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
907 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000908 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000909 - Added QASYMM8 support to the following kernels:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000910 - NEArithmeticAdditionKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000911 - @ref NEScale
912 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000913 - Deprecated functions/interfaces
914 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
915
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000916v18.11 Public major release
917 - Various bug fixes.
918 - Various optimisations.
919 - New Neon kernels / functions:
920 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
921 - @ref NEReduceMean
922 - @ref NEReorgLayer / @ref NEReorgLayerKernel
923 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000924 - NEUpsampleLayer / NEUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000925 - NEYOLOLayer / NEYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000926 - New OpenCL kernels / functions:
927 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
928 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000929 - @ref CLComputeAllAnchorsKernel
930 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000931 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
932 - @ref CLReorgLayer / @ref CLReorgLayerKernel
933 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
934 - @ref CLPadLayer
935 - @ref CLReduceMean
936 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
937 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
938 - @ref CLSlice
939 - @ref CLSplit
940 - @ref CLStridedSlice / @ref CLStridedSliceKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000941 - CLUpsampleLayer / CLUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000942 - CLYOLOLayer / CLYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000943 - New CPP kernels / functions:
944 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
945 - Added the validate method in:
946 - @ref NEDepthConvertLayer
947 - @ref NEFloor / @ref CLFloor
948 - @ref NEGEMMMatrixAdditionKernel
949 - @ref NEReshapeLayer / @ref CLReshapeLayer
950 - @ref CLScale
951 - Added new examples:
952 - graph_shufflenet.cpp
953 - graph_yolov3.cpp
954 - Added documentation for add a new function or kernel.
955 - Improved doxygen documentation adding a list of the existing functions.
956 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100957 - CLWidthConcatenateLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +0000958 - CLFlattenLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000959 - @ref CLSoftmaxLayer
960 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
961 - Add SVE support
962 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
963 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
964 - Added NHWC data layout support to:
965 - @ref CLChannelShuffleLayer
966 - @ref CLDeconvolutionLayer
967 - @ref CLL2NormalizeLayer
968 - Added QASYMM8 support to the following kernels:
969 - @ref CLScaleKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100970 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000971 - @ref CLPixelWiseMultiplicationKernel
972 - Added FP16 support to the following kernels:
973 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100974 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000975 - @ref CLNormalizePlanarYUVLayerKernel
976 - @ref CLWinogradConvolutionLayer (5x5 kernel)
977 - More tests added to both validation and benchmarking suites.
978
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100979v18.08 Public major release
980 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100981 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100982 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100983 - Removed support for QS8/QS16 data types.
984 - Added support for grouped convolution in @ref CLConvolutionLayer.
985 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100986 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100987 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
988 - @ref CLDepthwiseConvolutionLayer
989 - @ref CLDirectConvolutionLayer
990 - @ref CLConvolutionLayer
991 - @ref CLScale
992 - @ref CLIm2ColKernel
993 - New Neon kernels / functions:
994 - @ref NERNNLayer
995 - New OpenCL kernels / functions:
996 - @ref CLArithmeticDivision
997 - Introduced prepare() stage support in the graph API for GLES.
998 - Added support for memory reusage when trying to allocate smaller CLTensors.
999 - Enabled NHWC execution on graph examples.
1000 - Added JPEG accessor for validation purposes.
1001 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001002
1003v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001004 - Various bug fixes.
1005 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001006 - Major redesign in the interface for the neon kernels implemented in assembly.
1007 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
1008 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
1009 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001010 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
1011 - Improved doxygen documentation.
1012 - Improved memory management for layer's transitions.
1013 - Added support for NHWC data layout in tensors.
1014 - Added NHWC data layout support to:
1015 - @ref NEGEMMConvolutionLayer
1016 - @ref NEDirectConvolutionLayer
1017 - @ref NEPoolingLayer / @ref CLPoolingLayer
1018 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
1019 - @ref NEDepthwiseConvolutionLayer
1020 - @ref NEScale
Georgios Pinitasf7c5a412020-12-03 14:38:33 +00001021 - NEIm2Col
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001022 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
1023 - New OpenCL kernels / functions:
1024 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
1025 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
Sheri Zhang7e20e292021-02-02 11:49:34 +00001026 - @ref CLCopy / CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001027 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001028 - @ref CLRNNLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001029 - CLWidthConcatenateLayer / CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001030 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
1031 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
1032 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001033 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
1034 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
1035 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
1036 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
1037 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
1038 - Port mobilenet example to NHWC data layout.
1039 - Enabled Winograd method in @ref CLConvolutionLayer.
1040 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
1041 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
1042 - Added memory manager support in GLES functions.
1043 - Major refactoring of the graph API.
1044 - Added GLES backend in the graph API.
1045 - Added support for the memory manager in the graph API.
1046 - Enabled Winograd Convolution method in the graph API.
1047 - Added support for grouped convolutions in the graph API.
1048 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
1049 - Added fast maths flag in @ref CLConvolutionLayer.
1050 - Added new tests and benchmarks in validation and benchmark frameworks
1051 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
1052 - Added support to OpenCL 2.0 SVM
1053 - Added support to import memory in OpenCL tensors.
1054 - Added the prepare() method to perform any one off pre-processing before running the function.
1055 - Added new examples:
1056 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001057 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001058 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001059
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001060v18.03 Public maintenance release
1061 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +00001062 - Fixed bug in @ref NEActivationLayer
1063 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001064 - Updated recommended NDK version to r16b (And fixed warnings).
1065 - Fixed bug in validation code.
1066 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001067 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001068
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001069v18.02 Public major release
1070 - Various NEON / OpenCL / GLES optimisations.
1071 - Various bug fixes.
1072 - Changed default number of threads on big LITTLE systems.
1073 - Refactored examples and added:
1074 - graph_mobilenet_qassym8
1075 - graph_resnet
1076 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +00001077 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
1078 - Renamed @ref NEConvolutionLayer into @ref NEGEMMConvolutionLayer and created a new @ref NEConvolutionLayer to select the fastest convolution method.
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001079 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001080 - @ref CLActivationLayer
1081 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001082 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001083 - @ref CLActivationLayer
1084 - @ref CLDepthwiseConvolutionLayer
1085 - @ref NEDepthwiseConvolutionLayer
1086 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001087 - Added FP16 support to:
Manuel Bottini387259a2020-05-21 17:14:36 +01001088 - CLDepthwiseConvolutionLayer3x3
Anthony Barbier3762e742018-03-02 11:49:33 +00001089 - @ref CLDepthwiseConvolutionLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001090 - Added broadcasting support to NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
Anthony Barbier3762e742018-03-02 11:49:33 +00001091 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
1092 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001093 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +01001094 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +00001095 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001096 - Added name() method to all kernels.
1097 - Added support for Winograd 5x5.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001098 - NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001099 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
1100 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
1101 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +01001102 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001103 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001104 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +00001105
Anthony Barbier64c95a02018-01-22 18:48:55 +00001106v18.01 Public maintenance release
1107 - Various bug fixes
1108 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +00001109 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
Sheri Zhang7e20e292021-02-02 11:49:34 +00001110 - Added CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +00001111 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +00001112 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
1113 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
1114 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
1115 - Added @ref GCScaleKernel / @ref GCScale
1116 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +00001117 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001118 - @ref GCCol2ImKernel
1119 - @ref GCGEMMInterleave4x4Kernel
1120 - @ref GCGEMMTranspose1xWKernel
1121 - @ref GCIm2ColKernel
1122 - Refactored NEON Winograd (NEWinogradLayerKernel)
1123 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001124 - Added QASYMM8 support to the following NEON kernels:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001125 - NEDepthwiseConvolutionLayer3x3Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001126 - @ref NEFillBorderKernel
Michele Di Giorgio19289042021-02-03 16:05:00 +00001127 - NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001128 - Added new examples:
1129 - graph_cl_mobilenet_qasymm8.cpp
1130 - graph_inception_v3.cpp
1131 - gc_dc.cpp
1132 - More tests added to both validation and benchmarking suites.
1133
Gian Marcoff850932017-12-11 12:37:17 +00001134v17.12 Public major release
1135 - Most machine learning functions on OpenCL support the new data type QASYMM8
1136 - Introduced logging interface
1137 - Introduced opencl timer
1138 - Reworked GEMMLowp interface
1139 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
1140 - Added validation method for most Machine Learning kernels / functions
1141 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
1142 - Added sgemm example for OpenCL
1143 - Added absolute difference example for GLES compute
1144 - Added new tests and benchmarks in validation and benchmark frameworks
1145 - Added new kernels / functions for GLES compute
1146
1147 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001148 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
1149 - @ref GCActivationLayerKernel / @ref GCActivationLayer
1150 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
1151 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +01001152 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001153 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
1154 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
1155 - @ref GCFillBorderKernel / @ref GCFillBorder
1156 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
1157 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
1158 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
1159 - @ref GCIm2ColKernel
1160 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
1161 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
1162 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
1163 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
1164 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +00001165
1166 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +00001167 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
1168 - arm_compute::NEHGEMMAArch64FP16Kernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001169 - NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001170 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
1171 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001172 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +00001173
1174 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001175 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
Michele Di Giorgioba14c922020-10-12 13:27:57 +01001176 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +00001177
1178 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001179 - graph::BranchLayer
1180 - graph::DepthConvertLayer
1181 - graph::DepthwiseConvolutionLayer
1182 - graph::DequantizationLayer
1183 - graph::FlattenLayer
1184 - graph::QuantizationLayer
1185 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +00001186
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001187v17.10 Public maintenance release
1188 - Bug fixes:
1189 - Check the maximum local workgroup size supported by OpenCL devices
1190 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +00001191 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001192 - Added a few new Graph nodes, support for branches and grouping.
1193 - Automatically enable cl_printf in debug builds
1194 - Fixed bare metal builds for armv7a
1195 - Added AlexNet and cartoon effect examples
1196 - Fixed library builds: libraries are no longer built as supersets of each other.(It means application using the Runtime part of the library now need to link against both libarm_compute_core and libarm_compute)
1197
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001198v17.09 Public major release
1199 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +00001200 - Memory Manager (@ref BlobLifetimeManager, @ref BlobMemoryPool, @ref ILifetimeManager, @ref IMemoryGroup, @ref IMemoryManager, @ref IMemoryPool, @ref IPoolManager, @ref MemoryManagerOnDemand, @ref PoolManager)
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001201 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
1202 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
1203 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +00001204 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001205 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
Georgios Pinitas70eb53b2021-01-06 19:42:21 +00001206 - NEFloorKernel / @ref NEFloor
Anthony Barbier3762e742018-03-02 11:49:33 +00001207 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
1208 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
1209 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
1210 - @ref NEReductionOperationKernel / @ref NEReductionOperation
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001211 - NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001212
1213 - New OpenCL kernels / functions:
Manuel Bottini387259a2020-05-21 17:14:36 +01001214 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001215 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
1216 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +00001217 - CLFlattenLayer
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001218 - CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001219 - CLGEMMTranspose1xW
Michele Di Giorgioee82d342021-01-05 16:14:28 +00001220 - CLGEMMMatrixVectorMultiplyKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001221 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
1222 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
1223 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
1224 - @ref CLReductionOperationKernel / @ref CLReductionOperation
Sheri Zhang7e20e292021-02-02 11:49:34 +00001225 - CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001226
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001227v17.06 Public major release
1228 - Various bug fixes
1229 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
1230 - Added unit tests and benchmarks (AlexNet, LeNet)
1231 - Added support for sub tensors.
1232 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +00001233 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
1234 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
1235 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001236 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001237 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001238 - CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001239 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001240 - CLLocallyConnectedMatrixMultiplyKernel / CLLocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001241 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001242 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001243 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001244 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001245 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001246 - NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001247 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001248 - NELocallyConnectedMatrixMultiplyKernel / NELocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001249 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001250
1251v17.05 Public bug fixes release
1252 - Various bug fixes
1253 - Remaining of the functions ported to use accurate padding.
1254 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
1255 - Added "free" method to allocator.
1256 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
1257
1258v17.04 Public bug fixes release
1259
1260 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +00001261 - @ref CLColorConvertKernel
1262 - @ref CLEdgeNonMaxSuppressionKernel
1263 - @ref CLEdgeTraceKernel
1264 - @ref CLGaussianPyramidHorKernel
1265 - @ref CLGaussianPyramidVertKernel
1266 - @ref CLGradientKernel
1267 - @ref NEChannelCombineKernel
1268 - @ref NEFillArrayKernel
1269 - @ref NEGaussianPyramidHorKernel
1270 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +01001271 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001272 - @ref NEHarrisScoreKernel
1273 - @ref NEHOGDetectorKernel
Michalis Spyrou373b4072021-01-20 16:41:12 +00001274 - NELogits1DMaxKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001275 - NELogits1DShiftExpSumKernel
1276 - NELogits1DNormKernel
1277 - @ref NENonMaximaSuppression3x3FP16Kernel
1278 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001279
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001280v17.03.1 First Major public release of the sources
1281 - Renamed the library to arm_compute
1282 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
1283 - New padding calculation interface introduced and ported most kernels / functions to use it.
1284 - New OpenCL kernels / functions:
Gian Marco Iodiceeb65f6d2020-04-15 11:42:15 +01001285 - CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001286 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001287 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
1288 - @ref NETransposeKernel / @ref NETranspose
Michalis Spyrou373b4072021-01-20 16:41:12 +00001289 - NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001290 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +01001291 - NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001292 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001293
1294v17.03 Sources preview
1295 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001296 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001297 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001298 - CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001299 - @ref CLTransposeKernel / @ref CLTranspose
1300 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
1301 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
1302 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001303 - New NEON kernels / functions:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001304 - NEActivationLayerKernel / @ref NEActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001305 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
Michele Di Giorgio19289042021-02-03 16:05:00 +00001306 - NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001307
1308v17.02.1 Sources preview
1309 - New OpenCL kernels / functions:
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001310 - CLLogits1DMaxKernel, CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
Michele Di Giorgioe1314662021-02-01 17:09:32 +00001311 - CLPoolingLayerKernel / @ref CLPoolingLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001312 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
1313 - @ref CLRemapKernel / @ref CLRemap
1314 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
1315 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
1316 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001317 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +00001318 - @ref NEAccumulateWeightedFP16Kernel
1319 - @ref NEBox3x3FP16Kernel
1320 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001321
1322v17.02 Sources preview
1323 - New OpenCL kernels / functions:
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001324 - CLActivationLayerKernel / @ref CLActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001325 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1326 - @ref CLDerivativeKernel / @ref CLChannelExtract
1327 - @ref CLFastCornersKernel / @ref CLFastCorners
1328 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001329 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001330 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1331 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001332 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1333 - Switched all the kernels / functions to use tensors instead of images.
1334 - Updated documentation to include instructions to build the library from sources.
1335
1336v16.12 Binary preview release
1337 - Original release
1338
1339@section S3_how_to_build How to build the library and the examples
1340
1341@subsection S3_1_build_options Build options
1342
1343scons 2.3 or above is required to build the library.
1344To see the build options available simply run ```scons -h```:
1345
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001346 debug: Debug (yes|no)
1347 default: False
1348 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001349
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001350 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1351 default: False
1352 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001353
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001354 logging: Logging (this flag is forced to 1 for debug=1) (yes|no)
1355 default: False
1356 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001357
Sang-Hoon Park50e98bb2021-01-14 14:54:14 +00001358 arch: Target Architecture (armv7a|arm64-v8a|arm64-v8.2-a|arm64-v8.2-a-sve|arm64-v8.2-a-sve2|x86_32|x86_64|armv8a|armv8.2-a|armv8.2-a-sve|armv8.6-a|armv8.6-a-sve|armv8.6-a-sve2|armv8r64|x86)
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001359 default: armv7a
1360 actual: armv7a
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001361
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001362 estate: Execution State (auto|32|64)
1363 default: auto
1364 actual: auto
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001365
Georgios Pinitas45514032020-12-30 00:03:09 +00001366 os: Target OS (linux|android|macos|tizen|bare_metal)
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001367 default: linux
1368 actual: linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001369
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001370 build: Build type (native|cross_compile|embed_only)
1371 default: cross_compile
1372 actual: cross_compile
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001373
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001374 examples: Build example programs (yes|no)
1375 default: True
1376 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001377
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001378 gemm_tuner: Build gemm_tuner programs (yes|no)
1379 default: True
1380 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001381
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001382 Werror: Enable/disable the -Werror compilation flag (yes|no)
1383 default: True
1384 actual: True
Anthony Barbier20dbb822017-12-13 21:19:39 +00001385
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001386 standalone: Builds the tests as standalone executables, links statically with libgcc, libstdc++ and libarm_compute (yes|no)
1387 default: False
1388 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001389
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001390 opencl: Enable OpenCL support (yes|no)
1391 default: True
1392 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001393
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001394 neon: Enable Neon support (yes|no)
1395 default: False
1396 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001397
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001398 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1399 default: False
1400 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001401
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001402 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shaders in library binary (yes|no)
1403 default: True
1404 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001405
Georgios Pinitasea857272021-01-22 05:47:37 +00001406 compress_kernels: Compress embedded OpenCL kernels in library binary. Note embed_kernels should be enabled as well (yes|no)
1407 default: False
1408 actual: False
1409
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001410 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1411 default: False
1412 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001413
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001414 tracing: Enable runtime tracing (yes|no)
1415 default: False
1416 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001417
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001418 openmp: Enable OpenMP backend (yes|no)
1419 default: False
1420 actual: False
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001421
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001422 cppthreads: Enable C++11 threads backend (yes|no)
1423 default: True
1424 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001425
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001426 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1427 default: .
1428 actual: .
1429
1430 install_dir: Specify sub-folder for the install ( /path/to/install_dir )
1431 default:
1432 actual:
1433
1434 exceptions: Enable/disable C++ exception support (yes|no)
1435 default: True
1436 actual: True
1437
1438 linker_script: Use an external linker script ( /path/to/linker_script )
1439 default:
1440 actual:
1441
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001442 custom_options: Custom options that can be used to turn on/off features
1443 (all|none|comma-separated list of names)
1444 allowed names: disable_mmla_fp
1445 default: none
1446 actual:
1447
1448 data_type_support: Enable a list of data types to support
1449 (all|none|comma-separated list of names)
1450 allowed names: qasymm8 qasymm8_signed qsymm16 fp16 fp32
1451 default: all
1452 actual: qasymm8 qasymm8_signed qsymm16 fp16 fp32
1453
1454 toolchain_prefix: Override the toolchain prefix
1455 default:
1456 actual:
1457
1458 compiler_prefix: Override the compiler prefix
1459 default:
1460 actual:
1461
1462 extra_cxx_flags: Extra CXX flags to be appended to the build command
1463 default:
1464 actual:
1465
1466 extra_link_flags: Extra LD flags to be appended to the build command
1467 default:
1468 actual:
1469
1470 compiler_cache: Command to prefix to the C and C++ compiler (e.g ccache)
1471 default:
1472 actual:
1473
1474 specs_file: Specs file to use
1475 default: rdimon.specs
1476 actual: rdimon.specs
1477
1478 benchmark_examples: Build benchmark examples programs (yes|no)
1479 default: True
1480 actual: True
1481
1482 validate_examples: Build validate examples programs (yes|no)
1483 default: True
1484 actual: True
1485
1486 reference_openmp: Build reference validation with openmp (yes|no)
1487 default: True
1488 actual: True
1489
1490 validation_tests: Build validation test programs (yes|no)
1491 default: True
1492 actual: True
1493
1494 benchmark_tests: Build benchmark test programs (yes|no)
1495 default: True
1496 actual: True
1497
1498 test_filter: Pattern to specify the tests' filenames to be compiled
1499 default: *.cpp
1500 actual: *.cpp
1501
1502 pmu: Enable PMU counters (yes|no)
1503 default: False
1504 actual: False
1505
1506 mali: Enable Mali hardware counters (yes|no)
1507 default: False
1508 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001509
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001510 external_tests_dir: Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1511 default:
1512 actual:
1513
Anthony Barbier79c61782017-06-23 11:48:24 +01001514@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001515 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1516 - With debug=0 and asserts=1: Optimisations are enabled and symbols are removed, however all the asserts are still present (This is about 20% slower than the release build)
1517 - With debug=0 and asserts=0: All optimisations are enable and no validation is performed, if the application misuses the library it is likely to result in a crash. (Only use this mode once you are sure your application is working as expected).
1518
Anthony Barbier79c61782017-06-23 11:48:24 +01001519@b arch: The x86_32 and x86_64 targets can only be used with neon=0 and opencl=1.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001520
Anthony Barbier79c61782017-06-23 11:48:24 +01001521@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001522@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1523
Anthony Barbier79c61782017-06-23 11:48:24 +01001524@b build: you can either build directly on your device (native) or cross compile from your desktop machine (cross-compile). In both cases make sure the compiler is available in your path.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001525
Anthony Barbier79c61782017-06-23 11:48:24 +01001526@note If you want to natively compile for 32bit on a 64bit ARM device running a 64bit OS then you will have to use cross-compile too.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001527
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001528There is also an 'embed_only' option which will generate all the .embed files for the OpenCL kernels and / or OpenGLES compute shaders. This might be useful if using a different build system to compile the library.
1529
Georgios Pinitasea857272021-01-22 05:47:37 +00001530In addittion the option 'compress_kernels' will compress the embedded OpenCL kernel files using zlib and inject them in the library. This is useful for reducing the binary size. Note, this option is only available for Android when 'embed_kernels' is enabled.
1531
Michele Di Giorgioeca54a02021-02-16 15:37:59 +00001532@b Werror: If you are compiling using the same toolchains as the ones used in this guide then there shouldn't be any warning and therefore you should be able to keep Werror=1. If with a different compiler version the library fails to build because of warnings interpreted as errors then, if you are sure the warnings are not important, you might want to try to build with Werror=0 (But please do report the issue on Github).
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001533
Anthony Barbier20dbb822017-12-13 21:19:39 +00001534@b opencl / @b neon / @b gles_compute: Choose which SIMD technology you want to target. (NEON for ARM Cortex-A CPUs or OpenCL / GLES_COMPUTE for ARM Mali GPUs)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001535
Anthony Barbier20dbb822017-12-13 21:19:39 +00001536@b embed_kernels: For OpenCL / GLES_COMPUTE only: set embed_kernels=1 if you want the OpenCL / GLES_COMPUTE kernels to be built in the library's binaries instead of being read from separate ".cl" / ".cs" files. If embed_kernels is set to 0 then the application can set the path to the folder containing the OpenCL / GLES_COMPUTE kernel files by calling CLKernelLibrary::init() / GCKernelLibrary::init(). By default the path is set to "./cl_kernels" / "./cs_shaders".
Anthony Barbier79c61782017-06-23 11:48:24 +01001537
1538@b set_soname: Do you want to build the versioned version of the library ?
1539
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001540If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1541Example:
1542 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1543 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1544 libarm_compute_core.so.1.0.0
1545
1546@note This options is disabled by default as it requires SCons version 2.4 or above.
1547
Anthony Barbier79c61782017-06-23 11:48:24 +01001548@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1549
1550@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1551
1552@b examples: Build or not the examples
1553
1554@b validation_tests: Enable the build of the validation suite.
1555
Anthony Barbier79c61782017-06-23 11:48:24 +01001556@b benchmark_tests: Enable the build of the benchmark tests
1557
1558@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1559
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001560@b mali: Enable the collection of Mali hardware counters to measure execution time in benchmark tests. (Your device needs to have a Mali driver that supports it)
1561
Anthony Barbier79c61782017-06-23 11:48:24 +01001562@b openmp Build in the OpenMP scheduler for NEON.
1563
1564@note Only works when building with g++ not clang++
1565
1566@b cppthreads Build in the C++11 scheduler for NEON.
1567
Anthony Barbier3762e742018-03-02 11:49:33 +00001568@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001569
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001570@b external_tests_dir Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1571
1572In order to use this option, the external tests directory must have the following structure:
1573
1574 EXTERNAL_TESTS_DIR:
1575 └── tests
1576 ├── benchmark
1577 │   ├── CL
1578 │   ├── datasets
1579 │   ├── fixtures
1580 │   └── NEON
1581 └── validation
1582    ├── CL
1583     ├── datasets
1584     ├── fixtures
1585     └── NEON
1586
1587Then, build the library with `external_tests_dir=<PATH_TO_EXTERNAL_TESTS_DIR>`.
1588
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001589@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001590
1591@subsubsection S3_2_1_library How to build the library ?
1592
1593For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1594
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001595 - gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
1596 - gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001597
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001598To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1599
1600 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1601
1602To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1603
1604 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1605
Anthony Barbier20dbb822017-12-13 21:19:39 +00001606To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1607
1608 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1609
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001610You can also compile the library natively on an ARM device by using <b>build=native</b>:
1611
1612 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1613 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1614
1615@note g++ for ARM is mono-arch, therefore if you want to compile for Linux 32bit on a Linux 64bit platform you will have to use a cross compiler.
1616
1617For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1618
1619 apt-get install g++-arm-linux-gnueabihf
1620
1621Then run
1622
1623 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1624
1625or simply remove the build parameter as build=cross_compile is the default value:
1626
1627 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1628
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001629@subsubsection S3_2_2_examples How to manually build the examples ?
1630
1631The examples get automatically built by scons as part of the build process of the library described above. This section just describes how you can build and link your own application against our library.
1632
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001633@note The following command lines assume the arm_compute libraries are present in the current directory or in the system library path. If this is not the case you can specify the location of the pre-built libraries with the compiler option -L. When building the OpenCL example the commands below assume that the CL headers are located in the include folder where the command is executed.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001634
1635To cross compile a NEON example for Linux 32bit:
1636
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001637 arm-linux-gnueabihf-g++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -mfpu=neon -L. -larm_compute -larm_compute_core -o neon_convolution
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001638
1639To cross compile a NEON example for Linux 64bit:
1640
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001641 aarch64-linux-gnu-g++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -L. -larm_compute -larm_compute_core -o neon_convolution
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001642
1643(notice the only difference with the 32 bit command is that we don't need the -mfpu option and the compiler's name is different)
1644
1645To cross compile an OpenCL example for Linux 32bit:
1646
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001647 arm-linux-gnueabihf-g++ examples/cl_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -mfpu=neon -L. -larm_compute -larm_compute_core -o cl_convolution -DARM_COMPUTE_CL
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001648
1649To cross compile an OpenCL example for Linux 64bit:
1650
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001651 aarch64-linux-gnu-g++ examples/cl_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -L. -larm_compute -larm_compute_core -o cl_convolution -DARM_COMPUTE_CL
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001652
Anthony Barbier14c86a92017-12-14 16:27:41 +00001653To cross compile a GLES example for Linux 32bit:
1654
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001655 arm-linux-gnueabihf-g++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude/ -L. -larm_compute -larm_compute_core -std=c++14 -mfpu=neon -DARM_COMPUTE_GC -Iinclude/linux/ -o gc_absdiff
Anthony Barbier14c86a92017-12-14 16:27:41 +00001656
1657To cross compile a GLES example for Linux 64bit:
1658
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001659 aarch64-linux-gnu-g++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude/ -L. -larm_compute -larm_compute_core -std=c++14 -DARM_COMPUTE_GC -Iinclude/linux/ -o gc_absdiff
Anthony Barbier14c86a92017-12-14 16:27:41 +00001660
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001661(notice the only difference with the 32 bit command is that we don't need the -mfpu option and the compiler's name is different)
1662
Anthony Barbier14c86a92017-12-14 16:27:41 +00001663To cross compile the examples with the Graph API, such as graph_lenet.cpp, you need to link the examples against arm_compute_graph.so too.
1664
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001665i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1666
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001667 arm-linux-gnueabihf-g++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++14 -mfpu=neon -L. -larm_compute_graph -larm_compute -larm_compute_core -Wl,--allow-shlib-undefined -o graph_lenet
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001668
1669i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1670
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001671 aarch64-linux-gnu-g++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++14 -L. -larm_compute_graph -larm_compute -larm_compute_core -Wl,--allow-shlib-undefined -o graph_lenet
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001672
1673(notice the only difference with the 32 bit command is that we don't need the -mfpu option and the compiler's name is different)
1674
Anthony Barbiere5007472017-10-27 15:01:44 +01001675@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1676
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001677To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1678
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001679 g++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -mfpu=neon -larm_compute -larm_compute_core -o neon_convolution
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001680
1681To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1682
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001683 g++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -larm_compute -larm_compute_core -o neon_convolution
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001684
1685(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1686
1687To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1688
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001689 g++ examples/cl_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -larm_compute -larm_compute_core -o cl_convolution -DARM_COMPUTE_CL
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001690
Anthony Barbier14c86a92017-12-14 16:27:41 +00001691To compile natively (i.e directly on an ARM device) for GLES for Linux 32bit or Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001692
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001693 g++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude/ -L. -larm_compute -larm_compute_core -std=c++14 -DARM_COMPUTE_GC -Iinclude/linux/ -o gc_absdiff
Anthony Barbier14c86a92017-12-14 16:27:41 +00001694
1695To compile natively the examples with the Graph API, such as graph_lenet.cpp, you need to link the examples against arm_compute_graph.so too.
Anthony Barbier14c86a92017-12-14 16:27:41 +00001696
1697i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001698
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001699 g++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++14 -mfpu=neon -L. -larm_compute_graph -larm_compute -larm_compute_core -Wl,--allow-shlib-undefined -o graph_lenet
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001700
Anthony Barbier14c86a92017-12-14 16:27:41 +00001701i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001702
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001703 g++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++14 -L. -larm_compute_graph -larm_compute -larm_compute_core -Wl,--allow-shlib-undefined -o graph_lenet
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001704
1705(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001706
Anthony Barbiere5007472017-10-27 15:01:44 +01001707@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1708
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001709@note These two commands assume libarm_compute.so is available in your library path, if not add the path to it using -L (e.g. -Llib/linux-arm64-v8a-neon-cl-asserts/)
Georgios Pinitas58216322020-02-26 11:13:13 +00001710@note You might need to export the path to OpenCL library as well in your LD_LIBRARY_PATH if Compute Library was built with OpenCL enabled.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001711
1712To run the built executable simply run:
1713
1714 LD_LIBRARY_PATH=build ./neon_convolution
1715
1716or
1717
1718 LD_LIBRARY_PATH=build ./cl_convolution
1719
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001720@note Examples accept different types of arguments, to find out what they are run the example with \a --help as an argument. If no arguments are specified then random values will be used to execute the graph.
Anthony Barbier3762e742018-03-02 11:49:33 +00001721
1722For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001723
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001724 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001725
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001726Below is a list of the common parameters among the graph examples :
1727@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001728
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001729@subsubsection S3_2_3_sve Build for SVE or SVE2
1730
1731In order to build for SVE or SVE2 you need a compiler that supports them. You can find more information in the following these links:
1732 -# GCC: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/sve-support
1733 -# LLVM: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/llvm-toolchain/sve-support
1734
1735@note You the need to indicate the toolchains using the scons "toolchain_prefix" parameter.
1736
1737An example build command with SVE is:
1738
1739 scons arch=arm64-v8.2-a-sve os=linux build_dir=arm64 -j55 standalone=0 opencl=0 openmp=0 validation_tests=1 neon=1 cppthreads=1 toolchain_prefix=aarch64-none-linux-gnu-
1740
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001741@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001742
1743For Android, the library was successfully built and tested using Google's standalone toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001744 - clang++ from NDK r18b for armv7a
1745 - clang++ from NDK r18b for arm64-v8a
1746 - clang++ from NDK r18b for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001747
1748Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1749
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001750- Download the NDK r18b from here: https://developer.android.com/ndk/downloads/index.html to directory $NDK
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001751- Make sure you have Python 2.7 installed on your machine.
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001752- Generate the 32 and/or 64 toolchains by running the following commands to your toolchain dirctory $MY_TOOLCHAINS:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001753
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001754
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001755 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b --stl libc++ --api 21
1756 $NDK/build/tools/make_standalone_toolchain.py --arch arm --install-dir $MY_TOOLCHAINS/arm-linux-android-ndk-r18b --stl libc++ --api 21
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001757
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001758@attention We used to use gnustl but as of NDK r17 it is deprecated so we switched to libc++
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001759
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001760@note Make sure to add the toolchains to your PATH:
1761
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001762 export PATH=$PATH:$MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b/bin:$MY_TOOLCHAINS/arm-linux-android-ndk-r18b/bin
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001763
1764@subsubsection S3_3_1_library How to build the library ?
1765
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001766To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1767
1768 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1769
1770To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1771
Anthony Barbier14c86a92017-12-14 16:27:41 +00001772 CXX=clang++ CC=clang scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=android arch=arm64-v8a
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001773
Anthony Barbier20dbb822017-12-13 21:19:39 +00001774To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1775
Anthony Barbier14c86a92017-12-14 16:27:41 +00001776 CXX=clang++ CC=clang scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=android arch=arm64-v8a
Anthony Barbier20dbb822017-12-13 21:19:39 +00001777
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001778@subsubsection S3_3_2_examples How to manually build the examples ?
1779
1780The examples get automatically built by scons as part of the build process of the library described above. This section just describes how you can build and link your own application against our library.
1781
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001782@note The following command lines assume the arm_compute libraries are present in the current directory or in the system library path. If this is not the case you can specify the location of the pre-built libraries with the compiler option -L. When building the OpenCL example the commands below assume that the CL headers are located in the include folder where the command is executed.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001783
1784Once you've got your Android standalone toolchain built and added to your path you can do the following:
1785
1786To cross compile a NEON example:
1787
1788 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001789 arm-linux-androideabi-clang++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -larm_compute-static -larm_compute_core-static -L. -o neon_convolution_arm -static-libstdc++ -pie
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001790 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001791 aarch64-linux-android-clang++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -larm_compute-static -larm_compute_core-static -L. -o neon_convolution_aarch64 -static-libstdc++ -pie
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001792
1793To cross compile an OpenCL example:
1794
1795 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001796 arm-linux-androideabi-clang++ examples/cl_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -larm_compute-static -larm_compute_core-static -L. -o cl_convolution_arm -static-libstdc++ -pie -DARM_COMPUTE_CL
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001797 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001798 aarch64-linux-android-clang++ examples/cl_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -larm_compute-static -larm_compute_core-static -L. -o cl_convolution_aarch64 -static-libstdc++ -pie -DARM_COMPUTE_CL
Anthony Barbier14c86a92017-12-14 16:27:41 +00001799
1800To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001801
Anthony Barbier14c86a92017-12-14 16:27:41 +00001802 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001803 arm-linux-androideabi-clang++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -larm_compute-static -larm_compute_core-static -L. -o gc_absdiff_arm -static-libstdc++ -pie -DARM_COMPUTE_GC
Anthony Barbier14c86a92017-12-14 16:27:41 +00001804 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001805 aarch64-linux-android-clang++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude -std=c++14 -larm_compute-static -larm_compute_core-static -L. -o gc_absdiff_aarch64 -static-libstdc++ -pie -DARM_COMPUTE_GC
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001806
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001807To cross compile the examples with the Graph API, such as graph_lenet.cpp, you need to link the library arm_compute_graph also.
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001808
1809 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001810 arm-linux-androideabi-clang++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++14 -Wl,--whole-archive -larm_compute_graph-static -Wl,--no-whole-archive -larm_compute-static -larm_compute_core-static -L. -o graph_lenet_arm -static-libstdc++ -pie -DARM_COMPUTE_CL
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001811 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001812 aarch64-linux-android-clang++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++14 -Wl,--whole-archive -larm_compute_graph-static -Wl,--no-whole-archive -larm_compute-static -larm_compute_core-static -L. -o graph_lenet_aarch64 -static-libstdc++ -pie -DARM_COMPUTE_CL
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001813
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001814@note Due to some issues in older versions of the Mali OpenCL DDK (<= r13p0), we recommend to link arm_compute statically on Android.
Anthony Barbier20dbb822017-12-13 21:19:39 +00001815@note When linked statically the arm_compute_graph library currently needs the --whole-archive linker flag in order to work properly
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001816
1817Then you need to do is upload the executable and the shared library to the device using ADB:
1818
1819 adb push neon_convolution_arm /data/local/tmp/
1820 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001821 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001822 adb shell chmod 777 -R /data/local/tmp/
1823
1824And finally to run the example:
1825
1826 adb shell /data/local/tmp/neon_convolution_arm
1827 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001828 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001829
1830For 64bit:
1831
1832 adb push neon_convolution_aarch64 /data/local/tmp/
1833 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001834 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001835 adb shell chmod 777 -R /data/local/tmp/
1836
1837And finally to run the example:
1838
1839 adb shell /data/local/tmp/neon_convolution_aarch64
1840 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001841 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001842
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001843@note Examples accept different types of arguments, to find out what they are run the example with \a --help as an argument. If no arguments are specified then random values will be used to execute the graph.
Anthony Barbier3762e742018-03-02 11:49:33 +00001844
1845For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001846 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001847
1848In this case the first argument of LeNet (like all the graph examples) is the target (i.e 0 to run on NEON, 1 to run on OpenCL if available, 2 to run on OpenCL using the CLTuner), the second argument is the path to the folder containing the npy files for the weights and finally the third argument is the number of batches to run.
1849
Georgios Pinitas45514032020-12-30 00:03:09 +00001850@subsection S3_4_macos Building for macOS
1851
1852The library was successfully natively built for Apple Silicon under macOS 11.1 using clang v12.0.0.
1853
1854To natively compile the library with accelerated CPU support:
1855
1856 scons Werror=1 -j8 neon=1 opencl=0 os=macos arch=arm64-v8a build=native
1857
1858@note Initial support disables feature discovery through HWCAPS and thread scheduling affinity controls
1859
1860@subsection S3_5_bare_metal Building for bare metal
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001861
Georgios Pinitas58216322020-02-26 11:13:13 +00001862For bare metal, the library was successfully built using linaro's latest (gcc-linaro-6.3.1-2017.05) bare metal toolchains:
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001863 - arm-eabi for armv7a
1864 - aarch64-elf for arm64-v8a
1865
1866Download linaro for <a href="https://releases.linaro.org/components/toolchain/binaries/6.3-2017.05/arm-eabi/">armv7a</a> and <a href="https://releases.linaro.org/components/toolchain/binaries/6.3-2017.05/aarch64-elf/">arm64-v8a</a>.
1867
1868@note Make sure to add the toolchains to your PATH: export PATH=$PATH:$MY_TOOLCHAINS/gcc-linaro-6.3.1-2017.05-x86_64_aarch64-elf/bin:$MY_TOOLCHAINS/gcc-linaro-6.3.1-2017.05-x86_64_arm-eabi/bin
1869
Georgios Pinitas45514032020-12-30 00:03:09 +00001870@subsubsection S3_5_1_library How to build the library ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001871
1872To cross-compile the library with NEON support for baremetal arm64-v8a:
1873
1874 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=bare_metal arch=arm64-v8a build=cross_compile cppthreads=0 openmp=0 standalone=1
1875
Georgios Pinitas45514032020-12-30 00:03:09 +00001876@subsubsection S3_5_2_examples How to manually build the examples ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001877
1878Examples are disabled when building for bare metal. If you want to build the examples you need to provide a custom bootcode depending on the target architecture and link against the compute library. More information about bare metal bootcode can be found <a href="http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dai0527a/index.html">here</a>.
1879
Georgios Pinitas45514032020-12-30 00:03:09 +00001880@subsection S3_6_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001881
1882Using `scons` directly from the Windows command line is known to cause
1883problems. The reason seems to be that if `scons` is setup for cross-compilation
1884it gets confused about Windows style paths (using backslashes). Thus it is
1885recommended to follow one of the options outlined below.
1886
Georgios Pinitas45514032020-12-30 00:03:09 +00001887@subsubsection S3_6_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001888
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001889The best and easiest option is to use
1890<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001891This feature is still marked as *beta* and thus might not be available.
1892However, if it is building the library is as simple as opening a *Bash on
1893Ubuntu on Windows* shell and following the general guidelines given above.
1894
Georgios Pinitas45514032020-12-30 00:03:09 +00001895@subsubsection S3_6_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001896
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001897If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001898can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1899to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001900also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001901code of the library.) Linaro provides pre-built versions of
1902<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001903that can be used from the Cygwin terminal. When building for Android the
1904compiler is included in the Android standalone toolchain. After everything has
1905been set up in the Cygwin terminal the general guide on building the library
1906can be followed.
1907
Georgios Pinitas45514032020-12-30 00:03:09 +00001908@subsection S3_7_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001909
Georgios Pinitas45514032020-12-30 00:03:09 +00001910@subsubsection S3_7_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001911
1912Compute Library requires OpenCL 1.1 and above with support of non uniform workgroup sizes, which is officially supported in the Mali OpenCL DDK r8p0 and above as an extension (respective extension flag is \a -cl-arm-non-uniform-work-group-size).
1913
1914Enabling 16-bit floating point calculations require \a cl_khr_fp16 extension to be supported. All Mali GPUs with compute capabilities have native support for half precision floating points.
1915
1916Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1917
Georgios Pinitas45514032020-12-30 00:03:09 +00001918@subsubsection S3_7_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001919
1920Integer dot product built-in function extensions (and therefore optimized kernels) are available with Mali OpenCL DDK r22p0 and above for the following GPUs : G71, G76. The relevant extensions are \a cl_arm_integer_dot_product_int8, \a cl_arm_integer_dot_product_accumulate_int8 and \a cl_arm_integer_dot_product_accumulate_int16.
1921
1922OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1923
1924SVM allocations are supported for all the underlying allocations in Compute Library. To enable this OpenCL 2.0 and above is a requirement.
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001925
Georgios Pinitas45514032020-12-30 00:03:09 +00001926@subsection S3_8_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001927
1928The OpenCL tuner, a.k.a. CLTuner, is a module of Arm Compute Library that can improve the performance of the OpenCL kernels tuning the Local-Workgroup-Size (LWS).
1929The optimal LWS for each unique OpenCL kernel configuration is stored in a table. This table can be either imported or exported from/to a file.
Vidhya Sudhan Loganathandc5d3432019-04-29 11:44:11 +01001930The OpenCL tuner runs the same OpenCL kernel for a range of local workgroup sizes and keeps the local workgroup size of the fastest run to use in subsequent calls to the kernel. It supports three modes of tuning with different trade-offs between the time taken to tune and the kernel execution time achieved using the best LWS found. In the Exhaustive mode, it searches all the supported values of LWS. This mode takes the longest time to tune and is the most likely to find the optimal LWS. Normal mode searches a subset of LWS values to yield a good approximation of the optimal LWS. It takes less time to tune than Exhaustive mode. Rapid mode takes the shortest time to tune and finds an LWS value that is at least as good or better than the default LWS value. The mode affects only the search for the optimal LWS and has no effect when the LWS value is imported from a file.
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001931In order for the performance numbers to be meaningful you must disable the GPU power management and set it to a fixed frequency for the entire duration of the tuning phase.
1932
1933If you wish to know more about LWS and the important role on improving the GPU cache utilization, we suggest having a look at the presentation "Even Faster CNNs: Exploring the New Class of Winograd Algorithms available at the following link:
1934
1935https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1936
1937Tuning a network from scratch can be long and affect considerably the execution time for the first run of your network. It is recommended for this reason to store the CLTuner's result in a file to amortize this time when you either re-use the same network or the functions with the same configurations. The tuning is performed only once for each OpenCL kernel.
1938
1939CLTuner looks for the optimal LWS for each unique OpenCL kernel configuration. Since a function (i.e. Convolution Layer, Pooling Layer, Fully Connected Layer ...) can be called multiple times but with different parameters, we associate an "id" (called "config_id") to each kernel to distinguish the unique configurations.
1940
1941 #Example: 2 unique Matrix Multiply configurations
1942@code{.cpp}
1943 TensorShape a0 = TensorShape(32,32);
1944 TensorShape b0 = TensorShape(32,32);
1945 TensorShape c0 = TensorShape(32,32);
1946 TensorShape a1 = TensorShape(64,64);
1947 TensorShape b1 = TensorShape(64,64);
1948 TensorShape c1 = TensorShape(64,64);
1949
1950 Tensor a0_tensor;
1951 Tensor b0_tensor;
1952 Tensor c0_tensor;
1953 Tensor a1_tensor;
1954 Tensor b1_tensor;
1955 Tensor c1_tensor;
1956
1957 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1958 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1959 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1960 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1961 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1962 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1963
1964 CLGEMM gemm0;
1965 CLGEMM gemm1;
1966
1967 // Configuration 0
1968 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1969
1970 // Configuration 1
1971 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1972@endcode
1973
Georgios Pinitas45514032020-12-30 00:03:09 +00001974@subsubsection S3_8_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001975
Michele Di Giorgio57f30a92020-09-08 14:03:51 +01001976All the graph examples in the Compute Library's folder "examples" and the arm_compute_benchmark accept an argument to enable the OpenCL tuner and an argument to export/import the LWS values to/from a file
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001977
1978 #Enable CL tuner
1979 ./graph_mobilenet --enable-tuner –-target=CL
1980 ./arm_compute_benchmark --enable-tuner
1981
1982 #Export/Import to/from a file
1983 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1984 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1985
1986If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1987
1988Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1989
1990 -# Disable the power management
1991 -# Keep the GPU frequency constant
1992 -# Run multiple times the network (i.e. 10).
1993
1994If you are not using the graph API or the benchmark infrastructure you will need to manually pass a CLTuner object to CLScheduler before configuring any function.
1995
1996@code{.cpp}
1997CLTuner tuner;
1998
1999// Setup Scheduler
2000CLScheduler::get().default_init(&tuner);
2001@endcode
2002
2003After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
2004- tuner.save_to_file("results.csv");
2005
2006This file can be also imported using the method "load_from_file("results.csv")".
2007- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01002008*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01002009} // namespace arm_compute