blob: d7ef3dcb7ddf81e12b1444c0e47f35daaf8ca1f4 [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 Zhangda6a6eb2021-01-06 11:15:06 +0000102 - Remove functions:
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000103 - NELocallyConnectedLayer / CLLocallyConnectedLayer
Georgios Pinitasf7c5a412020-12-03 14:38:33 +0000104 - NEIm2Col
105 - NECol2Im
106 - NEGEMMInterleave4x4
107 - NEGEMMTranspose1xW
Georgios Pinitas8c3c0e72020-12-03 20:11:53 +0000108 - NEComputeAllAnchors / CLComputeAllAnchors
Georgios Pinitasec2256b2020-12-03 18:51:58 +0000109 - NEGEMMAssemblyDispatch
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000110 - NEUpsampleLayer / CLUpsampleLayer
Sheri Zhangda6a6eb2021-01-06 11:15:06 +0000111 - Remove kernels:
Georgios Pinitasd308df32020-12-01 16:56:36 +0000112 - NEGEMMMatrixVectorMultiplyKernel
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000113 - NELocallyConnectedMatrixMultiplyKernel / CLLocallyConnectedMatrixMultiplyKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000114 - NEUpsampleLayerKernel / CLUpsampleLayerKernel
Georgios Pinitas40f51a62020-11-21 03:04:18 +0000115
SiCong Li96209c72020-08-21 12:28:30 +0100116v20.11 Public major release
morgolock70b1eb82020-11-24 13:54:19 +0000117 - Various bug fixes.
118 - Various optimisations.
119 - 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 +0000120 This is planned to be resolved in 21.02 release.
morgolock70b1eb82020-11-24 13:54:19 +0000121 - Added new data type QASYMM8_SIGNED support for @ref NEROIAlignLayer.
SiCong Li903f8cc2020-08-27 10:17:10 +0100122 - Added new data type S32 support for:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000123 - NEArithmeticSubtraction
124 - NEArithmeticSubtractionKernel
SiCong Libb88f892020-08-28 11:18:47 +0100125 - @ref NEPixelWiseMultiplication
126 - @ref NEPixelWiseMultiplicationKernel
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000127 - NEElementwiseDivision
128 - NEDivisionOperationKernel
SiCong Li96209c72020-08-21 12:28:30 +0100129 - Interface change
130 - Properly support softmax axis to have the same meaning as other major frameworks. That is, axis now defines the dimension
131 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.
132 The supported value range of axis is [-rank, rank).
133 This change applies to the following functions:
134 - @ref NESoftmaxLayer
135 - @ref NELogSoftmaxLayer
136 - @ref CLSoftmaxLayer
137 - @ref CLLogSoftmaxLayer
138 - @ref GCSoftmaxLayer
Sheri Zhang824061d2020-10-26 15:46:37 +0000139 - New OpenCL kernels / functions:
140 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
morgolock0e728492020-11-20 11:03:33 +0000141 - @ref CLLogicalNot
142 - @ref CLLogicalAnd
143 - @ref CLLogicalOr
144 - New NEON kernels / functions:
145 - @ref NELogicalNot
146 - @ref NELogicalAnd
147 - @ref NELogicalOr
Sheri Zhang824061d2020-10-26 15:46:37 +0000148 - Removed padding from NEON kernels:
Sheri Zhanged367132020-10-08 15:46:16 +0100149 - @ref NEComplexPixelWiseMultiplicationKernel
150 - @ref NENonMaximaSuppression3x3Kernel
151 - @ref NERemapKernel
152 - @ref NEGEMMInterleave4x4Kernel
153 - @ref NEDirectConvolutionLayerKernel
154 - @ref NEScaleKernel
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000155 - NELocallyConnectedMatrixMultiplyKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100156 - @ref NEGEMMLowpOffsetContributionKernel
157 - @ref NEGEMMTranspose1xWKernel
158 - @ref NEPoolingLayerKernel
159 - @ref NEConvolutionKernel
160 - @ref NEDepthwiseConvolutionLayerNativeKernel
161 - @ref NEGEMMLowpMatrixMultiplyKernel
162 - @ref NEGEMMMatrixMultiplyKernel
163 - @ref NEDirectConvolutionLayerOutputStageKernel
164 - @ref NEReductionOperationKernel
165 - @ref NEGEMMLowpMatrixAReductionKernel
166 - @ref NEGEMMLowpMatrixBReductionKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000167 - Removed padding from OpenCL kernels:
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000168 - CLBatchConcatenateLayerKernel
Michele Di Giorgio1e0208a2021-01-22 15:42:59 +0000169 - CLElementwiseOperationKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000170 - @ref CLBatchNormalizationLayerKernel
171 - @ref CLPoolingLayerKernel
172 - @ref CLWinogradInputTransformKernel
173 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
174 - @ref CLGEMMLowpMatrixAReductionKernel
175 - @ref CLGEMMLowpMatrixBReductionKernel
176 - @ref CLGEMMLowpOffsetContributionOutputStageKernel
177 - @ref CLGEMMLowpOffsetContributionKernel
178 - @ref CLWinogradOutputTransformKernel
179 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
180 - @ref CLFuseBatchNormalizationKernel
181 - @ref CLDepthwiseConvolutionLayerNativeKernel
182 - @ref CLDepthConvertLayerKernel
183 - @ref CLCopyKernel
184 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000185 - CLActivationLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000186 - @ref CLWinogradFilterTransformKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000187 - CLWidthConcatenateLayerKernel
188 - CLWidthConcatenate4TensorsKernel
189 - CLWidthConcatenate2TensorsKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000190 - @ref CLLogits1DMaxShiftExpSumKernel
191 - @ref CLLogits1DNormKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000192 - CLHeightConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000193 - @ref CLGEMMMatrixMultiplyKernel
194 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
195 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
196 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000197 - CLDepthConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000198 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
199 - Removed OpenCL kernels / functions:
200 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
201 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel
202 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel
morgolock00c76012020-11-06 10:40:12 +0000203 - 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 +0100204 - CLLocallyConnectedLayer
205 - CLLocallyConnectedMatrixMultiplyKernel
morgolock00c76012020-11-06 10:40:12 +0000206 - CLAbsoluteDifference
207 - CLAbsoluteDifferenceKernel
208 - CLAccumulate
209 - CLAccumulateKernel
210 - CLAccumulateSquared
211 - CLAccumulateSquaredKernel
212 - CLAccumulateWeighted
213 - CLAccumulateWeightedKernel
214 - CLAccumulateWeightedFP16Kernel
215 - CLBox3x3
216 - CLBox3x3Kernel
217 - CLBox3x3FP16Kernel
218 - CLCannyEdge
219 - CLChannelCombine
220 - CLChannelCombineKernel
221 - CLChannelExtract
222 - CLChannelExtractKernel
223 - CLColorConvert
224 - CLColorConvertKernel
225 - CLConvolution3x3
226 - CLConvolutionRectangle
227 - CLConvolutionRectangleKernel
228 - CLConvolutionSquare
229 - CLConvolutionKernel
230 - CLDerivative
231 - CLDerivativeKernel
232 - CLDilate
233 - CLDilateKernel
234 - CLEqualizeHistogram
235 - CLErode
236 - CLErodeKernel
237 - CLFastCorners
238 - CLFastCornersKernel
239 - CLGaussian3x3
240 - CLGaussian3x3Kernel
241 - CLGaussian5x5
242 - CLGaussian5x5HorKernel
243 - CLGaussian5x5VertKernel
244 - CLGaussianPyramid
245 - CLGaussianPyramidHalf
246 - CLGaussianPyramidOrb
247 - CLHarrisCorners
248 - CLHarrisScoreKernel
249 - CLHarrisScoreFP16Kernel
250 - CLHistogram
251 - CLHistogramKernel
252 - CLHOGOrientationBinningKernel
253 - CLHOGBlockNormalizationKernel
254 - CLHOGDetectorKernel
255 - CLHOGNonMaximaSuppressionKernel
256 - CLHOGDescriptor
257 - CLHOGDetector
258 - CLHOGGradient
259 - CLHOGMultiDetection
260 - CLHOGOrientationBinningKernel
261 - CLHOGBlockNormalizationKernel
262 - CLHOGDetectorKernel
263 - CLIntegralImage
264 - CLIntegralImageKernel
265 - CLLaplacianReconstruct
266 - CLLaplacianPyramid
267 - CLMagnitude
268 - CLMagnitudePhaseKernel
269 - CLMedian3x3
270 - CLMedian3x3Kernel
271 - CLMinMaxLocation
272 - CLMinMaxLocationKernel
273 - CLNonLinearFilter
274 - CLNonLinearFilterKernel
275 - CLNonMaximaSuppression3x3
276 - CLNonMaximaSuppression3x3FP16Kernel
277 - CLNonMaximaSuppression3x3Kernel
278 - CLOpticalFlow
279 - CLPhase
280 - CLRemap
281 - CLRemapKernel
282 - CLScharr3x3
283 - CLScharr3x3Kernel
284 - CLSobel3x3
285 - CLSobel3x3Kernel
286 - CLSobel5x5
287 - CLSobel5x5HorKernel
288 - CLSobel5x5VertKernel
289 - CLSobel7x7
290 - CLSobel7x7HorKernel
291 - CLSobel7x7VertKernel
292 - CLThreshold
293 - CLThresholdKernel
294 - CLWarpAffine
295 - CLWarpAffineKernel
296 - CLWarpPerspective
297 - CLWarpPerspectiveKernel
298 - 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 +0100299 - NELocallyConnectedLayer
300 - NELocallyConnectedMatrixMultiplyKernel
morgolock0c862652020-11-06 08:59:45 +0000301 - NEAbsoluteDifference
302 - NEAbsoluteDifferenceKernel
303 - NEAccumulate
304 - NEAccumulateKernel
305 - NEAccumulateSquared
306 - NEAccumulateSquaredKernel
307 - NEAccumulateWeighted
308 - NEAccumulateWeightedKernel
309 - NEAccumulateWeightedFP16Kernel
310 - NEBox3x3
311 - NEBox3x3Kernel
312 - NEBox3x3FP16Kernel
313 - NECannyEdge
314 - NEChannelCombine
315 - NEChannelCombineKernel
316 - NEChannelExtract
317 - NEChannelExtractKernel
318 - NEColorConvert
319 - NEColorConvertKernel
320 - NEConvolution3x3
321 - NEConvolutionRectangle
322 - NEConvolutionRectangleKernel
323 - NEConvolutionSquare
324 - NEConvolutionKernel
325 - NEDerivative
326 - NEDerivativeKernel
327 - NEDilate
328 - NEDilateKernel
329 - NEEqualizeHistogram
330 - NEErode
331 - NEErodeKernel
332 - NEFastCorners
333 - NEFastCornersKernel
334 - NEGaussian3x3
335 - NEGaussian3x3Kernel
336 - NEGaussian5x5
337 - NEGaussian5x5HorKernel
338 - NEGaussian5x5VertKernel
339 - NEGaussianPyramid
340 - NEGaussianPyramidHalf
341 - NEGaussianPyramidOrb
342 - NEHarrisCorners
343 - NEHarrisScoreKernel
344 - NEHarrisScoreFP16Kernel
345 - NEHistogram
346 - NEHistogramKernel
347 - NEHOGOrientationBinningKernel
348 - NEHOGBlockNormalizationKernel
349 - NEHOGDetectorKernel
350 - NEHOGNonMaximaSuppressionKernel
351 - NEHOGDescriptor
352 - NEHOGDetector
353 - NEHOGGradient
354 - NEHOGMultiDetection
355 - NEHOGOrientationBinningKernel
356 - NEHOGBlockNormalizationKernel
357 - NEHOGDetectorKernel
358 - NEIntegralImage
359 - NEIntegralImageKernel
360 - NELaplacianReconstruct
361 - NELaplacianPyramid
362 - NEMagnitude
363 - NEMagnitudePhaseKernel
364 - NEMedian3x3
365 - NEMedian3x3Kernel
366 - NEMinMaxLocation
367 - NEMinMaxLocationKernel
368 - NENonLinearFilter
369 - NENonLinearFilterKernel
370 - NENonMaximaSuppression3x3
371 - NENonMaximaSuppression3x3FP16Kernel
372 - NENonMaximaSuppression3x3Kernel
373 - NEOpticalFlow
374 - NEPhase
375 - NERemap
376 - NERemapKernel
377 - NEScharr3x3
378 - NEScharr3x3Kernel
379 - NESobel3x3
380 - NESobel3x3Kernel
381 - NESobel5x5
382 - NESobel5x5HorKernel
383 - NESobel5x5VertKernel
384 - NESobel7x7
385 - NESobel7x7HorKernel
386 - NESobel7x7VertKernel
387 - NEThreshold
388 - NEThresholdKernel
389 - NEWarpAffine
390 - NEWarpAffineKernel
391 - NEWarpPerspective
392 - NEWarpPerspectiveKernel
morgolockd6ee9ed2020-11-19 10:07:14 +0000393 - Deprecated GLES kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together):
394 - GCAbsoluteDifference
395 - GCActivationLayer
396 - GCArithmeticAddition
397 - GCBatchNormalizationLayer
398 - GCConcatenateLayer
399 - GCConvolutionLayer
400 - GCDepthwiseConvolutionLayer
401 - GCDirectConvolutionLayer
402 - GCDropoutLayer
403 - GCFillBorder
404 - GCFullyConnectedLayer
405 - GCGEMM
406 - GCGEMMInterleave4x4
407 - GCGEMMTranspose1xW
408 - GCNormalizationLayer
409 - GCNormalizePlanarYUVLayer
410 - GCPixelWiseMultiplication
411 - GCPoolingLayer
412 - GCScale
413 - GCSoftmaxLayer
414 - GCTensorShift
415 - GCTranspose
416
SiCong Li96209c72020-08-21 12:28:30 +0100417
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100418v20.08 Public major release
419 - Various bug fixes.
420 - Various optimisations.
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100421 - Added new data type QASYMM8_SIGNED support for:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100422 - @ref CLArgMinMaxLayer
423 - @ref CLArgMinMaxLayerKernel
424 - Added new data type U8 support for:
425 - @ref NECropKernel
426 - @ref CLCropKernel
427 - Added aligh_corner support for nearest neighbor interpolation in:
428 - @ref NEScaleKernel
429 - @ref CLScaleKernel
430 - New OpenCL kernels / functions:
431 - @ref CLMaxUnpoolingLayerKernel
432 - New NEON kernels / functions:
433 - @ref NEMaxUnpoolingLayerKernel
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100434 - New graph example:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100435 - graph_yolov3_output_detector
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100436 - GEMMTuner improvements:
437 - Added fp16 support
438 - Output json files for easier integration
439 - Enabled tuning for export_to_cl_image_rhs option for RHS tensors
440 - More robust script for running benchmarks
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100441 - Removed padding from:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100442 - @ref NEPixelWiseMultiplicationKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000443 - NEHeightConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100444 - @ref NEThresholdKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000445 - NEBatchConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100446 - @ref NETransposeKernel
447 - @ref NEBatchNormalizationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000448 - NEArithmeticSubtractionKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100449 - @ref NEBoundingBoxTransformKernel
450 - @ref NELogits1DMaxKernel
451 - @ref NELogits1DSoftmaxKernel
452 - @ref NEROIPoolingLayerKernel
453 - @ref NEROIAlignLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000454 - NEYOLOLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000455 - NEUpsampleLayerKernel
Georgios Pinitas70eb53b2021-01-06 19:42:21 +0000456 - NEFloorKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000457 - NEWidthConcatenateLayerKernel
458 - NEDepthConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100459 - @ref NENormalizationLayerKernel
460 - @ref NEL2NormalizeLayerKernel
461 - @ref NEFillArrayKernel
462 - @ref NEDepthConvertLayerKernel
463 - @ref NERangeKernel
464 - @ref NEPriorBoxLayer
Sheri Zhanged367132020-10-08 15:46:16 +0100465 - Removed OpenCL kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100466 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
467 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Sang-Hoon Parka45abfd2020-08-17 13:50:15 +0100468 - Removed NEON kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100469 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
470 - NEGEMMMatrixAccumulateBiasesKernel
SiCong Lid004a7a2020-05-28 15:26:41 +0100471 - Deprecated functions / interfaces:
472 - Non-descriptor based interfaces for @ref NEThreshold, @ref CLThreshold
Sang-Hoon Park97c1a672020-08-18 11:44:13 +0100473 - Non-descriptor based interfaces for @ref NEScale, @ref CLScale and @ref GCScale
SiCong Lid004a7a2020-05-28 15:26:41 +0100474 - In @ref NESoftmaxLayer, @ref NELogSoftmaxLayer, @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer :
morgolock9c7fed82020-08-05 12:30:56 +0100475 The default "axis" value for @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer is changed from 1 to 0.
476 Only axis 0 is supported.
477 The default "axis" value for @ref NESoftmaxLayer, @ref NELogSoftmaxLayer is changed from 1 to 0.
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100478 Only axis 0 is supported.
Sang-Hoon Parka0205b92020-07-07 09:36:09 +0100479 - The support for quantized data types has been removed from @ref CLLogSoftmaxLayer due to implementation complexity.
Gian Marco Iodice547b2e72020-08-12 10:25:29 +0100480 - 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 +0100481 - This change allows to use @ref CLGEMMConvolutionLayer without extra padding for the input and output.
482 - Only the weights/bias of @ref CLGEMMConvolutionLayer could require padding for the computation.
483 - 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 +0100484 - 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 +0100485 - This support allows to export the OpenCL buffer used for the reshaped RHS matrix to the OpenCL image object.
486 - The padding requirement for the OpenCL image object is considered into the @ref CLGEMMReshapeRHSMatrixKernel.
487 - The reshaped RHS matrix stores the weights when GEMM is used to accelerate @ref CLGEMMConvolutionLayer.
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100488
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000489v20.05 Public major release
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000490 - Various bug fixes.
491 - Various optimisations.
Michele Di Giorgio36a551f2020-04-23 11:55:29 +0100492 - Updated recommended NDK version to r18b.
493 - Updated recommended gcc version to Linaro 6.3.1.
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000494 - Added Bfloat16 type support
495 - Added Bfloat16 support in:
496 - @ref NEWeightsReshapeKernel
497 - @ref NEConvolutionLayerReshapeWeights
498 - @ref NEIm2ColKernel
Georgios Pinitasf7c5a412020-12-03 14:38:33 +0000499 - NEIm2Col
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000500 - @ref NEDepthConvertLayerKernel
501 - @ref NEDepthConvertLayer
502 - @ref NEGEMMConvolutionLayer
Georgios Pinitasec2256b2020-12-03 18:51:58 +0000503 - NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000504 - Added new data type QASYMM8_SIGNED support for:
505 - @ref CLDirectConvolutionLayer
506 - @ref CLDeconvolutionLayer
507 - @ref CLDirectDeconvolutionLayer
508 - @ref CLGEMMDeconvolutionLayer
509 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
510 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
511 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
512 - @ref CLReductionOperation
513 - @ref CLReduceMean
Sheri Zhang359c48e2020-04-30 22:53:39 +0100514 - @ref NEScale
515 - @ref NEScaleKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000516 - NEUpsampleLayer
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000517 - @ref NECast
518 - @ref NEReductionOperation
519 - @ref NEReduceMean
520 - @ref NEArgMinMaxLayer
521 - @ref NEDeconvolutionLayer
522 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
523 - @ref CPPBoxWithNonMaximaSuppressionLimit
524 - @ref CPPDetectionPostProcessLayer
525 - @ref CPPPermuteKernel
526 - @ref CPPPermute
527 - @ref CPPTopKVKernel
528 - @ref CPPTopKV
Sheri Zhang359c48e2020-04-30 22:53:39 +0100529 - @ref CPPUpsample
530 - @ref CPPUpsampleKernel
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100531 - New OpenCL kernels / functions:
532 - @ref CLQLSTMLayer
533 - @ref CLQLSTMLayerNormalizationKernel
534 - New NEON kernels / functions:
535 - @ref NEQLSTMLayer
536 - @ref NEQLSTMLayerNormalizationKernel
537 - Added HARD_SWISH support in:
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000538 - CLActivationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000539 - NEActivationLayerKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000540 - Deprecated OpenCL kernels / functions:
541 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
542 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
543 - Deprecated NEON kernels / functions:
544 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
545 - Removed CPP kernels / functions:
546 - CPPFlipWeightsKernel
Manuel Bottini387259a2020-05-21 17:14:36 +0100547 - Removed PoolingLayerInfo constructors without Data Layout.
548 - Removed CLDepthwiseConvolutionLayer3x3
549 - Removed NEDepthwiseConvolutionLayerOptimized
Manuel Bottini075253a2020-05-22 12:57:18 +0100550 - Added support for Winograd 3x3,4x4 on NEON FP16:
551 - @ref NEWinogradConvolutionLayer
552 - @ref NEWinogradLayerTransformInputKernel
553 - @ref NEWinogradLayerTransformOutputKernel
554 - @ref NEWinogradLayerTransformWeightsKernel
555 - Added CLCompileContext
556 - Added NEON GEMM kernel with 2D window support
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000557
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000558v20.02.1 Maintenance release
559 - Added Android-NN build script.
560
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000561v20.02 Public major release
562 - Various bug fixes.
563 - Various optimisations.
564 - Added new data type QASYMM8_SIGNED support for:
565 - @ref CLDepthwiseConvolutionLayer
Manuel Bottini387259a2020-05-21 17:14:36 +0100566 - CLDepthwiseConvolutionLayer3x3
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000567 - @ref CLGEMMConvolutionLayer
568 - @ref CLGEMMLowpMatrixMultiplyCore
569 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
570 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
571 - @ref NEActivationLayer
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000572 - NEComparisonOperationKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000573 - @ref NEConvolutionLayer
574 - @ref NEDepthwiseConvolutionLayer
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100575 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000576 - @ref NEDirectConvolutionLayerOutputStageKernel
577 - @ref NEElementwiseComparison
578 - @ref NEElementwiseMax
579 - @ref NEElementwiseMin
580 - @ref NEElementwiseSquaredDiff
581 - @ref NEFullyConnectedLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +0100582 - NEGEMMMatrixVectorMultiplyKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000583 - @ref NEPixelWiseMultiplication
584 - @ref NEPoolingLayer
585 - @ref NEPReluLayer
586 - Added support for QSYMM8_PER_CHANNEL in:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100587 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000588 - Added support for split sizes in:
589 - @ref CLSplit
590 - @ref NESplit
591 - New OpenCL kernels / functions:
592 - @ref CLFill
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100593 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000594 - New NEON kernels / functions:
595 - @ref NEFill
596 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
597 - Deprecated NEON functions / interfaces:
Manuel Bottini387259a2020-05-21 17:14:36 +0100598 - CLDepthwiseConvolutionLayer3x3
599 - NEDepthwiseConvolutionLayerOptimized
600 - PoolingLayerInfo constructors without Data Layout.
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000601 - Added support for quantization with multiplier greater than 1 on NEON and CL.
602 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
603 - Added the ability to build bootcode for bare metal.
604 - Added support for generating synthetic QASYMM8 graphs.
605 - Added support for F16 datatype in VGG16.
606 - Removed pre-built binaries for GLES.
607
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000608v19.11.1 Public maintenance release
609 - Fix offset calculation in NEReductionOperationKernel.
610 - Fix data layout in NEScaleKernel for nhwc.
611 - Retain configuration step data layout to avoid side-effects.
612 - Perform sqrt in double domain for L2 pooling.
613 - Fix output shape calculation for Reduce Mean
614 - Restrict cases where optimized NEPadLayer runs.
615
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100616v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000617 - Various bug fixes.
618 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000619 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000620 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100621 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
622 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000623 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100624 - CLDepthwiseVectorToTensorKernel
625 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000626 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100627 - NEDepthwiseWeightsReshapeKernel
628 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000629 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100630 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100631 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000632 - New OpenCL kernels / functions:
633 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
634 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
635 OpenCL kernels / functions)
636 - @ref CLLogSoftmaxLayer
637 - New NEON kernels / functions:
638 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
Georgios Pinitas8c3c0e72020-12-03 20:11:53 +0000639 - @ref NEComputeAllAnchorsKernel / NEComputeAllAnchors
SiCong Lica1f98c2019-11-28 11:06:11 +0000640 - @ref NEDetectionPostProcessLayer
641 - @ref NEGenerateProposalsLayer
642 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
643 - @ref NELogSoftmaxLayer
644 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
645 - Added QASYMM8 support for:
646 - @ref CLGenerateProposalsLayer
647 - @ref CLROIAlignLayer
648 - @ref CPPBoxWithNonMaximaSuppressionLimit
649 - Added QASYMM16 support for:
650 - @ref CLBoundingBoxTransform
651 - Added FP16 support for:
652 - @ref CLGEMMMatrixMultiplyReshapedKernel
653 - Added new data type QASYMM8_PER_CHANNEL support for:
654 - @ref CLDequantizationLayer
655 - @ref NEDequantizationLayer
656 - Added new data type QSYMM8_PER_CHANNEL support for:
657 - @ref CLConvolutionLayer
658 - @ref NEConvolutionLayer
659 - @ref CLDepthwiseConvolutionLayer
660 - @ref NEDepthwiseConvolutionLayer
661 - Added FP16 mixed-precision support for:
662 - @ref CLGEMMMatrixMultiplyReshapedKernel
663 - @ref CLPoolingLayerKernel
664 - Added FP32 and FP16 ELU activation for:
665 - @ref CLActivationLayer
666 - @ref NEActivationLayer
667 - Added asymmetric padding support for:
668 - @ref CLDirectDeconvolutionLayer
669 - @ref CLGEMMDeconvolutionLayer
670 - @ref NEDeconvolutionLayer
671 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000672 - Replaced the calls to NECopyKernel and NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
673 - Replaced the calls to CLCopyKernel and CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
SiCong Lica1f98c2019-11-28 11:06:11 +0000674 - Improved performance for CL Inception V3 - FP16.
675 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
676 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
677 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
678 - Optimized @ref CLPadLayer.
679 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
680 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100681
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000682v19.08.1 Public maintenance release
683 - Fix offset calculation in NEReductionOperationKernel.
684 - Fix data layout in NEScaleKernel for nhwc.
685 - Retain configuration step data layout to avoid side-effects.
686 - Perform sqrt in double domain for L2 pooling.
687 - Fix output shape calculation for Reduce Mean
688 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
689
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100690v19.08 Public major release
691 - Various bug fixes.
692 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100693 - Deprecated NEON functions
694 - NEDepthConcatenateLayer
695 - NEWidthConcatenateLayer
696 - Deprecated OpenCL kernels / functions
697 - CLDepthConcatenateLayer
698 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
699 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
700 - CLWidthConcatenateLayer
701 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100702 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100703 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100704 - @ref NEElementwisePower
705 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100706 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100707 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100708 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100709 - @ref NESinLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000710 - NEBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100711 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
712 - @ref NEDepthwiseConvolutionLayerNativeKernel
713 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
714 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
715 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
716 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100717 - @ref CLAbsLayer
718 - @ref CLElementwisePower
719 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100720 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100721 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100722 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100723 - @ref CLSinLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000724 - CLBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100725 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
726 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100727 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100728 - @ref CLGEMMMatrixMultiplyNativeKernel
729 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
730 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
731 - New examples:
732 - neon_opticalflow
733 - cl_cache
734 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100735 - Added support for FP16 in @ref NEDeconvolutionLayer
736 - Added support for FP16 in @ref CLDeconvolutionLayer
737 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100738 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
739 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
740 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
741 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
742 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
743 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini387259a2020-05-21 17:14:36 +0100744 - The CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
745 - The NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100746 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
747 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100748 - 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 +0100749
Michalis Spyroua9c44722019-04-05 17:18:36 +0100750v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100751 - Various bug fixes.
752 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100753 - New Neon kernels / functions:
754 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100755 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100756 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100757 - @ref NEDepthwiseConvolutionAssemblyDispatch
758 - @ref NEFFTDigitReverseKernel
759 - @ref NEFFTRadixStageKernel
760 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100761 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000762 - NEHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100763 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100764 - @ref NEFFT1D
765 - @ref NEFFT2D
766 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100767 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100768 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100769 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100770 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100771 - @ref CLFFTDigitReverseKernel
772 - @ref CLFFTRadixStageKernel
773 - @ref CLFFTScaleKernel
774 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
775 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000776 - CLHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100777 - @ref CLDirectDeconvolutionLayer
778 - @ref CLFFT1D
779 - @ref CLFFT2D
780 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100781 - @ref CLGEMMDeconvolutionLayer
782 - New OpenGLES kernels / functions:
783 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100784 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100785 - GCDepthConcatenateLayer
786 - NEWidthConcatenateLayer
787 - NEDepthConcatenateLayer
788 - CLWidthConcatenateLayer
789 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100790 - CLGEMMInterleave4x4
791 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100792 - Support different quantization info in CLConcatLayer.
793 - Add checks on different input/output quantization info were not supported.
794 - Tensors have different quantization information.
795 - Add FP16 support checks.
796 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
797 - New graph examples:
798 - graph_convolution
799 - graph_fully_connected
800 - graph_depthwise_convolution
801 - Deepspeech v0.4.1
802 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
803 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
804 - Add support for QASYMM8 NEDeconvolution.
805 - Add support for DequantizationLayer for NEON/CL.
806 - Add support for dilation in CLDepthwiseConvolution.
807 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
808 - Optimize CLDeconvolution.
809 - Add StackLayer to the graph API.
810 - Add support for "reflect" padding mode in NEPad.
811 - Winograd 7x7 NHWC on OpenCL.
812 - Rework CL ML layers to run exclusively on CL.
813 - Support different quantization info in PoolingLayer.
814 - Implement and test import memory interfaces.
815 - Added new tests and removed old ones.
816 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100817
giuros01a69a88b2019-01-31 16:29:19 +0000818v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000819 - Various bug fixes.
820 - Various optimisations.
821 - New Neon kernels / functions:
822 - @ref NETileKernel / @ref NETile
823 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000824 - NEElementwiseOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000825 - @ref NEElementwiseMax
826 - @ref NEElementwiseMin
827 - @ref NEElementwiseSquaredDiff
828 - @ref NESelectKernel / @ref NESelect
829 - @ref NESplit
830 - @ref NESlice
831 - @ref NEUnstack
832 - @ref NEStridedSliceKernel / @ref NEStridedSlice
Sang-Hoon Park7249f152021-01-22 11:55:03 +0000833 - NEElementwiseUnaryKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000834 - @ref NERsqrtLayer
835 - @ref NEExpLayer
836 - @ref NEReverseKernel / @ref NEReverse
837 - @ref NEArgMinMaxLayer
838 - @ref NEStackLayerKernel / @ref NEStackLayer
839 - @ref NERangeKernel / @ref NERange
840 - @ref NEPadLayer
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000841 - NEMemsetKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000842 - @ref NEGatherKernel / @ref NEGather
843 - @ref NEElementwiseComparison
844 - @ref NEElementwiseComparisonStatic
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000845 - NEComparisonOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000846 - @ref NEElementwiseDivision
847 - New OpenCL kernels / functions:
848 - @ref CLSelectKernel / @ref CLSelect
849 - @ref CLTileKernel / @ref CLTile
850 - @ref CLComparisonKernel / @ref CLComparison
851 - @ref CLArgMinMaxLayer
852 - @ref CLElementwiseMax
853 - @ref CLElementwiseMin
854 - @ref CLElementwiseSquaredDiff
855 - @ref CLStackLayerKernel / @ref CLStackLayer
856 - @ref CLReverse / @ref CLReverseKernel
857 - @ref CLRsqrtLayer
858 - @ref CLExpLayer
859 - @ref CLElementWiseUnaryLayerKernel
860 - @ref CLGEMMReshapeLHSMatrixKernel
861 - @ref CLGEMMReshapeRHSMatrixKernel
862 - @ref CLGEMMMatrixMultiplyReshapedKernel
863 - @ref CLRangeKernel / @ref CLRange
864 - @ref CLUnstack
865 - @ref CLGatherKernel / @ref CLGather
866 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
867 - New CPP kernels / functions:
868 - @ref CPPDetectionOutputLayer
869 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000870 - Added new examples:
871 - graph_ssd_mobilenet.cpp
872 - graph_mobilenet_v2.cpp
873 - graph_resnet12.cpp
874 - graph_srcnn955.cpp
875 - graph_vgg_vdsr.cpp
876 - graph_inception_resnet_v1.cpp
877 - Add 4D tensors support to
878 - @ref NESoftmaxLayer
879 - Fused activation in @ref CLWinogradConvolutionLayer
880 - Extented @ref NEPermute to support more cases
881 - Added NEON/SVE GEMM Hybrid kernels
882 - Added u8 and s8 hybrid assembly kernels
883 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
884 - Improved @ref CLTuner
885 - Fused the bias addition within @ref CLGEMM
886 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
887 - Added NHWC data layout support to:
888 - @ref NEScale for F16
889 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
890 - @ref NEL2NormalizeLayer for FP32/FP16
891 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
892 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000893 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000894 - Added QASYMM8 support to the following kernels:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000895 - NEArithmeticAdditionKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000896 - @ref NEScale
897 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000898 - Deprecated functions/interfaces
899 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
900
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000901v18.11 Public major release
902 - Various bug fixes.
903 - Various optimisations.
904 - New Neon kernels / functions:
905 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
906 - @ref NEReduceMean
907 - @ref NEReorgLayer / @ref NEReorgLayerKernel
908 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000909 - NEUpsampleLayer / NEUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000910 - NEYOLOLayer / NEYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000911 - New OpenCL kernels / functions:
912 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
913 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000914 - @ref CLComputeAllAnchorsKernel
915 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000916 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
917 - @ref CLReorgLayer / @ref CLReorgLayerKernel
918 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
919 - @ref CLPadLayer
920 - @ref CLReduceMean
921 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
922 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
923 - @ref CLSlice
924 - @ref CLSplit
925 - @ref CLStridedSlice / @ref CLStridedSliceKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000926 - CLUpsampleLayer / CLUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000927 - CLYOLOLayer / CLYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000928 - New CPP kernels / functions:
929 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
930 - Added the validate method in:
931 - @ref NEDepthConvertLayer
932 - @ref NEFloor / @ref CLFloor
933 - @ref NEGEMMMatrixAdditionKernel
934 - @ref NEReshapeLayer / @ref CLReshapeLayer
935 - @ref CLScale
936 - Added new examples:
937 - graph_shufflenet.cpp
938 - graph_yolov3.cpp
939 - Added documentation for add a new function or kernel.
940 - Improved doxygen documentation adding a list of the existing functions.
941 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100942 - CLWidthConcatenateLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +0000943 - CLFlattenLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000944 - @ref CLSoftmaxLayer
945 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
946 - Add SVE support
947 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
948 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
949 - Added NHWC data layout support to:
950 - @ref CLChannelShuffleLayer
951 - @ref CLDeconvolutionLayer
952 - @ref CLL2NormalizeLayer
953 - Added QASYMM8 support to the following kernels:
954 - @ref CLScaleKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100955 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000956 - @ref CLPixelWiseMultiplicationKernel
957 - Added FP16 support to the following kernels:
958 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100959 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000960 - @ref CLNormalizePlanarYUVLayerKernel
961 - @ref CLWinogradConvolutionLayer (5x5 kernel)
962 - More tests added to both validation and benchmarking suites.
963
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100964v18.08 Public major release
965 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100966 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100967 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100968 - Removed support for QS8/QS16 data types.
969 - Added support for grouped convolution in @ref CLConvolutionLayer.
970 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100971 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100972 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
973 - @ref CLDepthwiseConvolutionLayer
974 - @ref CLDirectConvolutionLayer
975 - @ref CLConvolutionLayer
976 - @ref CLScale
977 - @ref CLIm2ColKernel
978 - New Neon kernels / functions:
979 - @ref NERNNLayer
980 - New OpenCL kernels / functions:
981 - @ref CLArithmeticDivision
982 - Introduced prepare() stage support in the graph API for GLES.
983 - Added support for memory reusage when trying to allocate smaller CLTensors.
984 - Enabled NHWC execution on graph examples.
985 - Added JPEG accessor for validation purposes.
986 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100987
988v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100989 - Various bug fixes.
990 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000991 - Major redesign in the interface for the neon kernels implemented in assembly.
992 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
993 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
994 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100995 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
996 - Improved doxygen documentation.
997 - Improved memory management for layer's transitions.
998 - Added support for NHWC data layout in tensors.
999 - Added NHWC data layout support to:
1000 - @ref NEGEMMConvolutionLayer
1001 - @ref NEDirectConvolutionLayer
1002 - @ref NEPoolingLayer / @ref CLPoolingLayer
1003 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
1004 - @ref NEDepthwiseConvolutionLayer
1005 - @ref NEScale
Georgios Pinitasf7c5a412020-12-03 14:38:33 +00001006 - NEIm2Col
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001007 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
1008 - New OpenCL kernels / functions:
1009 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
1010 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
1011 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001012 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001013 - @ref CLRNNLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001014 - CLWidthConcatenateLayer / CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001015 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
1016 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
1017 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001018 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
1019 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
1020 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
1021 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
1022 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
1023 - Port mobilenet example to NHWC data layout.
1024 - Enabled Winograd method in @ref CLConvolutionLayer.
1025 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
1026 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
1027 - Added memory manager support in GLES functions.
1028 - Major refactoring of the graph API.
1029 - Added GLES backend in the graph API.
1030 - Added support for the memory manager in the graph API.
1031 - Enabled Winograd Convolution method in the graph API.
1032 - Added support for grouped convolutions in the graph API.
1033 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
1034 - Added fast maths flag in @ref CLConvolutionLayer.
1035 - Added new tests and benchmarks in validation and benchmark frameworks
1036 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
1037 - Added support to OpenCL 2.0 SVM
1038 - Added support to import memory in OpenCL tensors.
1039 - Added the prepare() method to perform any one off pre-processing before running the function.
1040 - Added new examples:
1041 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001042 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001043 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001044
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001045v18.03 Public maintenance release
1046 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +00001047 - Fixed bug in @ref NEActivationLayer
1048 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001049 - Updated recommended NDK version to r16b (And fixed warnings).
1050 - Fixed bug in validation code.
1051 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001052 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001053
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001054v18.02 Public major release
1055 - Various NEON / OpenCL / GLES optimisations.
1056 - Various bug fixes.
1057 - Changed default number of threads on big LITTLE systems.
1058 - Refactored examples and added:
1059 - graph_mobilenet_qassym8
1060 - graph_resnet
1061 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +00001062 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
1063 - 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 +00001064 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001065 - @ref CLActivationLayer
1066 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001067 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001068 - @ref CLActivationLayer
1069 - @ref CLDepthwiseConvolutionLayer
1070 - @ref NEDepthwiseConvolutionLayer
1071 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001072 - Added FP16 support to:
Manuel Bottini387259a2020-05-21 17:14:36 +01001073 - CLDepthwiseConvolutionLayer3x3
Anthony Barbier3762e742018-03-02 11:49:33 +00001074 - @ref CLDepthwiseConvolutionLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001075 - Added broadcasting support to NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
Anthony Barbier3762e742018-03-02 11:49:33 +00001076 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
1077 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001078 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +01001079 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +00001080 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001081 - Added name() method to all kernels.
1082 - Added support for Winograd 5x5.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001083 - NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001084 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
1085 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
1086 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +01001087 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001088 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001089 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +00001090
Anthony Barbier64c95a02018-01-22 18:48:55 +00001091v18.01 Public maintenance release
1092 - Various bug fixes
1093 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +00001094 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
1095 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +00001096 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +00001097 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
1098 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
1099 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
1100 - Added @ref GCScaleKernel / @ref GCScale
1101 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +00001102 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001103 - @ref GCCol2ImKernel
1104 - @ref GCGEMMInterleave4x4Kernel
1105 - @ref GCGEMMTranspose1xWKernel
1106 - @ref GCIm2ColKernel
1107 - Refactored NEON Winograd (NEWinogradLayerKernel)
1108 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001109 - Added QASYMM8 support to the following NEON kernels:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001110 - NEDepthwiseConvolutionLayer3x3Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001111 - @ref NEFillBorderKernel
1112 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001113 - Added new examples:
1114 - graph_cl_mobilenet_qasymm8.cpp
1115 - graph_inception_v3.cpp
1116 - gc_dc.cpp
1117 - More tests added to both validation and benchmarking suites.
1118
Gian Marcoff850932017-12-11 12:37:17 +00001119v17.12 Public major release
1120 - Most machine learning functions on OpenCL support the new data type QASYMM8
1121 - Introduced logging interface
1122 - Introduced opencl timer
1123 - Reworked GEMMLowp interface
1124 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
1125 - Added validation method for most Machine Learning kernels / functions
1126 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
1127 - Added sgemm example for OpenCL
1128 - Added absolute difference example for GLES compute
1129 - Added new tests and benchmarks in validation and benchmark frameworks
1130 - Added new kernels / functions for GLES compute
1131
1132 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001133 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
1134 - @ref GCActivationLayerKernel / @ref GCActivationLayer
1135 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
1136 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +01001137 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001138 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
1139 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
1140 - @ref GCFillBorderKernel / @ref GCFillBorder
1141 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
1142 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
1143 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
1144 - @ref GCIm2ColKernel
1145 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
1146 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
1147 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
1148 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
1149 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +00001150
1151 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +00001152 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
1153 - arm_compute::NEHGEMMAArch64FP16Kernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001154 - NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001155 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
1156 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001157 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +00001158
1159 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001160 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
Michele Di Giorgioba14c922020-10-12 13:27:57 +01001161 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +00001162
1163 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001164 - graph::BranchLayer
1165 - graph::DepthConvertLayer
1166 - graph::DepthwiseConvolutionLayer
1167 - graph::DequantizationLayer
1168 - graph::FlattenLayer
1169 - graph::QuantizationLayer
1170 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +00001171
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001172v17.10 Public maintenance release
1173 - Bug fixes:
1174 - Check the maximum local workgroup size supported by OpenCL devices
1175 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +00001176 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001177 - Added a few new Graph nodes, support for branches and grouping.
1178 - Automatically enable cl_printf in debug builds
1179 - Fixed bare metal builds for armv7a
1180 - Added AlexNet and cartoon effect examples
1181 - 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)
1182
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001183v17.09 Public major release
1184 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +00001185 - 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 +01001186 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
1187 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
1188 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +00001189 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001190 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
Georgios Pinitas70eb53b2021-01-06 19:42:21 +00001191 - NEFloorKernel / @ref NEFloor
Anthony Barbier3762e742018-03-02 11:49:33 +00001192 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
1193 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
1194 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
1195 - @ref NEReductionOperationKernel / @ref NEReductionOperation
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001196 - NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001197
1198 - New OpenCL kernels / functions:
Manuel Bottini387259a2020-05-21 17:14:36 +01001199 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001200 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
1201 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +00001202 - CLFlattenLayer
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001203 - CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001204 - CLGEMMTranspose1xW
Michele Di Giorgioee82d342021-01-05 16:14:28 +00001205 - CLGEMMMatrixVectorMultiplyKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001206 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
1207 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
1208 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
1209 - @ref CLReductionOperationKernel / @ref CLReductionOperation
1210 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001211
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001212v17.06 Public major release
1213 - Various bug fixes
1214 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
1215 - Added unit tests and benchmarks (AlexNet, LeNet)
1216 - Added support for sub tensors.
1217 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +00001218 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
1219 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
1220 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001221 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001222 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001223 - CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001224 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001225 - CLLocallyConnectedMatrixMultiplyKernel / CLLocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001226 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001227 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001228 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001229 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001230 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001231 - NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001232 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001233 - NELocallyConnectedMatrixMultiplyKernel / NELocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001234 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001235
1236v17.05 Public bug fixes release
1237 - Various bug fixes
1238 - Remaining of the functions ported to use accurate padding.
1239 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
1240 - Added "free" method to allocator.
1241 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
1242
1243v17.04 Public bug fixes release
1244
1245 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +00001246 - @ref CLColorConvertKernel
1247 - @ref CLEdgeNonMaxSuppressionKernel
1248 - @ref CLEdgeTraceKernel
1249 - @ref CLGaussianPyramidHorKernel
1250 - @ref CLGaussianPyramidVertKernel
1251 - @ref CLGradientKernel
1252 - @ref NEChannelCombineKernel
1253 - @ref NEFillArrayKernel
1254 - @ref NEGaussianPyramidHorKernel
1255 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +01001256 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001257 - @ref NEHarrisScoreKernel
1258 - @ref NEHOGDetectorKernel
1259 - @ref NELogits1DMaxKernel
1260 - NELogits1DShiftExpSumKernel
1261 - NELogits1DNormKernel
1262 - @ref NENonMaximaSuppression3x3FP16Kernel
1263 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001264
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001265v17.03.1 First Major public release of the sources
1266 - Renamed the library to arm_compute
1267 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
1268 - New padding calculation interface introduced and ported most kernels / functions to use it.
1269 - New OpenCL kernels / functions:
Gian Marco Iodiceeb65f6d2020-04-15 11:42:15 +01001270 - CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001271 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001272 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
1273 - @ref NETransposeKernel / @ref NETranspose
1274 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
1275 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +01001276 - NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001277 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001278
1279v17.03 Sources preview
1280 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001281 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001282 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001283 - CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001284 - @ref CLTransposeKernel / @ref CLTranspose
1285 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
1286 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
1287 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001288 - New NEON kernels / functions:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001289 - NEActivationLayerKernel / @ref NEActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001290 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
1291 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001292
1293v17.02.1 Sources preview
1294 - New OpenCL kernels / functions:
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001295 - CLLogits1DMaxKernel, CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001296 - @ref CLPoolingLayerKernel / @ref CLPoolingLayer
1297 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
1298 - @ref CLRemapKernel / @ref CLRemap
1299 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
1300 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
1301 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001302 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +00001303 - @ref NEAccumulateWeightedFP16Kernel
1304 - @ref NEBox3x3FP16Kernel
1305 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001306
1307v17.02 Sources preview
1308 - New OpenCL kernels / functions:
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001309 - CLActivationLayerKernel / @ref CLActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001310 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1311 - @ref CLDerivativeKernel / @ref CLChannelExtract
1312 - @ref CLFastCornersKernel / @ref CLFastCorners
1313 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001314 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001315 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1316 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001317 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1318 - Switched all the kernels / functions to use tensors instead of images.
1319 - Updated documentation to include instructions to build the library from sources.
1320
1321v16.12 Binary preview release
1322 - Original release
1323
1324@section S3_how_to_build How to build the library and the examples
1325
1326@subsection S3_1_build_options Build options
1327
1328scons 2.3 or above is required to build the library.
1329To see the build options available simply run ```scons -h```:
1330
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001331 debug: Debug (yes|no)
1332 default: False
1333 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001334
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001335 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1336 default: False
1337 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001338
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001339 logging: Logging (this flag is forced to 1 for debug=1) (yes|no)
1340 default: False
1341 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001342
Sang-Hoon Park50e98bb2021-01-14 14:54:14 +00001343 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 +00001344 default: armv7a
1345 actual: armv7a
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001346
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001347 estate: Execution State (auto|32|64)
1348 default: auto
1349 actual: auto
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001350
Georgios Pinitas45514032020-12-30 00:03:09 +00001351 os: Target OS (linux|android|macos|tizen|bare_metal)
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001352 default: linux
1353 actual: linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001354
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001355 build: Build type (native|cross_compile|embed_only)
1356 default: cross_compile
1357 actual: cross_compile
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001358
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001359 examples: Build example programs (yes|no)
1360 default: True
1361 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001362
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001363 gemm_tuner: Build gemm_tuner programs (yes|no)
1364 default: True
1365 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001366
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001367 Werror: Enable/disable the -Werror compilation flag (yes|no)
1368 default: True
1369 actual: True
Anthony Barbier20dbb822017-12-13 21:19:39 +00001370
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001371 standalone: Builds the tests as standalone executables, links statically with libgcc, libstdc++ and libarm_compute (yes|no)
1372 default: False
1373 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001374
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001375 opencl: Enable OpenCL support (yes|no)
1376 default: True
1377 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001378
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001379 neon: Enable Neon support (yes|no)
1380 default: False
1381 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001382
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001383 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1384 default: False
1385 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001386
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001387 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shaders in library binary (yes|no)
1388 default: True
1389 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001390
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001391 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1392 default: False
1393 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001394
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001395 tracing: Enable runtime tracing (yes|no)
1396 default: False
1397 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001398
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001399 openmp: Enable OpenMP backend (yes|no)
1400 default: False
1401 actual: False
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001402
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001403 cppthreads: Enable C++11 threads backend (yes|no)
1404 default: True
1405 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001406
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001407 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1408 default: .
1409 actual: .
1410
1411 install_dir: Specify sub-folder for the install ( /path/to/install_dir )
1412 default:
1413 actual:
1414
1415 exceptions: Enable/disable C++ exception support (yes|no)
1416 default: True
1417 actual: True
1418
1419 linker_script: Use an external linker script ( /path/to/linker_script )
1420 default:
1421 actual:
1422
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001423 custom_options: Custom options that can be used to turn on/off features
1424 (all|none|comma-separated list of names)
1425 allowed names: disable_mmla_fp
1426 default: none
1427 actual:
1428
1429 data_type_support: Enable a list of data types to support
1430 (all|none|comma-separated list of names)
1431 allowed names: qasymm8 qasymm8_signed qsymm16 fp16 fp32
1432 default: all
1433 actual: qasymm8 qasymm8_signed qsymm16 fp16 fp32
1434
1435 toolchain_prefix: Override the toolchain prefix
1436 default:
1437 actual:
1438
1439 compiler_prefix: Override the compiler prefix
1440 default:
1441 actual:
1442
1443 extra_cxx_flags: Extra CXX flags to be appended to the build command
1444 default:
1445 actual:
1446
1447 extra_link_flags: Extra LD flags to be appended to the build command
1448 default:
1449 actual:
1450
1451 compiler_cache: Command to prefix to the C and C++ compiler (e.g ccache)
1452 default:
1453 actual:
1454
1455 specs_file: Specs file to use
1456 default: rdimon.specs
1457 actual: rdimon.specs
1458
1459 benchmark_examples: Build benchmark examples programs (yes|no)
1460 default: True
1461 actual: True
1462
1463 validate_examples: Build validate examples programs (yes|no)
1464 default: True
1465 actual: True
1466
1467 reference_openmp: Build reference validation with openmp (yes|no)
1468 default: True
1469 actual: True
1470
1471 validation_tests: Build validation test programs (yes|no)
1472 default: True
1473 actual: True
1474
1475 benchmark_tests: Build benchmark test programs (yes|no)
1476 default: True
1477 actual: True
1478
1479 test_filter: Pattern to specify the tests' filenames to be compiled
1480 default: *.cpp
1481 actual: *.cpp
1482
1483 pmu: Enable PMU counters (yes|no)
1484 default: False
1485 actual: False
1486
1487 mali: Enable Mali hardware counters (yes|no)
1488 default: False
1489 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001490
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001491 external_tests_dir: Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1492 default:
1493 actual:
1494
Anthony Barbier79c61782017-06-23 11:48:24 +01001495@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001496 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1497 - 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)
1498 - 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).
1499
Anthony Barbier79c61782017-06-23 11:48:24 +01001500@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 +01001501
Anthony Barbier79c61782017-06-23 11:48:24 +01001502@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001503@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1504
Anthony Barbier79c61782017-06-23 11:48:24 +01001505@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 +01001506
Anthony Barbier79c61782017-06-23 11:48:24 +01001507@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 +01001508
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001509There 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.
1510
Anthony Barbier79c61782017-06-23 11:48:24 +01001511@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 +01001512
Anthony Barbier20dbb822017-12-13 21:19:39 +00001513@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 +01001514
Anthony Barbier20dbb822017-12-13 21:19:39 +00001515@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 +01001516
1517@b set_soname: Do you want to build the versioned version of the library ?
1518
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001519If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1520Example:
1521 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1522 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1523 libarm_compute_core.so.1.0.0
1524
1525@note This options is disabled by default as it requires SCons version 2.4 or above.
1526
Anthony Barbier79c61782017-06-23 11:48:24 +01001527@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1528
1529@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1530
1531@b examples: Build or not the examples
1532
1533@b validation_tests: Enable the build of the validation suite.
1534
Anthony Barbier79c61782017-06-23 11:48:24 +01001535@b benchmark_tests: Enable the build of the benchmark tests
1536
1537@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1538
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001539@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)
1540
Anthony Barbier79c61782017-06-23 11:48:24 +01001541@b openmp Build in the OpenMP scheduler for NEON.
1542
1543@note Only works when building with g++ not clang++
1544
1545@b cppthreads Build in the C++11 scheduler for NEON.
1546
Anthony Barbier3762e742018-03-02 11:49:33 +00001547@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001548
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001549@b external_tests_dir Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1550
1551In order to use this option, the external tests directory must have the following structure:
1552
1553 EXTERNAL_TESTS_DIR:
1554 └── tests
1555 ├── benchmark
1556 │   ├── CL
1557 │   ├── datasets
1558 │   ├── fixtures
1559 │   └── NEON
1560 └── validation
1561    ├── CL
1562     ├── datasets
1563     ├── fixtures
1564     └── NEON
1565
1566Then, build the library with `external_tests_dir=<PATH_TO_EXTERNAL_TESTS_DIR>`.
1567
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001568@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001569
1570@subsubsection S3_2_1_library How to build the library ?
1571
1572For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1573
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001574 - gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
1575 - gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001576
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001577To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1578
1579 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1580
1581To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1582
1583 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1584
Anthony Barbier20dbb822017-12-13 21:19:39 +00001585To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1586
1587 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1588
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001589You can also compile the library natively on an ARM device by using <b>build=native</b>:
1590
1591 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1592 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1593
1594@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.
1595
1596For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1597
1598 apt-get install g++-arm-linux-gnueabihf
1599
1600Then run
1601
1602 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1603
1604or simply remove the build parameter as build=cross_compile is the default value:
1605
1606 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1607
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001608@subsubsection S3_2_2_examples How to manually build the examples ?
1609
1610The 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.
1611
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001612@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 +01001613
1614To cross compile a NEON example for Linux 32bit:
1615
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001616 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 +01001617
1618To cross compile a NEON example for Linux 64bit:
1619
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001620 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 +01001621
1622(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)
1623
1624To cross compile an OpenCL example for Linux 32bit:
1625
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001626 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 +01001627
1628To cross compile an OpenCL example for Linux 64bit:
1629
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001630 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 +01001631
Anthony Barbier14c86a92017-12-14 16:27:41 +00001632To cross compile a GLES example for Linux 32bit:
1633
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001634 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 +00001635
1636To cross compile a GLES example for Linux 64bit:
1637
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001638 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 +00001639
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001640(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)
1641
Anthony Barbier14c86a92017-12-14 16:27:41 +00001642To 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.
1643
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001644i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1645
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001646 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 +01001647
1648i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1649
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001650 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 +01001651
1652(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)
1653
Anthony Barbiere5007472017-10-27 15:01:44 +01001654@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1655
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001656To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1657
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001658 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 +01001659
1660To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1661
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001662 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 +01001663
1664(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1665
1666To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1667
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001668 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 +01001669
Anthony Barbier14c86a92017-12-14 16:27:41 +00001670To 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 +01001671
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001672 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 +00001673
1674To 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 +00001675
1676i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001677
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001678 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 +01001679
Anthony Barbier14c86a92017-12-14 16:27:41 +00001680i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001681
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001682 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 +01001683
1684(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 +01001685
Anthony Barbiere5007472017-10-27 15:01:44 +01001686@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1687
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001688@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 +00001689@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 +01001690
1691To run the built executable simply run:
1692
1693 LD_LIBRARY_PATH=build ./neon_convolution
1694
1695or
1696
1697 LD_LIBRARY_PATH=build ./cl_convolution
1698
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001699@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 +00001700
1701For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001702
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001703 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001704
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001705Below is a list of the common parameters among the graph examples :
1706@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001707
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001708@subsubsection S3_2_3_sve Build for SVE or SVE2
1709
1710In order to build for SVE or SVE2 you need a compiler that supports them. You can find more information in the following these links:
1711 -# GCC: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/sve-support
1712 -# LLVM: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/llvm-toolchain/sve-support
1713
1714@note You the need to indicate the toolchains using the scons "toolchain_prefix" parameter.
1715
1716An example build command with SVE is:
1717
1718 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-
1719
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001720@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001721
1722For Android, the library was successfully built and tested using Google's standalone toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001723 - clang++ from NDK r18b for armv7a
1724 - clang++ from NDK r18b for arm64-v8a
1725 - clang++ from NDK r18b for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001726
1727Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1728
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001729- Download the NDK r18b from here: https://developer.android.com/ndk/downloads/index.html to directory $NDK
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001730- Make sure you have Python 2.7 installed on your machine.
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001731- 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 +01001732
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001733
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001734 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b --stl libc++ --api 21
1735 $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 +01001736
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001737@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 +01001738
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001739@note Make sure to add the toolchains to your PATH:
1740
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001741 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 +01001742
1743@subsubsection S3_3_1_library How to build the library ?
1744
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001745To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1746
1747 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1748
1749To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1750
Anthony Barbier14c86a92017-12-14 16:27:41 +00001751 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 +01001752
Anthony Barbier20dbb822017-12-13 21:19:39 +00001753To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1754
Anthony Barbier14c86a92017-12-14 16:27:41 +00001755 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 +00001756
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001757@subsubsection S3_3_2_examples How to manually build the examples ?
1758
1759The 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.
1760
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001761@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 +01001762
1763Once you've got your Android standalone toolchain built and added to your path you can do the following:
1764
1765To cross compile a NEON example:
1766
1767 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001768 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 +01001769 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001770 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 +01001771
1772To cross compile an OpenCL example:
1773
1774 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001775 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 +01001776 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001777 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 +00001778
1779To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001780
Anthony Barbier14c86a92017-12-14 16:27:41 +00001781 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001782 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 +00001783 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001784 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 +01001785
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001786To 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 +01001787
1788 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001789 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 +01001790 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001791 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 +01001792
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001793@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 +00001794@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 +01001795
1796Then you need to do is upload the executable and the shared library to the device using ADB:
1797
1798 adb push neon_convolution_arm /data/local/tmp/
1799 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001800 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001801 adb shell chmod 777 -R /data/local/tmp/
1802
1803And finally to run the example:
1804
1805 adb shell /data/local/tmp/neon_convolution_arm
1806 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001807 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001808
1809For 64bit:
1810
1811 adb push neon_convolution_aarch64 /data/local/tmp/
1812 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001813 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001814 adb shell chmod 777 -R /data/local/tmp/
1815
1816And finally to run the example:
1817
1818 adb shell /data/local/tmp/neon_convolution_aarch64
1819 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001820 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001821
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001822@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 +00001823
1824For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001825 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001826
1827In 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.
1828
Georgios Pinitas45514032020-12-30 00:03:09 +00001829@subsection S3_4_macos Building for macOS
1830
1831The library was successfully natively built for Apple Silicon under macOS 11.1 using clang v12.0.0.
1832
1833To natively compile the library with accelerated CPU support:
1834
1835 scons Werror=1 -j8 neon=1 opencl=0 os=macos arch=arm64-v8a build=native
1836
1837@note Initial support disables feature discovery through HWCAPS and thread scheduling affinity controls
1838
1839@subsection S3_5_bare_metal Building for bare metal
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001840
Georgios Pinitas58216322020-02-26 11:13:13 +00001841For 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 +01001842 - arm-eabi for armv7a
1843 - aarch64-elf for arm64-v8a
1844
1845Download 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>.
1846
1847@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
1848
Georgios Pinitas45514032020-12-30 00:03:09 +00001849@subsubsection S3_5_1_library How to build the library ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001850
1851To cross-compile the library with NEON support for baremetal arm64-v8a:
1852
1853 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
1854
Georgios Pinitas45514032020-12-30 00:03:09 +00001855@subsubsection S3_5_2_examples How to manually build the examples ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001856
1857Examples 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>.
1858
Georgios Pinitas45514032020-12-30 00:03:09 +00001859@subsection S3_6_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001860
1861Using `scons` directly from the Windows command line is known to cause
1862problems. The reason seems to be that if `scons` is setup for cross-compilation
1863it gets confused about Windows style paths (using backslashes). Thus it is
1864recommended to follow one of the options outlined below.
1865
Georgios Pinitas45514032020-12-30 00:03:09 +00001866@subsubsection S3_6_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001867
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001868The best and easiest option is to use
1869<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001870This feature is still marked as *beta* and thus might not be available.
1871However, if it is building the library is as simple as opening a *Bash on
1872Ubuntu on Windows* shell and following the general guidelines given above.
1873
Georgios Pinitas45514032020-12-30 00:03:09 +00001874@subsubsection S3_6_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001875
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001876If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001877can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1878to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001879also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001880code of the library.) Linaro provides pre-built versions of
1881<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001882that can be used from the Cygwin terminal. When building for Android the
1883compiler is included in the Android standalone toolchain. After everything has
1884been set up in the Cygwin terminal the general guide on building the library
1885can be followed.
1886
Georgios Pinitas45514032020-12-30 00:03:09 +00001887@subsection S3_7_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001888
Georgios Pinitas45514032020-12-30 00:03:09 +00001889@subsubsection S3_7_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001890
1891Compute 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).
1892
1893Enabling 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.
1894
1895Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1896
Georgios Pinitas45514032020-12-30 00:03:09 +00001897@subsubsection S3_7_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001898
1899Integer 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.
1900
1901OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1902
1903SVM 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 +01001904
Georgios Pinitas45514032020-12-30 00:03:09 +00001905@subsection S3_8_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001906
1907The 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).
1908The 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 +01001909The 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 +01001910In 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.
1911
1912If 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:
1913
1914https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1915
1916Tuning 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.
1917
1918CLTuner 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.
1919
1920 #Example: 2 unique Matrix Multiply configurations
1921@code{.cpp}
1922 TensorShape a0 = TensorShape(32,32);
1923 TensorShape b0 = TensorShape(32,32);
1924 TensorShape c0 = TensorShape(32,32);
1925 TensorShape a1 = TensorShape(64,64);
1926 TensorShape b1 = TensorShape(64,64);
1927 TensorShape c1 = TensorShape(64,64);
1928
1929 Tensor a0_tensor;
1930 Tensor b0_tensor;
1931 Tensor c0_tensor;
1932 Tensor a1_tensor;
1933 Tensor b1_tensor;
1934 Tensor c1_tensor;
1935
1936 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1937 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1938 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1939 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1940 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1941 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1942
1943 CLGEMM gemm0;
1944 CLGEMM gemm1;
1945
1946 // Configuration 0
1947 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1948
1949 // Configuration 1
1950 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1951@endcode
1952
Georgios Pinitas45514032020-12-30 00:03:09 +00001953@subsubsection S3_8_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001954
Michele Di Giorgio57f30a92020-09-08 14:03:51 +01001955All 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 +01001956
1957 #Enable CL tuner
1958 ./graph_mobilenet --enable-tuner –-target=CL
1959 ./arm_compute_benchmark --enable-tuner
1960
1961 #Export/Import to/from a file
1962 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1963 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1964
1965If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1966
1967Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1968
1969 -# Disable the power management
1970 -# Keep the GPU frequency constant
1971 -# Run multiple times the network (i.e. 10).
1972
1973If 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.
1974
1975@code{.cpp}
1976CLTuner tuner;
1977
1978// Setup Scheduler
1979CLScheduler::get().default_init(&tuner);
1980@endcode
1981
1982After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1983- tuner.save_to_file("results.csv");
1984
1985This file can be also imported using the method "load_from_file("results.csv")".
1986- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001987*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001988} // namespace arm_compute