blob: 79d2585cf05415971f59dd1a3d22ac72335b0164 [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
Sheri Zhangcece42c2021-02-10 15:32:38 +000030The Computer Vision and Machine Learning library is a set of functions optimised for both Arm CPUs and GPUs using SIMD technologies.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010031
32Several builds of the library are available using various configurations:
Sheri Zhangcece42c2021-02-10 15:32:38 +000033 - OS: Android or Linux.
34 - Architecture: armv7a (32bit) or arm64-v8a (64bit).
35 - Technology: Neon / OpenCL / Neon and OpenCL.
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 Giorgio9a6ac342021-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:
Giorgio Arenadf2a9a32021-02-22 14:58:37 +000052 - Linux armv7a: gcc-linaro-7.2.1-2017.11-x86_64_arm-linux-gnueabihf
53 - Linux arm64-v8a: gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu
Michele Di Giorgio36a551f2020-04-23 11:55:29 +010054 - Android armv7a: clang++ / libc++ NDK r18b
Giorgio Arenadf2a9a32021-02-22 14:58:37 +000055 - Android am64-v8a: clang++ / libc++ NDK r20b
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 Arenaaebca262021-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 Arenaaebca262021-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 Arenaaebca262021-02-19 09:53:06 +0000112 - @ref opencl::kernels::ClFloorKernel
Sheri Zhangdda69142021-02-01 19:06:57 +0000113 - @ref CLTransposeKernel
Giorgio Arena26111da2021-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
Giorgio Arenadf2a9a32021-02-22 14:58:37 +0000135 - Note: there might be performance regressions against v20.08 in Inception v3 using int8 data types on Arm Mali-G77 GPUs. Currently under investigation
Giorgio Arenaf42d90a2021-02-23 12:30:49 +0000136 - Note: data-type decoupling is in progress and expiremental. Warning of unused symbols might be raised
Georgios Pinitas40f51a62020-11-21 03:04:18 +0000137
SiCong Li96209c72020-08-21 12:28:30 +0100138v20.11 Public major release
morgolock70b1eb82020-11-24 13:54:19 +0000139 - Various bug fixes.
140 - Various optimisations.
141 - 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 +0000142 This is planned to be resolved in 21.02 release.
morgolock70b1eb82020-11-24 13:54:19 +0000143 - Added new data type QASYMM8_SIGNED support for @ref NEROIAlignLayer.
SiCong Li903f8cc2020-08-27 10:17:10 +0100144 - Added new data type S32 support for:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000145 - NEArithmeticSubtraction
146 - NEArithmeticSubtractionKernel
SiCong Libb88f892020-08-28 11:18:47 +0100147 - @ref NEPixelWiseMultiplication
148 - @ref NEPixelWiseMultiplicationKernel
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000149 - NEElementwiseDivision
150 - NEDivisionOperationKernel
SiCong Li96209c72020-08-21 12:28:30 +0100151 - Interface change
152 - Properly support softmax axis to have the same meaning as other major frameworks. That is, axis now defines the dimension
153 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.
154 The supported value range of axis is [-rank, rank).
155 This change applies to the following functions:
156 - @ref NESoftmaxLayer
157 - @ref NELogSoftmaxLayer
158 - @ref CLSoftmaxLayer
159 - @ref CLLogSoftmaxLayer
160 - @ref GCSoftmaxLayer
Sheri Zhang824061d2020-10-26 15:46:37 +0000161 - New OpenCL kernels / functions:
162 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
morgolock0e728492020-11-20 11:03:33 +0000163 - @ref CLLogicalNot
164 - @ref CLLogicalAnd
165 - @ref CLLogicalOr
Sheri Zhangcece42c2021-02-10 15:32:38 +0000166 - New Neon kernels / functions:
morgolock0e728492020-11-20 11:03:33 +0000167 - @ref NELogicalNot
168 - @ref NELogicalAnd
169 - @ref NELogicalOr
Sheri Zhangcece42c2021-02-10 15:32:38 +0000170 - Removed padding from Neon kernels:
Sheri Zhanged367132020-10-08 15:46:16 +0100171 - @ref NEComplexPixelWiseMultiplicationKernel
172 - @ref NENonMaximaSuppression3x3Kernel
173 - @ref NERemapKernel
174 - @ref NEGEMMInterleave4x4Kernel
175 - @ref NEDirectConvolutionLayerKernel
176 - @ref NEScaleKernel
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000177 - NELocallyConnectedMatrixMultiplyKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100178 - @ref NEGEMMLowpOffsetContributionKernel
179 - @ref NEGEMMTranspose1xWKernel
Michele Di Giorgio19289042021-02-03 16:05:00 +0000180 - NEPoolingLayerKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100181 - @ref NEConvolutionKernel
182 - @ref NEDepthwiseConvolutionLayerNativeKernel
183 - @ref NEGEMMLowpMatrixMultiplyKernel
184 - @ref NEGEMMMatrixMultiplyKernel
185 - @ref NEDirectConvolutionLayerOutputStageKernel
186 - @ref NEReductionOperationKernel
187 - @ref NEGEMMLowpMatrixAReductionKernel
188 - @ref NEGEMMLowpMatrixBReductionKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000189 - Removed padding from OpenCL kernels:
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000190 - CLBatchConcatenateLayerKernel
Michele Di Giorgio1e0208a2021-01-22 15:42:59 +0000191 - CLElementwiseOperationKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000192 - @ref CLBatchNormalizationLayerKernel
Michele Di Giorgioe1314662021-02-01 17:09:32 +0000193 - CLPoolingLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000194 - @ref CLWinogradInputTransformKernel
195 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
196 - @ref CLGEMMLowpMatrixAReductionKernel
197 - @ref CLGEMMLowpMatrixBReductionKernel
198 - @ref CLGEMMLowpOffsetContributionOutputStageKernel
199 - @ref CLGEMMLowpOffsetContributionKernel
200 - @ref CLWinogradOutputTransformKernel
201 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
202 - @ref CLFuseBatchNormalizationKernel
203 - @ref CLDepthwiseConvolutionLayerNativeKernel
204 - @ref CLDepthConvertLayerKernel
Sheri Zhang7e20e292021-02-02 11:49:34 +0000205 - CLCopyKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000206 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000207 - CLActivationLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000208 - @ref CLWinogradFilterTransformKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000209 - CLWidthConcatenateLayerKernel
210 - CLWidthConcatenate4TensorsKernel
211 - CLWidthConcatenate2TensorsKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000212 - @ref CLLogits1DMaxShiftExpSumKernel
213 - @ref CLLogits1DNormKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000214 - CLHeightConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000215 - @ref CLGEMMMatrixMultiplyKernel
216 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
217 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
218 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000219 - CLDepthConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000220 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
221 - Removed OpenCL kernels / functions:
222 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
223 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel
224 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel
morgolock00c76012020-11-06 10:40:12 +0000225 - 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 +0100226 - CLLocallyConnectedLayer
227 - CLLocallyConnectedMatrixMultiplyKernel
morgolock00c76012020-11-06 10:40:12 +0000228 - CLAbsoluteDifference
229 - CLAbsoluteDifferenceKernel
230 - CLAccumulate
231 - CLAccumulateKernel
232 - CLAccumulateSquared
233 - CLAccumulateSquaredKernel
234 - CLAccumulateWeighted
235 - CLAccumulateWeightedKernel
236 - CLAccumulateWeightedFP16Kernel
237 - CLBox3x3
238 - CLBox3x3Kernel
239 - CLBox3x3FP16Kernel
240 - CLCannyEdge
241 - CLChannelCombine
242 - CLChannelCombineKernel
243 - CLChannelExtract
244 - CLChannelExtractKernel
245 - CLColorConvert
246 - CLColorConvertKernel
247 - CLConvolution3x3
248 - CLConvolutionRectangle
249 - CLConvolutionRectangleKernel
250 - CLConvolutionSquare
251 - CLConvolutionKernel
252 - CLDerivative
253 - CLDerivativeKernel
254 - CLDilate
255 - CLDilateKernel
256 - CLEqualizeHistogram
257 - CLErode
258 - CLErodeKernel
259 - CLFastCorners
260 - CLFastCornersKernel
261 - CLGaussian3x3
262 - CLGaussian3x3Kernel
263 - CLGaussian5x5
264 - CLGaussian5x5HorKernel
265 - CLGaussian5x5VertKernel
266 - CLGaussianPyramid
267 - CLGaussianPyramidHalf
268 - CLGaussianPyramidOrb
269 - CLHarrisCorners
270 - CLHarrisScoreKernel
271 - CLHarrisScoreFP16Kernel
272 - CLHistogram
273 - CLHistogramKernel
274 - CLHOGOrientationBinningKernel
275 - CLHOGBlockNormalizationKernel
276 - CLHOGDetectorKernel
277 - CLHOGNonMaximaSuppressionKernel
278 - CLHOGDescriptor
279 - CLHOGDetector
280 - CLHOGGradient
281 - CLHOGMultiDetection
282 - CLHOGOrientationBinningKernel
283 - CLHOGBlockNormalizationKernel
284 - CLHOGDetectorKernel
285 - CLIntegralImage
286 - CLIntegralImageKernel
287 - CLLaplacianReconstruct
288 - CLLaplacianPyramid
289 - CLMagnitude
290 - CLMagnitudePhaseKernel
291 - CLMedian3x3
292 - CLMedian3x3Kernel
293 - CLMinMaxLocation
294 - CLMinMaxLocationKernel
295 - CLNonLinearFilter
296 - CLNonLinearFilterKernel
297 - CLNonMaximaSuppression3x3
298 - CLNonMaximaSuppression3x3FP16Kernel
299 - CLNonMaximaSuppression3x3Kernel
300 - CLOpticalFlow
301 - CLPhase
302 - CLRemap
303 - CLRemapKernel
304 - CLScharr3x3
305 - CLScharr3x3Kernel
306 - CLSobel3x3
307 - CLSobel3x3Kernel
308 - CLSobel5x5
309 - CLSobel5x5HorKernel
310 - CLSobel5x5VertKernel
311 - CLSobel7x7
312 - CLSobel7x7HorKernel
313 - CLSobel7x7VertKernel
314 - CLThreshold
315 - CLThresholdKernel
316 - CLWarpAffine
317 - CLWarpAffineKernel
318 - CLWarpPerspective
319 - CLWarpPerspectiveKernel
Sheri Zhangcece42c2021-02-10 15:32:38 +0000320 - 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 +0100321 - NELocallyConnectedLayer
322 - NELocallyConnectedMatrixMultiplyKernel
morgolock0c862652020-11-06 08:59:45 +0000323 - NEAbsoluteDifference
324 - NEAbsoluteDifferenceKernel
325 - NEAccumulate
326 - NEAccumulateKernel
327 - NEAccumulateSquared
328 - NEAccumulateSquaredKernel
329 - NEAccumulateWeighted
330 - NEAccumulateWeightedKernel
331 - NEAccumulateWeightedFP16Kernel
332 - NEBox3x3
333 - NEBox3x3Kernel
334 - NEBox3x3FP16Kernel
335 - NECannyEdge
336 - NEChannelCombine
337 - NEChannelCombineKernel
338 - NEChannelExtract
339 - NEChannelExtractKernel
340 - NEColorConvert
341 - NEColorConvertKernel
342 - NEConvolution3x3
343 - NEConvolutionRectangle
344 - NEConvolutionRectangleKernel
345 - NEConvolutionSquare
346 - NEConvolutionKernel
347 - NEDerivative
348 - NEDerivativeKernel
349 - NEDilate
350 - NEDilateKernel
351 - NEEqualizeHistogram
352 - NEErode
353 - NEErodeKernel
354 - NEFastCorners
355 - NEFastCornersKernel
356 - NEGaussian3x3
357 - NEGaussian3x3Kernel
358 - NEGaussian5x5
359 - NEGaussian5x5HorKernel
360 - NEGaussian5x5VertKernel
361 - NEGaussianPyramid
362 - NEGaussianPyramidHalf
363 - NEGaussianPyramidOrb
364 - NEHarrisCorners
365 - NEHarrisScoreKernel
366 - NEHarrisScoreFP16Kernel
367 - NEHistogram
368 - NEHistogramKernel
369 - NEHOGOrientationBinningKernel
370 - NEHOGBlockNormalizationKernel
371 - NEHOGDetectorKernel
372 - NEHOGNonMaximaSuppressionKernel
373 - NEHOGDescriptor
374 - NEHOGDetector
375 - NEHOGGradient
376 - NEHOGMultiDetection
377 - NEHOGOrientationBinningKernel
378 - NEHOGBlockNormalizationKernel
379 - NEHOGDetectorKernel
380 - NEIntegralImage
381 - NEIntegralImageKernel
382 - NELaplacianReconstruct
383 - NELaplacianPyramid
384 - NEMagnitude
385 - NEMagnitudePhaseKernel
386 - NEMedian3x3
387 - NEMedian3x3Kernel
388 - NEMinMaxLocation
389 - NEMinMaxLocationKernel
390 - NENonLinearFilter
391 - NENonLinearFilterKernel
392 - NENonMaximaSuppression3x3
393 - NENonMaximaSuppression3x3FP16Kernel
394 - NENonMaximaSuppression3x3Kernel
395 - NEOpticalFlow
396 - NEPhase
397 - NERemap
398 - NERemapKernel
399 - NEScharr3x3
400 - NEScharr3x3Kernel
401 - NESobel3x3
402 - NESobel3x3Kernel
403 - NESobel5x5
404 - NESobel5x5HorKernel
405 - NESobel5x5VertKernel
406 - NESobel7x7
407 - NESobel7x7HorKernel
408 - NESobel7x7VertKernel
409 - NEThreshold
410 - NEThresholdKernel
411 - NEWarpAffine
412 - NEWarpAffineKernel
413 - NEWarpPerspective
414 - NEWarpPerspectiveKernel
morgolockd6ee9ed2020-11-19 10:07:14 +0000415 - Deprecated GLES kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together):
416 - GCAbsoluteDifference
417 - GCActivationLayer
418 - GCArithmeticAddition
419 - GCBatchNormalizationLayer
420 - GCConcatenateLayer
421 - GCConvolutionLayer
422 - GCDepthwiseConvolutionLayer
423 - GCDirectConvolutionLayer
424 - GCDropoutLayer
425 - GCFillBorder
426 - GCFullyConnectedLayer
427 - GCGEMM
428 - GCGEMMInterleave4x4
429 - GCGEMMTranspose1xW
430 - GCNormalizationLayer
431 - GCNormalizePlanarYUVLayer
432 - GCPixelWiseMultiplication
433 - GCPoolingLayer
434 - GCScale
435 - GCSoftmaxLayer
436 - GCTensorShift
437 - GCTranspose
438
SiCong Li96209c72020-08-21 12:28:30 +0100439
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100440v20.08 Public major release
441 - Various bug fixes.
442 - Various optimisations.
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100443 - Added new data type QASYMM8_SIGNED support for:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100444 - @ref CLArgMinMaxLayer
445 - @ref CLArgMinMaxLayerKernel
446 - Added new data type U8 support for:
447 - @ref NECropKernel
Sheri Zhang7e20e292021-02-02 11:49:34 +0000448 - CLCropKernel
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100449 - Added aligh_corner support for nearest neighbor interpolation in:
450 - @ref NEScaleKernel
451 - @ref CLScaleKernel
452 - New OpenCL kernels / functions:
453 - @ref CLMaxUnpoolingLayerKernel
Sheri Zhangcece42c2021-02-10 15:32:38 +0000454 - New Neon kernels / functions:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100455 - @ref NEMaxUnpoolingLayerKernel
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100456 - New graph example:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100457 - graph_yolov3_output_detector
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100458 - GEMMTuner improvements:
459 - Added fp16 support
460 - Output json files for easier integration
461 - Enabled tuning for export_to_cl_image_rhs option for RHS tensors
462 - More robust script for running benchmarks
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100463 - Removed padding from:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100464 - @ref NEPixelWiseMultiplicationKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000465 - NEHeightConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100466 - @ref NEThresholdKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000467 - NEBatchConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100468 - @ref NETransposeKernel
469 - @ref NEBatchNormalizationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000470 - NEArithmeticSubtractionKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100471 - @ref NEBoundingBoxTransformKernel
Michalis Spyrou373b4072021-01-20 16:41:12 +0000472 - NELogits1DMaxKernel
473 - NELogits1DSoftmaxKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100474 - @ref NEROIPoolingLayerKernel
475 - @ref NEROIAlignLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000476 - NEYOLOLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000477 - NEUpsampleLayerKernel
Georgios Pinitas70eb53b2021-01-06 19:42:21 +0000478 - NEFloorKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000479 - NEWidthConcatenateLayerKernel
480 - NEDepthConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100481 - @ref NENormalizationLayerKernel
482 - @ref NEL2NormalizeLayerKernel
483 - @ref NEFillArrayKernel
484 - @ref NEDepthConvertLayerKernel
485 - @ref NERangeKernel
486 - @ref NEPriorBoxLayer
Sheri Zhanged367132020-10-08 15:46:16 +0100487 - Removed OpenCL kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100488 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
489 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Sheri Zhangcece42c2021-02-10 15:32:38 +0000490 - Removed Neon kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100491 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
492 - NEGEMMMatrixAccumulateBiasesKernel
SiCong Lid004a7a2020-05-28 15:26:41 +0100493 - Deprecated functions / interfaces:
494 - Non-descriptor based interfaces for @ref NEThreshold, @ref CLThreshold
Sang-Hoon Park97c1a672020-08-18 11:44:13 +0100495 - Non-descriptor based interfaces for @ref NEScale, @ref CLScale and @ref GCScale
SiCong Lid004a7a2020-05-28 15:26:41 +0100496 - In @ref NESoftmaxLayer, @ref NELogSoftmaxLayer, @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer :
morgolock9c7fed82020-08-05 12:30:56 +0100497 The default "axis" value for @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer is changed from 1 to 0.
498 Only axis 0 is supported.
499 The default "axis" value for @ref NESoftmaxLayer, @ref NELogSoftmaxLayer is changed from 1 to 0.
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100500 Only axis 0 is supported.
Sang-Hoon Parka0205b92020-07-07 09:36:09 +0100501 - The support for quantized data types has been removed from @ref CLLogSoftmaxLayer due to implementation complexity.
Gian Marco Iodice547b2e72020-08-12 10:25:29 +0100502 - 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 +0100503 - This change allows to use @ref CLGEMMConvolutionLayer without extra padding for the input and output.
504 - Only the weights/bias of @ref CLGEMMConvolutionLayer could require padding for the computation.
505 - 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 +0100506 - 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 +0100507 - This support allows to export the OpenCL buffer used for the reshaped RHS matrix to the OpenCL image object.
508 - The padding requirement for the OpenCL image object is considered into the @ref CLGEMMReshapeRHSMatrixKernel.
509 - The reshaped RHS matrix stores the weights when GEMM is used to accelerate @ref CLGEMMConvolutionLayer.
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100510
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000511v20.05 Public major release
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000512 - Various bug fixes.
513 - Various optimisations.
Michele Di Giorgio36a551f2020-04-23 11:55:29 +0100514 - Updated recommended NDK version to r18b.
515 - Updated recommended gcc version to Linaro 6.3.1.
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000516 - Added Bfloat16 type support
517 - Added Bfloat16 support in:
518 - @ref NEWeightsReshapeKernel
519 - @ref NEConvolutionLayerReshapeWeights
520 - @ref NEIm2ColKernel
Georgios Pinitasf7c5a412020-12-03 14:38:33 +0000521 - NEIm2Col
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000522 - @ref NEDepthConvertLayerKernel
523 - @ref NEDepthConvertLayer
524 - @ref NEGEMMConvolutionLayer
Georgios Pinitasec2256b2020-12-03 18:51:58 +0000525 - NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000526 - Added new data type QASYMM8_SIGNED support for:
527 - @ref CLDirectConvolutionLayer
528 - @ref CLDeconvolutionLayer
529 - @ref CLDirectDeconvolutionLayer
530 - @ref CLGEMMDeconvolutionLayer
531 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
532 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
533 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
534 - @ref CLReductionOperation
535 - @ref CLReduceMean
Sheri Zhang359c48e2020-04-30 22:53:39 +0100536 - @ref NEScale
537 - @ref NEScaleKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000538 - NEUpsampleLayer
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000539 - @ref NECast
540 - @ref NEReductionOperation
541 - @ref NEReduceMean
542 - @ref NEArgMinMaxLayer
543 - @ref NEDeconvolutionLayer
544 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
545 - @ref CPPBoxWithNonMaximaSuppressionLimit
546 - @ref CPPDetectionPostProcessLayer
547 - @ref CPPPermuteKernel
548 - @ref CPPPermute
549 - @ref CPPTopKVKernel
550 - @ref CPPTopKV
Sheri Zhang359c48e2020-04-30 22:53:39 +0100551 - @ref CPPUpsample
552 - @ref CPPUpsampleKernel
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100553 - New OpenCL kernels / functions:
554 - @ref CLQLSTMLayer
555 - @ref CLQLSTMLayerNormalizationKernel
Sheri Zhangcece42c2021-02-10 15:32:38 +0000556 - New Neon kernels / functions:
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100557 - @ref NEQLSTMLayer
558 - @ref NEQLSTMLayerNormalizationKernel
559 - Added HARD_SWISH support in:
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000560 - CLActivationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000561 - NEActivationLayerKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000562 - Deprecated OpenCL kernels / functions:
563 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
564 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Sheri Zhangcece42c2021-02-10 15:32:38 +0000565 - Deprecated Neon kernels / functions:
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000566 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
567 - Removed CPP kernels / functions:
568 - CPPFlipWeightsKernel
Manuel Bottini387259a2020-05-21 17:14:36 +0100569 - Removed PoolingLayerInfo constructors without Data Layout.
570 - Removed CLDepthwiseConvolutionLayer3x3
571 - Removed NEDepthwiseConvolutionLayerOptimized
Sheri Zhangcece42c2021-02-10 15:32:38 +0000572 - Added support for Winograd 3x3,4x4 on Neon FP16:
Manuel Bottini075253a2020-05-22 12:57:18 +0100573 - @ref NEWinogradConvolutionLayer
574 - @ref NEWinogradLayerTransformInputKernel
575 - @ref NEWinogradLayerTransformOutputKernel
576 - @ref NEWinogradLayerTransformWeightsKernel
577 - Added CLCompileContext
Sheri Zhangcece42c2021-02-10 15:32:38 +0000578 - Added Neon GEMM kernel with 2D window support
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000579
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000580v20.02.1 Maintenance release
581 - Added Android-NN build script.
582
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000583v20.02 Public major release
584 - Various bug fixes.
585 - Various optimisations.
586 - Added new data type QASYMM8_SIGNED support for:
587 - @ref CLDepthwiseConvolutionLayer
Manuel Bottini387259a2020-05-21 17:14:36 +0100588 - CLDepthwiseConvolutionLayer3x3
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000589 - @ref CLGEMMConvolutionLayer
590 - @ref CLGEMMLowpMatrixMultiplyCore
591 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
592 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
593 - @ref NEActivationLayer
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000594 - NEComparisonOperationKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000595 - @ref NEConvolutionLayer
596 - @ref NEDepthwiseConvolutionLayer
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100597 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000598 - @ref NEDirectConvolutionLayerOutputStageKernel
599 - @ref NEElementwiseComparison
600 - @ref NEElementwiseMax
601 - @ref NEElementwiseMin
602 - @ref NEElementwiseSquaredDiff
603 - @ref NEFullyConnectedLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +0100604 - NEGEMMMatrixVectorMultiplyKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000605 - @ref NEPixelWiseMultiplication
606 - @ref NEPoolingLayer
607 - @ref NEPReluLayer
608 - Added support for QSYMM8_PER_CHANNEL in:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100609 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000610 - Added support for split sizes in:
611 - @ref CLSplit
612 - @ref NESplit
613 - New OpenCL kernels / functions:
614 - @ref CLFill
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100615 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
Sheri Zhangcece42c2021-02-10 15:32:38 +0000616 - New Neon kernels / functions:
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000617 - @ref NEFill
618 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
Sheri Zhangcece42c2021-02-10 15:32:38 +0000619 - Deprecated Neon functions / interfaces:
Manuel Bottini387259a2020-05-21 17:14:36 +0100620 - CLDepthwiseConvolutionLayer3x3
621 - NEDepthwiseConvolutionLayerOptimized
622 - PoolingLayerInfo constructors without Data Layout.
Sheri Zhangcece42c2021-02-10 15:32:38 +0000623 - Added support for quantization with multiplier greater than 1 on Neon and CL.
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000624 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
625 - Added the ability to build bootcode for bare metal.
626 - Added support for generating synthetic QASYMM8 graphs.
627 - Added support for F16 datatype in VGG16.
628 - Removed pre-built binaries for GLES.
629
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000630v19.11.1 Public maintenance release
631 - Fix offset calculation in NEReductionOperationKernel.
632 - Fix data layout in NEScaleKernel for nhwc.
633 - Retain configuration step data layout to avoid side-effects.
634 - Perform sqrt in double domain for L2 pooling.
635 - Fix output shape calculation for Reduce Mean
636 - Restrict cases where optimized NEPadLayer runs.
637
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100638v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000639 - Various bug fixes.
640 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000641 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000642 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100643 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
644 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000645 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100646 - CLDepthwiseVectorToTensorKernel
647 - CLDirectConvolutionLayerOutputStageKernel
Sheri Zhangcece42c2021-02-10 15:32:38 +0000648 - Deprecated Neon kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100649 - NEDepthwiseWeightsReshapeKernel
650 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000651 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100652 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100653 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000654 - New OpenCL kernels / functions:
655 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
656 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
657 OpenCL kernels / functions)
658 - @ref CLLogSoftmaxLayer
Sheri Zhangcece42c2021-02-10 15:32:38 +0000659 - New Neon kernels / functions:
SiCong Lica1f98c2019-11-28 11:06:11 +0000660 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
Georgios Pinitas8c3c0e72020-12-03 20:11:53 +0000661 - @ref NEComputeAllAnchorsKernel / NEComputeAllAnchors
SiCong Lica1f98c2019-11-28 11:06:11 +0000662 - @ref NEDetectionPostProcessLayer
663 - @ref NEGenerateProposalsLayer
664 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
665 - @ref NELogSoftmaxLayer
666 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
667 - Added QASYMM8 support for:
668 - @ref CLGenerateProposalsLayer
669 - @ref CLROIAlignLayer
670 - @ref CPPBoxWithNonMaximaSuppressionLimit
671 - Added QASYMM16 support for:
672 - @ref CLBoundingBoxTransform
673 - Added FP16 support for:
674 - @ref CLGEMMMatrixMultiplyReshapedKernel
675 - Added new data type QASYMM8_PER_CHANNEL support for:
676 - @ref CLDequantizationLayer
677 - @ref NEDequantizationLayer
678 - Added new data type QSYMM8_PER_CHANNEL support for:
679 - @ref CLConvolutionLayer
680 - @ref NEConvolutionLayer
681 - @ref CLDepthwiseConvolutionLayer
682 - @ref NEDepthwiseConvolutionLayer
683 - Added FP16 mixed-precision support for:
684 - @ref CLGEMMMatrixMultiplyReshapedKernel
Michele Di Giorgioe1314662021-02-01 17:09:32 +0000685 - CLPoolingLayerKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000686 - Added FP32 and FP16 ELU activation for:
687 - @ref CLActivationLayer
688 - @ref NEActivationLayer
689 - Added asymmetric padding support for:
690 - @ref CLDirectDeconvolutionLayer
691 - @ref CLGEMMDeconvolutionLayer
692 - @ref NEDeconvolutionLayer
693 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000694 - Replaced the calls to NECopyKernel and NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
695 - Replaced the calls to CLCopyKernel and CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
SiCong Lica1f98c2019-11-28 11:06:11 +0000696 - Improved performance for CL Inception V3 - FP16.
697 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
Sheri Zhangcece42c2021-02-10 15:32:38 +0000698 - Improved Neon performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
699 - Improved Neon performance for MobileNet-SSD by improving the output detection performance.
SiCong Lica1f98c2019-11-28 11:06:11 +0000700 - Optimized @ref CLPadLayer.
701 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
702 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100703
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000704v19.08.1 Public maintenance release
705 - Fix offset calculation in NEReductionOperationKernel.
706 - Fix data layout in NEScaleKernel for nhwc.
707 - Retain configuration step data layout to avoid side-effects.
708 - Perform sqrt in double domain for L2 pooling.
709 - Fix output shape calculation for Reduce Mean
710 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
711
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100712v19.08 Public major release
713 - Various bug fixes.
714 - Various optimisations.
Sheri Zhangcece42c2021-02-10 15:32:38 +0000715 - Deprecated Neon functions
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100716 - NEDepthConcatenateLayer
717 - NEWidthConcatenateLayer
718 - Deprecated OpenCL kernels / functions
719 - CLDepthConcatenateLayer
720 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
721 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
722 - CLWidthConcatenateLayer
Sheri Zhangcece42c2021-02-10 15:32:38 +0000723 - New Neon kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100724 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100725 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100726 - @ref NEElementwisePower
727 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100728 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100729 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100730 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100731 - @ref NESinLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000732 - NEBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100733 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
734 - @ref NEDepthwiseConvolutionLayerNativeKernel
735 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
736 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
737 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
738 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100739 - @ref CLAbsLayer
740 - @ref CLElementwisePower
741 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100742 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100743 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100744 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100745 - @ref CLSinLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000746 - CLBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100747 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
748 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100749 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100750 - @ref CLGEMMMatrixMultiplyNativeKernel
751 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
752 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
753 - New examples:
754 - neon_opticalflow
755 - cl_cache
756 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100757 - Added support for FP16 in @ref NEDeconvolutionLayer
758 - Added support for FP16 in @ref CLDeconvolutionLayer
759 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100760 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
761 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
Sheri Zhangcece42c2021-02-10 15:32:38 +0000762 - Re-factored the depthwise convolution layer kernel on Neon for generic cases
763 - Added an optimized depthwise convolution layer kernel for 5x5 filters (Neon only)
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100764 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
765 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini387259a2020-05-21 17:14:36 +0100766 - The CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
767 - The NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100768 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
769 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Sheri Zhangcece42c2021-02-10 15:32:38 +0000770 - 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 +0100771
Michalis Spyroua9c44722019-04-05 17:18:36 +0100772v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100773 - Various bug fixes.
774 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100775 - New Neon kernels / functions:
776 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100777 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100778 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100779 - @ref NEDepthwiseConvolutionAssemblyDispatch
780 - @ref NEFFTDigitReverseKernel
781 - @ref NEFFTRadixStageKernel
782 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100783 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000784 - NEHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100785 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100786 - @ref NEFFT1D
787 - @ref NEFFT2D
788 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100789 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100790 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Sheri Zhang7e20e292021-02-02 11:49:34 +0000791 - CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100792 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100793 - @ref CLFFTDigitReverseKernel
794 - @ref CLFFTRadixStageKernel
795 - @ref CLFFTScaleKernel
796 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
797 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000798 - CLHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100799 - @ref CLDirectDeconvolutionLayer
800 - @ref CLFFT1D
801 - @ref CLFFT2D
802 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100803 - @ref CLGEMMDeconvolutionLayer
804 - New OpenGLES kernels / functions:
805 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100806 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100807 - GCDepthConcatenateLayer
808 - NEWidthConcatenateLayer
809 - NEDepthConcatenateLayer
810 - CLWidthConcatenateLayer
811 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100812 - CLGEMMInterleave4x4
813 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100814 - Support different quantization info in CLConcatLayer.
815 - Add checks on different input/output quantization info were not supported.
816 - Tensors have different quantization information.
817 - Add FP16 support checks.
818 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
819 - New graph examples:
820 - graph_convolution
821 - graph_fully_connected
822 - graph_depthwise_convolution
823 - Deepspeech v0.4.1
824 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
825 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
826 - Add support for QASYMM8 NEDeconvolution.
Sheri Zhangcece42c2021-02-10 15:32:38 +0000827 - Add support for DequantizationLayer for Neon/CL.
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100828 - Add support for dilation in CLDepthwiseConvolution.
829 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
830 - Optimize CLDeconvolution.
831 - Add StackLayer to the graph API.
832 - Add support for "reflect" padding mode in NEPad.
833 - Winograd 7x7 NHWC on OpenCL.
834 - Rework CL ML layers to run exclusively on CL.
835 - Support different quantization info in PoolingLayer.
836 - Implement and test import memory interfaces.
837 - Added new tests and removed old ones.
838 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100839
giuros01a69a88b2019-01-31 16:29:19 +0000840v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000841 - Various bug fixes.
842 - Various optimisations.
843 - New Neon kernels / functions:
844 - @ref NETileKernel / @ref NETile
845 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000846 - NEElementwiseOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000847 - @ref NEElementwiseMax
848 - @ref NEElementwiseMin
849 - @ref NEElementwiseSquaredDiff
850 - @ref NESelectKernel / @ref NESelect
851 - @ref NESplit
852 - @ref NESlice
853 - @ref NEUnstack
854 - @ref NEStridedSliceKernel / @ref NEStridedSlice
Sang-Hoon Park7249f152021-01-22 11:55:03 +0000855 - NEElementwiseUnaryKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000856 - @ref NERsqrtLayer
857 - @ref NEExpLayer
858 - @ref NEReverseKernel / @ref NEReverse
859 - @ref NEArgMinMaxLayer
860 - @ref NEStackLayerKernel / @ref NEStackLayer
861 - @ref NERangeKernel / @ref NERange
862 - @ref NEPadLayer
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000863 - NEMemsetKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000864 - @ref NEGatherKernel / @ref NEGather
865 - @ref NEElementwiseComparison
866 - @ref NEElementwiseComparisonStatic
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000867 - NEComparisonOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000868 - @ref NEElementwiseDivision
869 - New OpenCL kernels / functions:
870 - @ref CLSelectKernel / @ref CLSelect
871 - @ref CLTileKernel / @ref CLTile
872 - @ref CLComparisonKernel / @ref CLComparison
873 - @ref CLArgMinMaxLayer
874 - @ref CLElementwiseMax
875 - @ref CLElementwiseMin
876 - @ref CLElementwiseSquaredDiff
877 - @ref CLStackLayerKernel / @ref CLStackLayer
878 - @ref CLReverse / @ref CLReverseKernel
879 - @ref CLRsqrtLayer
880 - @ref CLExpLayer
Michele Di Giorgioc9c89052021-01-26 10:20:17 +0000881 - CLElementWiseUnaryLayerKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000882 - @ref CLGEMMReshapeLHSMatrixKernel
883 - @ref CLGEMMReshapeRHSMatrixKernel
884 - @ref CLGEMMMatrixMultiplyReshapedKernel
885 - @ref CLRangeKernel / @ref CLRange
886 - @ref CLUnstack
887 - @ref CLGatherKernel / @ref CLGather
888 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
889 - New CPP kernels / functions:
890 - @ref CPPDetectionOutputLayer
891 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000892 - Added new examples:
893 - graph_ssd_mobilenet.cpp
894 - graph_mobilenet_v2.cpp
895 - graph_resnet12.cpp
896 - graph_srcnn955.cpp
897 - graph_vgg_vdsr.cpp
898 - graph_inception_resnet_v1.cpp
899 - Add 4D tensors support to
900 - @ref NESoftmaxLayer
901 - Fused activation in @ref CLWinogradConvolutionLayer
902 - Extented @ref NEPermute to support more cases
Sheri Zhangcece42c2021-02-10 15:32:38 +0000903 - Added Neon/SVE GEMM Hybrid kernels
Isabella Gottardi62538972019-02-12 19:52:44 +0000904 - Added u8 and s8 hybrid assembly kernels
905 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
906 - Improved @ref CLTuner
907 - Fused the bias addition within @ref CLGEMM
908 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
909 - Added NHWC data layout support to:
910 - @ref NEScale for F16
911 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
912 - @ref NEL2NormalizeLayer for FP32/FP16
913 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
914 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000915 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000916 - Added QASYMM8 support to the following kernels:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000917 - NEArithmeticAdditionKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000918 - @ref NEScale
919 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000920 - Deprecated functions/interfaces
921 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
922
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000923v18.11 Public major release
924 - Various bug fixes.
925 - Various optimisations.
926 - New Neon kernels / functions:
927 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
928 - @ref NEReduceMean
929 - @ref NEReorgLayer / @ref NEReorgLayerKernel
930 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000931 - NEUpsampleLayer / NEUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000932 - NEYOLOLayer / NEYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000933 - New OpenCL kernels / functions:
934 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
935 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000936 - @ref CLComputeAllAnchorsKernel
937 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000938 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
939 - @ref CLReorgLayer / @ref CLReorgLayerKernel
940 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
941 - @ref CLPadLayer
942 - @ref CLReduceMean
943 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
944 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
945 - @ref CLSlice
946 - @ref CLSplit
947 - @ref CLStridedSlice / @ref CLStridedSliceKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000948 - CLUpsampleLayer / CLUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000949 - CLYOLOLayer / CLYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000950 - New CPP kernels / functions:
951 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
952 - Added the validate method in:
953 - @ref NEDepthConvertLayer
954 - @ref NEFloor / @ref CLFloor
955 - @ref NEGEMMMatrixAdditionKernel
956 - @ref NEReshapeLayer / @ref CLReshapeLayer
957 - @ref CLScale
958 - Added new examples:
959 - graph_shufflenet.cpp
960 - graph_yolov3.cpp
961 - Added documentation for add a new function or kernel.
962 - Improved doxygen documentation adding a list of the existing functions.
963 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100964 - CLWidthConcatenateLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +0000965 - CLFlattenLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000966 - @ref CLSoftmaxLayer
967 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
968 - Add SVE support
969 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
970 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
971 - Added NHWC data layout support to:
972 - @ref CLChannelShuffleLayer
973 - @ref CLDeconvolutionLayer
974 - @ref CLL2NormalizeLayer
975 - Added QASYMM8 support to the following kernels:
976 - @ref CLScaleKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100977 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000978 - @ref CLPixelWiseMultiplicationKernel
979 - Added FP16 support to the following kernels:
980 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100981 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000982 - @ref CLNormalizePlanarYUVLayerKernel
983 - @ref CLWinogradConvolutionLayer (5x5 kernel)
984 - More tests added to both validation and benchmarking suites.
985
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100986v18.08 Public major release
987 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100988 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100989 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100990 - Removed support for QS8/QS16 data types.
991 - Added support for grouped convolution in @ref CLConvolutionLayer.
992 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100993 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100994 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
995 - @ref CLDepthwiseConvolutionLayer
996 - @ref CLDirectConvolutionLayer
997 - @ref CLConvolutionLayer
998 - @ref CLScale
999 - @ref CLIm2ColKernel
1000 - New Neon kernels / functions:
1001 - @ref NERNNLayer
1002 - New OpenCL kernels / functions:
1003 - @ref CLArithmeticDivision
1004 - Introduced prepare() stage support in the graph API for GLES.
1005 - Added support for memory reusage when trying to allocate smaller CLTensors.
1006 - Enabled NHWC execution on graph examples.
1007 - Added JPEG accessor for validation purposes.
1008 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001009
1010v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001011 - Various bug fixes.
1012 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001013 - Major redesign in the interface for the neon kernels implemented in assembly.
1014 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
1015 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
1016 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Sheri Zhangcece42c2021-02-10 15:32:38 +00001017 - Moved neon assembly kernels to the folder src/core/Neon/kernels/arm_gemm.
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001018 - Improved doxygen documentation.
1019 - Improved memory management for layer's transitions.
1020 - Added support for NHWC data layout in tensors.
1021 - Added NHWC data layout support to:
1022 - @ref NEGEMMConvolutionLayer
1023 - @ref NEDirectConvolutionLayer
1024 - @ref NEPoolingLayer / @ref CLPoolingLayer
1025 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
1026 - @ref NEDepthwiseConvolutionLayer
1027 - @ref NEScale
Georgios Pinitasf7c5a412020-12-03 14:38:33 +00001028 - NEIm2Col
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001029 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
1030 - New OpenCL kernels / functions:
1031 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
1032 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
Sheri Zhang7e20e292021-02-02 11:49:34 +00001033 - @ref CLCopy / CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001034 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001035 - @ref CLRNNLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001036 - CLWidthConcatenateLayer / CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001037 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
1038 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
1039 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001040 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
1041 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
1042 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
1043 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
1044 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
1045 - Port mobilenet example to NHWC data layout.
1046 - Enabled Winograd method in @ref CLConvolutionLayer.
1047 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
Sheri Zhangcece42c2021-02-10 15:32:38 +00001048 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/Neon/kernels/arm_gemm.
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001049 - Added memory manager support in GLES functions.
1050 - Major refactoring of the graph API.
1051 - Added GLES backend in the graph API.
1052 - Added support for the memory manager in the graph API.
1053 - Enabled Winograd Convolution method in the graph API.
1054 - Added support for grouped convolutions in the graph API.
1055 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
1056 - Added fast maths flag in @ref CLConvolutionLayer.
1057 - Added new tests and benchmarks in validation and benchmark frameworks
Sheri Zhangcece42c2021-02-10 15:32:38 +00001058 - Merge Activation layer with Convolution Layer (Neon. CL, GLES)
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001059 - Added support to OpenCL 2.0 SVM
1060 - Added support to import memory in OpenCL tensors.
1061 - Added the prepare() method to perform any one off pre-processing before running the function.
1062 - Added new examples:
1063 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001064 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001065 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001066
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001067v18.03 Public maintenance release
1068 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +00001069 - Fixed bug in @ref NEActivationLayer
1070 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001071 - Updated recommended NDK version to r16b (And fixed warnings).
1072 - Fixed bug in validation code.
1073 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001074 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001075
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001076v18.02 Public major release
Sheri Zhangcece42c2021-02-10 15:32:38 +00001077 - Various Neon / OpenCL / GLES optimisations.
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001078 - Various bug fixes.
1079 - Changed default number of threads on big LITTLE systems.
1080 - Refactored examples and added:
1081 - graph_mobilenet_qassym8
1082 - graph_resnet
1083 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +00001084 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
1085 - 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 +00001086 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001087 - @ref CLActivationLayer
1088 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001089 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001090 - @ref CLActivationLayer
1091 - @ref CLDepthwiseConvolutionLayer
1092 - @ref NEDepthwiseConvolutionLayer
1093 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001094 - Added FP16 support to:
Manuel Bottini387259a2020-05-21 17:14:36 +01001095 - CLDepthwiseConvolutionLayer3x3
Anthony Barbier3762e742018-03-02 11:49:33 +00001096 - @ref CLDepthwiseConvolutionLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001097 - Added broadcasting support to NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
Anthony Barbier3762e742018-03-02 11:49:33 +00001098 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
1099 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001100 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +01001101 - CLDirectConvolutionLayerOutputStageKernel
Sheri Zhangcece42c2021-02-10 15:32:38 +00001102 - New Neon kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001103 - Added name() method to all kernels.
1104 - Added support for Winograd 5x5.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001105 - NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001106 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
1107 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
1108 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +01001109 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001110 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001111 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +00001112
Anthony Barbier64c95a02018-01-22 18:48:55 +00001113v18.01 Public maintenance release
1114 - Various bug fixes
1115 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +00001116 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
Sheri Zhang7e20e292021-02-02 11:49:34 +00001117 - Added CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +00001118 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +00001119 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
1120 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
1121 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
1122 - Added @ref GCScaleKernel / @ref GCScale
1123 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +00001124 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001125 - @ref GCCol2ImKernel
1126 - @ref GCGEMMInterleave4x4Kernel
1127 - @ref GCGEMMTranspose1xWKernel
1128 - @ref GCIm2ColKernel
Sheri Zhangcece42c2021-02-10 15:32:38 +00001129 - Refactored Neon Winograd (NEWinogradLayerKernel)
Anthony Barbier3762e742018-03-02 11:49:33 +00001130 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Sheri Zhangcece42c2021-02-10 15:32:38 +00001131 - Added QASYMM8 support to the following Neon kernels:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001132 - NEDepthwiseConvolutionLayer3x3Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001133 - @ref NEFillBorderKernel
Michele Di Giorgio19289042021-02-03 16:05:00 +00001134 - NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001135 - Added new examples:
1136 - graph_cl_mobilenet_qasymm8.cpp
1137 - graph_inception_v3.cpp
1138 - gc_dc.cpp
1139 - More tests added to both validation and benchmarking suites.
1140
Gian Marcoff850932017-12-11 12:37:17 +00001141v17.12 Public major release
1142 - Most machine learning functions on OpenCL support the new data type QASYMM8
1143 - Introduced logging interface
1144 - Introduced opencl timer
1145 - Reworked GEMMLowp interface
Sheri Zhangcece42c2021-02-10 15:32:38 +00001146 - Added new Neon assembly kernels for GEMMLowp, SGEMM and HGEMM
Gian Marcoff850932017-12-11 12:37:17 +00001147 - Added validation method for most Machine Learning kernels / functions
1148 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
1149 - Added sgemm example for OpenCL
1150 - Added absolute difference example for GLES compute
1151 - Added new tests and benchmarks in validation and benchmark frameworks
1152 - Added new kernels / functions for GLES compute
1153
1154 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001155 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
1156 - @ref GCActivationLayerKernel / @ref GCActivationLayer
1157 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
1158 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +01001159 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001160 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
1161 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
1162 - @ref GCFillBorderKernel / @ref GCFillBorder
1163 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
1164 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
1165 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
1166 - @ref GCIm2ColKernel
1167 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
1168 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
1169 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
1170 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
1171 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +00001172
Sheri Zhangcece42c2021-02-10 15:32:38 +00001173 - New Neon kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +00001174 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
1175 - arm_compute::NEHGEMMAArch64FP16Kernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001176 - NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001177 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
1178 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001179 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +00001180
1181 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001182 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
Michele Di Giorgioba14c922020-10-12 13:27:57 +01001183 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +00001184
Sheri Zhangcece42c2021-02-10 15:32:38 +00001185 - New graph nodes for Neon and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001186 - graph::BranchLayer
1187 - graph::DepthConvertLayer
1188 - graph::DepthwiseConvolutionLayer
1189 - graph::DequantizationLayer
1190 - graph::FlattenLayer
1191 - graph::QuantizationLayer
1192 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +00001193
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001194v17.10 Public maintenance release
1195 - Bug fixes:
1196 - Check the maximum local workgroup size supported by OpenCL devices
1197 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +00001198 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001199 - Added a few new Graph nodes, support for branches and grouping.
1200 - Automatically enable cl_printf in debug builds
1201 - Fixed bare metal builds for armv7a
1202 - Added AlexNet and cartoon effect examples
1203 - 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)
1204
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001205v17.09 Public major release
1206 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +00001207 - 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 +01001208 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
Sheri Zhangcece42c2021-02-10 15:32:38 +00001209 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both Neon and OpenCL.
1210 - New Neon kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +00001211 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001212 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
Georgios Pinitas70eb53b2021-01-06 19:42:21 +00001213 - NEFloorKernel / @ref NEFloor
Anthony Barbier3762e742018-03-02 11:49:33 +00001214 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
1215 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
1216 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
1217 - @ref NEReductionOperationKernel / @ref NEReductionOperation
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001218 - NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001219
1220 - New OpenCL kernels / functions:
Manuel Bottini387259a2020-05-21 17:14:36 +01001221 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001222 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
1223 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +00001224 - CLFlattenLayer
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001225 - CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001226 - CLGEMMTranspose1xW
Michele Di Giorgioee82d342021-01-05 16:14:28 +00001227 - CLGEMMMatrixVectorMultiplyKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001228 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
1229 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
1230 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
1231 - @ref CLReductionOperationKernel / @ref CLReductionOperation
Sheri Zhang7e20e292021-02-02 11:49:34 +00001232 - CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001233
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001234v17.06 Public major release
1235 - Various bug fixes
Sheri Zhangcece42c2021-02-10 15:32:38 +00001236 - Added support for fixed point 8 bit (QS8) to the various Neon machine learning kernels.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001237 - Added unit tests and benchmarks (AlexNet, LeNet)
1238 - Added support for sub tensors.
1239 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Sheri Zhangcece42c2021-02-10 15:32:38 +00001240 - Added @ref OMPScheduler (OpenMP) scheduler for Neon
1241 - Added @ref SingleThreadScheduler scheduler for Neon (For bare metal)
Anthony Barbier3762e742018-03-02 11:49:33 +00001242 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001243 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001244 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001245 - CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001246 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001247 - CLLocallyConnectedMatrixMultiplyKernel / CLLocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001248 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001249 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001250 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Sheri Zhangcece42c2021-02-10 15:32:38 +00001251 - New Neon kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001252 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001253 - NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001254 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001255 - NELocallyConnectedMatrixMultiplyKernel / NELocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001256 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001257
1258v17.05 Public bug fixes release
1259 - Various bug fixes
1260 - Remaining of the functions ported to use accurate padding.
1261 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
1262 - Added "free" method to allocator.
1263 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
1264
1265v17.04 Public bug fixes release
1266
1267 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +00001268 - @ref CLColorConvertKernel
1269 - @ref CLEdgeNonMaxSuppressionKernel
1270 - @ref CLEdgeTraceKernel
1271 - @ref CLGaussianPyramidHorKernel
1272 - @ref CLGaussianPyramidVertKernel
1273 - @ref CLGradientKernel
1274 - @ref NEChannelCombineKernel
1275 - @ref NEFillArrayKernel
1276 - @ref NEGaussianPyramidHorKernel
1277 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +01001278 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001279 - @ref NEHarrisScoreKernel
1280 - @ref NEHOGDetectorKernel
Michalis Spyrou373b4072021-01-20 16:41:12 +00001281 - NELogits1DMaxKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001282 - NELogits1DShiftExpSumKernel
1283 - NELogits1DNormKernel
1284 - @ref NENonMaximaSuppression3x3FP16Kernel
1285 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001286
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001287v17.03.1 First Major public release of the sources
1288 - Renamed the library to arm_compute
Sheri Zhangcece42c2021-02-10 15:32:38 +00001289 - New CPP target introduced for C++ kernels shared between Neon and CL functions.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001290 - New padding calculation interface introduced and ported most kernels / functions to use it.
1291 - New OpenCL kernels / functions:
Gian Marco Iodiceeb65f6d2020-04-15 11:42:15 +01001292 - CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Sheri Zhangcece42c2021-02-10 15:32:38 +00001293 - New Neon kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001294 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
1295 - @ref NETransposeKernel / @ref NETranspose
Michalis Spyrou373b4072021-01-20 16:41:12 +00001296 - NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001297 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +01001298 - NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001299 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001300
1301v17.03 Sources preview
1302 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001303 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001304 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001305 - CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001306 - @ref CLTransposeKernel / @ref CLTranspose
1307 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
1308 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
1309 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Sheri Zhangcece42c2021-02-10 15:32:38 +00001310 - New Neon kernels / functions:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001311 - NEActivationLayerKernel / @ref NEActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001312 - 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 +00001313 - NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001314
1315v17.02.1 Sources preview
1316 - New OpenCL kernels / functions:
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001317 - CLLogits1DMaxKernel, CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
Michele Di Giorgioe1314662021-02-01 17:09:32 +00001318 - CLPoolingLayerKernel / @ref CLPoolingLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001319 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
1320 - @ref CLRemapKernel / @ref CLRemap
1321 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
1322 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
1323 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Sheri Zhangcece42c2021-02-10 15:32:38 +00001324 - New Neon FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +00001325 - @ref NEAccumulateWeightedFP16Kernel
1326 - @ref NEBox3x3FP16Kernel
1327 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001328
1329v17.02 Sources preview
1330 - New OpenCL kernels / functions:
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001331 - CLActivationLayerKernel / @ref CLActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001332 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1333 - @ref CLDerivativeKernel / @ref CLChannelExtract
1334 - @ref CLFastCornersKernel / @ref CLFastCorners
1335 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Sheri Zhangcece42c2021-02-10 15:32:38 +00001336 - New Neon kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001337 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1338 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001339 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1340 - Switched all the kernels / functions to use tensors instead of images.
1341 - Updated documentation to include instructions to build the library from sources.
1342
1343v16.12 Binary preview release
1344 - Original release
1345
1346@section S3_how_to_build How to build the library and the examples
1347
1348@subsection S3_1_build_options Build options
1349
1350scons 2.3 or above is required to build the library.
1351To see the build options available simply run ```scons -h```:
1352
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001353 debug: Debug (yes|no)
1354 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001355
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001356 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1357 default: 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
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001361
Sang-Hoon Park50e98bb2021-01-14 14:54:14 +00001362 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 +00001363 default: armv7a
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001364
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001365 estate: Execution State (auto|32|64)
1366 default: auto
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001367
Georgios Pinitas45514032020-12-30 00:03:09 +00001368 os: Target OS (linux|android|macos|tizen|bare_metal)
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001369 default: linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001370
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001371 build: Build type (native|cross_compile|embed_only)
1372 default: cross_compile
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001373
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001374 examples: Build example programs (yes|no)
1375 default: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001376
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001377 gemm_tuner: Build gemm_tuner programs (yes|no)
1378 default: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001379
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001380 Werror: Enable/disable the -Werror compilation flag (yes|no)
1381 default: True
Anthony Barbier20dbb822017-12-13 21:19:39 +00001382
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001383 standalone: Builds the tests as standalone executables, links statically with libgcc, libstdc++ and libarm_compute (yes|no)
1384 default: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001385
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001386 opencl: Enable OpenCL support (yes|no)
1387 default: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001388
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001389 neon: Enable Neon support (yes|no)
1390 default: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001391
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001392 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1393 default: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001394
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001395 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shaders in library binary (yes|no)
1396 default: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001397
Georgios Pinitasea857272021-01-22 05:47:37 +00001398 compress_kernels: Compress embedded OpenCL kernels in library binary. Note embed_kernels should be enabled as well (yes|no)
1399 default: False
Georgios Pinitasea857272021-01-22 05:47:37 +00001400
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001401 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1402 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001403
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001404 tracing: Enable runtime tracing (yes|no)
1405 default: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001406
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001407 openmp: Enable OpenMP backend (yes|no)
1408 default: False
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001409
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001410 cppthreads: Enable C++11 threads backend (yes|no)
1411 default: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001412
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001413 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1414 default: .
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001415
1416 install_dir: Specify sub-folder for the install ( /path/to/install_dir )
1417 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001418
1419 exceptions: Enable/disable C++ exception support (yes|no)
1420 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001421
1422 linker_script: Use an external linker script ( /path/to/linker_script )
1423 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001424
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001425 custom_options: Custom options that can be used to turn on/off features
1426 (all|none|comma-separated list of names)
1427 allowed names: disable_mmla_fp
1428 default: none
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001429
1430 data_type_support: Enable a list of data types to support
1431 (all|none|comma-separated list of names)
1432 allowed names: qasymm8 qasymm8_signed qsymm16 fp16 fp32
1433 default: all
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001434
1435 toolchain_prefix: Override the toolchain prefix
1436 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001437
1438 compiler_prefix: Override the compiler prefix
1439 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001440
1441 extra_cxx_flags: Extra CXX flags to be appended to the build command
1442 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001443
1444 extra_link_flags: Extra LD flags to be appended to the build command
1445 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001446
1447 compiler_cache: Command to prefix to the C and C++ compiler (e.g ccache)
1448 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001449
1450 specs_file: Specs file to use
1451 default: rdimon.specs
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001452
1453 benchmark_examples: Build benchmark examples programs (yes|no)
1454 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001455
1456 validate_examples: Build validate examples programs (yes|no)
1457 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001458
1459 reference_openmp: Build reference validation with openmp (yes|no)
1460 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001461
1462 validation_tests: Build validation test programs (yes|no)
1463 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001464
1465 benchmark_tests: Build benchmark test programs (yes|no)
1466 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001467
1468 test_filter: Pattern to specify the tests' filenames to be compiled
1469 default: *.cpp
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001470
1471 pmu: Enable PMU counters (yes|no)
1472 default: False
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001473
1474 mali: Enable Mali hardware counters (yes|no)
1475 default: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001476
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001477 external_tests_dir: Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1478 default:
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001479
Anthony Barbier79c61782017-06-23 11:48:24 +01001480@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001481 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1482 - 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)
1483 - 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).
1484
Anthony Barbier79c61782017-06-23 11:48:24 +01001485@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 +01001486
Anthony Barbier79c61782017-06-23 11:48:24 +01001487@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Sheri Zhangcece42c2021-02-10 15:32:38 +00001488@note bare metal can only be used for Neon (not OpenCL), only static libraries get built and Neon's multi-threading support is disabled.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001489
Anthony Barbier79c61782017-06-23 11:48:24 +01001490@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 +01001491
Sheri Zhangcece42c2021-02-10 15:32:38 +00001492@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 +01001493
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001494There 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.
1495
Georgios Pinitasea857272021-01-22 05:47:37 +00001496In 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.
1497
Michele Di Giorgio9a6ac342021-02-16 15:37:59 +00001498@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 +01001499
Sheri Zhangcece42c2021-02-10 15:32:38 +00001500@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 +01001501
Anthony Barbier20dbb822017-12-13 21:19:39 +00001502@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 +01001503
1504@b set_soname: Do you want to build the versioned version of the library ?
1505
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001506If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1507Example:
1508 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1509 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1510 libarm_compute_core.so.1.0.0
1511
1512@note This options is disabled by default as it requires SCons version 2.4 or above.
1513
Anthony Barbier79c61782017-06-23 11:48:24 +01001514@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1515
1516@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1517
1518@b examples: Build or not the examples
1519
1520@b validation_tests: Enable the build of the validation suite.
1521
Anthony Barbier79c61782017-06-23 11:48:24 +01001522@b benchmark_tests: Enable the build of the benchmark tests
1523
1524@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1525
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001526@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)
1527
Sheri Zhangcece42c2021-02-10 15:32:38 +00001528@b openmp Build in the OpenMP scheduler for Neon.
Anthony Barbier79c61782017-06-23 11:48:24 +01001529
1530@note Only works when building with g++ not clang++
1531
Sheri Zhangcece42c2021-02-10 15:32:38 +00001532@b cppthreads Build in the C++11 scheduler for Neon.
Anthony Barbier79c61782017-06-23 11:48:24 +01001533
Anthony Barbier3762e742018-03-02 11:49:33 +00001534@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001535
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001536@b external_tests_dir Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1537
1538In order to use this option, the external tests directory must have the following structure:
1539
1540 EXTERNAL_TESTS_DIR:
1541 └── tests
1542 ├── benchmark
1543 │   ├── CL
1544 │   ├── datasets
1545 │   ├── fixtures
Sheri Zhangcece42c2021-02-10 15:32:38 +00001546 │   └── Neon
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001547 └── validation
1548    ├── CL
1549     ├── datasets
1550     ├── fixtures
Sheri Zhangcece42c2021-02-10 15:32:38 +00001551     └── Neon
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001552
1553Then, build the library with `external_tests_dir=<PATH_TO_EXTERNAL_TESTS_DIR>`.
1554
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001555@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001556
1557@subsubsection S3_2_1_library How to build the library ?
1558
1559For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1560
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001561 - gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
1562 - gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001563
Sheri Zhangcece42c2021-02-10 15:32:38 +00001564To cross-compile the library in debug mode, with Neon only support, for Linux 32bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001565
1566 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1567
1568To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1569
1570 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1571
Anthony Barbier20dbb822017-12-13 21:19:39 +00001572To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1573
1574 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1575
Sheri Zhangcece42c2021-02-10 15:32:38 +00001576You can also compile the library natively on an Arm device by using <b>build=native</b>:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001577
1578 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1579 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1580
Sheri Zhangcece42c2021-02-10 15:32:38 +00001581@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.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001582
1583For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1584
1585 apt-get install g++-arm-linux-gnueabihf
1586
1587Then run
1588
1589 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1590
1591or simply remove the build parameter as build=cross_compile is the default value:
1592
1593 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1594
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001595@subsubsection S3_2_2_examples How to manually build the examples ?
1596
1597The 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.
1598
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001599@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 +01001600
Sheri Zhangcece42c2021-02-10 15:32:38 +00001601To cross compile a Neon example for Linux 32bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001602
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001603 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 +01001604
Sheri Zhangcece42c2021-02-10 15:32:38 +00001605To cross compile a Neon example for Linux 64bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001606
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001607 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 +01001608
1609(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)
1610
1611To cross compile an OpenCL example for Linux 32bit:
1612
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001613 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 +01001614
1615To cross compile an OpenCL example for Linux 64bit:
1616
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001617 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 +01001618
Anthony Barbier14c86a92017-12-14 16:27:41 +00001619To cross compile a GLES example for Linux 32bit:
1620
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001621 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 +00001622
1623To cross compile a GLES example for Linux 64bit:
1624
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001625 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 +00001626
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001627(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)
1628
Anthony Barbier14c86a92017-12-14 16:27:41 +00001629To 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.
1630
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001631i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1632
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001633 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 +01001634
1635i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1636
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001637 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 +01001638
1639(notice the only difference with the 32 bit command is that we don't need the -mfpu option and the compiler's name is different)
1640
Anthony Barbiere5007472017-10-27 15:01:44 +01001641@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1642
Sheri Zhangcece42c2021-02-10 15:32:38 +00001643To compile natively (i.e directly on an Arm device) for Neon for Linux 32bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001644
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001645 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 +01001646
Sheri Zhangcece42c2021-02-10 15:32:38 +00001647To compile natively (i.e directly on an Arm device) for Neon for Linux 64bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001648
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001649 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 +01001650
1651(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1652
Sheri Zhangcece42c2021-02-10 15:32:38 +00001653To compile natively (i.e directly on an Arm device) for OpenCL for Linux 32bit or Linux 64bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001654
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001655 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 +01001656
Sheri Zhangcece42c2021-02-10 15:32:38 +00001657To 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 +01001658
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001659 g++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude/ -L. -larm_compute -larm_compute_core -std=c++14 -DARM_COMPUTE_GC -Iinclude/linux/ -o gc_absdiff
Anthony Barbier14c86a92017-12-14 16:27:41 +00001660
1661To 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 +00001662
1663i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001664
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001665 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 +01001666
Anthony Barbier14c86a92017-12-14 16:27:41 +00001667i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001668
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001669 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 +01001670
1671(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 +01001672
Anthony Barbiere5007472017-10-27 15:01:44 +01001673@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1674
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001675@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 +00001676@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 +01001677
1678To run the built executable simply run:
1679
1680 LD_LIBRARY_PATH=build ./neon_convolution
1681
1682or
1683
1684 LD_LIBRARY_PATH=build ./cl_convolution
1685
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001686@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 +00001687
1688For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001689
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001690 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001691
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001692Below is a list of the common parameters among the graph examples :
1693@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001694
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001695@subsubsection S3_2_3_sve Build for SVE or SVE2
1696
1697In order to build for SVE or SVE2 you need a compiler that supports them. You can find more information in the following these links:
1698 -# GCC: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/sve-support
1699 -# LLVM: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/llvm-toolchain/sve-support
1700
1701@note You the need to indicate the toolchains using the scons "toolchain_prefix" parameter.
1702
1703An example build command with SVE is:
1704
1705 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-
1706
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001707@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001708
1709For Android, the library was successfully built and tested using Google's standalone toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001710 - clang++ from NDK r18b for armv7a
Giorgio Arenadf2a9a32021-02-22 14:58:37 +00001711 - clang++ from NDK r20b for arm64-v8a
1712 - clang++ from NDK r20b for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001713
Giorgio Arenadf2a9a32021-02-22 14:58:37 +00001714Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>. Minimum NDK version required: r18b
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001715
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001716- Download the NDK r18b from here: https://developer.android.com/ndk/downloads/index.html to directory $NDK
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001717- Make sure you have Python 2.7 installed on your machine.
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001718- 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 +01001719
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001720
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001721 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b --stl libc++ --api 21
1722 $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 +01001723
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001724@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 +01001725
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001726@note Make sure to add the toolchains to your PATH:
1727
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001728 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 +01001729
1730@subsubsection S3_3_1_library How to build the library ?
1731
Sheri Zhangcece42c2021-02-10 15:32:38 +00001732To cross-compile the library in debug mode, with Neon only support, for Android 32bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001733
1734 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1735
1736To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1737
Anthony Barbier14c86a92017-12-14 16:27:41 +00001738 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 +01001739
Anthony Barbier20dbb822017-12-13 21:19:39 +00001740To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1741
Anthony Barbier14c86a92017-12-14 16:27:41 +00001742 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 +00001743
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001744@subsubsection S3_3_2_examples How to manually build the examples ?
1745
1746The 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.
1747
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001748@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 +01001749
1750Once you've got your Android standalone toolchain built and added to your path you can do the following:
1751
Sheri Zhangcece42c2021-02-10 15:32:38 +00001752To cross compile a Neon example:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001753
1754 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001755 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 +01001756 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001757 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 +01001758
1759To cross compile an OpenCL example:
1760
1761 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001762 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 +01001763 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001764 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 +00001765
1766To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001767
Anthony Barbier14c86a92017-12-14 16:27:41 +00001768 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001769 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 +00001770 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001771 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 +01001772
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001773To 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 +01001774
1775 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001776 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 +01001777 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001778 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 +01001779
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001780@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 +00001781@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 +01001782
1783Then you need to do is upload the executable and the shared library to the device using ADB:
1784
1785 adb push neon_convolution_arm /data/local/tmp/
1786 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001787 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001788 adb shell chmod 777 -R /data/local/tmp/
1789
1790And finally to run the example:
1791
1792 adb shell /data/local/tmp/neon_convolution_arm
1793 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001794 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001795
1796For 64bit:
1797
1798 adb push neon_convolution_aarch64 /data/local/tmp/
1799 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001800 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001801 adb shell chmod 777 -R /data/local/tmp/
1802
1803And finally to run the example:
1804
1805 adb shell /data/local/tmp/neon_convolution_aarch64
1806 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001807 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001808
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001809@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 +00001810
1811For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001812 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001813
Sheri Zhangcece42c2021-02-10 15:32:38 +00001814In 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.
Anthony Barbier3762e742018-03-02 11:49:33 +00001815
Georgios Pinitas45514032020-12-30 00:03:09 +00001816@subsection S3_4_macos Building for macOS
1817
1818The library was successfully natively built for Apple Silicon under macOS 11.1 using clang v12.0.0.
1819
1820To natively compile the library with accelerated CPU support:
1821
1822 scons Werror=1 -j8 neon=1 opencl=0 os=macos arch=arm64-v8a build=native
1823
1824@note Initial support disables feature discovery through HWCAPS and thread scheduling affinity controls
1825
1826@subsection S3_5_bare_metal Building for bare metal
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001827
Georgios Pinitas58216322020-02-26 11:13:13 +00001828For 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 +01001829 - arm-eabi for armv7a
1830 - aarch64-elf for arm64-v8a
1831
1832Download 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>.
1833
1834@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
1835
Georgios Pinitas45514032020-12-30 00:03:09 +00001836@subsubsection S3_5_1_library How to build the library ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001837
Sheri Zhangcece42c2021-02-10 15:32:38 +00001838To cross-compile the library with Neon support for baremetal arm64-v8a:
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001839
1840 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
1841
Georgios Pinitas45514032020-12-30 00:03:09 +00001842@subsubsection S3_5_2_examples How to manually build the examples ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001843
1844Examples 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>.
1845
Georgios Pinitas45514032020-12-30 00:03:09 +00001846@subsection S3_6_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001847
1848Using `scons` directly from the Windows command line is known to cause
1849problems. The reason seems to be that if `scons` is setup for cross-compilation
1850it gets confused about Windows style paths (using backslashes). Thus it is
1851recommended to follow one of the options outlined below.
1852
Georgios Pinitas45514032020-12-30 00:03:09 +00001853@subsubsection S3_6_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001854
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001855The best and easiest option is to use
1856<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001857This feature is still marked as *beta* and thus might not be available.
1858However, if it is building the library is as simple as opening a *Bash on
1859Ubuntu on Windows* shell and following the general guidelines given above.
1860
Georgios Pinitas45514032020-12-30 00:03:09 +00001861@subsubsection S3_6_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001862
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001863If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001864can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1865to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001866also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001867code of the library.) Linaro provides pre-built versions of
1868<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001869that can be used from the Cygwin terminal. When building for Android the
1870compiler is included in the Android standalone toolchain. After everything has
1871been set up in the Cygwin terminal the general guide on building the library
1872can be followed.
1873
Georgios Pinitas45514032020-12-30 00:03:09 +00001874@subsection S3_7_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001875
Georgios Pinitas45514032020-12-30 00:03:09 +00001876@subsubsection S3_7_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001877
1878Compute 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).
1879
1880Enabling 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.
1881
1882Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1883
Georgios Pinitas45514032020-12-30 00:03:09 +00001884@subsubsection S3_7_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001885
1886Integer 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.
1887
1888OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1889
1890SVM 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 +01001891
Georgios Pinitas45514032020-12-30 00:03:09 +00001892@subsection S3_8_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001893
1894The 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).
1895The 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 +01001896The 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 +01001897In 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.
1898
1899If 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:
1900
1901https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1902
1903Tuning 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.
1904
1905CLTuner 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.
1906
1907 #Example: 2 unique Matrix Multiply configurations
1908@code{.cpp}
1909 TensorShape a0 = TensorShape(32,32);
1910 TensorShape b0 = TensorShape(32,32);
1911 TensorShape c0 = TensorShape(32,32);
1912 TensorShape a1 = TensorShape(64,64);
1913 TensorShape b1 = TensorShape(64,64);
1914 TensorShape c1 = TensorShape(64,64);
1915
1916 Tensor a0_tensor;
1917 Tensor b0_tensor;
1918 Tensor c0_tensor;
1919 Tensor a1_tensor;
1920 Tensor b1_tensor;
1921 Tensor c1_tensor;
1922
1923 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1924 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1925 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1926 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1927 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1928 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1929
1930 CLGEMM gemm0;
1931 CLGEMM gemm1;
1932
1933 // Configuration 0
1934 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1935
1936 // Configuration 1
1937 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1938@endcode
1939
Georgios Pinitas45514032020-12-30 00:03:09 +00001940@subsubsection S3_8_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001941
Michele Di Giorgio57f30a92020-09-08 14:03:51 +01001942All 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 +01001943
1944 #Enable CL tuner
1945 ./graph_mobilenet --enable-tuner –-target=CL
1946 ./arm_compute_benchmark --enable-tuner
1947
1948 #Export/Import to/from a file
1949 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1950 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1951
1952If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1953
1954Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1955
1956 -# Disable the power management
1957 -# Keep the GPU frequency constant
1958 -# Run multiple times the network (i.e. 10).
1959
1960If 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.
1961
1962@code{.cpp}
1963CLTuner tuner;
1964
1965// Setup Scheduler
1966CLScheduler::get().default_init(&tuner);
1967@endcode
1968
1969After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1970- tuner.save_to_file("results.csv");
1971
1972This file can be also imported using the method "load_from_file("results.csv")".
1973- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001974*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001975} // namespace arm_compute