blob: 735f60ad2c779ec4ba6fae8e4e208e10b367462a [file] [log] [blame]
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00001///
Michele Di Giorgiod9eaf612020-07-08 11:12:57 +01002/// Copyright (c) 2017-2020 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
40Please email developer@arm.com
41
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
99 - @ref NELogits1DSoftmaxKernel
100 - @ref 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
Georgios Pinitas40f51a62020-11-21 03:04:18 +0000126
SiCong Li96209c72020-08-21 12:28:30 +0100127v20.11 Public major release
morgolock70b1eb82020-11-24 13:54:19 +0000128 - Various bug fixes.
129 - Various optimisations.
130 - 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 +0000131 This is planned to be resolved in 21.02 release.
morgolock70b1eb82020-11-24 13:54:19 +0000132 - Added new data type QASYMM8_SIGNED support for @ref NEROIAlignLayer.
SiCong Li903f8cc2020-08-27 10:17:10 +0100133 - Added new data type S32 support for:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000134 - NEArithmeticSubtraction
135 - NEArithmeticSubtractionKernel
SiCong Libb88f892020-08-28 11:18:47 +0100136 - @ref NEPixelWiseMultiplication
137 - @ref NEPixelWiseMultiplicationKernel
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000138 - NEElementwiseDivision
139 - NEDivisionOperationKernel
SiCong Li96209c72020-08-21 12:28:30 +0100140 - Interface change
141 - Properly support softmax axis to have the same meaning as other major frameworks. That is, axis now defines the dimension
142 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.
143 The supported value range of axis is [-rank, rank).
144 This change applies to the following functions:
145 - @ref NESoftmaxLayer
146 - @ref NELogSoftmaxLayer
147 - @ref CLSoftmaxLayer
148 - @ref CLLogSoftmaxLayer
149 - @ref GCSoftmaxLayer
Sheri Zhang824061d2020-10-26 15:46:37 +0000150 - New OpenCL kernels / functions:
151 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
morgolock0e728492020-11-20 11:03:33 +0000152 - @ref CLLogicalNot
153 - @ref CLLogicalAnd
154 - @ref CLLogicalOr
155 - New NEON kernels / functions:
156 - @ref NELogicalNot
157 - @ref NELogicalAnd
158 - @ref NELogicalOr
Sheri Zhang824061d2020-10-26 15:46:37 +0000159 - Removed padding from NEON kernels:
Sheri Zhanged367132020-10-08 15:46:16 +0100160 - @ref NEComplexPixelWiseMultiplicationKernel
161 - @ref NENonMaximaSuppression3x3Kernel
162 - @ref NERemapKernel
163 - @ref NEGEMMInterleave4x4Kernel
164 - @ref NEDirectConvolutionLayerKernel
165 - @ref NEScaleKernel
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000166 - NELocallyConnectedMatrixMultiplyKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100167 - @ref NEGEMMLowpOffsetContributionKernel
168 - @ref NEGEMMTranspose1xWKernel
169 - @ref NEPoolingLayerKernel
170 - @ref NEConvolutionKernel
171 - @ref NEDepthwiseConvolutionLayerNativeKernel
172 - @ref NEGEMMLowpMatrixMultiplyKernel
173 - @ref NEGEMMMatrixMultiplyKernel
174 - @ref NEDirectConvolutionLayerOutputStageKernel
175 - @ref NEReductionOperationKernel
176 - @ref NEGEMMLowpMatrixAReductionKernel
177 - @ref NEGEMMLowpMatrixBReductionKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000178 - Removed padding from OpenCL kernels:
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000179 - CLBatchConcatenateLayerKernel
Michele Di Giorgio1e0208a2021-01-22 15:42:59 +0000180 - CLElementwiseOperationKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000181 - @ref CLBatchNormalizationLayerKernel
Michele Di Giorgioe1314662021-02-01 17:09:32 +0000182 - CLPoolingLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000183 - @ref CLWinogradInputTransformKernel
184 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
185 - @ref CLGEMMLowpMatrixAReductionKernel
186 - @ref CLGEMMLowpMatrixBReductionKernel
187 - @ref CLGEMMLowpOffsetContributionOutputStageKernel
188 - @ref CLGEMMLowpOffsetContributionKernel
189 - @ref CLWinogradOutputTransformKernel
190 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
191 - @ref CLFuseBatchNormalizationKernel
192 - @ref CLDepthwiseConvolutionLayerNativeKernel
193 - @ref CLDepthConvertLayerKernel
194 - @ref CLCopyKernel
195 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000196 - CLActivationLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000197 - @ref CLWinogradFilterTransformKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000198 - CLWidthConcatenateLayerKernel
199 - CLWidthConcatenate4TensorsKernel
200 - CLWidthConcatenate2TensorsKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000201 - @ref CLLogits1DMaxShiftExpSumKernel
202 - @ref CLLogits1DNormKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000203 - CLHeightConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000204 - @ref CLGEMMMatrixMultiplyKernel
205 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
206 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
207 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000208 - CLDepthConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000209 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
210 - Removed OpenCL kernels / functions:
211 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
212 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel
213 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel
morgolock00c76012020-11-06 10:40:12 +0000214 - 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 +0100215 - CLLocallyConnectedLayer
216 - CLLocallyConnectedMatrixMultiplyKernel
morgolock00c76012020-11-06 10:40:12 +0000217 - CLAbsoluteDifference
218 - CLAbsoluteDifferenceKernel
219 - CLAccumulate
220 - CLAccumulateKernel
221 - CLAccumulateSquared
222 - CLAccumulateSquaredKernel
223 - CLAccumulateWeighted
224 - CLAccumulateWeightedKernel
225 - CLAccumulateWeightedFP16Kernel
226 - CLBox3x3
227 - CLBox3x3Kernel
228 - CLBox3x3FP16Kernel
229 - CLCannyEdge
230 - CLChannelCombine
231 - CLChannelCombineKernel
232 - CLChannelExtract
233 - CLChannelExtractKernel
234 - CLColorConvert
235 - CLColorConvertKernel
236 - CLConvolution3x3
237 - CLConvolutionRectangle
238 - CLConvolutionRectangleKernel
239 - CLConvolutionSquare
240 - CLConvolutionKernel
241 - CLDerivative
242 - CLDerivativeKernel
243 - CLDilate
244 - CLDilateKernel
245 - CLEqualizeHistogram
246 - CLErode
247 - CLErodeKernel
248 - CLFastCorners
249 - CLFastCornersKernel
250 - CLGaussian3x3
251 - CLGaussian3x3Kernel
252 - CLGaussian5x5
253 - CLGaussian5x5HorKernel
254 - CLGaussian5x5VertKernel
255 - CLGaussianPyramid
256 - CLGaussianPyramidHalf
257 - CLGaussianPyramidOrb
258 - CLHarrisCorners
259 - CLHarrisScoreKernel
260 - CLHarrisScoreFP16Kernel
261 - CLHistogram
262 - CLHistogramKernel
263 - CLHOGOrientationBinningKernel
264 - CLHOGBlockNormalizationKernel
265 - CLHOGDetectorKernel
266 - CLHOGNonMaximaSuppressionKernel
267 - CLHOGDescriptor
268 - CLHOGDetector
269 - CLHOGGradient
270 - CLHOGMultiDetection
271 - CLHOGOrientationBinningKernel
272 - CLHOGBlockNormalizationKernel
273 - CLHOGDetectorKernel
274 - CLIntegralImage
275 - CLIntegralImageKernel
276 - CLLaplacianReconstruct
277 - CLLaplacianPyramid
278 - CLMagnitude
279 - CLMagnitudePhaseKernel
280 - CLMedian3x3
281 - CLMedian3x3Kernel
282 - CLMinMaxLocation
283 - CLMinMaxLocationKernel
284 - CLNonLinearFilter
285 - CLNonLinearFilterKernel
286 - CLNonMaximaSuppression3x3
287 - CLNonMaximaSuppression3x3FP16Kernel
288 - CLNonMaximaSuppression3x3Kernel
289 - CLOpticalFlow
290 - CLPhase
291 - CLRemap
292 - CLRemapKernel
293 - CLScharr3x3
294 - CLScharr3x3Kernel
295 - CLSobel3x3
296 - CLSobel3x3Kernel
297 - CLSobel5x5
298 - CLSobel5x5HorKernel
299 - CLSobel5x5VertKernel
300 - CLSobel7x7
301 - CLSobel7x7HorKernel
302 - CLSobel7x7VertKernel
303 - CLThreshold
304 - CLThresholdKernel
305 - CLWarpAffine
306 - CLWarpAffineKernel
307 - CLWarpPerspective
308 - CLWarpPerspectiveKernel
309 - 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 +0100310 - NELocallyConnectedLayer
311 - NELocallyConnectedMatrixMultiplyKernel
morgolock0c862652020-11-06 08:59:45 +0000312 - NEAbsoluteDifference
313 - NEAbsoluteDifferenceKernel
314 - NEAccumulate
315 - NEAccumulateKernel
316 - NEAccumulateSquared
317 - NEAccumulateSquaredKernel
318 - NEAccumulateWeighted
319 - NEAccumulateWeightedKernel
320 - NEAccumulateWeightedFP16Kernel
321 - NEBox3x3
322 - NEBox3x3Kernel
323 - NEBox3x3FP16Kernel
324 - NECannyEdge
325 - NEChannelCombine
326 - NEChannelCombineKernel
327 - NEChannelExtract
328 - NEChannelExtractKernel
329 - NEColorConvert
330 - NEColorConvertKernel
331 - NEConvolution3x3
332 - NEConvolutionRectangle
333 - NEConvolutionRectangleKernel
334 - NEConvolutionSquare
335 - NEConvolutionKernel
336 - NEDerivative
337 - NEDerivativeKernel
338 - NEDilate
339 - NEDilateKernel
340 - NEEqualizeHistogram
341 - NEErode
342 - NEErodeKernel
343 - NEFastCorners
344 - NEFastCornersKernel
345 - NEGaussian3x3
346 - NEGaussian3x3Kernel
347 - NEGaussian5x5
348 - NEGaussian5x5HorKernel
349 - NEGaussian5x5VertKernel
350 - NEGaussianPyramid
351 - NEGaussianPyramidHalf
352 - NEGaussianPyramidOrb
353 - NEHarrisCorners
354 - NEHarrisScoreKernel
355 - NEHarrisScoreFP16Kernel
356 - NEHistogram
357 - NEHistogramKernel
358 - NEHOGOrientationBinningKernel
359 - NEHOGBlockNormalizationKernel
360 - NEHOGDetectorKernel
361 - NEHOGNonMaximaSuppressionKernel
362 - NEHOGDescriptor
363 - NEHOGDetector
364 - NEHOGGradient
365 - NEHOGMultiDetection
366 - NEHOGOrientationBinningKernel
367 - NEHOGBlockNormalizationKernel
368 - NEHOGDetectorKernel
369 - NEIntegralImage
370 - NEIntegralImageKernel
371 - NELaplacianReconstruct
372 - NELaplacianPyramid
373 - NEMagnitude
374 - NEMagnitudePhaseKernel
375 - NEMedian3x3
376 - NEMedian3x3Kernel
377 - NEMinMaxLocation
378 - NEMinMaxLocationKernel
379 - NENonLinearFilter
380 - NENonLinearFilterKernel
381 - NENonMaximaSuppression3x3
382 - NENonMaximaSuppression3x3FP16Kernel
383 - NENonMaximaSuppression3x3Kernel
384 - NEOpticalFlow
385 - NEPhase
386 - NERemap
387 - NERemapKernel
388 - NEScharr3x3
389 - NEScharr3x3Kernel
390 - NESobel3x3
391 - NESobel3x3Kernel
392 - NESobel5x5
393 - NESobel5x5HorKernel
394 - NESobel5x5VertKernel
395 - NESobel7x7
396 - NESobel7x7HorKernel
397 - NESobel7x7VertKernel
398 - NEThreshold
399 - NEThresholdKernel
400 - NEWarpAffine
401 - NEWarpAffineKernel
402 - NEWarpPerspective
403 - NEWarpPerspectiveKernel
morgolockd6ee9ed2020-11-19 10:07:14 +0000404 - Deprecated GLES kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together):
405 - GCAbsoluteDifference
406 - GCActivationLayer
407 - GCArithmeticAddition
408 - GCBatchNormalizationLayer
409 - GCConcatenateLayer
410 - GCConvolutionLayer
411 - GCDepthwiseConvolutionLayer
412 - GCDirectConvolutionLayer
413 - GCDropoutLayer
414 - GCFillBorder
415 - GCFullyConnectedLayer
416 - GCGEMM
417 - GCGEMMInterleave4x4
418 - GCGEMMTranspose1xW
419 - GCNormalizationLayer
420 - GCNormalizePlanarYUVLayer
421 - GCPixelWiseMultiplication
422 - GCPoolingLayer
423 - GCScale
424 - GCSoftmaxLayer
425 - GCTensorShift
426 - GCTranspose
427
SiCong Li96209c72020-08-21 12:28:30 +0100428
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100429v20.08 Public major release
430 - Various bug fixes.
431 - Various optimisations.
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100432 - Added new data type QASYMM8_SIGNED support for:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100433 - @ref CLArgMinMaxLayer
434 - @ref CLArgMinMaxLayerKernel
435 - Added new data type U8 support for:
436 - @ref NECropKernel
437 - @ref CLCropKernel
438 - Added aligh_corner support for nearest neighbor interpolation in:
439 - @ref NEScaleKernel
440 - @ref CLScaleKernel
441 - New OpenCL kernels / functions:
442 - @ref CLMaxUnpoolingLayerKernel
443 - New NEON kernels / functions:
444 - @ref NEMaxUnpoolingLayerKernel
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100445 - New graph example:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100446 - graph_yolov3_output_detector
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100447 - GEMMTuner improvements:
448 - Added fp16 support
449 - Output json files for easier integration
450 - Enabled tuning for export_to_cl_image_rhs option for RHS tensors
451 - More robust script for running benchmarks
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100452 - Removed padding from:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100453 - @ref NEPixelWiseMultiplicationKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000454 - NEHeightConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100455 - @ref NEThresholdKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000456 - NEBatchConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100457 - @ref NETransposeKernel
458 - @ref NEBatchNormalizationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000459 - NEArithmeticSubtractionKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100460 - @ref NEBoundingBoxTransformKernel
461 - @ref NELogits1DMaxKernel
462 - @ref NELogits1DSoftmaxKernel
463 - @ref NEROIPoolingLayerKernel
464 - @ref NEROIAlignLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000465 - NEYOLOLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000466 - NEUpsampleLayerKernel
Georgios Pinitas70eb53b2021-01-06 19:42:21 +0000467 - NEFloorKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000468 - NEWidthConcatenateLayerKernel
469 - NEDepthConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100470 - @ref NENormalizationLayerKernel
471 - @ref NEL2NormalizeLayerKernel
472 - @ref NEFillArrayKernel
473 - @ref NEDepthConvertLayerKernel
474 - @ref NERangeKernel
475 - @ref NEPriorBoxLayer
Sheri Zhanged367132020-10-08 15:46:16 +0100476 - Removed OpenCL kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100477 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
478 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Sang-Hoon Parka45abfd2020-08-17 13:50:15 +0100479 - Removed NEON kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100480 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
481 - NEGEMMMatrixAccumulateBiasesKernel
SiCong Lid004a7a2020-05-28 15:26:41 +0100482 - Deprecated functions / interfaces:
483 - Non-descriptor based interfaces for @ref NEThreshold, @ref CLThreshold
Sang-Hoon Park97c1a672020-08-18 11:44:13 +0100484 - Non-descriptor based interfaces for @ref NEScale, @ref CLScale and @ref GCScale
SiCong Lid004a7a2020-05-28 15:26:41 +0100485 - In @ref NESoftmaxLayer, @ref NELogSoftmaxLayer, @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer :
morgolock9c7fed82020-08-05 12:30:56 +0100486 The default "axis" value for @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer is changed from 1 to 0.
487 Only axis 0 is supported.
488 The default "axis" value for @ref NESoftmaxLayer, @ref NELogSoftmaxLayer is changed from 1 to 0.
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100489 Only axis 0 is supported.
Sang-Hoon Parka0205b92020-07-07 09:36:09 +0100490 - The support for quantized data types has been removed from @ref CLLogSoftmaxLayer due to implementation complexity.
Gian Marco Iodice547b2e72020-08-12 10:25:29 +0100491 - 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 +0100492 - This change allows to use @ref CLGEMMConvolutionLayer without extra padding for the input and output.
493 - Only the weights/bias of @ref CLGEMMConvolutionLayer could require padding for the computation.
494 - 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 +0100495 - 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 +0100496 - This support allows to export the OpenCL buffer used for the reshaped RHS matrix to the OpenCL image object.
497 - The padding requirement for the OpenCL image object is considered into the @ref CLGEMMReshapeRHSMatrixKernel.
498 - The reshaped RHS matrix stores the weights when GEMM is used to accelerate @ref CLGEMMConvolutionLayer.
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100499
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000500v20.05 Public major release
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000501 - Various bug fixes.
502 - Various optimisations.
Michele Di Giorgio36a551f2020-04-23 11:55:29 +0100503 - Updated recommended NDK version to r18b.
504 - Updated recommended gcc version to Linaro 6.3.1.
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000505 - Added Bfloat16 type support
506 - Added Bfloat16 support in:
507 - @ref NEWeightsReshapeKernel
508 - @ref NEConvolutionLayerReshapeWeights
509 - @ref NEIm2ColKernel
Georgios Pinitasf7c5a412020-12-03 14:38:33 +0000510 - NEIm2Col
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000511 - @ref NEDepthConvertLayerKernel
512 - @ref NEDepthConvertLayer
513 - @ref NEGEMMConvolutionLayer
Georgios Pinitasec2256b2020-12-03 18:51:58 +0000514 - NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000515 - Added new data type QASYMM8_SIGNED support for:
516 - @ref CLDirectConvolutionLayer
517 - @ref CLDeconvolutionLayer
518 - @ref CLDirectDeconvolutionLayer
519 - @ref CLGEMMDeconvolutionLayer
520 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
521 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
522 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
523 - @ref CLReductionOperation
524 - @ref CLReduceMean
Sheri Zhang359c48e2020-04-30 22:53:39 +0100525 - @ref NEScale
526 - @ref NEScaleKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000527 - NEUpsampleLayer
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000528 - @ref NECast
529 - @ref NEReductionOperation
530 - @ref NEReduceMean
531 - @ref NEArgMinMaxLayer
532 - @ref NEDeconvolutionLayer
533 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
534 - @ref CPPBoxWithNonMaximaSuppressionLimit
535 - @ref CPPDetectionPostProcessLayer
536 - @ref CPPPermuteKernel
537 - @ref CPPPermute
538 - @ref CPPTopKVKernel
539 - @ref CPPTopKV
Sheri Zhang359c48e2020-04-30 22:53:39 +0100540 - @ref CPPUpsample
541 - @ref CPPUpsampleKernel
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100542 - New OpenCL kernels / functions:
543 - @ref CLQLSTMLayer
544 - @ref CLQLSTMLayerNormalizationKernel
545 - New NEON kernels / functions:
546 - @ref NEQLSTMLayer
547 - @ref NEQLSTMLayerNormalizationKernel
548 - Added HARD_SWISH support in:
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000549 - CLActivationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000550 - NEActivationLayerKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000551 - Deprecated OpenCL kernels / functions:
552 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
553 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
554 - Deprecated NEON kernels / functions:
555 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
556 - Removed CPP kernels / functions:
557 - CPPFlipWeightsKernel
Manuel Bottini387259a2020-05-21 17:14:36 +0100558 - Removed PoolingLayerInfo constructors without Data Layout.
559 - Removed CLDepthwiseConvolutionLayer3x3
560 - Removed NEDepthwiseConvolutionLayerOptimized
Manuel Bottini075253a2020-05-22 12:57:18 +0100561 - Added support for Winograd 3x3,4x4 on NEON FP16:
562 - @ref NEWinogradConvolutionLayer
563 - @ref NEWinogradLayerTransformInputKernel
564 - @ref NEWinogradLayerTransformOutputKernel
565 - @ref NEWinogradLayerTransformWeightsKernel
566 - Added CLCompileContext
567 - Added NEON GEMM kernel with 2D window support
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000568
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000569v20.02.1 Maintenance release
570 - Added Android-NN build script.
571
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000572v20.02 Public major release
573 - Various bug fixes.
574 - Various optimisations.
575 - Added new data type QASYMM8_SIGNED support for:
576 - @ref CLDepthwiseConvolutionLayer
Manuel Bottini387259a2020-05-21 17:14:36 +0100577 - CLDepthwiseConvolutionLayer3x3
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000578 - @ref CLGEMMConvolutionLayer
579 - @ref CLGEMMLowpMatrixMultiplyCore
580 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
581 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
582 - @ref NEActivationLayer
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000583 - NEComparisonOperationKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000584 - @ref NEConvolutionLayer
585 - @ref NEDepthwiseConvolutionLayer
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100586 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000587 - @ref NEDirectConvolutionLayerOutputStageKernel
588 - @ref NEElementwiseComparison
589 - @ref NEElementwiseMax
590 - @ref NEElementwiseMin
591 - @ref NEElementwiseSquaredDiff
592 - @ref NEFullyConnectedLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +0100593 - NEGEMMMatrixVectorMultiplyKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000594 - @ref NEPixelWiseMultiplication
595 - @ref NEPoolingLayer
596 - @ref NEPReluLayer
597 - Added support for QSYMM8_PER_CHANNEL in:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100598 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000599 - Added support for split sizes in:
600 - @ref CLSplit
601 - @ref NESplit
602 - New OpenCL kernels / functions:
603 - @ref CLFill
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100604 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000605 - New NEON kernels / functions:
606 - @ref NEFill
607 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
608 - Deprecated NEON functions / interfaces:
Manuel Bottini387259a2020-05-21 17:14:36 +0100609 - CLDepthwiseConvolutionLayer3x3
610 - NEDepthwiseConvolutionLayerOptimized
611 - PoolingLayerInfo constructors without Data Layout.
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000612 - Added support for quantization with multiplier greater than 1 on NEON and CL.
613 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
614 - Added the ability to build bootcode for bare metal.
615 - Added support for generating synthetic QASYMM8 graphs.
616 - Added support for F16 datatype in VGG16.
617 - Removed pre-built binaries for GLES.
618
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000619v19.11.1 Public maintenance release
620 - Fix offset calculation in NEReductionOperationKernel.
621 - Fix data layout in NEScaleKernel for nhwc.
622 - Retain configuration step data layout to avoid side-effects.
623 - Perform sqrt in double domain for L2 pooling.
624 - Fix output shape calculation for Reduce Mean
625 - Restrict cases where optimized NEPadLayer runs.
626
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100627v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000628 - Various bug fixes.
629 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000630 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000631 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100632 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
633 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000634 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100635 - CLDepthwiseVectorToTensorKernel
636 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000637 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100638 - NEDepthwiseWeightsReshapeKernel
639 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000640 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100641 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100642 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000643 - New OpenCL kernels / functions:
644 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
645 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
646 OpenCL kernels / functions)
647 - @ref CLLogSoftmaxLayer
648 - New NEON kernels / functions:
649 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
Georgios Pinitas8c3c0e72020-12-03 20:11:53 +0000650 - @ref NEComputeAllAnchorsKernel / NEComputeAllAnchors
SiCong Lica1f98c2019-11-28 11:06:11 +0000651 - @ref NEDetectionPostProcessLayer
652 - @ref NEGenerateProposalsLayer
653 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
654 - @ref NELogSoftmaxLayer
655 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
656 - Added QASYMM8 support for:
657 - @ref CLGenerateProposalsLayer
658 - @ref CLROIAlignLayer
659 - @ref CPPBoxWithNonMaximaSuppressionLimit
660 - Added QASYMM16 support for:
661 - @ref CLBoundingBoxTransform
662 - Added FP16 support for:
663 - @ref CLGEMMMatrixMultiplyReshapedKernel
664 - Added new data type QASYMM8_PER_CHANNEL support for:
665 - @ref CLDequantizationLayer
666 - @ref NEDequantizationLayer
667 - Added new data type QSYMM8_PER_CHANNEL support for:
668 - @ref CLConvolutionLayer
669 - @ref NEConvolutionLayer
670 - @ref CLDepthwiseConvolutionLayer
671 - @ref NEDepthwiseConvolutionLayer
672 - Added FP16 mixed-precision support for:
673 - @ref CLGEMMMatrixMultiplyReshapedKernel
Michele Di Giorgioe1314662021-02-01 17:09:32 +0000674 - CLPoolingLayerKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000675 - Added FP32 and FP16 ELU activation for:
676 - @ref CLActivationLayer
677 - @ref NEActivationLayer
678 - Added asymmetric padding support for:
679 - @ref CLDirectDeconvolutionLayer
680 - @ref CLGEMMDeconvolutionLayer
681 - @ref NEDeconvolutionLayer
682 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000683 - Replaced the calls to NECopyKernel and NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
684 - Replaced the calls to CLCopyKernel and CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
SiCong Lica1f98c2019-11-28 11:06:11 +0000685 - Improved performance for CL Inception V3 - FP16.
686 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
687 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
688 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
689 - Optimized @ref CLPadLayer.
690 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
691 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100692
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000693v19.08.1 Public maintenance release
694 - Fix offset calculation in NEReductionOperationKernel.
695 - Fix data layout in NEScaleKernel for nhwc.
696 - Retain configuration step data layout to avoid side-effects.
697 - Perform sqrt in double domain for L2 pooling.
698 - Fix output shape calculation for Reduce Mean
699 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
700
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100701v19.08 Public major release
702 - Various bug fixes.
703 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100704 - Deprecated NEON functions
705 - NEDepthConcatenateLayer
706 - NEWidthConcatenateLayer
707 - Deprecated OpenCL kernels / functions
708 - CLDepthConcatenateLayer
709 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
710 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
711 - CLWidthConcatenateLayer
712 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100713 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100714 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100715 - @ref NEElementwisePower
716 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100717 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100718 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100719 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100720 - @ref NESinLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000721 - NEBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100722 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
723 - @ref NEDepthwiseConvolutionLayerNativeKernel
724 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
725 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
726 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
727 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100728 - @ref CLAbsLayer
729 - @ref CLElementwisePower
730 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100731 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100732 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100733 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100734 - @ref CLSinLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000735 - CLBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100736 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
737 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100738 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100739 - @ref CLGEMMMatrixMultiplyNativeKernel
740 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
741 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
742 - New examples:
743 - neon_opticalflow
744 - cl_cache
745 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100746 - Added support for FP16 in @ref NEDeconvolutionLayer
747 - Added support for FP16 in @ref CLDeconvolutionLayer
748 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100749 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
750 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
751 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
752 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
753 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
754 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini387259a2020-05-21 17:14:36 +0100755 - The CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
756 - The NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100757 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
758 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100759 - 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 +0100760
Michalis Spyroua9c44722019-04-05 17:18:36 +0100761v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100762 - Various bug fixes.
763 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100764 - New Neon kernels / functions:
765 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100766 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100767 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100768 - @ref NEDepthwiseConvolutionAssemblyDispatch
769 - @ref NEFFTDigitReverseKernel
770 - @ref NEFFTRadixStageKernel
771 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100772 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000773 - NEHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100774 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100775 - @ref NEFFT1D
776 - @ref NEFFT2D
777 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100778 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100779 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100780 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100781 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100782 - @ref CLFFTDigitReverseKernel
783 - @ref CLFFTRadixStageKernel
784 - @ref CLFFTScaleKernel
785 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
786 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000787 - CLHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100788 - @ref CLDirectDeconvolutionLayer
789 - @ref CLFFT1D
790 - @ref CLFFT2D
791 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100792 - @ref CLGEMMDeconvolutionLayer
793 - New OpenGLES kernels / functions:
794 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100795 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100796 - GCDepthConcatenateLayer
797 - NEWidthConcatenateLayer
798 - NEDepthConcatenateLayer
799 - CLWidthConcatenateLayer
800 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100801 - CLGEMMInterleave4x4
802 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100803 - Support different quantization info in CLConcatLayer.
804 - Add checks on different input/output quantization info were not supported.
805 - Tensors have different quantization information.
806 - Add FP16 support checks.
807 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
808 - New graph examples:
809 - graph_convolution
810 - graph_fully_connected
811 - graph_depthwise_convolution
812 - Deepspeech v0.4.1
813 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
814 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
815 - Add support for QASYMM8 NEDeconvolution.
816 - Add support for DequantizationLayer for NEON/CL.
817 - Add support for dilation in CLDepthwiseConvolution.
818 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
819 - Optimize CLDeconvolution.
820 - Add StackLayer to the graph API.
821 - Add support for "reflect" padding mode in NEPad.
822 - Winograd 7x7 NHWC on OpenCL.
823 - Rework CL ML layers to run exclusively on CL.
824 - Support different quantization info in PoolingLayer.
825 - Implement and test import memory interfaces.
826 - Added new tests and removed old ones.
827 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100828
giuros01a69a88b2019-01-31 16:29:19 +0000829v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000830 - Various bug fixes.
831 - Various optimisations.
832 - New Neon kernels / functions:
833 - @ref NETileKernel / @ref NETile
834 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000835 - NEElementwiseOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000836 - @ref NEElementwiseMax
837 - @ref NEElementwiseMin
838 - @ref NEElementwiseSquaredDiff
839 - @ref NESelectKernel / @ref NESelect
840 - @ref NESplit
841 - @ref NESlice
842 - @ref NEUnstack
843 - @ref NEStridedSliceKernel / @ref NEStridedSlice
Sang-Hoon Park7249f152021-01-22 11:55:03 +0000844 - NEElementwiseUnaryKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000845 - @ref NERsqrtLayer
846 - @ref NEExpLayer
847 - @ref NEReverseKernel / @ref NEReverse
848 - @ref NEArgMinMaxLayer
849 - @ref NEStackLayerKernel / @ref NEStackLayer
850 - @ref NERangeKernel / @ref NERange
851 - @ref NEPadLayer
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000852 - NEMemsetKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000853 - @ref NEGatherKernel / @ref NEGather
854 - @ref NEElementwiseComparison
855 - @ref NEElementwiseComparisonStatic
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000856 - NEComparisonOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000857 - @ref NEElementwiseDivision
858 - New OpenCL kernels / functions:
859 - @ref CLSelectKernel / @ref CLSelect
860 - @ref CLTileKernel / @ref CLTile
861 - @ref CLComparisonKernel / @ref CLComparison
862 - @ref CLArgMinMaxLayer
863 - @ref CLElementwiseMax
864 - @ref CLElementwiseMin
865 - @ref CLElementwiseSquaredDiff
866 - @ref CLStackLayerKernel / @ref CLStackLayer
867 - @ref CLReverse / @ref CLReverseKernel
868 - @ref CLRsqrtLayer
869 - @ref CLExpLayer
Michele Di Giorgioc9c89052021-01-26 10:20:17 +0000870 - CLElementWiseUnaryLayerKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000871 - @ref CLGEMMReshapeLHSMatrixKernel
872 - @ref CLGEMMReshapeRHSMatrixKernel
873 - @ref CLGEMMMatrixMultiplyReshapedKernel
874 - @ref CLRangeKernel / @ref CLRange
875 - @ref CLUnstack
876 - @ref CLGatherKernel / @ref CLGather
877 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
878 - New CPP kernels / functions:
879 - @ref CPPDetectionOutputLayer
880 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000881 - Added new examples:
882 - graph_ssd_mobilenet.cpp
883 - graph_mobilenet_v2.cpp
884 - graph_resnet12.cpp
885 - graph_srcnn955.cpp
886 - graph_vgg_vdsr.cpp
887 - graph_inception_resnet_v1.cpp
888 - Add 4D tensors support to
889 - @ref NESoftmaxLayer
890 - Fused activation in @ref CLWinogradConvolutionLayer
891 - Extented @ref NEPermute to support more cases
892 - Added NEON/SVE GEMM Hybrid kernels
893 - Added u8 and s8 hybrid assembly kernels
894 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
895 - Improved @ref CLTuner
896 - Fused the bias addition within @ref CLGEMM
897 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
898 - Added NHWC data layout support to:
899 - @ref NEScale for F16
900 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
901 - @ref NEL2NormalizeLayer for FP32/FP16
902 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
903 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000904 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000905 - Added QASYMM8 support to the following kernels:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000906 - NEArithmeticAdditionKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000907 - @ref NEScale
908 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000909 - Deprecated functions/interfaces
910 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
911
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000912v18.11 Public major release
913 - Various bug fixes.
914 - Various optimisations.
915 - New Neon kernels / functions:
916 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
917 - @ref NEReduceMean
918 - @ref NEReorgLayer / @ref NEReorgLayerKernel
919 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000920 - NEUpsampleLayer / NEUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000921 - NEYOLOLayer / NEYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000922 - New OpenCL kernels / functions:
923 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
924 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000925 - @ref CLComputeAllAnchorsKernel
926 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000927 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
928 - @ref CLReorgLayer / @ref CLReorgLayerKernel
929 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
930 - @ref CLPadLayer
931 - @ref CLReduceMean
932 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
933 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
934 - @ref CLSlice
935 - @ref CLSplit
936 - @ref CLStridedSlice / @ref CLStridedSliceKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000937 - CLUpsampleLayer / CLUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000938 - CLYOLOLayer / CLYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000939 - New CPP kernels / functions:
940 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
941 - Added the validate method in:
942 - @ref NEDepthConvertLayer
943 - @ref NEFloor / @ref CLFloor
944 - @ref NEGEMMMatrixAdditionKernel
945 - @ref NEReshapeLayer / @ref CLReshapeLayer
946 - @ref CLScale
947 - Added new examples:
948 - graph_shufflenet.cpp
949 - graph_yolov3.cpp
950 - Added documentation for add a new function or kernel.
951 - Improved doxygen documentation adding a list of the existing functions.
952 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100953 - CLWidthConcatenateLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +0000954 - CLFlattenLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000955 - @ref CLSoftmaxLayer
956 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
957 - Add SVE support
958 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
959 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
960 - Added NHWC data layout support to:
961 - @ref CLChannelShuffleLayer
962 - @ref CLDeconvolutionLayer
963 - @ref CLL2NormalizeLayer
964 - Added QASYMM8 support to the following kernels:
965 - @ref CLScaleKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100966 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000967 - @ref CLPixelWiseMultiplicationKernel
968 - Added FP16 support to the following kernels:
969 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100970 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000971 - @ref CLNormalizePlanarYUVLayerKernel
972 - @ref CLWinogradConvolutionLayer (5x5 kernel)
973 - More tests added to both validation and benchmarking suites.
974
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100975v18.08 Public major release
976 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100977 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100978 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100979 - Removed support for QS8/QS16 data types.
980 - Added support for grouped convolution in @ref CLConvolutionLayer.
981 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100982 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100983 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
984 - @ref CLDepthwiseConvolutionLayer
985 - @ref CLDirectConvolutionLayer
986 - @ref CLConvolutionLayer
987 - @ref CLScale
988 - @ref CLIm2ColKernel
989 - New Neon kernels / functions:
990 - @ref NERNNLayer
991 - New OpenCL kernels / functions:
992 - @ref CLArithmeticDivision
993 - Introduced prepare() stage support in the graph API for GLES.
994 - Added support for memory reusage when trying to allocate smaller CLTensors.
995 - Enabled NHWC execution on graph examples.
996 - Added JPEG accessor for validation purposes.
997 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100998
999v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001000 - Various bug fixes.
1001 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001002 - Major redesign in the interface for the neon kernels implemented in assembly.
1003 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
1004 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
1005 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001006 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
1007 - Improved doxygen documentation.
1008 - Improved memory management for layer's transitions.
1009 - Added support for NHWC data layout in tensors.
1010 - Added NHWC data layout support to:
1011 - @ref NEGEMMConvolutionLayer
1012 - @ref NEDirectConvolutionLayer
1013 - @ref NEPoolingLayer / @ref CLPoolingLayer
1014 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
1015 - @ref NEDepthwiseConvolutionLayer
1016 - @ref NEScale
Georgios Pinitasf7c5a412020-12-03 14:38:33 +00001017 - NEIm2Col
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001018 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
1019 - New OpenCL kernels / functions:
1020 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
1021 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
1022 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001023 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001024 - @ref CLRNNLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001025 - CLWidthConcatenateLayer / CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001026 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
1027 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
1028 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001029 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
1030 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
1031 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
1032 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
1033 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
1034 - Port mobilenet example to NHWC data layout.
1035 - Enabled Winograd method in @ref CLConvolutionLayer.
1036 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
1037 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
1038 - Added memory manager support in GLES functions.
1039 - Major refactoring of the graph API.
1040 - Added GLES backend in the graph API.
1041 - Added support for the memory manager in the graph API.
1042 - Enabled Winograd Convolution method in the graph API.
1043 - Added support for grouped convolutions in the graph API.
1044 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
1045 - Added fast maths flag in @ref CLConvolutionLayer.
1046 - Added new tests and benchmarks in validation and benchmark frameworks
1047 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
1048 - Added support to OpenCL 2.0 SVM
1049 - Added support to import memory in OpenCL tensors.
1050 - Added the prepare() method to perform any one off pre-processing before running the function.
1051 - Added new examples:
1052 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001053 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001054 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001055
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001056v18.03 Public maintenance release
1057 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +00001058 - Fixed bug in @ref NEActivationLayer
1059 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001060 - Updated recommended NDK version to r16b (And fixed warnings).
1061 - Fixed bug in validation code.
1062 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001063 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001064
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001065v18.02 Public major release
1066 - Various NEON / OpenCL / GLES optimisations.
1067 - Various bug fixes.
1068 - Changed default number of threads on big LITTLE systems.
1069 - Refactored examples and added:
1070 - graph_mobilenet_qassym8
1071 - graph_resnet
1072 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +00001073 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
1074 - 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 +00001075 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001076 - @ref CLActivationLayer
1077 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001078 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001079 - @ref CLActivationLayer
1080 - @ref CLDepthwiseConvolutionLayer
1081 - @ref NEDepthwiseConvolutionLayer
1082 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001083 - Added FP16 support to:
Manuel Bottini387259a2020-05-21 17:14:36 +01001084 - CLDepthwiseConvolutionLayer3x3
Anthony Barbier3762e742018-03-02 11:49:33 +00001085 - @ref CLDepthwiseConvolutionLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001086 - Added broadcasting support to NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
Anthony Barbier3762e742018-03-02 11:49:33 +00001087 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
1088 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001089 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +01001090 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +00001091 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001092 - Added name() method to all kernels.
1093 - Added support for Winograd 5x5.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001094 - NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001095 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
1096 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
1097 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +01001098 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001099 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001100 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +00001101
Anthony Barbier64c95a02018-01-22 18:48:55 +00001102v18.01 Public maintenance release
1103 - Various bug fixes
1104 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +00001105 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
1106 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +00001107 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +00001108 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
1109 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
1110 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
1111 - Added @ref GCScaleKernel / @ref GCScale
1112 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +00001113 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001114 - @ref GCCol2ImKernel
1115 - @ref GCGEMMInterleave4x4Kernel
1116 - @ref GCGEMMTranspose1xWKernel
1117 - @ref GCIm2ColKernel
1118 - Refactored NEON Winograd (NEWinogradLayerKernel)
1119 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001120 - Added QASYMM8 support to the following NEON kernels:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001121 - NEDepthwiseConvolutionLayer3x3Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001122 - @ref NEFillBorderKernel
1123 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001124 - Added new examples:
1125 - graph_cl_mobilenet_qasymm8.cpp
1126 - graph_inception_v3.cpp
1127 - gc_dc.cpp
1128 - More tests added to both validation and benchmarking suites.
1129
Gian Marcoff850932017-12-11 12:37:17 +00001130v17.12 Public major release
1131 - Most machine learning functions on OpenCL support the new data type QASYMM8
1132 - Introduced logging interface
1133 - Introduced opencl timer
1134 - Reworked GEMMLowp interface
1135 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
1136 - Added validation method for most Machine Learning kernels / functions
1137 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
1138 - Added sgemm example for OpenCL
1139 - Added absolute difference example for GLES compute
1140 - Added new tests and benchmarks in validation and benchmark frameworks
1141 - Added new kernels / functions for GLES compute
1142
1143 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001144 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
1145 - @ref GCActivationLayerKernel / @ref GCActivationLayer
1146 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
1147 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +01001148 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001149 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
1150 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
1151 - @ref GCFillBorderKernel / @ref GCFillBorder
1152 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
1153 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
1154 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
1155 - @ref GCIm2ColKernel
1156 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
1157 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
1158 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
1159 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
1160 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +00001161
1162 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +00001163 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
1164 - arm_compute::NEHGEMMAArch64FP16Kernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001165 - NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001166 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
1167 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001168 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +00001169
1170 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001171 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
Michele Di Giorgioba14c922020-10-12 13:27:57 +01001172 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +00001173
1174 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001175 - graph::BranchLayer
1176 - graph::DepthConvertLayer
1177 - graph::DepthwiseConvolutionLayer
1178 - graph::DequantizationLayer
1179 - graph::FlattenLayer
1180 - graph::QuantizationLayer
1181 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +00001182
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001183v17.10 Public maintenance release
1184 - Bug fixes:
1185 - Check the maximum local workgroup size supported by OpenCL devices
1186 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +00001187 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001188 - Added a few new Graph nodes, support for branches and grouping.
1189 - Automatically enable cl_printf in debug builds
1190 - Fixed bare metal builds for armv7a
1191 - Added AlexNet and cartoon effect examples
1192 - 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)
1193
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001194v17.09 Public major release
1195 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +00001196 - 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 +01001197 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
1198 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
1199 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +00001200 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001201 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
Georgios Pinitas70eb53b2021-01-06 19:42:21 +00001202 - NEFloorKernel / @ref NEFloor
Anthony Barbier3762e742018-03-02 11:49:33 +00001203 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
1204 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
1205 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
1206 - @ref NEReductionOperationKernel / @ref NEReductionOperation
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001207 - NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001208
1209 - New OpenCL kernels / functions:
Manuel Bottini387259a2020-05-21 17:14:36 +01001210 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001211 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
1212 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +00001213 - CLFlattenLayer
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001214 - CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001215 - CLGEMMTranspose1xW
Michele Di Giorgioee82d342021-01-05 16:14:28 +00001216 - CLGEMMMatrixVectorMultiplyKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001217 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
1218 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
1219 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
1220 - @ref CLReductionOperationKernel / @ref CLReductionOperation
1221 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001222
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001223v17.06 Public major release
1224 - Various bug fixes
1225 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
1226 - Added unit tests and benchmarks (AlexNet, LeNet)
1227 - Added support for sub tensors.
1228 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +00001229 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
1230 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
1231 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001232 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001233 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001234 - CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001235 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001236 - CLLocallyConnectedMatrixMultiplyKernel / CLLocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001237 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001238 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001239 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001240 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001241 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001242 - NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001243 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001244 - NELocallyConnectedMatrixMultiplyKernel / NELocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001245 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001246
1247v17.05 Public bug fixes release
1248 - Various bug fixes
1249 - Remaining of the functions ported to use accurate padding.
1250 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
1251 - Added "free" method to allocator.
1252 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
1253
1254v17.04 Public bug fixes release
1255
1256 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +00001257 - @ref CLColorConvertKernel
1258 - @ref CLEdgeNonMaxSuppressionKernel
1259 - @ref CLEdgeTraceKernel
1260 - @ref CLGaussianPyramidHorKernel
1261 - @ref CLGaussianPyramidVertKernel
1262 - @ref CLGradientKernel
1263 - @ref NEChannelCombineKernel
1264 - @ref NEFillArrayKernel
1265 - @ref NEGaussianPyramidHorKernel
1266 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +01001267 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001268 - @ref NEHarrisScoreKernel
1269 - @ref NEHOGDetectorKernel
1270 - @ref NELogits1DMaxKernel
1271 - NELogits1DShiftExpSumKernel
1272 - NELogits1DNormKernel
1273 - @ref NENonMaximaSuppression3x3FP16Kernel
1274 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001275
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001276v17.03.1 First Major public release of the sources
1277 - Renamed the library to arm_compute
1278 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
1279 - New padding calculation interface introduced and ported most kernels / functions to use it.
1280 - New OpenCL kernels / functions:
Gian Marco Iodiceeb65f6d2020-04-15 11:42:15 +01001281 - CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001282 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001283 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
1284 - @ref NETransposeKernel / @ref NETranspose
1285 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
1286 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +01001287 - NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001288 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001289
1290v17.03 Sources preview
1291 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001292 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001293 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001294 - CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001295 - @ref CLTransposeKernel / @ref CLTranspose
1296 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
1297 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
1298 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001299 - New NEON kernels / functions:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001300 - NEActivationLayerKernel / @ref NEActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001301 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
1302 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001303
1304v17.02.1 Sources preview
1305 - New OpenCL kernels / functions:
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001306 - CLLogits1DMaxKernel, CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
Michele Di Giorgioe1314662021-02-01 17:09:32 +00001307 - CLPoolingLayerKernel / @ref CLPoolingLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001308 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
1309 - @ref CLRemapKernel / @ref CLRemap
1310 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
1311 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
1312 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001313 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +00001314 - @ref NEAccumulateWeightedFP16Kernel
1315 - @ref NEBox3x3FP16Kernel
1316 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001317
1318v17.02 Sources preview
1319 - New OpenCL kernels / functions:
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001320 - CLActivationLayerKernel / @ref CLActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001321 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1322 - @ref CLDerivativeKernel / @ref CLChannelExtract
1323 - @ref CLFastCornersKernel / @ref CLFastCorners
1324 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001325 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001326 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1327 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001328 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1329 - Switched all the kernels / functions to use tensors instead of images.
1330 - Updated documentation to include instructions to build the library from sources.
1331
1332v16.12 Binary preview release
1333 - Original release
1334
1335@section S3_how_to_build How to build the library and the examples
1336
1337@subsection S3_1_build_options Build options
1338
1339scons 2.3 or above is required to build the library.
1340To see the build options available simply run ```scons -h```:
1341
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001342 debug: Debug (yes|no)
1343 default: False
1344 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001345
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001346 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1347 default: False
1348 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001349
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001350 logging: Logging (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
Sang-Hoon Park50e98bb2021-01-14 14:54:14 +00001354 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 +00001355 default: armv7a
1356 actual: armv7a
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001357
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001358 estate: Execution State (auto|32|64)
1359 default: auto
1360 actual: auto
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001361
Georgios Pinitas45514032020-12-30 00:03:09 +00001362 os: Target OS (linux|android|macos|tizen|bare_metal)
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001363 default: linux
1364 actual: linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001365
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001366 build: Build type (native|cross_compile|embed_only)
1367 default: cross_compile
1368 actual: cross_compile
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001369
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001370 examples: Build example programs (yes|no)
1371 default: True
1372 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001373
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001374 gemm_tuner: Build gemm_tuner 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 Werror: Enable/disable the -Werror compilation flag (yes|no)
1379 default: True
1380 actual: True
Anthony Barbier20dbb822017-12-13 21:19:39 +00001381
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001382 standalone: Builds the tests as standalone executables, links statically with libgcc, libstdc++ and libarm_compute (yes|no)
1383 default: False
1384 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001385
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001386 opencl: Enable OpenCL support (yes|no)
1387 default: True
1388 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001389
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001390 neon: Enable Neon support (yes|no)
1391 default: False
1392 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001393
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001394 gles_compute: Enable OpenGL ES Compute Shader 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 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shaders in library binary (yes|no)
1399 default: True
1400 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001401
Georgios Pinitasea857272021-01-22 05:47:37 +00001402 compress_kernels: Compress embedded OpenCL kernels in library binary. Note embed_kernels should be enabled as well (yes|no)
1403 default: False
1404 actual: False
1405
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001406 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1407 default: False
1408 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001409
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001410 tracing: Enable runtime tracing (yes|no)
1411 default: False
1412 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001413
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001414 openmp: Enable OpenMP backend (yes|no)
1415 default: False
1416 actual: False
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001417
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001418 cppthreads: Enable C++11 threads backend (yes|no)
1419 default: True
1420 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001421
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001422 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1423 default: .
1424 actual: .
1425
1426 install_dir: Specify sub-folder for the install ( /path/to/install_dir )
1427 default:
1428 actual:
1429
1430 exceptions: Enable/disable C++ exception support (yes|no)
1431 default: True
1432 actual: True
1433
1434 linker_script: Use an external linker script ( /path/to/linker_script )
1435 default:
1436 actual:
1437
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001438 custom_options: Custom options that can be used to turn on/off features
1439 (all|none|comma-separated list of names)
1440 allowed names: disable_mmla_fp
1441 default: none
1442 actual:
1443
1444 data_type_support: Enable a list of data types to support
1445 (all|none|comma-separated list of names)
1446 allowed names: qasymm8 qasymm8_signed qsymm16 fp16 fp32
1447 default: all
1448 actual: qasymm8 qasymm8_signed qsymm16 fp16 fp32
1449
1450 toolchain_prefix: Override the toolchain prefix
1451 default:
1452 actual:
1453
1454 compiler_prefix: Override the compiler prefix
1455 default:
1456 actual:
1457
1458 extra_cxx_flags: Extra CXX flags to be appended to the build command
1459 default:
1460 actual:
1461
1462 extra_link_flags: Extra LD flags to be appended to the build command
1463 default:
1464 actual:
1465
1466 compiler_cache: Command to prefix to the C and C++ compiler (e.g ccache)
1467 default:
1468 actual:
1469
1470 specs_file: Specs file to use
1471 default: rdimon.specs
1472 actual: rdimon.specs
1473
1474 benchmark_examples: Build benchmark examples programs (yes|no)
1475 default: True
1476 actual: True
1477
1478 validate_examples: Build validate examples programs (yes|no)
1479 default: True
1480 actual: True
1481
1482 reference_openmp: Build reference validation with openmp (yes|no)
1483 default: True
1484 actual: True
1485
1486 validation_tests: Build validation test programs (yes|no)
1487 default: True
1488 actual: True
1489
1490 benchmark_tests: Build benchmark test programs (yes|no)
1491 default: True
1492 actual: True
1493
1494 test_filter: Pattern to specify the tests' filenames to be compiled
1495 default: *.cpp
1496 actual: *.cpp
1497
1498 pmu: Enable PMU counters (yes|no)
1499 default: False
1500 actual: False
1501
1502 mali: Enable Mali hardware counters (yes|no)
1503 default: False
1504 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001505
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001506 external_tests_dir: Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1507 default:
1508 actual:
1509
Anthony Barbier79c61782017-06-23 11:48:24 +01001510@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001511 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1512 - 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)
1513 - 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).
1514
Anthony Barbier79c61782017-06-23 11:48:24 +01001515@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 +01001516
Anthony Barbier79c61782017-06-23 11:48:24 +01001517@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001518@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1519
Anthony Barbier79c61782017-06-23 11:48:24 +01001520@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 +01001521
Anthony Barbier79c61782017-06-23 11:48:24 +01001522@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 +01001523
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001524There 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.
1525
Georgios Pinitasea857272021-01-22 05:47:37 +00001526In 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.
1527
Anthony Barbier79c61782017-06-23 11:48:24 +01001528@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 either on Github or by an email to developer@arm.com so that the issue can be addressed).
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001529
Anthony Barbier20dbb822017-12-13 21:19:39 +00001530@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 +01001531
Anthony Barbier20dbb822017-12-13 21:19:39 +00001532@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 +01001533
1534@b set_soname: Do you want to build the versioned version of the library ?
1535
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001536If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1537Example:
1538 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1539 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1540 libarm_compute_core.so.1.0.0
1541
1542@note This options is disabled by default as it requires SCons version 2.4 or above.
1543
Anthony Barbier79c61782017-06-23 11:48:24 +01001544@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1545
1546@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1547
1548@b examples: Build or not the examples
1549
1550@b validation_tests: Enable the build of the validation suite.
1551
Anthony Barbier79c61782017-06-23 11:48:24 +01001552@b benchmark_tests: Enable the build of the benchmark tests
1553
1554@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1555
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001556@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)
1557
Anthony Barbier79c61782017-06-23 11:48:24 +01001558@b openmp Build in the OpenMP scheduler for NEON.
1559
1560@note Only works when building with g++ not clang++
1561
1562@b cppthreads Build in the C++11 scheduler for NEON.
1563
Anthony Barbier3762e742018-03-02 11:49:33 +00001564@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001565
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001566@b external_tests_dir Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1567
1568In order to use this option, the external tests directory must have the following structure:
1569
1570 EXTERNAL_TESTS_DIR:
1571 └── tests
1572 ├── benchmark
1573 │   ├── CL
1574 │   ├── datasets
1575 │   ├── fixtures
1576 │   └── NEON
1577 └── validation
1578    ├── CL
1579     ├── datasets
1580     ├── fixtures
1581     └── NEON
1582
1583Then, build the library with `external_tests_dir=<PATH_TO_EXTERNAL_TESTS_DIR>`.
1584
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001585@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001586
1587@subsubsection S3_2_1_library How to build the library ?
1588
1589For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1590
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001591 - gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
1592 - gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001593
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001594To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1595
1596 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1597
1598To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1599
1600 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1601
Anthony Barbier20dbb822017-12-13 21:19:39 +00001602To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1603
1604 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1605
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001606You can also compile the library natively on an ARM device by using <b>build=native</b>:
1607
1608 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1609 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1610
1611@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.
1612
1613For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1614
1615 apt-get install g++-arm-linux-gnueabihf
1616
1617Then run
1618
1619 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1620
1621or simply remove the build parameter as build=cross_compile is the default value:
1622
1623 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1624
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001625@subsubsection S3_2_2_examples How to manually build the examples ?
1626
1627The 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.
1628
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001629@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 +01001630
1631To cross compile a NEON example for Linux 32bit:
1632
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001633 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 +01001634
1635To cross compile a NEON example for Linux 64bit:
1636
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001637 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 +01001638
1639(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)
1640
1641To cross compile an OpenCL example for Linux 32bit:
1642
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001643 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 +01001644
1645To cross compile an OpenCL example for Linux 64bit:
1646
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001647 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 +01001648
Anthony Barbier14c86a92017-12-14 16:27:41 +00001649To cross compile a GLES example for Linux 32bit:
1650
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001651 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 +00001652
1653To cross compile a GLES example for Linux 64bit:
1654
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001655 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 +00001656
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001657(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)
1658
Anthony Barbier14c86a92017-12-14 16:27:41 +00001659To 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.
1660
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001661i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1662
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001663 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 +01001664
1665i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1666
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001667 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 +01001668
1669(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)
1670
Anthony Barbiere5007472017-10-27 15:01:44 +01001671@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1672
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001673To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1674
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001675 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 +01001676
1677To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1678
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001679 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 +01001680
1681(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1682
1683To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1684
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001685 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 +01001686
Anthony Barbier14c86a92017-12-14 16:27:41 +00001687To 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 +01001688
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001689 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 +00001690
1691To 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 +00001692
1693i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001694
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001695 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 +01001696
Anthony Barbier14c86a92017-12-14 16:27:41 +00001697i.e. to natively compile the "graph_lenet" example for Linux 64bit:
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 -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
1701(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 +01001702
Anthony Barbiere5007472017-10-27 15:01:44 +01001703@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1704
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001705@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 +00001706@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 +01001707
1708To run the built executable simply run:
1709
1710 LD_LIBRARY_PATH=build ./neon_convolution
1711
1712or
1713
1714 LD_LIBRARY_PATH=build ./cl_convolution
1715
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001716@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 +00001717
1718For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001719
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001720 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001721
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001722Below is a list of the common parameters among the graph examples :
1723@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001724
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001725@subsubsection S3_2_3_sve Build for SVE or SVE2
1726
1727In order to build for SVE or SVE2 you need a compiler that supports them. You can find more information in the following these links:
1728 -# GCC: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/sve-support
1729 -# LLVM: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/llvm-toolchain/sve-support
1730
1731@note You the need to indicate the toolchains using the scons "toolchain_prefix" parameter.
1732
1733An example build command with SVE is:
1734
1735 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-
1736
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001737@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001738
1739For Android, the library was successfully built and tested using Google's standalone toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001740 - clang++ from NDK r18b for armv7a
1741 - clang++ from NDK r18b for arm64-v8a
1742 - clang++ from NDK r18b for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001743
1744Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1745
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001746- Download the NDK r18b from here: https://developer.android.com/ndk/downloads/index.html to directory $NDK
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001747- Make sure you have Python 2.7 installed on your machine.
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001748- 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 +01001749
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001750
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001751 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b --stl libc++ --api 21
1752 $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 +01001753
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001754@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 +01001755
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001756@note Make sure to add the toolchains to your PATH:
1757
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001758 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 +01001759
1760@subsubsection S3_3_1_library How to build the library ?
1761
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001762To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1763
1764 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1765
1766To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1767
Anthony Barbier14c86a92017-12-14 16:27:41 +00001768 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 +01001769
Anthony Barbier20dbb822017-12-13 21:19:39 +00001770To cross-compile the library in asserts mode, with GLES_COMPUTE 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=0 gles_compute=1 embed_kernels=1 os=android arch=arm64-v8a
Anthony Barbier20dbb822017-12-13 21:19:39 +00001773
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001774@subsubsection S3_3_2_examples How to manually build the examples ?
1775
1776The 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.
1777
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001778@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 +01001779
1780Once you've got your Android standalone toolchain built and added to your path you can do the following:
1781
1782To cross compile a NEON example:
1783
1784 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001785 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 +01001786 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001787 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 +01001788
1789To cross compile an OpenCL example:
1790
1791 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001792 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 +01001793 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001794 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 +00001795
1796To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001797
Anthony Barbier14c86a92017-12-14 16:27:41 +00001798 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001799 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 +00001800 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001801 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 +01001802
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001803To 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 +01001804
1805 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001806 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 +01001807 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001808 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 +01001809
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001810@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 +00001811@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 +01001812
1813Then you need to do is upload the executable and the shared library to the device using ADB:
1814
1815 adb push neon_convolution_arm /data/local/tmp/
1816 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001817 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001818 adb shell chmod 777 -R /data/local/tmp/
1819
1820And finally to run the example:
1821
1822 adb shell /data/local/tmp/neon_convolution_arm
1823 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001824 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001825
1826For 64bit:
1827
1828 adb push neon_convolution_aarch64 /data/local/tmp/
1829 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001830 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001831 adb shell chmod 777 -R /data/local/tmp/
1832
1833And finally to run the example:
1834
1835 adb shell /data/local/tmp/neon_convolution_aarch64
1836 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001837 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001838
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001839@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 +00001840
1841For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001842 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001843
1844In 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.
1845
Georgios Pinitas45514032020-12-30 00:03:09 +00001846@subsection S3_4_macos Building for macOS
1847
1848The library was successfully natively built for Apple Silicon under macOS 11.1 using clang v12.0.0.
1849
1850To natively compile the library with accelerated CPU support:
1851
1852 scons Werror=1 -j8 neon=1 opencl=0 os=macos arch=arm64-v8a build=native
1853
1854@note Initial support disables feature discovery through HWCAPS and thread scheduling affinity controls
1855
1856@subsection S3_5_bare_metal Building for bare metal
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001857
Georgios Pinitas58216322020-02-26 11:13:13 +00001858For 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 +01001859 - arm-eabi for armv7a
1860 - aarch64-elf for arm64-v8a
1861
1862Download 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>.
1863
1864@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
1865
Georgios Pinitas45514032020-12-30 00:03:09 +00001866@subsubsection S3_5_1_library How to build the library ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001867
1868To cross-compile the library with NEON support for baremetal arm64-v8a:
1869
1870 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
1871
Georgios Pinitas45514032020-12-30 00:03:09 +00001872@subsubsection S3_5_2_examples How to manually build the examples ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001873
1874Examples 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>.
1875
Georgios Pinitas45514032020-12-30 00:03:09 +00001876@subsection S3_6_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001877
1878Using `scons` directly from the Windows command line is known to cause
1879problems. The reason seems to be that if `scons` is setup for cross-compilation
1880it gets confused about Windows style paths (using backslashes). Thus it is
1881recommended to follow one of the options outlined below.
1882
Georgios Pinitas45514032020-12-30 00:03:09 +00001883@subsubsection S3_6_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001884
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001885The best and easiest option is to use
1886<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001887This feature is still marked as *beta* and thus might not be available.
1888However, if it is building the library is as simple as opening a *Bash on
1889Ubuntu on Windows* shell and following the general guidelines given above.
1890
Georgios Pinitas45514032020-12-30 00:03:09 +00001891@subsubsection S3_6_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001892
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001893If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001894can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1895to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001896also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001897code of the library.) Linaro provides pre-built versions of
1898<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001899that can be used from the Cygwin terminal. When building for Android the
1900compiler is included in the Android standalone toolchain. After everything has
1901been set up in the Cygwin terminal the general guide on building the library
1902can be followed.
1903
Georgios Pinitas45514032020-12-30 00:03:09 +00001904@subsection S3_7_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001905
Georgios Pinitas45514032020-12-30 00:03:09 +00001906@subsubsection S3_7_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001907
1908Compute 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).
1909
1910Enabling 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.
1911
1912Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1913
Georgios Pinitas45514032020-12-30 00:03:09 +00001914@subsubsection S3_7_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001915
1916Integer 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.
1917
1918OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1919
1920SVM 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 +01001921
Georgios Pinitas45514032020-12-30 00:03:09 +00001922@subsection S3_8_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001923
1924The 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).
1925The 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 +01001926The 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 +01001927In 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.
1928
1929If 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:
1930
1931https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1932
1933Tuning 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.
1934
1935CLTuner 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.
1936
1937 #Example: 2 unique Matrix Multiply configurations
1938@code{.cpp}
1939 TensorShape a0 = TensorShape(32,32);
1940 TensorShape b0 = TensorShape(32,32);
1941 TensorShape c0 = TensorShape(32,32);
1942 TensorShape a1 = TensorShape(64,64);
1943 TensorShape b1 = TensorShape(64,64);
1944 TensorShape c1 = TensorShape(64,64);
1945
1946 Tensor a0_tensor;
1947 Tensor b0_tensor;
1948 Tensor c0_tensor;
1949 Tensor a1_tensor;
1950 Tensor b1_tensor;
1951 Tensor c1_tensor;
1952
1953 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1954 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1955 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1956 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1957 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1958 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1959
1960 CLGEMM gemm0;
1961 CLGEMM gemm1;
1962
1963 // Configuration 0
1964 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1965
1966 // Configuration 1
1967 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1968@endcode
1969
Georgios Pinitas45514032020-12-30 00:03:09 +00001970@subsubsection S3_8_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001971
Michele Di Giorgio57f30a92020-09-08 14:03:51 +01001972All 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 +01001973
1974 #Enable CL tuner
1975 ./graph_mobilenet --enable-tuner –-target=CL
1976 ./arm_compute_benchmark --enable-tuner
1977
1978 #Export/Import to/from a file
1979 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1980 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1981
1982If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1983
1984Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1985
1986 -# Disable the power management
1987 -# Keep the GPU frequency constant
1988 -# Run multiple times the network (i.e. 10).
1989
1990If 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.
1991
1992@code{.cpp}
1993CLTuner tuner;
1994
1995// Setup Scheduler
1996CLScheduler::get().default_init(&tuner);
1997@endcode
1998
1999After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
2000- tuner.save_to_file("results.csv");
2001
2002This file can be also imported using the method "load_from_file("results.csv")".
2003- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01002004*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01002005} // namespace arm_compute