blob: 45824b1f4254ccbbffb31aa2b0a831587d1bb309 [file] [log] [blame]
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00001///
Gian Marco Iodice716b1be2021-02-10 17:33:27 +00002/// Copyright (c) 2017-2021 Arm Limited.
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00003///
4/// SPDX-License-Identifier: MIT
5///
6/// Permission is hereby granted, free of charge, to any person obtaining a copy
7/// of this software and associated documentation files (the "Software"), to
8/// deal in the Software without restriction, including without limitation the
9/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10/// sell copies of the Software, and to permit persons to whom the Software is
11/// furnished to do so, subject to the following conditions:
12///
13/// The above copyright notice and this permission notice shall be included in all
14/// copies or substantial portions of the Software.
15///
16/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22/// SOFTWARE.
23///
Anthony Barbier3762e742018-03-02 11:49:33 +000024namespace arm_compute
25{
Anthony Barbier6ff3b192017-09-04 18:44:23 +010026/** @mainpage Introduction
27
28@tableofcontents
29
30The Computer Vision and Machine Learning library is a set of functions optimised for both ARM CPUs and GPUs using SIMD technologies.
31
32Several builds of the library are available using various configurations:
Georgios Pinitas45514032020-12-30 00:03:09 +000033 - OS: Linux, Android, macOS or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010034 - Architecture: armv7a (32bit) or arm64-v8a (64bit)
Anthony Barbier20dbb822017-12-13 21:19:39 +000035 - Technology: NEON / OpenCL / GLES_COMPUTE / NEON and OpenCL and GLES_COMPUTE
Anthony Barbier6ff3b192017-09-04 18:44:23 +010036 - Debug / Asserts / Release: Use a build with asserts enabled to debug your application and enable extra validation. Once you are sure your application works as expected you can switch to a release build of the library for maximum performance.
37
38@section S0_1_contact Contact / Support
39
Michele Di Giorgioeca54a02021-02-16 15:37:59 +000040Please create an issue on <a href="https://github.com/ARM-software/ComputeLibrary/issues">Github</a>.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010041
42In order to facilitate the work of the support team please provide the build information of the library you are using. To get the version of the library you are using simply run:
43
44 $ strings android-armv7a-cl-asserts/libarm_compute.so | grep arm_compute_version
45 arm_compute_version=v16.12 Build options: {'embed_kernels': '1', 'opencl': '1', 'arch': 'armv7a', 'neon': '0', 'asserts': '1', 'debug': '0', 'os': 'android', 'Werror': '1'} Git hash=f51a545d4ea12a9059fe4e598a092f1fd06dc858
46
Anthony Barbier14c86a92017-12-14 16:27:41 +000047@section S0_2_prebuilt_binaries Pre-built binaries
48
49For each release we provide some pre-built binaries of the library [here](https://github.com/ARM-software/ComputeLibrary/releases)
50
51These binaries have been built using the following toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +010052 - Linux armv7a: gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
53 - Linux arm64-v8a: gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
54 - Android armv7a: clang++ / libc++ NDK r18b
55 - Android am64-v8a: clang++ / libc++ NDK r18b
Anthony Barbier14c86a92017-12-14 16:27:41 +000056
57@warning Make sure to use a compatible toolchain to build your application or you will get some std::bad_alloc errors at runtime.
58
Anthony Barbier6ff3b192017-09-04 18:44:23 +010059@section S1_file_organisation File organisation
60
61This archive contains:
62 - The arm_compute header and source files
63 - The latest Khronos OpenCL 1.2 C headers from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a>
64 - The latest Khronos cl2.hpp from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a> (API version 2.1 when this document was written)
Anthony Barbier20dbb822017-12-13 21:19:39 +000065 - The latest Khronos OpenGL ES 3.1 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos OpenGL ES registry</a>
66 - The latest Khronos EGL 1.5 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos EGL registry</a>
67 - The sources for a stub version of libOpenCL.so, libGLESv1_CM.so, libGLESv2.so and libEGL.so to help you build your application.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010068 - An examples folder containing a few examples to compile and link against the library.
69 - A @ref utils folder containing headers with some boiler plate code used by the examples.
70 - This documentation.
71
Michele Di Giorgio552e11d2020-09-23 15:08:38 +010072 For detailed information about file organization, please refer to Files -> File List section of this documentation.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010073
74@section S2_versions_changelog Release versions and changelog
75
76@subsection S2_1_versions Release versions
77
78All releases are numbered vYY.MM Where YY are the last two digits of the year, and MM the month number.
79If there is more than one release in a month then an extra sequential number is appended at the end:
80
81 v17.03 (First release of March 2017)
82 v17.03.1 (Second release of March 2017)
83 v17.04 (First release of April 2017)
84
85@note We're aiming at releasing one major public release with new features per quarter. All releases in between will only contain bug fixes.
86
87@subsection S2_2_changelog Changelog
88
Georgios Pinitas40f51a62020-11-21 03:04:18 +000089v21.02 Public major release
Sheri Zhangda6a6eb2021-01-06 11:15:06 +000090 - Various bug fixes.
91 - Various optimisations.
Georgios Pinitas45514032020-12-30 00:03:09 +000092 - Upgrade C++ standard to C++14
93 - Add macOS support
Giorgio Arena1055dc12021-02-19 09:53:06 +000094 - Add Armv8-R AArch64 architecture support
Sheri Zhangda6a6eb2021-01-06 11:15:06 +000095 - Add SVE/SVE2 support for:
96 - @ref NEScaleKernel
97 - @ref NEActivationLayer
98 - @ref NEArithmeticAddition
99 - @ref NEBatchNormalizationLayerKernel
Giorgio Arena1055dc12021-02-19 09:53:06 +0000100 - @ref cpu::kernels::CpuLogits1DSoftmaxKernel
101 - @ref cpu::kernels::CpuLogits1DMaxKernel
102 - @ref cpu::kernels::CpuElementwiseUnaryKernel
Sheri Zhangdda69142021-02-01 19:06:57 +0000103 - Remove padding from OpenCL kernels:
104 - @ref CLDirectConvolutionLayerKernel
105 - @ref CLArgMinMaxLayerKernel
106 - @ref CLPadLayerKernel
107 - @ref CLROIAlignLayerKernel
108 - @ref CLRangeKernel
109 - @ref CLScaleKernel
110 - @ref CLSelectKernel
111 - @ref CLBitwiseKernel
Giorgio Arena1055dc12021-02-19 09:53:06 +0000112 - @ref opencl::kernels::ClFloorKernel
Sheri Zhangdda69142021-02-01 19:06:57 +0000113 - @ref CLTransposeKernel
Giorgio Arena5b50f422021-02-17 11:43:05 +0000114 - Deprecate functions in CLTuner:
115 - add_lws_to_table
116 - import_lws_table
117 - lws_table
Sheri Zhangda6a6eb2021-01-06 11:15:06 +0000118 - Remove functions:
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000119 - NELocallyConnectedLayer / CLLocallyConnectedLayer
Georgios Pinitasf7c5a412020-12-03 14:38:33 +0000120 - NEIm2Col
121 - NECol2Im
122 - NEGEMMInterleave4x4
123 - NEGEMMTranspose1xW
Georgios Pinitas8c3c0e72020-12-03 20:11:53 +0000124 - NEComputeAllAnchors / CLComputeAllAnchors
Georgios Pinitasec2256b2020-12-03 18:51:58 +0000125 - NEGEMMAssemblyDispatch
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000126 - NEUpsampleLayer / CLUpsampleLayer
Sheri Zhangda6a6eb2021-01-06 11:15:06 +0000127 - Remove kernels:
Georgios Pinitasd308df32020-12-01 16:56:36 +0000128 - NEGEMMMatrixVectorMultiplyKernel
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000129 - NELocallyConnectedMatrixMultiplyKernel / CLLocallyConnectedMatrixMultiplyKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000130 - NEUpsampleLayerKernel / CLUpsampleLayerKernel
Gian Marco Iodicef5aad512021-02-08 17:34:40 +0000131 - Extend OpenCL tuner with workgroup batch size support
132 - Experimental extension for the OpenCL tuner to tune the batches of work groups distribute to compute units
Gian Marco Iodice716b1be2021-02-10 17:33:27 +0000133 - Add functionality to load the OpenCL GEMM heuristics at runtime
134 - The GEMM heuristic file (MLGO) can be used to update the default GEMM heuristics available for OpenCL
Georgios Pinitas40f51a62020-11-21 03:04:18 +0000135
SiCong Li96209c72020-08-21 12:28:30 +0100136v20.11 Public major release
morgolock70b1eb82020-11-24 13:54:19 +0000137 - Various bug fixes.
138 - Various optimisations.
139 - 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 +0000140 This is planned to be resolved in 21.02 release.
morgolock70b1eb82020-11-24 13:54:19 +0000141 - Added new data type QASYMM8_SIGNED support for @ref NEROIAlignLayer.
SiCong Li903f8cc2020-08-27 10:17:10 +0100142 - Added new data type S32 support for:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000143 - NEArithmeticSubtraction
144 - NEArithmeticSubtractionKernel
SiCong Libb88f892020-08-28 11:18:47 +0100145 - @ref NEPixelWiseMultiplication
146 - @ref NEPixelWiseMultiplicationKernel
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000147 - NEElementwiseDivision
148 - NEDivisionOperationKernel
SiCong Li96209c72020-08-21 12:28:30 +0100149 - Interface change
150 - Properly support softmax axis to have the same meaning as other major frameworks. That is, axis now defines the dimension
151 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.
152 The supported value range of axis is [-rank, rank).
153 This change applies to the following functions:
154 - @ref NESoftmaxLayer
155 - @ref NELogSoftmaxLayer
156 - @ref CLSoftmaxLayer
157 - @ref CLLogSoftmaxLayer
158 - @ref GCSoftmaxLayer
Sheri Zhang824061d2020-10-26 15:46:37 +0000159 - New OpenCL kernels / functions:
160 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
morgolock0e728492020-11-20 11:03:33 +0000161 - @ref CLLogicalNot
162 - @ref CLLogicalAnd
163 - @ref CLLogicalOr
164 - New NEON kernels / functions:
165 - @ref NELogicalNot
166 - @ref NELogicalAnd
167 - @ref NELogicalOr
Sheri Zhang824061d2020-10-26 15:46:37 +0000168 - Removed padding from NEON kernels:
Sheri Zhanged367132020-10-08 15:46:16 +0100169 - @ref NEComplexPixelWiseMultiplicationKernel
170 - @ref NENonMaximaSuppression3x3Kernel
171 - @ref NERemapKernel
172 - @ref NEGEMMInterleave4x4Kernel
173 - @ref NEDirectConvolutionLayerKernel
174 - @ref NEScaleKernel
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000175 - NELocallyConnectedMatrixMultiplyKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100176 - @ref NEGEMMLowpOffsetContributionKernel
177 - @ref NEGEMMTranspose1xWKernel
Michele Di Giorgio19289042021-02-03 16:05:00 +0000178 - NEPoolingLayerKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100179 - @ref NEConvolutionKernel
180 - @ref NEDepthwiseConvolutionLayerNativeKernel
181 - @ref NEGEMMLowpMatrixMultiplyKernel
182 - @ref NEGEMMMatrixMultiplyKernel
183 - @ref NEDirectConvolutionLayerOutputStageKernel
184 - @ref NEReductionOperationKernel
185 - @ref NEGEMMLowpMatrixAReductionKernel
186 - @ref NEGEMMLowpMatrixBReductionKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000187 - Removed padding from OpenCL kernels:
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000188 - CLBatchConcatenateLayerKernel
Michele Di Giorgio1e0208a2021-01-22 15:42:59 +0000189 - CLElementwiseOperationKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000190 - @ref CLBatchNormalizationLayerKernel
Michele Di Giorgioe1314662021-02-01 17:09:32 +0000191 - CLPoolingLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000192 - @ref CLWinogradInputTransformKernel
193 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
194 - @ref CLGEMMLowpMatrixAReductionKernel
195 - @ref CLGEMMLowpMatrixBReductionKernel
196 - @ref CLGEMMLowpOffsetContributionOutputStageKernel
197 - @ref CLGEMMLowpOffsetContributionKernel
198 - @ref CLWinogradOutputTransformKernel
199 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
200 - @ref CLFuseBatchNormalizationKernel
201 - @ref CLDepthwiseConvolutionLayerNativeKernel
202 - @ref CLDepthConvertLayerKernel
Sheri Zhang7e20e292021-02-02 11:49:34 +0000203 - CLCopyKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000204 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000205 - CLActivationLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000206 - @ref CLWinogradFilterTransformKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000207 - CLWidthConcatenateLayerKernel
208 - CLWidthConcatenate4TensorsKernel
209 - CLWidthConcatenate2TensorsKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000210 - @ref CLLogits1DMaxShiftExpSumKernel
211 - @ref CLLogits1DNormKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000212 - CLHeightConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000213 - @ref CLGEMMMatrixMultiplyKernel
214 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
215 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
216 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000217 - CLDepthConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000218 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
219 - Removed OpenCL kernels / functions:
220 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
221 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel
222 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel
morgolock00c76012020-11-06 10:40:12 +0000223 - 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 +0100224 - CLLocallyConnectedLayer
225 - CLLocallyConnectedMatrixMultiplyKernel
morgolock00c76012020-11-06 10:40:12 +0000226 - CLAbsoluteDifference
227 - CLAbsoluteDifferenceKernel
228 - CLAccumulate
229 - CLAccumulateKernel
230 - CLAccumulateSquared
231 - CLAccumulateSquaredKernel
232 - CLAccumulateWeighted
233 - CLAccumulateWeightedKernel
234 - CLAccumulateWeightedFP16Kernel
235 - CLBox3x3
236 - CLBox3x3Kernel
237 - CLBox3x3FP16Kernel
238 - CLCannyEdge
239 - CLChannelCombine
240 - CLChannelCombineKernel
241 - CLChannelExtract
242 - CLChannelExtractKernel
243 - CLColorConvert
244 - CLColorConvertKernel
245 - CLConvolution3x3
246 - CLConvolutionRectangle
247 - CLConvolutionRectangleKernel
248 - CLConvolutionSquare
249 - CLConvolutionKernel
250 - CLDerivative
251 - CLDerivativeKernel
252 - CLDilate
253 - CLDilateKernel
254 - CLEqualizeHistogram
255 - CLErode
256 - CLErodeKernel
257 - CLFastCorners
258 - CLFastCornersKernel
259 - CLGaussian3x3
260 - CLGaussian3x3Kernel
261 - CLGaussian5x5
262 - CLGaussian5x5HorKernel
263 - CLGaussian5x5VertKernel
264 - CLGaussianPyramid
265 - CLGaussianPyramidHalf
266 - CLGaussianPyramidOrb
267 - CLHarrisCorners
268 - CLHarrisScoreKernel
269 - CLHarrisScoreFP16Kernel
270 - CLHistogram
271 - CLHistogramKernel
272 - CLHOGOrientationBinningKernel
273 - CLHOGBlockNormalizationKernel
274 - CLHOGDetectorKernel
275 - CLHOGNonMaximaSuppressionKernel
276 - CLHOGDescriptor
277 - CLHOGDetector
278 - CLHOGGradient
279 - CLHOGMultiDetection
280 - CLHOGOrientationBinningKernel
281 - CLHOGBlockNormalizationKernel
282 - CLHOGDetectorKernel
283 - CLIntegralImage
284 - CLIntegralImageKernel
285 - CLLaplacianReconstruct
286 - CLLaplacianPyramid
287 - CLMagnitude
288 - CLMagnitudePhaseKernel
289 - CLMedian3x3
290 - CLMedian3x3Kernel
291 - CLMinMaxLocation
292 - CLMinMaxLocationKernel
293 - CLNonLinearFilter
294 - CLNonLinearFilterKernel
295 - CLNonMaximaSuppression3x3
296 - CLNonMaximaSuppression3x3FP16Kernel
297 - CLNonMaximaSuppression3x3Kernel
298 - CLOpticalFlow
299 - CLPhase
300 - CLRemap
301 - CLRemapKernel
302 - CLScharr3x3
303 - CLScharr3x3Kernel
304 - CLSobel3x3
305 - CLSobel3x3Kernel
306 - CLSobel5x5
307 - CLSobel5x5HorKernel
308 - CLSobel5x5VertKernel
309 - CLSobel7x7
310 - CLSobel7x7HorKernel
311 - CLSobel7x7VertKernel
312 - CLThreshold
313 - CLThresholdKernel
314 - CLWarpAffine
315 - CLWarpAffineKernel
316 - CLWarpPerspective
317 - CLWarpPerspectiveKernel
318 - 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 +0100319 - NELocallyConnectedLayer
320 - NELocallyConnectedMatrixMultiplyKernel
morgolock0c862652020-11-06 08:59:45 +0000321 - NEAbsoluteDifference
322 - NEAbsoluteDifferenceKernel
323 - NEAccumulate
324 - NEAccumulateKernel
325 - NEAccumulateSquared
326 - NEAccumulateSquaredKernel
327 - NEAccumulateWeighted
328 - NEAccumulateWeightedKernel
329 - NEAccumulateWeightedFP16Kernel
330 - NEBox3x3
331 - NEBox3x3Kernel
332 - NEBox3x3FP16Kernel
333 - NECannyEdge
334 - NEChannelCombine
335 - NEChannelCombineKernel
336 - NEChannelExtract
337 - NEChannelExtractKernel
338 - NEColorConvert
339 - NEColorConvertKernel
340 - NEConvolution3x3
341 - NEConvolutionRectangle
342 - NEConvolutionRectangleKernel
343 - NEConvolutionSquare
344 - NEConvolutionKernel
345 - NEDerivative
346 - NEDerivativeKernel
347 - NEDilate
348 - NEDilateKernel
349 - NEEqualizeHistogram
350 - NEErode
351 - NEErodeKernel
352 - NEFastCorners
353 - NEFastCornersKernel
354 - NEGaussian3x3
355 - NEGaussian3x3Kernel
356 - NEGaussian5x5
357 - NEGaussian5x5HorKernel
358 - NEGaussian5x5VertKernel
359 - NEGaussianPyramid
360 - NEGaussianPyramidHalf
361 - NEGaussianPyramidOrb
362 - NEHarrisCorners
363 - NEHarrisScoreKernel
364 - NEHarrisScoreFP16Kernel
365 - NEHistogram
366 - NEHistogramKernel
367 - NEHOGOrientationBinningKernel
368 - NEHOGBlockNormalizationKernel
369 - NEHOGDetectorKernel
370 - NEHOGNonMaximaSuppressionKernel
371 - NEHOGDescriptor
372 - NEHOGDetector
373 - NEHOGGradient
374 - NEHOGMultiDetection
375 - NEHOGOrientationBinningKernel
376 - NEHOGBlockNormalizationKernel
377 - NEHOGDetectorKernel
378 - NEIntegralImage
379 - NEIntegralImageKernel
380 - NELaplacianReconstruct
381 - NELaplacianPyramid
382 - NEMagnitude
383 - NEMagnitudePhaseKernel
384 - NEMedian3x3
385 - NEMedian3x3Kernel
386 - NEMinMaxLocation
387 - NEMinMaxLocationKernel
388 - NENonLinearFilter
389 - NENonLinearFilterKernel
390 - NENonMaximaSuppression3x3
391 - NENonMaximaSuppression3x3FP16Kernel
392 - NENonMaximaSuppression3x3Kernel
393 - NEOpticalFlow
394 - NEPhase
395 - NERemap
396 - NERemapKernel
397 - NEScharr3x3
398 - NEScharr3x3Kernel
399 - NESobel3x3
400 - NESobel3x3Kernel
401 - NESobel5x5
402 - NESobel5x5HorKernel
403 - NESobel5x5VertKernel
404 - NESobel7x7
405 - NESobel7x7HorKernel
406 - NESobel7x7VertKernel
407 - NEThreshold
408 - NEThresholdKernel
409 - NEWarpAffine
410 - NEWarpAffineKernel
411 - NEWarpPerspective
412 - NEWarpPerspectiveKernel
morgolockd6ee9ed2020-11-19 10:07:14 +0000413 - Deprecated GLES kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together):
414 - GCAbsoluteDifference
415 - GCActivationLayer
416 - GCArithmeticAddition
417 - GCBatchNormalizationLayer
418 - GCConcatenateLayer
419 - GCConvolutionLayer
420 - GCDepthwiseConvolutionLayer
421 - GCDirectConvolutionLayer
422 - GCDropoutLayer
423 - GCFillBorder
424 - GCFullyConnectedLayer
425 - GCGEMM
426 - GCGEMMInterleave4x4
427 - GCGEMMTranspose1xW
428 - GCNormalizationLayer
429 - GCNormalizePlanarYUVLayer
430 - GCPixelWiseMultiplication
431 - GCPoolingLayer
432 - GCScale
433 - GCSoftmaxLayer
434 - GCTensorShift
435 - GCTranspose
436
SiCong Li96209c72020-08-21 12:28:30 +0100437
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100438v20.08 Public major release
439 - Various bug fixes.
440 - Various optimisations.
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100441 - Added new data type QASYMM8_SIGNED support for:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100442 - @ref CLArgMinMaxLayer
443 - @ref CLArgMinMaxLayerKernel
444 - Added new data type U8 support for:
445 - @ref NECropKernel
Sheri Zhang7e20e292021-02-02 11:49:34 +0000446 - CLCropKernel
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100447 - Added aligh_corner support for nearest neighbor interpolation in:
448 - @ref NEScaleKernel
449 - @ref CLScaleKernel
450 - New OpenCL kernels / functions:
451 - @ref CLMaxUnpoolingLayerKernel
452 - New NEON kernels / functions:
453 - @ref NEMaxUnpoolingLayerKernel
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100454 - New graph example:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100455 - graph_yolov3_output_detector
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100456 - GEMMTuner improvements:
457 - Added fp16 support
458 - Output json files for easier integration
459 - Enabled tuning for export_to_cl_image_rhs option for RHS tensors
460 - More robust script for running benchmarks
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100461 - Removed padding from:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100462 - @ref NEPixelWiseMultiplicationKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000463 - NEHeightConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100464 - @ref NEThresholdKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000465 - NEBatchConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100466 - @ref NETransposeKernel
467 - @ref NEBatchNormalizationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000468 - NEArithmeticSubtractionKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100469 - @ref NEBoundingBoxTransformKernel
Michalis Spyrou373b4072021-01-20 16:41:12 +0000470 - NELogits1DMaxKernel
471 - NELogits1DSoftmaxKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100472 - @ref NEROIPoolingLayerKernel
473 - @ref NEROIAlignLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000474 - NEYOLOLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000475 - NEUpsampleLayerKernel
Georgios Pinitas70eb53b2021-01-06 19:42:21 +0000476 - NEFloorKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000477 - NEWidthConcatenateLayerKernel
478 - NEDepthConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100479 - @ref NENormalizationLayerKernel
480 - @ref NEL2NormalizeLayerKernel
481 - @ref NEFillArrayKernel
482 - @ref NEDepthConvertLayerKernel
483 - @ref NERangeKernel
484 - @ref NEPriorBoxLayer
Sheri Zhanged367132020-10-08 15:46:16 +0100485 - Removed OpenCL kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100486 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
487 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Sang-Hoon Parka45abfd2020-08-17 13:50:15 +0100488 - Removed NEON kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100489 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
490 - NEGEMMMatrixAccumulateBiasesKernel
SiCong Lid004a7a2020-05-28 15:26:41 +0100491 - Deprecated functions / interfaces:
492 - Non-descriptor based interfaces for @ref NEThreshold, @ref CLThreshold
Sang-Hoon Park97c1a672020-08-18 11:44:13 +0100493 - Non-descriptor based interfaces for @ref NEScale, @ref CLScale and @ref GCScale
SiCong Lid004a7a2020-05-28 15:26:41 +0100494 - In @ref NESoftmaxLayer, @ref NELogSoftmaxLayer, @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer :
morgolock9c7fed82020-08-05 12:30:56 +0100495 The default "axis" value for @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer is changed from 1 to 0.
496 Only axis 0 is supported.
497 The default "axis" value for @ref NESoftmaxLayer, @ref NELogSoftmaxLayer is changed from 1 to 0.
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100498 Only axis 0 is supported.
Sang-Hoon Parka0205b92020-07-07 09:36:09 +0100499 - The support for quantized data types has been removed from @ref CLLogSoftmaxLayer due to implementation complexity.
Gian Marco Iodice547b2e72020-08-12 10:25:29 +0100500 - 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 +0100501 - This change allows to use @ref CLGEMMConvolutionLayer without extra padding for the input and output.
502 - Only the weights/bias of @ref CLGEMMConvolutionLayer could require padding for the computation.
503 - 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 +0100504 - 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 +0100505 - This support allows to export the OpenCL buffer used for the reshaped RHS matrix to the OpenCL image object.
506 - The padding requirement for the OpenCL image object is considered into the @ref CLGEMMReshapeRHSMatrixKernel.
507 - The reshaped RHS matrix stores the weights when GEMM is used to accelerate @ref CLGEMMConvolutionLayer.
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100508
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000509v20.05 Public major release
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000510 - Various bug fixes.
511 - Various optimisations.
Michele Di Giorgio36a551f2020-04-23 11:55:29 +0100512 - Updated recommended NDK version to r18b.
513 - Updated recommended gcc version to Linaro 6.3.1.
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000514 - Added Bfloat16 type support
515 - Added Bfloat16 support in:
516 - @ref NEWeightsReshapeKernel
517 - @ref NEConvolutionLayerReshapeWeights
518 - @ref NEIm2ColKernel
Georgios Pinitasf7c5a412020-12-03 14:38:33 +0000519 - NEIm2Col
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000520 - @ref NEDepthConvertLayerKernel
521 - @ref NEDepthConvertLayer
522 - @ref NEGEMMConvolutionLayer
Georgios Pinitasec2256b2020-12-03 18:51:58 +0000523 - NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000524 - Added new data type QASYMM8_SIGNED support for:
525 - @ref CLDirectConvolutionLayer
526 - @ref CLDeconvolutionLayer
527 - @ref CLDirectDeconvolutionLayer
528 - @ref CLGEMMDeconvolutionLayer
529 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
530 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
531 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
532 - @ref CLReductionOperation
533 - @ref CLReduceMean
Sheri Zhang359c48e2020-04-30 22:53:39 +0100534 - @ref NEScale
535 - @ref NEScaleKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000536 - NEUpsampleLayer
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000537 - @ref NECast
538 - @ref NEReductionOperation
539 - @ref NEReduceMean
540 - @ref NEArgMinMaxLayer
541 - @ref NEDeconvolutionLayer
542 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
543 - @ref CPPBoxWithNonMaximaSuppressionLimit
544 - @ref CPPDetectionPostProcessLayer
545 - @ref CPPPermuteKernel
546 - @ref CPPPermute
547 - @ref CPPTopKVKernel
548 - @ref CPPTopKV
Sheri Zhang359c48e2020-04-30 22:53:39 +0100549 - @ref CPPUpsample
550 - @ref CPPUpsampleKernel
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100551 - New OpenCL kernels / functions:
552 - @ref CLQLSTMLayer
553 - @ref CLQLSTMLayerNormalizationKernel
554 - New NEON kernels / functions:
555 - @ref NEQLSTMLayer
556 - @ref NEQLSTMLayerNormalizationKernel
557 - Added HARD_SWISH support in:
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000558 - CLActivationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000559 - NEActivationLayerKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000560 - Deprecated OpenCL kernels / functions:
561 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
562 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
563 - Deprecated NEON kernels / functions:
564 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
565 - Removed CPP kernels / functions:
566 - CPPFlipWeightsKernel
Manuel Bottini387259a2020-05-21 17:14:36 +0100567 - Removed PoolingLayerInfo constructors without Data Layout.
568 - Removed CLDepthwiseConvolutionLayer3x3
569 - Removed NEDepthwiseConvolutionLayerOptimized
Manuel Bottini075253a2020-05-22 12:57:18 +0100570 - Added support for Winograd 3x3,4x4 on NEON FP16:
571 - @ref NEWinogradConvolutionLayer
572 - @ref NEWinogradLayerTransformInputKernel
573 - @ref NEWinogradLayerTransformOutputKernel
574 - @ref NEWinogradLayerTransformWeightsKernel
575 - Added CLCompileContext
576 - Added NEON GEMM kernel with 2D window support
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000577
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000578v20.02.1 Maintenance release
579 - Added Android-NN build script.
580
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000581v20.02 Public major release
582 - Various bug fixes.
583 - Various optimisations.
584 - Added new data type QASYMM8_SIGNED support for:
585 - @ref CLDepthwiseConvolutionLayer
Manuel Bottini387259a2020-05-21 17:14:36 +0100586 - CLDepthwiseConvolutionLayer3x3
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000587 - @ref CLGEMMConvolutionLayer
588 - @ref CLGEMMLowpMatrixMultiplyCore
589 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
590 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
591 - @ref NEActivationLayer
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000592 - NEComparisonOperationKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000593 - @ref NEConvolutionLayer
594 - @ref NEDepthwiseConvolutionLayer
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100595 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000596 - @ref NEDirectConvolutionLayerOutputStageKernel
597 - @ref NEElementwiseComparison
598 - @ref NEElementwiseMax
599 - @ref NEElementwiseMin
600 - @ref NEElementwiseSquaredDiff
601 - @ref NEFullyConnectedLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +0100602 - NEGEMMMatrixVectorMultiplyKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000603 - @ref NEPixelWiseMultiplication
604 - @ref NEPoolingLayer
605 - @ref NEPReluLayer
606 - Added support for QSYMM8_PER_CHANNEL in:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100607 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000608 - Added support for split sizes in:
609 - @ref CLSplit
610 - @ref NESplit
611 - New OpenCL kernels / functions:
612 - @ref CLFill
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100613 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000614 - New NEON kernels / functions:
615 - @ref NEFill
616 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
617 - Deprecated NEON functions / interfaces:
Manuel Bottini387259a2020-05-21 17:14:36 +0100618 - CLDepthwiseConvolutionLayer3x3
619 - NEDepthwiseConvolutionLayerOptimized
620 - PoolingLayerInfo constructors without Data Layout.
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000621 - Added support for quantization with multiplier greater than 1 on NEON and CL.
622 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
623 - Added the ability to build bootcode for bare metal.
624 - Added support for generating synthetic QASYMM8 graphs.
625 - Added support for F16 datatype in VGG16.
626 - Removed pre-built binaries for GLES.
627
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000628v19.11.1 Public maintenance release
629 - Fix offset calculation in NEReductionOperationKernel.
630 - Fix data layout in NEScaleKernel for nhwc.
631 - Retain configuration step data layout to avoid side-effects.
632 - Perform sqrt in double domain for L2 pooling.
633 - Fix output shape calculation for Reduce Mean
634 - Restrict cases where optimized NEPadLayer runs.
635
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100636v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000637 - Various bug fixes.
638 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000639 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000640 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100641 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
642 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000643 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100644 - CLDepthwiseVectorToTensorKernel
645 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000646 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100647 - NEDepthwiseWeightsReshapeKernel
648 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000649 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100650 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100651 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000652 - New OpenCL kernels / functions:
653 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
654 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
655 OpenCL kernels / functions)
656 - @ref CLLogSoftmaxLayer
657 - New NEON kernels / functions:
658 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
Georgios Pinitas8c3c0e72020-12-03 20:11:53 +0000659 - @ref NEComputeAllAnchorsKernel / NEComputeAllAnchors
SiCong Lica1f98c2019-11-28 11:06:11 +0000660 - @ref NEDetectionPostProcessLayer
661 - @ref NEGenerateProposalsLayer
662 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
663 - @ref NELogSoftmaxLayer
664 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
665 - Added QASYMM8 support for:
666 - @ref CLGenerateProposalsLayer
667 - @ref CLROIAlignLayer
668 - @ref CPPBoxWithNonMaximaSuppressionLimit
669 - Added QASYMM16 support for:
670 - @ref CLBoundingBoxTransform
671 - Added FP16 support for:
672 - @ref CLGEMMMatrixMultiplyReshapedKernel
673 - Added new data type QASYMM8_PER_CHANNEL support for:
674 - @ref CLDequantizationLayer
675 - @ref NEDequantizationLayer
676 - Added new data type QSYMM8_PER_CHANNEL support for:
677 - @ref CLConvolutionLayer
678 - @ref NEConvolutionLayer
679 - @ref CLDepthwiseConvolutionLayer
680 - @ref NEDepthwiseConvolutionLayer
681 - Added FP16 mixed-precision support for:
682 - @ref CLGEMMMatrixMultiplyReshapedKernel
Michele Di Giorgioe1314662021-02-01 17:09:32 +0000683 - CLPoolingLayerKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000684 - Added FP32 and FP16 ELU activation for:
685 - @ref CLActivationLayer
686 - @ref NEActivationLayer
687 - Added asymmetric padding support for:
688 - @ref CLDirectDeconvolutionLayer
689 - @ref CLGEMMDeconvolutionLayer
690 - @ref NEDeconvolutionLayer
691 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000692 - Replaced the calls to NECopyKernel and NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
693 - Replaced the calls to CLCopyKernel and CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
SiCong Lica1f98c2019-11-28 11:06:11 +0000694 - Improved performance for CL Inception V3 - FP16.
695 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
696 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
697 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
698 - Optimized @ref CLPadLayer.
699 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
700 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100701
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000702v19.08.1 Public maintenance release
703 - Fix offset calculation in NEReductionOperationKernel.
704 - Fix data layout in NEScaleKernel for nhwc.
705 - Retain configuration step data layout to avoid side-effects.
706 - Perform sqrt in double domain for L2 pooling.
707 - Fix output shape calculation for Reduce Mean
708 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
709
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100710v19.08 Public major release
711 - Various bug fixes.
712 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100713 - Deprecated NEON functions
714 - NEDepthConcatenateLayer
715 - NEWidthConcatenateLayer
716 - Deprecated OpenCL kernels / functions
717 - CLDepthConcatenateLayer
718 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
719 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
720 - CLWidthConcatenateLayer
721 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100722 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100723 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100724 - @ref NEElementwisePower
725 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100726 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100727 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100728 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100729 - @ref NESinLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000730 - NEBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100731 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
732 - @ref NEDepthwiseConvolutionLayerNativeKernel
733 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
734 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
735 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
736 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100737 - @ref CLAbsLayer
738 - @ref CLElementwisePower
739 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100740 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100741 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100742 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100743 - @ref CLSinLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000744 - CLBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100745 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
746 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100747 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100748 - @ref CLGEMMMatrixMultiplyNativeKernel
749 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
750 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
751 - New examples:
752 - neon_opticalflow
753 - cl_cache
754 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100755 - Added support for FP16 in @ref NEDeconvolutionLayer
756 - Added support for FP16 in @ref CLDeconvolutionLayer
757 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100758 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
759 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
760 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
761 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
762 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
763 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini387259a2020-05-21 17:14:36 +0100764 - The CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
765 - The NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100766 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
767 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100768 - 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 +0100769
Michalis Spyroua9c44722019-04-05 17:18:36 +0100770v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100771 - Various bug fixes.
772 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100773 - New Neon kernels / functions:
774 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100775 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100776 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100777 - @ref NEDepthwiseConvolutionAssemblyDispatch
778 - @ref NEFFTDigitReverseKernel
779 - @ref NEFFTRadixStageKernel
780 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100781 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000782 - NEHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100783 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100784 - @ref NEFFT1D
785 - @ref NEFFT2D
786 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100787 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100788 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Sheri Zhang7e20e292021-02-02 11:49:34 +0000789 - CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100790 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100791 - @ref CLFFTDigitReverseKernel
792 - @ref CLFFTRadixStageKernel
793 - @ref CLFFTScaleKernel
794 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
795 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000796 - CLHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100797 - @ref CLDirectDeconvolutionLayer
798 - @ref CLFFT1D
799 - @ref CLFFT2D
800 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100801 - @ref CLGEMMDeconvolutionLayer
802 - New OpenGLES kernels / functions:
803 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100804 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100805 - GCDepthConcatenateLayer
806 - NEWidthConcatenateLayer
807 - NEDepthConcatenateLayer
808 - CLWidthConcatenateLayer
809 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100810 - CLGEMMInterleave4x4
811 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100812 - Support different quantization info in CLConcatLayer.
813 - Add checks on different input/output quantization info were not supported.
814 - Tensors have different quantization information.
815 - Add FP16 support checks.
816 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
817 - New graph examples:
818 - graph_convolution
819 - graph_fully_connected
820 - graph_depthwise_convolution
821 - Deepspeech v0.4.1
822 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
823 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
824 - Add support for QASYMM8 NEDeconvolution.
825 - Add support for DequantizationLayer for NEON/CL.
826 - Add support for dilation in CLDepthwiseConvolution.
827 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
828 - Optimize CLDeconvolution.
829 - Add StackLayer to the graph API.
830 - Add support for "reflect" padding mode in NEPad.
831 - Winograd 7x7 NHWC on OpenCL.
832 - Rework CL ML layers to run exclusively on CL.
833 - Support different quantization info in PoolingLayer.
834 - Implement and test import memory interfaces.
835 - Added new tests and removed old ones.
836 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100837
giuros01a69a88b2019-01-31 16:29:19 +0000838v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000839 - Various bug fixes.
840 - Various optimisations.
841 - New Neon kernels / functions:
842 - @ref NETileKernel / @ref NETile
843 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000844 - NEElementwiseOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000845 - @ref NEElementwiseMax
846 - @ref NEElementwiseMin
847 - @ref NEElementwiseSquaredDiff
848 - @ref NESelectKernel / @ref NESelect
849 - @ref NESplit
850 - @ref NESlice
851 - @ref NEUnstack
852 - @ref NEStridedSliceKernel / @ref NEStridedSlice
Sang-Hoon Park7249f152021-01-22 11:55:03 +0000853 - NEElementwiseUnaryKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000854 - @ref NERsqrtLayer
855 - @ref NEExpLayer
856 - @ref NEReverseKernel / @ref NEReverse
857 - @ref NEArgMinMaxLayer
858 - @ref NEStackLayerKernel / @ref NEStackLayer
859 - @ref NERangeKernel / @ref NERange
860 - @ref NEPadLayer
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000861 - NEMemsetKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000862 - @ref NEGatherKernel / @ref NEGather
863 - @ref NEElementwiseComparison
864 - @ref NEElementwiseComparisonStatic
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000865 - NEComparisonOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000866 - @ref NEElementwiseDivision
867 - New OpenCL kernels / functions:
868 - @ref CLSelectKernel / @ref CLSelect
869 - @ref CLTileKernel / @ref CLTile
870 - @ref CLComparisonKernel / @ref CLComparison
871 - @ref CLArgMinMaxLayer
872 - @ref CLElementwiseMax
873 - @ref CLElementwiseMin
874 - @ref CLElementwiseSquaredDiff
875 - @ref CLStackLayerKernel / @ref CLStackLayer
876 - @ref CLReverse / @ref CLReverseKernel
877 - @ref CLRsqrtLayer
878 - @ref CLExpLayer
Michele Di Giorgioc9c89052021-01-26 10:20:17 +0000879 - CLElementWiseUnaryLayerKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000880 - @ref CLGEMMReshapeLHSMatrixKernel
881 - @ref CLGEMMReshapeRHSMatrixKernel
882 - @ref CLGEMMMatrixMultiplyReshapedKernel
883 - @ref CLRangeKernel / @ref CLRange
884 - @ref CLUnstack
885 - @ref CLGatherKernel / @ref CLGather
886 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
887 - New CPP kernels / functions:
888 - @ref CPPDetectionOutputLayer
889 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000890 - Added new examples:
891 - graph_ssd_mobilenet.cpp
892 - graph_mobilenet_v2.cpp
893 - graph_resnet12.cpp
894 - graph_srcnn955.cpp
895 - graph_vgg_vdsr.cpp
896 - graph_inception_resnet_v1.cpp
897 - Add 4D tensors support to
898 - @ref NESoftmaxLayer
899 - Fused activation in @ref CLWinogradConvolutionLayer
900 - Extented @ref NEPermute to support more cases
901 - Added NEON/SVE GEMM Hybrid kernels
902 - Added u8 and s8 hybrid assembly kernels
903 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
904 - Improved @ref CLTuner
905 - Fused the bias addition within @ref CLGEMM
906 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
907 - Added NHWC data layout support to:
908 - @ref NEScale for F16
909 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
910 - @ref NEL2NormalizeLayer for FP32/FP16
911 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
912 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000913 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000914 - Added QASYMM8 support to the following kernels:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000915 - NEArithmeticAdditionKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000916 - @ref NEScale
917 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000918 - Deprecated functions/interfaces
919 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
920
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000921v18.11 Public major release
922 - Various bug fixes.
923 - Various optimisations.
924 - New Neon kernels / functions:
925 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
926 - @ref NEReduceMean
927 - @ref NEReorgLayer / @ref NEReorgLayerKernel
928 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000929 - NEUpsampleLayer / NEUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000930 - NEYOLOLayer / NEYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000931 - New OpenCL kernels / functions:
932 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
933 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000934 - @ref CLComputeAllAnchorsKernel
935 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000936 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
937 - @ref CLReorgLayer / @ref CLReorgLayerKernel
938 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
939 - @ref CLPadLayer
940 - @ref CLReduceMean
941 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
942 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
943 - @ref CLSlice
944 - @ref CLSplit
945 - @ref CLStridedSlice / @ref CLStridedSliceKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000946 - CLUpsampleLayer / CLUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000947 - CLYOLOLayer / CLYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000948 - New CPP kernels / functions:
949 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
950 - Added the validate method in:
951 - @ref NEDepthConvertLayer
952 - @ref NEFloor / @ref CLFloor
953 - @ref NEGEMMMatrixAdditionKernel
954 - @ref NEReshapeLayer / @ref CLReshapeLayer
955 - @ref CLScale
956 - Added new examples:
957 - graph_shufflenet.cpp
958 - graph_yolov3.cpp
959 - Added documentation for add a new function or kernel.
960 - Improved doxygen documentation adding a list of the existing functions.
961 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100962 - CLWidthConcatenateLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +0000963 - CLFlattenLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000964 - @ref CLSoftmaxLayer
965 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
966 - Add SVE support
967 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
968 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
969 - Added NHWC data layout support to:
970 - @ref CLChannelShuffleLayer
971 - @ref CLDeconvolutionLayer
972 - @ref CLL2NormalizeLayer
973 - Added QASYMM8 support to the following kernels:
974 - @ref CLScaleKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100975 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000976 - @ref CLPixelWiseMultiplicationKernel
977 - Added FP16 support to the following kernels:
978 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100979 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000980 - @ref CLNormalizePlanarYUVLayerKernel
981 - @ref CLWinogradConvolutionLayer (5x5 kernel)
982 - More tests added to both validation and benchmarking suites.
983
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100984v18.08 Public major release
985 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100986 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100987 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100988 - Removed support for QS8/QS16 data types.
989 - Added support for grouped convolution in @ref CLConvolutionLayer.
990 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100991 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100992 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
993 - @ref CLDepthwiseConvolutionLayer
994 - @ref CLDirectConvolutionLayer
995 - @ref CLConvolutionLayer
996 - @ref CLScale
997 - @ref CLIm2ColKernel
998 - New Neon kernels / functions:
999 - @ref NERNNLayer
1000 - New OpenCL kernels / functions:
1001 - @ref CLArithmeticDivision
1002 - Introduced prepare() stage support in the graph API for GLES.
1003 - Added support for memory reusage when trying to allocate smaller CLTensors.
1004 - Enabled NHWC execution on graph examples.
1005 - Added JPEG accessor for validation purposes.
1006 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001007
1008v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001009 - Various bug fixes.
1010 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001011 - Major redesign in the interface for the neon kernels implemented in assembly.
1012 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
1013 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
1014 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001015 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
1016 - Improved doxygen documentation.
1017 - Improved memory management for layer's transitions.
1018 - Added support for NHWC data layout in tensors.
1019 - Added NHWC data layout support to:
1020 - @ref NEGEMMConvolutionLayer
1021 - @ref NEDirectConvolutionLayer
1022 - @ref NEPoolingLayer / @ref CLPoolingLayer
1023 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
1024 - @ref NEDepthwiseConvolutionLayer
1025 - @ref NEScale
Georgios Pinitasf7c5a412020-12-03 14:38:33 +00001026 - NEIm2Col
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001027 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
1028 - New OpenCL kernels / functions:
1029 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
1030 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
Sheri Zhang7e20e292021-02-02 11:49:34 +00001031 - @ref CLCopy / CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001032 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001033 - @ref CLRNNLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001034 - CLWidthConcatenateLayer / CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001035 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
1036 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
1037 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001038 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
1039 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
1040 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
1041 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
1042 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
1043 - Port mobilenet example to NHWC data layout.
1044 - Enabled Winograd method in @ref CLConvolutionLayer.
1045 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
1046 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
1047 - Added memory manager support in GLES functions.
1048 - Major refactoring of the graph API.
1049 - Added GLES backend in the graph API.
1050 - Added support for the memory manager in the graph API.
1051 - Enabled Winograd Convolution method in the graph API.
1052 - Added support for grouped convolutions in the graph API.
1053 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
1054 - Added fast maths flag in @ref CLConvolutionLayer.
1055 - Added new tests and benchmarks in validation and benchmark frameworks
1056 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
1057 - Added support to OpenCL 2.0 SVM
1058 - Added support to import memory in OpenCL tensors.
1059 - Added the prepare() method to perform any one off pre-processing before running the function.
1060 - Added new examples:
1061 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001062 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001063 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001064
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001065v18.03 Public maintenance release
1066 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +00001067 - Fixed bug in @ref NEActivationLayer
1068 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001069 - Updated recommended NDK version to r16b (And fixed warnings).
1070 - Fixed bug in validation code.
1071 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001072 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001073
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001074v18.02 Public major release
1075 - Various NEON / OpenCL / GLES optimisations.
1076 - Various bug fixes.
1077 - Changed default number of threads on big LITTLE systems.
1078 - Refactored examples and added:
1079 - graph_mobilenet_qassym8
1080 - graph_resnet
1081 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +00001082 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
1083 - 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 +00001084 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001085 - @ref CLActivationLayer
1086 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001087 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001088 - @ref CLActivationLayer
1089 - @ref CLDepthwiseConvolutionLayer
1090 - @ref NEDepthwiseConvolutionLayer
1091 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001092 - Added FP16 support to:
Manuel Bottini387259a2020-05-21 17:14:36 +01001093 - CLDepthwiseConvolutionLayer3x3
Anthony Barbier3762e742018-03-02 11:49:33 +00001094 - @ref CLDepthwiseConvolutionLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001095 - Added broadcasting support to NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
Anthony Barbier3762e742018-03-02 11:49:33 +00001096 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
1097 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001098 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +01001099 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +00001100 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001101 - Added name() method to all kernels.
1102 - Added support for Winograd 5x5.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001103 - NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001104 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
1105 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
1106 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +01001107 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001108 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001109 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +00001110
Anthony Barbier64c95a02018-01-22 18:48:55 +00001111v18.01 Public maintenance release
1112 - Various bug fixes
1113 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +00001114 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
Sheri Zhang7e20e292021-02-02 11:49:34 +00001115 - Added CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +00001116 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +00001117 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
1118 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
1119 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
1120 - Added @ref GCScaleKernel / @ref GCScale
1121 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +00001122 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001123 - @ref GCCol2ImKernel
1124 - @ref GCGEMMInterleave4x4Kernel
1125 - @ref GCGEMMTranspose1xWKernel
1126 - @ref GCIm2ColKernel
1127 - Refactored NEON Winograd (NEWinogradLayerKernel)
1128 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001129 - Added QASYMM8 support to the following NEON kernels:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001130 - NEDepthwiseConvolutionLayer3x3Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001131 - @ref NEFillBorderKernel
Michele Di Giorgio19289042021-02-03 16:05:00 +00001132 - NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001133 - Added new examples:
1134 - graph_cl_mobilenet_qasymm8.cpp
1135 - graph_inception_v3.cpp
1136 - gc_dc.cpp
1137 - More tests added to both validation and benchmarking suites.
1138
Gian Marcoff850932017-12-11 12:37:17 +00001139v17.12 Public major release
1140 - Most machine learning functions on OpenCL support the new data type QASYMM8
1141 - Introduced logging interface
1142 - Introduced opencl timer
1143 - Reworked GEMMLowp interface
1144 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
1145 - Added validation method for most Machine Learning kernels / functions
1146 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
1147 - Added sgemm example for OpenCL
1148 - Added absolute difference example for GLES compute
1149 - Added new tests and benchmarks in validation and benchmark frameworks
1150 - Added new kernels / functions for GLES compute
1151
1152 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001153 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
1154 - @ref GCActivationLayerKernel / @ref GCActivationLayer
1155 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
1156 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +01001157 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001158 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
1159 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
1160 - @ref GCFillBorderKernel / @ref GCFillBorder
1161 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
1162 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
1163 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
1164 - @ref GCIm2ColKernel
1165 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
1166 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
1167 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
1168 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
1169 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +00001170
1171 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +00001172 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
1173 - arm_compute::NEHGEMMAArch64FP16Kernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001174 - NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001175 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
1176 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001177 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +00001178
1179 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001180 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
Michele Di Giorgioba14c922020-10-12 13:27:57 +01001181 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +00001182
1183 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001184 - graph::BranchLayer
1185 - graph::DepthConvertLayer
1186 - graph::DepthwiseConvolutionLayer
1187 - graph::DequantizationLayer
1188 - graph::FlattenLayer
1189 - graph::QuantizationLayer
1190 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +00001191
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001192v17.10 Public maintenance release
1193 - Bug fixes:
1194 - Check the maximum local workgroup size supported by OpenCL devices
1195 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +00001196 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001197 - Added a few new Graph nodes, support for branches and grouping.
1198 - Automatically enable cl_printf in debug builds
1199 - Fixed bare metal builds for armv7a
1200 - Added AlexNet and cartoon effect examples
1201 - 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)
1202
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001203v17.09 Public major release
1204 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +00001205 - 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 +01001206 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
1207 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
1208 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +00001209 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001210 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
Georgios Pinitas70eb53b2021-01-06 19:42:21 +00001211 - NEFloorKernel / @ref NEFloor
Anthony Barbier3762e742018-03-02 11:49:33 +00001212 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
1213 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
1214 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
1215 - @ref NEReductionOperationKernel / @ref NEReductionOperation
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001216 - NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001217
1218 - New OpenCL kernels / functions:
Manuel Bottini387259a2020-05-21 17:14:36 +01001219 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001220 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
1221 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +00001222 - CLFlattenLayer
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001223 - CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001224 - CLGEMMTranspose1xW
Michele Di Giorgioee82d342021-01-05 16:14:28 +00001225 - CLGEMMMatrixVectorMultiplyKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001226 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
1227 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
1228 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
1229 - @ref CLReductionOperationKernel / @ref CLReductionOperation
Sheri Zhang7e20e292021-02-02 11:49:34 +00001230 - CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001231
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001232v17.06 Public major release
1233 - Various bug fixes
1234 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
1235 - Added unit tests and benchmarks (AlexNet, LeNet)
1236 - Added support for sub tensors.
1237 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +00001238 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
1239 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
1240 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001241 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001242 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001243 - CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001244 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001245 - CLLocallyConnectedMatrixMultiplyKernel / CLLocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001246 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001247 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001248 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001249 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001250 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001251 - NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001252 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001253 - NELocallyConnectedMatrixMultiplyKernel / NELocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001254 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001255
1256v17.05 Public bug fixes release
1257 - Various bug fixes
1258 - Remaining of the functions ported to use accurate padding.
1259 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
1260 - Added "free" method to allocator.
1261 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
1262
1263v17.04 Public bug fixes release
1264
1265 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +00001266 - @ref CLColorConvertKernel
1267 - @ref CLEdgeNonMaxSuppressionKernel
1268 - @ref CLEdgeTraceKernel
1269 - @ref CLGaussianPyramidHorKernel
1270 - @ref CLGaussianPyramidVertKernel
1271 - @ref CLGradientKernel
1272 - @ref NEChannelCombineKernel
1273 - @ref NEFillArrayKernel
1274 - @ref NEGaussianPyramidHorKernel
1275 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +01001276 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001277 - @ref NEHarrisScoreKernel
1278 - @ref NEHOGDetectorKernel
Michalis Spyrou373b4072021-01-20 16:41:12 +00001279 - NELogits1DMaxKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001280 - NELogits1DShiftExpSumKernel
1281 - NELogits1DNormKernel
1282 - @ref NENonMaximaSuppression3x3FP16Kernel
1283 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001284
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001285v17.03.1 First Major public release of the sources
1286 - Renamed the library to arm_compute
1287 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
1288 - New padding calculation interface introduced and ported most kernels / functions to use it.
1289 - New OpenCL kernels / functions:
Gian Marco Iodiceeb65f6d2020-04-15 11:42:15 +01001290 - CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001291 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001292 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
1293 - @ref NETransposeKernel / @ref NETranspose
Michalis Spyrou373b4072021-01-20 16:41:12 +00001294 - NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001295 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +01001296 - NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001297 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001298
1299v17.03 Sources preview
1300 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001301 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001302 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001303 - CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001304 - @ref CLTransposeKernel / @ref CLTranspose
1305 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
1306 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
1307 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001308 - New NEON kernels / functions:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001309 - NEActivationLayerKernel / @ref NEActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001310 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
Michele Di Giorgio19289042021-02-03 16:05:00 +00001311 - NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001312
1313v17.02.1 Sources preview
1314 - New OpenCL kernels / functions:
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001315 - CLLogits1DMaxKernel, CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
Michele Di Giorgioe1314662021-02-01 17:09:32 +00001316 - CLPoolingLayerKernel / @ref CLPoolingLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001317 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
1318 - @ref CLRemapKernel / @ref CLRemap
1319 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
1320 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
1321 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001322 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +00001323 - @ref NEAccumulateWeightedFP16Kernel
1324 - @ref NEBox3x3FP16Kernel
1325 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001326
1327v17.02 Sources preview
1328 - New OpenCL kernels / functions:
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001329 - CLActivationLayerKernel / @ref CLActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001330 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1331 - @ref CLDerivativeKernel / @ref CLChannelExtract
1332 - @ref CLFastCornersKernel / @ref CLFastCorners
1333 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001334 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001335 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1336 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001337 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1338 - Switched all the kernels / functions to use tensors instead of images.
1339 - Updated documentation to include instructions to build the library from sources.
1340
1341v16.12 Binary preview release
1342 - Original release
1343
1344@section S3_how_to_build How to build the library and the examples
1345
1346@subsection S3_1_build_options Build options
1347
1348scons 2.3 or above is required to build the library.
1349To see the build options available simply run ```scons -h```:
1350
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001351 debug: Debug (yes|no)
1352 default: False
1353 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001354
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001355 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1356 default: False
1357 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001358
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001359 logging: Logging (this flag is forced to 1 for debug=1) (yes|no)
1360 default: False
1361 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001362
Sang-Hoon Park50e98bb2021-01-14 14:54:14 +00001363 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 +00001364 default: armv7a
1365 actual: armv7a
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001366
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001367 estate: Execution State (auto|32|64)
1368 default: auto
1369 actual: auto
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001370
Georgios Pinitas45514032020-12-30 00:03:09 +00001371 os: Target OS (linux|android|macos|tizen|bare_metal)
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001372 default: linux
1373 actual: linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001374
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001375 build: Build type (native|cross_compile|embed_only)
1376 default: cross_compile
1377 actual: cross_compile
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001378
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001379 examples: Build example programs (yes|no)
1380 default: True
1381 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001382
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001383 gemm_tuner: Build gemm_tuner programs (yes|no)
1384 default: True
1385 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001386
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001387 Werror: Enable/disable the -Werror compilation flag (yes|no)
1388 default: True
1389 actual: True
Anthony Barbier20dbb822017-12-13 21:19:39 +00001390
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001391 standalone: Builds the tests as standalone executables, links statically with libgcc, libstdc++ and libarm_compute (yes|no)
1392 default: False
1393 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001394
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001395 opencl: Enable OpenCL support (yes|no)
1396 default: True
1397 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001398
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001399 neon: Enable Neon support (yes|no)
1400 default: False
1401 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001402
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001403 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1404 default: False
1405 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001406
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001407 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shaders in library binary (yes|no)
1408 default: True
1409 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001410
Georgios Pinitasea857272021-01-22 05:47:37 +00001411 compress_kernels: Compress embedded OpenCL kernels in library binary. Note embed_kernels should be enabled as well (yes|no)
1412 default: False
1413 actual: False
1414
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001415 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1416 default: False
1417 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001418
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001419 tracing: Enable runtime tracing (yes|no)
1420 default: False
1421 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001422
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001423 openmp: Enable OpenMP backend (yes|no)
1424 default: False
1425 actual: False
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001426
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001427 cppthreads: Enable C++11 threads backend (yes|no)
1428 default: True
1429 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001430
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001431 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1432 default: .
1433 actual: .
1434
1435 install_dir: Specify sub-folder for the install ( /path/to/install_dir )
1436 default:
1437 actual:
1438
1439 exceptions: Enable/disable C++ exception support (yes|no)
1440 default: True
1441 actual: True
1442
1443 linker_script: Use an external linker script ( /path/to/linker_script )
1444 default:
1445 actual:
1446
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001447 custom_options: Custom options that can be used to turn on/off features
1448 (all|none|comma-separated list of names)
1449 allowed names: disable_mmla_fp
1450 default: none
1451 actual:
1452
1453 data_type_support: Enable a list of data types to support
1454 (all|none|comma-separated list of names)
1455 allowed names: qasymm8 qasymm8_signed qsymm16 fp16 fp32
1456 default: all
1457 actual: qasymm8 qasymm8_signed qsymm16 fp16 fp32
1458
1459 toolchain_prefix: Override the toolchain prefix
1460 default:
1461 actual:
1462
1463 compiler_prefix: Override the compiler prefix
1464 default:
1465 actual:
1466
1467 extra_cxx_flags: Extra CXX flags to be appended to the build command
1468 default:
1469 actual:
1470
1471 extra_link_flags: Extra LD flags to be appended to the build command
1472 default:
1473 actual:
1474
1475 compiler_cache: Command to prefix to the C and C++ compiler (e.g ccache)
1476 default:
1477 actual:
1478
1479 specs_file: Specs file to use
1480 default: rdimon.specs
1481 actual: rdimon.specs
1482
1483 benchmark_examples: Build benchmark examples programs (yes|no)
1484 default: True
1485 actual: True
1486
1487 validate_examples: Build validate examples programs (yes|no)
1488 default: True
1489 actual: True
1490
1491 reference_openmp: Build reference validation with openmp (yes|no)
1492 default: True
1493 actual: True
1494
1495 validation_tests: Build validation test programs (yes|no)
1496 default: True
1497 actual: True
1498
1499 benchmark_tests: Build benchmark test programs (yes|no)
1500 default: True
1501 actual: True
1502
1503 test_filter: Pattern to specify the tests' filenames to be compiled
1504 default: *.cpp
1505 actual: *.cpp
1506
1507 pmu: Enable PMU counters (yes|no)
1508 default: False
1509 actual: False
1510
1511 mali: Enable Mali hardware counters (yes|no)
1512 default: False
1513 actual: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001514
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001515 external_tests_dir: Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1516 default:
1517 actual:
1518
Anthony Barbier79c61782017-06-23 11:48:24 +01001519@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001520 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1521 - 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)
1522 - 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).
1523
Anthony Barbier79c61782017-06-23 11:48:24 +01001524@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 +01001525
Anthony Barbier79c61782017-06-23 11:48:24 +01001526@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001527@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1528
Anthony Barbier79c61782017-06-23 11:48:24 +01001529@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 +01001530
Anthony Barbier79c61782017-06-23 11:48:24 +01001531@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 +01001532
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001533There 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.
1534
Georgios Pinitasea857272021-01-22 05:47:37 +00001535In addittion the option 'compress_kernels' will compress the embedded OpenCL kernel files using zlib and inject them in the library. This is useful for reducing the binary size. Note, this option is only available for Android when 'embed_kernels' is enabled.
1536
Michele Di Giorgioeca54a02021-02-16 15:37:59 +00001537@b Werror: If you are compiling using the same toolchains as the ones used in this guide then there shouldn't be any warning and therefore you should be able to keep Werror=1. If with a different compiler version the library fails to build because of warnings interpreted as errors then, if you are sure the warnings are not important, you might want to try to build with Werror=0 (But please do report the issue on Github).
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001538
Anthony Barbier20dbb822017-12-13 21:19:39 +00001539@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 +01001540
Anthony Barbier20dbb822017-12-13 21:19:39 +00001541@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 +01001542
1543@b set_soname: Do you want to build the versioned version of the library ?
1544
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001545If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1546Example:
1547 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1548 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1549 libarm_compute_core.so.1.0.0
1550
1551@note This options is disabled by default as it requires SCons version 2.4 or above.
1552
Anthony Barbier79c61782017-06-23 11:48:24 +01001553@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1554
1555@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1556
1557@b examples: Build or not the examples
1558
1559@b validation_tests: Enable the build of the validation suite.
1560
Anthony Barbier79c61782017-06-23 11:48:24 +01001561@b benchmark_tests: Enable the build of the benchmark tests
1562
1563@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1564
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001565@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)
1566
Anthony Barbier79c61782017-06-23 11:48:24 +01001567@b openmp Build in the OpenMP scheduler for NEON.
1568
1569@note Only works when building with g++ not clang++
1570
1571@b cppthreads Build in the C++11 scheduler for NEON.
1572
Anthony Barbier3762e742018-03-02 11:49:33 +00001573@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001574
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001575@b external_tests_dir Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1576
1577In order to use this option, the external tests directory must have the following structure:
1578
1579 EXTERNAL_TESTS_DIR:
1580 └── tests
1581 ├── benchmark
1582 │   ├── CL
1583 │   ├── datasets
1584 │   ├── fixtures
1585 │   └── NEON
1586 └── validation
1587    ├── CL
1588     ├── datasets
1589     ├── fixtures
1590     └── NEON
1591
1592Then, build the library with `external_tests_dir=<PATH_TO_EXTERNAL_TESTS_DIR>`.
1593
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001594@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001595
1596@subsubsection S3_2_1_library How to build the library ?
1597
1598For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1599
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001600 - gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
1601 - gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001602
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001603To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1604
1605 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1606
1607To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1608
1609 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1610
Anthony Barbier20dbb822017-12-13 21:19:39 +00001611To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1612
1613 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1614
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001615You can also compile the library natively on an ARM device by using <b>build=native</b>:
1616
1617 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1618 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1619
1620@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.
1621
1622For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1623
1624 apt-get install g++-arm-linux-gnueabihf
1625
1626Then run
1627
1628 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1629
1630or simply remove the build parameter as build=cross_compile is the default value:
1631
1632 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1633
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001634@subsubsection S3_2_2_examples How to manually build the examples ?
1635
1636The 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.
1637
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001638@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 +01001639
1640To cross compile a NEON example for Linux 32bit:
1641
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001642 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 +01001643
1644To cross compile a NEON example for Linux 64bit:
1645
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001646 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 +01001647
1648(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)
1649
1650To cross compile an OpenCL example for Linux 32bit:
1651
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001652 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 +01001653
1654To cross compile an OpenCL example for Linux 64bit:
1655
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001656 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 +01001657
Anthony Barbier14c86a92017-12-14 16:27:41 +00001658To cross compile a GLES example for Linux 32bit:
1659
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001660 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 +00001661
1662To cross compile a GLES example for Linux 64bit:
1663
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001664 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 +00001665
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001666(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)
1667
Anthony Barbier14c86a92017-12-14 16:27:41 +00001668To 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.
1669
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001670i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1671
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001672 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 +01001673
1674i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1675
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001676 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 +01001677
1678(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)
1679
Anthony Barbiere5007472017-10-27 15:01:44 +01001680@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1681
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001682To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1683
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001684 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 +01001685
1686To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1687
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001688 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 +01001689
1690(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1691
1692To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1693
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001694 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 +01001695
Anthony Barbier14c86a92017-12-14 16:27:41 +00001696To 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 +01001697
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001698 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 +00001699
1700To 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 +00001701
1702i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001703
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001704 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 +01001705
Anthony Barbier14c86a92017-12-14 16:27:41 +00001706i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001707
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001708 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 +01001709
1710(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 +01001711
Anthony Barbiere5007472017-10-27 15:01:44 +01001712@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1713
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001714@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 +00001715@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 +01001716
1717To run the built executable simply run:
1718
1719 LD_LIBRARY_PATH=build ./neon_convolution
1720
1721or
1722
1723 LD_LIBRARY_PATH=build ./cl_convolution
1724
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001725@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 +00001726
1727For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001728
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001729 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001730
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001731Below is a list of the common parameters among the graph examples :
1732@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001733
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001734@subsubsection S3_2_3_sve Build for SVE or SVE2
1735
1736In order to build for SVE or SVE2 you need a compiler that supports them. You can find more information in the following these links:
1737 -# GCC: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/sve-support
1738 -# LLVM: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/llvm-toolchain/sve-support
1739
1740@note You the need to indicate the toolchains using the scons "toolchain_prefix" parameter.
1741
1742An example build command with SVE is:
1743
1744 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-
1745
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001746@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001747
1748For Android, the library was successfully built and tested using Google's standalone toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001749 - clang++ from NDK r18b for armv7a
1750 - clang++ from NDK r18b for arm64-v8a
1751 - clang++ from NDK r18b for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001752
1753Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1754
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001755- Download the NDK r18b from here: https://developer.android.com/ndk/downloads/index.html to directory $NDK
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001756- Make sure you have Python 2.7 installed on your machine.
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001757- 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 +01001758
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001759
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001760 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b --stl libc++ --api 21
1761 $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 +01001762
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001763@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 +01001764
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001765@note Make sure to add the toolchains to your PATH:
1766
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001767 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 +01001768
1769@subsubsection S3_3_1_library How to build the library ?
1770
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001771To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1772
1773 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1774
1775To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1776
Anthony Barbier14c86a92017-12-14 16:27:41 +00001777 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 +01001778
Anthony Barbier20dbb822017-12-13 21:19:39 +00001779To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1780
Anthony Barbier14c86a92017-12-14 16:27:41 +00001781 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 +00001782
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001783@subsubsection S3_3_2_examples How to manually build the examples ?
1784
1785The 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.
1786
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001787@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 +01001788
1789Once you've got your Android standalone toolchain built and added to your path you can do the following:
1790
1791To cross compile a NEON example:
1792
1793 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001794 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 +01001795 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001796 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 +01001797
1798To cross compile an OpenCL example:
1799
1800 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001801 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 +01001802 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001803 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 +00001804
1805To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001806
Anthony Barbier14c86a92017-12-14 16:27:41 +00001807 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001808 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 +00001809 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001810 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 +01001811
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001812To 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 +01001813
1814 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001815 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 +01001816 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001817 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 +01001818
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001819@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 +00001820@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 +01001821
1822Then you need to do is upload the executable and the shared library to the device using ADB:
1823
1824 adb push neon_convolution_arm /data/local/tmp/
1825 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001826 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001827 adb shell chmod 777 -R /data/local/tmp/
1828
1829And finally to run the example:
1830
1831 adb shell /data/local/tmp/neon_convolution_arm
1832 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001833 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001834
1835For 64bit:
1836
1837 adb push neon_convolution_aarch64 /data/local/tmp/
1838 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001839 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001840 adb shell chmod 777 -R /data/local/tmp/
1841
1842And finally to run the example:
1843
1844 adb shell /data/local/tmp/neon_convolution_aarch64
1845 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001846 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001847
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001848@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 +00001849
1850For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001851 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001852
1853In 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.
1854
Georgios Pinitas45514032020-12-30 00:03:09 +00001855@subsection S3_4_macos Building for macOS
1856
1857The library was successfully natively built for Apple Silicon under macOS 11.1 using clang v12.0.0.
1858
1859To natively compile the library with accelerated CPU support:
1860
1861 scons Werror=1 -j8 neon=1 opencl=0 os=macos arch=arm64-v8a build=native
1862
1863@note Initial support disables feature discovery through HWCAPS and thread scheduling affinity controls
1864
1865@subsection S3_5_bare_metal Building for bare metal
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001866
Georgios Pinitas58216322020-02-26 11:13:13 +00001867For 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 +01001868 - arm-eabi for armv7a
1869 - aarch64-elf for arm64-v8a
1870
1871Download 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>.
1872
1873@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
1874
Georgios Pinitas45514032020-12-30 00:03:09 +00001875@subsubsection S3_5_1_library How to build the library ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001876
1877To cross-compile the library with NEON support for baremetal arm64-v8a:
1878
1879 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
1880
Georgios Pinitas45514032020-12-30 00:03:09 +00001881@subsubsection S3_5_2_examples How to manually build the examples ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001882
1883Examples 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>.
1884
Georgios Pinitas45514032020-12-30 00:03:09 +00001885@subsection S3_6_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001886
1887Using `scons` directly from the Windows command line is known to cause
1888problems. The reason seems to be that if `scons` is setup for cross-compilation
1889it gets confused about Windows style paths (using backslashes). Thus it is
1890recommended to follow one of the options outlined below.
1891
Georgios Pinitas45514032020-12-30 00:03:09 +00001892@subsubsection S3_6_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001893
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001894The best and easiest option is to use
1895<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001896This feature is still marked as *beta* and thus might not be available.
1897However, if it is building the library is as simple as opening a *Bash on
1898Ubuntu on Windows* shell and following the general guidelines given above.
1899
Georgios Pinitas45514032020-12-30 00:03:09 +00001900@subsubsection S3_6_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001901
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001902If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001903can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1904to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001905also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001906code of the library.) Linaro provides pre-built versions of
1907<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001908that can be used from the Cygwin terminal. When building for Android the
1909compiler is included in the Android standalone toolchain. After everything has
1910been set up in the Cygwin terminal the general guide on building the library
1911can be followed.
1912
Georgios Pinitas45514032020-12-30 00:03:09 +00001913@subsection S3_7_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001914
Georgios Pinitas45514032020-12-30 00:03:09 +00001915@subsubsection S3_7_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001916
1917Compute 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).
1918
1919Enabling 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.
1920
1921Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1922
Georgios Pinitas45514032020-12-30 00:03:09 +00001923@subsubsection S3_7_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001924
1925Integer 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.
1926
1927OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1928
1929SVM 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 +01001930
Georgios Pinitas45514032020-12-30 00:03:09 +00001931@subsection S3_8_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001932
1933The 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).
1934The 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 +01001935The 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 +01001936In 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.
1937
1938If 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:
1939
1940https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1941
1942Tuning 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.
1943
1944CLTuner 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.
1945
1946 #Example: 2 unique Matrix Multiply configurations
1947@code{.cpp}
1948 TensorShape a0 = TensorShape(32,32);
1949 TensorShape b0 = TensorShape(32,32);
1950 TensorShape c0 = TensorShape(32,32);
1951 TensorShape a1 = TensorShape(64,64);
1952 TensorShape b1 = TensorShape(64,64);
1953 TensorShape c1 = TensorShape(64,64);
1954
1955 Tensor a0_tensor;
1956 Tensor b0_tensor;
1957 Tensor c0_tensor;
1958 Tensor a1_tensor;
1959 Tensor b1_tensor;
1960 Tensor c1_tensor;
1961
1962 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1963 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1964 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1965 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1966 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1967 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1968
1969 CLGEMM gemm0;
1970 CLGEMM gemm1;
1971
1972 // Configuration 0
1973 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1974
1975 // Configuration 1
1976 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1977@endcode
1978
Georgios Pinitas45514032020-12-30 00:03:09 +00001979@subsubsection S3_8_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001980
Michele Di Giorgio57f30a92020-09-08 14:03:51 +01001981All 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 +01001982
1983 #Enable CL tuner
1984 ./graph_mobilenet --enable-tuner –-target=CL
1985 ./arm_compute_benchmark --enable-tuner
1986
1987 #Export/Import to/from a file
1988 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1989 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1990
1991If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1992
1993Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1994
1995 -# Disable the power management
1996 -# Keep the GPU frequency constant
1997 -# Run multiple times the network (i.e. 10).
1998
1999If 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.
2000
2001@code{.cpp}
2002CLTuner tuner;
2003
2004// Setup Scheduler
2005CLScheduler::get().default_init(&tuner);
2006@endcode
2007
2008After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
2009- tuner.save_to_file("results.csv");
2010
2011This file can be also imported using the method "load_from_file("results.csv")".
2012- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01002013*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01002014} // namespace arm_compute