blob: af840ec2b8b595f608f05780ee4f6e6aceeb2c1b [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
Michalis Spyrou473cb012021-02-23 11:48:12 +000030The Compute Library is a collection of low-level machine learning functions optimized 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:
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +000033 - OS: Linux, Android, macOS or bare metal.
Sheri Zhangac6499a2021-02-10 15:32:38 +000034 - 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 Giorgioeca54a02021-02-16 15:37:59 +000040Please create an issue on <a href="https://github.com/ARM-software/ComputeLibrary/issues">Github</a>.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010041
42In order to facilitate the work of the support team please provide the build information of the library you are using. To get the version of the library you are using simply run:
43
44 $ strings android-armv7a-cl-asserts/libarm_compute.so | grep arm_compute_version
45 arm_compute_version=v16.12 Build options: {'embed_kernels': '1', 'opencl': '1', 'arch': 'armv7a', 'neon': '0', 'asserts': '1', 'debug': '0', 'os': 'android', 'Werror': '1'} Git hash=f51a545d4ea12a9059fe4e598a092f1fd06dc858
46
Anthony Barbier14c86a92017-12-14 16:27:41 +000047@section S0_2_prebuilt_binaries Pre-built binaries
48
49For each release we provide some pre-built binaries of the library [here](https://github.com/ARM-software/ComputeLibrary/releases)
50
51These binaries have been built using the following toolchains:
Giorgio Arenacd7d1782021-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 Arenacd7d1782021-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 EGL 1.5 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos EGL registry</a>
66 - 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 +010067 - An examples folder containing a few examples to compile and link against the library.
68 - A @ref utils folder containing headers with some boiler plate code used by the examples.
69 - This documentation.
70
Michele Di Giorgio552e11d2020-09-23 15:08:38 +010071 For detailed information about file organization, please refer to Files -> File List section of this documentation.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010072
73@section S2_versions_changelog Release versions and changelog
74
75@subsection S2_1_versions Release versions
76
77All releases are numbered vYY.MM Where YY are the last two digits of the year, and MM the month number.
78If there is more than one release in a month then an extra sequential number is appended at the end:
79
80 v17.03 (First release of March 2017)
81 v17.03.1 (Second release of March 2017)
82 v17.04 (First release of April 2017)
83
84@note We're aiming at releasing one major public release with new features per quarter. All releases in between will only contain bug fixes.
85
86@subsection S2_2_changelog Changelog
87
Michalis Spyrou27e67f02021-02-16 11:34:39 +000088v21.05 Public major release
89 - Removed computer vision support from Neon backend
90 - Removed the following functions:
91 - NEAbsoluteDifference
92 - NEAccumulate
93 - NEBox3x3
94 - NECannyEdge
95 - NEChannelCombine
96 - NEChannelExtract
97 - NEColorConvert
Michalis Spyrou473cb012021-02-23 11:48:12 +000098 - NEConvolution
Michalis Spyrou27e67f02021-02-16 11:34:39 +000099 - NEDerivative
100 - NEDilate
101 - NEEqualizeHistogram
102 - NEErode
103 - NEFastCorners
104 - NEGaussian3x3
105 - NEGaussian5x5
106 - NEGaussianPyramid
107 - NEHOGDescriptor
108 - NEHOGDetector
109 - NEHOGGradient
110 - NEHOGMultiDetection
111 - NEHarrisCorners
112 - NEHistogram
113 - NEIntegralImage
114 - NELaplacianPyramid
115 - NELaplacianReconstruct
116 - NEMagnitude
117 - NEMeanStdDev
118 - NEMedian3x3
119 - NEMinMaxLocation
120 - NENonLinearFilter
121 - NEOpticalFlow
122 - NEPhase
Michalis Spyrou27e67f02021-02-16 11:34:39 +0000123 - NEScharr3x3
124 - NESobel3x3
125 - NESobel5x5
126 - NESobel7x7
127 - NETableLookup
128 - NEThreshold
129 - NEWarpAffine
Michalis Spyrou473cb012021-02-23 11:48:12 +0000130 - NEWarpPerspectiveKernel
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +0000131
Michalis Spyrou473cb012021-02-23 11:48:12 +0000132 - Remove all GLES kernels / functions / tests / examples
133 - Removed computer vision support from CL backend
134 - Removed the following functions:
135 - CLAbsoluteDifference
136 - CLAccumulate
137 - CLBox3x3
138 - CLCannyEdge
139 - CLChannelCombine
140 - CLChannelExtract
141 - CLColorConvert
142 - CLConvolution
143 - CLDerivative
144 - CLDilate
145 - CLEqualizeHistogram
146 - CLErode
147 - CLFastCorners
148 - CLGaussian3x3
149 - CLGaussian5x5
150 - CLGaussianPyramid
151 - CLHOGDescriptor
152 - CLHOGDetector
153 - CLHOGGradient
154 - CLHOGMultiDetection
155 - CLHarrisCorners
156 - CLHistogram
157 - CLIntegralImage
158 - CLLaplacianPyramid
159 - CLLaplacianReconstruct
160 - CLMagnitude
161 - CLMeanStdDev
162 - CLMedian3x3
163 - CLMinMaxLocation
164 - CLNonLinearFilter
165 - CLOpticalFlow
166 - CLPhase
167 - CLScharr3x3
168 - CLSobel3x3
169 - CLSobel5x5
170 - CLSobel7x7
171 - CLTableLookup
172 - CLThreshold
173 - CLWarpAffine
174 - CLWarpPerspective
175
Georgios Pinitas40f51a62020-11-21 03:04:18 +0000176v21.02 Public major release
Sheri Zhangda6a6eb2021-01-06 11:15:06 +0000177 - Various bug fixes.
178 - Various optimisations.
Georgios Pinitas45514032020-12-30 00:03:09 +0000179 - Upgrade C++ standard to C++14
180 - Add macOS support
Giorgio Arena1055dc12021-02-19 09:53:06 +0000181 - Add Armv8-R AArch64 architecture support
Sheri Zhangda6a6eb2021-01-06 11:15:06 +0000182 - Add SVE/SVE2 support for:
Manuel Bottini10b38262021-02-19 18:16:44 +0000183 - NEScaleKernel
Sheri Zhangda6a6eb2021-01-06 11:15:06 +0000184 - @ref NEActivationLayer
185 - @ref NEArithmeticAddition
186 - @ref NEBatchNormalizationLayerKernel
Giorgio Arena1055dc12021-02-19 09:53:06 +0000187 - @ref cpu::kernels::CpuLogits1DSoftmaxKernel
188 - @ref cpu::kernels::CpuLogits1DMaxKernel
189 - @ref cpu::kernels::CpuElementwiseUnaryKernel
Sheri Zhangdda69142021-02-01 19:06:57 +0000190 - Remove padding from OpenCL kernels:
191 - @ref CLDirectConvolutionLayerKernel
192 - @ref CLArgMinMaxLayerKernel
193 - @ref CLPadLayerKernel
194 - @ref CLROIAlignLayerKernel
195 - @ref CLRangeKernel
Manuel Bottini3b131ab2021-02-19 18:16:44 +0000196 - CLScaleKernel
Sheri Zhangdda69142021-02-01 19:06:57 +0000197 - @ref CLSelectKernel
198 - @ref CLBitwiseKernel
Giorgio Arena1055dc12021-02-19 09:53:06 +0000199 - @ref opencl::kernels::ClFloorKernel
Sheri Zhangdda69142021-02-01 19:06:57 +0000200 - @ref CLTransposeKernel
Giorgio Arena5b50f422021-02-17 11:43:05 +0000201 - Deprecate functions in CLTuner:
202 - add_lws_to_table
203 - import_lws_table
204 - lws_table
Sheri Zhangda6a6eb2021-01-06 11:15:06 +0000205 - Remove functions:
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000206 - NELocallyConnectedLayer / CLLocallyConnectedLayer
Georgios Pinitasf7c5a412020-12-03 14:38:33 +0000207 - NEIm2Col
208 - NECol2Im
209 - NEGEMMInterleave4x4
210 - NEGEMMTranspose1xW
Georgios Pinitas8c3c0e72020-12-03 20:11:53 +0000211 - NEComputeAllAnchors / CLComputeAllAnchors
Georgios Pinitasec2256b2020-12-03 18:51:58 +0000212 - NEGEMMAssemblyDispatch
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000213 - NEUpsampleLayer / CLUpsampleLayer
Sheri Zhangda6a6eb2021-01-06 11:15:06 +0000214 - Remove kernels:
Georgios Pinitasd308df32020-12-01 16:56:36 +0000215 - NEGEMMMatrixVectorMultiplyKernel
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000216 - NELocallyConnectedMatrixMultiplyKernel / CLLocallyConnectedMatrixMultiplyKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000217 - NEUpsampleLayerKernel / CLUpsampleLayerKernel
Gian Marco Iodicef5aad512021-02-08 17:34:40 +0000218 - Extend OpenCL tuner with workgroup batch size support
219 - 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 +0000220 - Add functionality to load the OpenCL GEMM heuristics at runtime
221 - The GEMM heuristic file (MLGO) can be used to update the default GEMM heuristics available for OpenCL
Giorgio Arenacd7d1782021-02-22 14:58:37 +0000222 - 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 Arena1ffa5ac2021-02-23 12:31:54 +0000223 - Note: data-type decoupling is in progress and expiremental. Warning of unused symbols might be raised
Georgios Pinitas40f51a62020-11-21 03:04:18 +0000224
SiCong Li96209c72020-08-21 12:28:30 +0100225v20.11 Public major release
morgolock70b1eb82020-11-24 13:54:19 +0000226 - Various bug fixes.
227 - Various optimisations.
228 - 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 +0000229 This is planned to be resolved in 21.02 release.
morgolock70b1eb82020-11-24 13:54:19 +0000230 - Added new data type QASYMM8_SIGNED support for @ref NEROIAlignLayer.
SiCong Li903f8cc2020-08-27 10:17:10 +0100231 - Added new data type S32 support for:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000232 - NEArithmeticSubtraction
233 - NEArithmeticSubtractionKernel
SiCong Libb88f892020-08-28 11:18:47 +0100234 - @ref NEPixelWiseMultiplication
235 - @ref NEPixelWiseMultiplicationKernel
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000236 - NEElementwiseDivision
237 - NEDivisionOperationKernel
SiCong Li96209c72020-08-21 12:28:30 +0100238 - Interface change
239 - Properly support softmax axis to have the same meaning as other major frameworks. That is, axis now defines the dimension
240 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.
241 The supported value range of axis is [-rank, rank).
242 This change applies to the following functions:
243 - @ref NESoftmaxLayer
244 - @ref NELogSoftmaxLayer
245 - @ref CLSoftmaxLayer
246 - @ref CLLogSoftmaxLayer
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +0000247 - GCSoftmaxLayer
Sheri Zhang824061d2020-10-26 15:46:37 +0000248 - New OpenCL kernels / functions:
249 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
morgolock0e728492020-11-20 11:03:33 +0000250 - @ref CLLogicalNot
251 - @ref CLLogicalAnd
252 - @ref CLLogicalOr
Sheri Zhangac6499a2021-02-10 15:32:38 +0000253 - New Neon kernels / functions:
morgolock0e728492020-11-20 11:03:33 +0000254 - @ref NELogicalNot
255 - @ref NELogicalAnd
256 - @ref NELogicalOr
Sheri Zhangac6499a2021-02-10 15:32:38 +0000257 - Removed padding from Neon kernels:
Sheri Zhanged367132020-10-08 15:46:16 +0100258 - @ref NEComplexPixelWiseMultiplicationKernel
Michalis Spyrou473cb012021-02-23 11:48:12 +0000259 - NENonMaximaSuppression3x3Kernel
260 - @ref NERemapKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100261 - @ref NEGEMMInterleave4x4Kernel
262 - @ref NEDirectConvolutionLayerKernel
Manuel Bottini10b38262021-02-19 18:16:44 +0000263 - NEScaleKernel
Georgios Pinitas96b16b62020-12-01 17:41:34 +0000264 - NELocallyConnectedMatrixMultiplyKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100265 - @ref NEGEMMLowpOffsetContributionKernel
266 - @ref NEGEMMTranspose1xWKernel
Michele Di Giorgio19289042021-02-03 16:05:00 +0000267 - NEPoolingLayerKernel
Michalis Spyrou473cb012021-02-23 11:48:12 +0000268 - NEConvolutionKernel
Sheri Zhanged367132020-10-08 15:46:16 +0100269 - @ref NEDepthwiseConvolutionLayerNativeKernel
270 - @ref NEGEMMLowpMatrixMultiplyKernel
271 - @ref NEGEMMMatrixMultiplyKernel
272 - @ref NEDirectConvolutionLayerOutputStageKernel
273 - @ref NEReductionOperationKernel
274 - @ref NEGEMMLowpMatrixAReductionKernel
275 - @ref NEGEMMLowpMatrixBReductionKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000276 - Removed padding from OpenCL kernels:
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000277 - CLBatchConcatenateLayerKernel
Michele Di Giorgio1e0208a2021-01-22 15:42:59 +0000278 - CLElementwiseOperationKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000279 - @ref CLBatchNormalizationLayerKernel
Michele Di Giorgioe1314662021-02-01 17:09:32 +0000280 - CLPoolingLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000281 - @ref CLWinogradInputTransformKernel
282 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
283 - @ref CLGEMMLowpMatrixAReductionKernel
284 - @ref CLGEMMLowpMatrixBReductionKernel
285 - @ref CLGEMMLowpOffsetContributionOutputStageKernel
286 - @ref CLGEMMLowpOffsetContributionKernel
287 - @ref CLWinogradOutputTransformKernel
288 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
289 - @ref CLFuseBatchNormalizationKernel
290 - @ref CLDepthwiseConvolutionLayerNativeKernel
291 - @ref CLDepthConvertLayerKernel
Sheri Zhang7e20e292021-02-02 11:49:34 +0000292 - CLCopyKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000293 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000294 - CLActivationLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000295 - @ref CLWinogradFilterTransformKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000296 - CLWidthConcatenateLayerKernel
297 - CLWidthConcatenate4TensorsKernel
298 - CLWidthConcatenate2TensorsKernel
Sang-Hoon Park201e0fe2021-01-27 13:14:56 +0000299 - CLLogits1DMaxShiftExpSumKernel
300 - CLLogits1DNormKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000301 - CLHeightConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000302 - @ref CLGEMMMatrixMultiplyKernel
303 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
304 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
305 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000306 - CLDepthConcatenateLayerKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000307 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
308 - Removed OpenCL kernels / functions:
309 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
310 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel
311 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel
morgolock00c76012020-11-06 10:40:12 +0000312 - 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 +0100313 - CLLocallyConnectedLayer
314 - CLLocallyConnectedMatrixMultiplyKernel
morgolock00c76012020-11-06 10:40:12 +0000315 - CLAbsoluteDifference
316 - CLAbsoluteDifferenceKernel
317 - CLAccumulate
318 - CLAccumulateKernel
319 - CLAccumulateSquared
320 - CLAccumulateSquaredKernel
321 - CLAccumulateWeighted
322 - CLAccumulateWeightedKernel
323 - CLAccumulateWeightedFP16Kernel
324 - CLBox3x3
325 - CLBox3x3Kernel
326 - CLBox3x3FP16Kernel
327 - CLCannyEdge
328 - CLChannelCombine
329 - CLChannelCombineKernel
330 - CLChannelExtract
331 - CLChannelExtractKernel
332 - CLColorConvert
333 - CLColorConvertKernel
334 - CLConvolution3x3
335 - CLConvolutionRectangle
336 - CLConvolutionRectangleKernel
337 - CLConvolutionSquare
338 - CLConvolutionKernel
339 - CLDerivative
340 - CLDerivativeKernel
341 - CLDilate
342 - CLDilateKernel
343 - CLEqualizeHistogram
344 - CLErode
345 - CLErodeKernel
346 - CLFastCorners
347 - CLFastCornersKernel
348 - CLGaussian3x3
349 - CLGaussian3x3Kernel
350 - CLGaussian5x5
351 - CLGaussian5x5HorKernel
352 - CLGaussian5x5VertKernel
353 - CLGaussianPyramid
354 - CLGaussianPyramidHalf
355 - CLGaussianPyramidOrb
356 - CLHarrisCorners
357 - CLHarrisScoreKernel
358 - CLHarrisScoreFP16Kernel
359 - CLHistogram
360 - CLHistogramKernel
361 - CLHOGOrientationBinningKernel
362 - CLHOGBlockNormalizationKernel
363 - CLHOGDetectorKernel
364 - CLHOGNonMaximaSuppressionKernel
365 - CLHOGDescriptor
366 - CLHOGDetector
367 - CLHOGGradient
368 - CLHOGMultiDetection
369 - CLHOGOrientationBinningKernel
370 - CLHOGBlockNormalizationKernel
371 - CLHOGDetectorKernel
372 - CLIntegralImage
373 - CLIntegralImageKernel
374 - CLLaplacianReconstruct
375 - CLLaplacianPyramid
376 - CLMagnitude
377 - CLMagnitudePhaseKernel
378 - CLMedian3x3
379 - CLMedian3x3Kernel
380 - CLMinMaxLocation
381 - CLMinMaxLocationKernel
382 - CLNonLinearFilter
383 - CLNonLinearFilterKernel
384 - CLNonMaximaSuppression3x3
385 - CLNonMaximaSuppression3x3FP16Kernel
386 - CLNonMaximaSuppression3x3Kernel
387 - CLOpticalFlow
388 - CLPhase
389 - CLRemap
390 - CLRemapKernel
391 - CLScharr3x3
392 - CLScharr3x3Kernel
393 - CLSobel3x3
394 - CLSobel3x3Kernel
395 - CLSobel5x5
396 - CLSobel5x5HorKernel
397 - CLSobel5x5VertKernel
398 - CLSobel7x7
399 - CLSobel7x7HorKernel
400 - CLSobel7x7VertKernel
401 - CLThreshold
402 - CLThresholdKernel
403 - CLWarpAffine
404 - CLWarpAffineKernel
405 - CLWarpPerspective
406 - CLWarpPerspectiveKernel
Sheri Zhangac6499a2021-02-10 15:32:38 +0000407 - 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 +0100408 - NELocallyConnectedLayer
409 - NELocallyConnectedMatrixMultiplyKernel
morgolock0c862652020-11-06 08:59:45 +0000410 - NEAbsoluteDifference
411 - NEAbsoluteDifferenceKernel
412 - NEAccumulate
413 - NEAccumulateKernel
414 - NEAccumulateSquared
415 - NEAccumulateSquaredKernel
416 - NEAccumulateWeighted
417 - NEAccumulateWeightedKernel
418 - NEAccumulateWeightedFP16Kernel
419 - NEBox3x3
420 - NEBox3x3Kernel
421 - NEBox3x3FP16Kernel
422 - NECannyEdge
423 - NEChannelCombine
424 - NEChannelCombineKernel
425 - NEChannelExtract
426 - NEChannelExtractKernel
427 - NEColorConvert
428 - NEColorConvertKernel
429 - NEConvolution3x3
430 - NEConvolutionRectangle
431 - NEConvolutionRectangleKernel
432 - NEConvolutionSquare
433 - NEConvolutionKernel
434 - NEDerivative
435 - NEDerivativeKernel
436 - NEDilate
437 - NEDilateKernel
438 - NEEqualizeHistogram
439 - NEErode
440 - NEErodeKernel
441 - NEFastCorners
442 - NEFastCornersKernel
443 - NEGaussian3x3
444 - NEGaussian3x3Kernel
445 - NEGaussian5x5
446 - NEGaussian5x5HorKernel
447 - NEGaussian5x5VertKernel
448 - NEGaussianPyramid
449 - NEGaussianPyramidHalf
450 - NEGaussianPyramidOrb
451 - NEHarrisCorners
452 - NEHarrisScoreKernel
453 - NEHarrisScoreFP16Kernel
454 - NEHistogram
455 - NEHistogramKernel
456 - NEHOGOrientationBinningKernel
457 - NEHOGBlockNormalizationKernel
458 - NEHOGDetectorKernel
459 - NEHOGNonMaximaSuppressionKernel
460 - NEHOGDescriptor
461 - NEHOGDetector
462 - NEHOGGradient
463 - NEHOGMultiDetection
464 - NEHOGOrientationBinningKernel
465 - NEHOGBlockNormalizationKernel
466 - NEHOGDetectorKernel
467 - NEIntegralImage
468 - NEIntegralImageKernel
469 - NELaplacianReconstruct
470 - NELaplacianPyramid
471 - NEMagnitude
472 - NEMagnitudePhaseKernel
473 - NEMedian3x3
474 - NEMedian3x3Kernel
475 - NEMinMaxLocation
476 - NEMinMaxLocationKernel
477 - NENonLinearFilter
478 - NENonLinearFilterKernel
479 - NENonMaximaSuppression3x3
480 - NENonMaximaSuppression3x3FP16Kernel
481 - NENonMaximaSuppression3x3Kernel
482 - NEOpticalFlow
483 - NEPhase
484 - NERemap
485 - NERemapKernel
486 - NEScharr3x3
487 - NEScharr3x3Kernel
488 - NESobel3x3
489 - NESobel3x3Kernel
490 - NESobel5x5
491 - NESobel5x5HorKernel
492 - NESobel5x5VertKernel
493 - NESobel7x7
494 - NESobel7x7HorKernel
495 - NESobel7x7VertKernel
496 - NEThreshold
497 - NEThresholdKernel
498 - NEWarpAffine
499 - NEWarpAffineKernel
500 - NEWarpPerspective
501 - NEWarpPerspectiveKernel
morgolockd6ee9ed2020-11-19 10:07:14 +0000502 - Deprecated GLES kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together):
503 - GCAbsoluteDifference
504 - GCActivationLayer
505 - GCArithmeticAddition
506 - GCBatchNormalizationLayer
507 - GCConcatenateLayer
508 - GCConvolutionLayer
509 - GCDepthwiseConvolutionLayer
510 - GCDirectConvolutionLayer
511 - GCDropoutLayer
512 - GCFillBorder
513 - GCFullyConnectedLayer
514 - GCGEMM
515 - GCGEMMInterleave4x4
516 - GCGEMMTranspose1xW
517 - GCNormalizationLayer
518 - GCNormalizePlanarYUVLayer
519 - GCPixelWiseMultiplication
520 - GCPoolingLayer
521 - GCScale
522 - GCSoftmaxLayer
523 - GCTensorShift
524 - GCTranspose
525
SiCong Li96209c72020-08-21 12:28:30 +0100526
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100527v20.08 Public major release
528 - Various bug fixes.
529 - Various optimisations.
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100530 - Added new data type QASYMM8_SIGNED support for:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100531 - @ref CLArgMinMaxLayer
532 - @ref CLArgMinMaxLayerKernel
533 - Added new data type U8 support for:
534 - @ref NECropKernel
Sheri Zhang7e20e292021-02-02 11:49:34 +0000535 - CLCropKernel
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100536 - Added aligh_corner support for nearest neighbor interpolation in:
Manuel Bottini10b38262021-02-19 18:16:44 +0000537 - NEScaleKernel
Manuel Bottini3b131ab2021-02-19 18:16:44 +0000538 - CLScaleKernel
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100539 - New OpenCL kernels / functions:
540 - @ref CLMaxUnpoolingLayerKernel
Sheri Zhangac6499a2021-02-10 15:32:38 +0000541 - New Neon kernels / functions:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100542 - @ref NEMaxUnpoolingLayerKernel
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100543 - New graph example:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100544 - graph_yolov3_output_detector
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100545 - GEMMTuner improvements:
546 - Added fp16 support
547 - Output json files for easier integration
548 - Enabled tuning for export_to_cl_image_rhs option for RHS tensors
549 - More robust script for running benchmarks
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100550 - Removed padding from:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100551 - @ref NEPixelWiseMultiplicationKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000552 - NEHeightConcatenateLayerKernel
Michalis Spyrou27e67f02021-02-16 11:34:39 +0000553 - NEThresholdKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000554 - NEBatchConcatenateLayerKernel
Teresa Charlind1dc09c2021-03-04 15:24:45 +0000555 - NETransposeKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100556 - @ref NEBatchNormalizationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000557 - NEArithmeticSubtractionKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100558 - @ref NEBoundingBoxTransformKernel
Michalis Spyrou373b4072021-01-20 16:41:12 +0000559 - NELogits1DMaxKernel
560 - NELogits1DSoftmaxKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100561 - @ref NEROIPoolingLayerKernel
562 - @ref NEROIAlignLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +0000563 - NEYOLOLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000564 - NEUpsampleLayerKernel
Georgios Pinitas70eb53b2021-01-06 19:42:21 +0000565 - NEFloorKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000566 - NEWidthConcatenateLayerKernel
567 - NEDepthConcatenateLayerKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100568 - @ref NENormalizationLayerKernel
569 - @ref NEL2NormalizeLayerKernel
570 - @ref NEFillArrayKernel
571 - @ref NEDepthConvertLayerKernel
572 - @ref NERangeKernel
573 - @ref NEPriorBoxLayer
Sheri Zhanged367132020-10-08 15:46:16 +0100574 - Removed OpenCL kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100575 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
576 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Sheri Zhangac6499a2021-02-10 15:32:38 +0000577 - Removed Neon kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100578 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
579 - NEGEMMMatrixAccumulateBiasesKernel
SiCong Lid004a7a2020-05-28 15:26:41 +0100580 - Deprecated functions / interfaces:
Michalis Spyrou473cb012021-02-23 11:48:12 +0000581 - Non-descriptor based interfaces for NEThreshold, CLThreshold
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +0000582 - Non-descriptor based interfaces for @ref NEScale, @ref CLScale and GCScale
583 - In @ref NESoftmaxLayer, @ref NELogSoftmaxLayer, @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and GCSoftmaxLayer :
584 The default "axis" value for @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and GCSoftmaxLayer is changed from 1 to 0.
morgolock9c7fed82020-08-05 12:30:56 +0100585 Only axis 0 is supported.
586 The default "axis" value for @ref NESoftmaxLayer, @ref NELogSoftmaxLayer is changed from 1 to 0.
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100587 Only axis 0 is supported.
Sang-Hoon Parka0205b92020-07-07 09:36:09 +0100588 - The support for quantized data types has been removed from @ref CLLogSoftmaxLayer due to implementation complexity.
Gian Marco Iodice547b2e72020-08-12 10:25:29 +0100589 - 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 +0100590 - This change allows to use @ref CLGEMMConvolutionLayer without extra padding for the input and output.
591 - Only the weights/bias of @ref CLGEMMConvolutionLayer could require padding for the computation.
592 - 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 +0100593 - 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 +0100594 - This support allows to export the OpenCL buffer used for the reshaped RHS matrix to the OpenCL image object.
595 - The padding requirement for the OpenCL image object is considered into the @ref CLGEMMReshapeRHSMatrixKernel.
596 - The reshaped RHS matrix stores the weights when GEMM is used to accelerate @ref CLGEMMConvolutionLayer.
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100597
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000598v20.05 Public major release
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000599 - Various bug fixes.
600 - Various optimisations.
Michele Di Giorgio36a551f2020-04-23 11:55:29 +0100601 - Updated recommended NDK version to r18b.
602 - Updated recommended gcc version to Linaro 6.3.1.
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000603 - Added Bfloat16 type support
604 - Added Bfloat16 support in:
605 - @ref NEWeightsReshapeKernel
606 - @ref NEConvolutionLayerReshapeWeights
607 - @ref NEIm2ColKernel
Georgios Pinitasf7c5a412020-12-03 14:38:33 +0000608 - NEIm2Col
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000609 - @ref NEDepthConvertLayerKernel
610 - @ref NEDepthConvertLayer
611 - @ref NEGEMMConvolutionLayer
Georgios Pinitasec2256b2020-12-03 18:51:58 +0000612 - NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000613 - Added new data type QASYMM8_SIGNED support for:
614 - @ref CLDirectConvolutionLayer
615 - @ref CLDeconvolutionLayer
616 - @ref CLDirectDeconvolutionLayer
617 - @ref CLGEMMDeconvolutionLayer
618 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
619 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
620 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
621 - @ref CLReductionOperation
622 - @ref CLReduceMean
Sheri Zhang359c48e2020-04-30 22:53:39 +0100623 - @ref NEScale
Manuel Bottini10b38262021-02-19 18:16:44 +0000624 - NEScaleKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +0000625 - NEUpsampleLayer
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000626 - @ref NECast
627 - @ref NEReductionOperation
628 - @ref NEReduceMean
629 - @ref NEArgMinMaxLayer
630 - @ref NEDeconvolutionLayer
631 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
632 - @ref CPPBoxWithNonMaximaSuppressionLimit
633 - @ref CPPDetectionPostProcessLayer
634 - @ref CPPPermuteKernel
635 - @ref CPPPermute
636 - @ref CPPTopKVKernel
637 - @ref CPPTopKV
Sheri Zhang359c48e2020-04-30 22:53:39 +0100638 - @ref CPPUpsample
639 - @ref CPPUpsampleKernel
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100640 - New OpenCL kernels / functions:
641 - @ref CLQLSTMLayer
642 - @ref CLQLSTMLayerNormalizationKernel
Sheri Zhangac6499a2021-02-10 15:32:38 +0000643 - New Neon kernels / functions:
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100644 - @ref NEQLSTMLayer
645 - @ref NEQLSTMLayerNormalizationKernel
646 - Added HARD_SWISH support in:
Georgios Pinitasf47f7182021-01-15 09:29:50 +0000647 - CLActivationLayerKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000648 - NEActivationLayerKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000649 - Deprecated OpenCL kernels / functions:
650 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
651 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Sheri Zhangac6499a2021-02-10 15:32:38 +0000652 - Deprecated Neon kernels / functions:
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000653 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
654 - Removed CPP kernels / functions:
655 - CPPFlipWeightsKernel
Manuel Bottini387259a2020-05-21 17:14:36 +0100656 - Removed PoolingLayerInfo constructors without Data Layout.
657 - Removed CLDepthwiseConvolutionLayer3x3
658 - Removed NEDepthwiseConvolutionLayerOptimized
Sheri Zhangac6499a2021-02-10 15:32:38 +0000659 - Added support for Winograd 3x3,4x4 on Neon FP16:
Manuel Bottini075253a2020-05-22 12:57:18 +0100660 - @ref NEWinogradConvolutionLayer
661 - @ref NEWinogradLayerTransformInputKernel
662 - @ref NEWinogradLayerTransformOutputKernel
663 - @ref NEWinogradLayerTransformWeightsKernel
664 - Added CLCompileContext
Sheri Zhangac6499a2021-02-10 15:32:38 +0000665 - Added Neon GEMM kernel with 2D window support
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000666
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000667v20.02.1 Maintenance release
668 - Added Android-NN build script.
669
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000670v20.02 Public major release
671 - Various bug fixes.
672 - Various optimisations.
673 - Added new data type QASYMM8_SIGNED support for:
674 - @ref CLDepthwiseConvolutionLayer
Manuel Bottini387259a2020-05-21 17:14:36 +0100675 - CLDepthwiseConvolutionLayer3x3
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000676 - @ref CLGEMMConvolutionLayer
677 - @ref CLGEMMLowpMatrixMultiplyCore
678 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
679 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
680 - @ref NEActivationLayer
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000681 - NEComparisonOperationKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000682 - @ref NEConvolutionLayer
683 - @ref NEDepthwiseConvolutionLayer
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100684 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000685 - @ref NEDirectConvolutionLayerOutputStageKernel
686 - @ref NEElementwiseComparison
687 - @ref NEElementwiseMax
688 - @ref NEElementwiseMin
689 - @ref NEElementwiseSquaredDiff
690 - @ref NEFullyConnectedLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +0100691 - NEGEMMMatrixVectorMultiplyKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000692 - @ref NEPixelWiseMultiplication
693 - @ref NEPoolingLayer
694 - @ref NEPReluLayer
695 - Added support for QSYMM8_PER_CHANNEL in:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100696 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000697 - Added support for split sizes in:
698 - @ref CLSplit
699 - @ref NESplit
700 - New OpenCL kernels / functions:
701 - @ref CLFill
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100702 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
Sheri Zhangac6499a2021-02-10 15:32:38 +0000703 - New Neon kernels / functions:
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000704 - @ref NEFill
705 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
Sheri Zhangac6499a2021-02-10 15:32:38 +0000706 - Deprecated Neon functions / interfaces:
Manuel Bottini387259a2020-05-21 17:14:36 +0100707 - CLDepthwiseConvolutionLayer3x3
708 - NEDepthwiseConvolutionLayerOptimized
709 - PoolingLayerInfo constructors without Data Layout.
Sheri Zhangac6499a2021-02-10 15:32:38 +0000710 - Added support for quantization with multiplier greater than 1 on Neon and CL.
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000711 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
712 - Added the ability to build bootcode for bare metal.
713 - Added support for generating synthetic QASYMM8 graphs.
714 - Added support for F16 datatype in VGG16.
715 - Removed pre-built binaries for GLES.
716
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000717v19.11.1 Public maintenance release
718 - Fix offset calculation in NEReductionOperationKernel.
719 - Fix data layout in NEScaleKernel for nhwc.
720 - Retain configuration step data layout to avoid side-effects.
721 - Perform sqrt in double domain for L2 pooling.
722 - Fix output shape calculation for Reduce Mean
723 - Restrict cases where optimized NEPadLayer runs.
724
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100725v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000726 - Various bug fixes.
727 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000728 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000729 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100730 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
731 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000732 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100733 - CLDepthwiseVectorToTensorKernel
734 - CLDirectConvolutionLayerOutputStageKernel
Sheri Zhangac6499a2021-02-10 15:32:38 +0000735 - Deprecated Neon kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100736 - NEDepthwiseWeightsReshapeKernel
737 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000738 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100739 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100740 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000741 - New OpenCL kernels / functions:
742 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
743 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
744 OpenCL kernels / functions)
745 - @ref CLLogSoftmaxLayer
Sheri Zhangac6499a2021-02-10 15:32:38 +0000746 - New Neon kernels / functions:
SiCong Lica1f98c2019-11-28 11:06:11 +0000747 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
Georgios Pinitas8c3c0e72020-12-03 20:11:53 +0000748 - @ref NEComputeAllAnchorsKernel / NEComputeAllAnchors
SiCong Lica1f98c2019-11-28 11:06:11 +0000749 - @ref NEDetectionPostProcessLayer
750 - @ref NEGenerateProposalsLayer
751 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
752 - @ref NELogSoftmaxLayer
753 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
754 - Added QASYMM8 support for:
755 - @ref CLGenerateProposalsLayer
756 - @ref CLROIAlignLayer
757 - @ref CPPBoxWithNonMaximaSuppressionLimit
758 - Added QASYMM16 support for:
759 - @ref CLBoundingBoxTransform
760 - Added FP16 support for:
761 - @ref CLGEMMMatrixMultiplyReshapedKernel
762 - Added new data type QASYMM8_PER_CHANNEL support for:
Manuel Bottini9e73c932021-03-02 17:40:42 +0000763 - CLDequantizationLayer
SiCong Lica1f98c2019-11-28 11:06:11 +0000764 - @ref NEDequantizationLayer
765 - Added new data type QSYMM8_PER_CHANNEL support for:
766 - @ref CLConvolutionLayer
767 - @ref NEConvolutionLayer
768 - @ref CLDepthwiseConvolutionLayer
769 - @ref NEDepthwiseConvolutionLayer
770 - Added FP16 mixed-precision support for:
771 - @ref CLGEMMMatrixMultiplyReshapedKernel
Michele Di Giorgioe1314662021-02-01 17:09:32 +0000772 - CLPoolingLayerKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000773 - Added FP32 and FP16 ELU activation for:
774 - @ref CLActivationLayer
775 - @ref NEActivationLayer
776 - Added asymmetric padding support for:
777 - @ref CLDirectDeconvolutionLayer
778 - @ref CLGEMMDeconvolutionLayer
779 - @ref NEDeconvolutionLayer
780 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000781 - Replaced the calls to NECopyKernel and NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
782 - Replaced the calls to CLCopyKernel and CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
SiCong Lica1f98c2019-11-28 11:06:11 +0000783 - Improved performance for CL Inception V3 - FP16.
784 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
Sheri Zhangac6499a2021-02-10 15:32:38 +0000785 - Improved Neon performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
786 - Improved Neon performance for MobileNet-SSD by improving the output detection performance.
SiCong Lica1f98c2019-11-28 11:06:11 +0000787 - Optimized @ref CLPadLayer.
788 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
789 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100790
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000791v19.08.1 Public maintenance release
792 - Fix offset calculation in NEReductionOperationKernel.
793 - Fix data layout in NEScaleKernel for nhwc.
794 - Retain configuration step data layout to avoid side-effects.
795 - Perform sqrt in double domain for L2 pooling.
796 - Fix output shape calculation for Reduce Mean
797 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
798
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100799v19.08 Public major release
800 - Various bug fixes.
801 - Various optimisations.
Sheri Zhangac6499a2021-02-10 15:32:38 +0000802 - Deprecated Neon functions
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100803 - NEDepthConcatenateLayer
804 - NEWidthConcatenateLayer
805 - Deprecated OpenCL kernels / functions
806 - CLDepthConcatenateLayer
807 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
808 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
809 - CLWidthConcatenateLayer
Sheri Zhangac6499a2021-02-10 15:32:38 +0000810 - New Neon kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100811 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100812 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100813 - @ref NEElementwisePower
814 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100815 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100816 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100817 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100818 - @ref NESinLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000819 - NEBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100820 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
821 - @ref NEDepthwiseConvolutionLayerNativeKernel
822 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
823 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
824 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
825 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100826 - @ref CLAbsLayer
827 - @ref CLElementwisePower
828 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100829 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100830 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100831 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100832 - @ref CLSinLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000833 - CLBatchConcatenateLayerKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100834 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
835 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100836 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100837 - @ref CLGEMMMatrixMultiplyNativeKernel
Michalis Spyrou473cb012021-02-23 11:48:12 +0000838 - CLMeanStdDevNormalizationKernel /CLMeanStdDevNormalizationLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100839 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
840 - New examples:
841 - neon_opticalflow
842 - cl_cache
843 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100844 - Added support for FP16 in @ref NEDeconvolutionLayer
845 - Added support for FP16 in @ref CLDeconvolutionLayer
846 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100847 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
848 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
Sheri Zhangac6499a2021-02-10 15:32:38 +0000849 - Re-factored the depthwise convolution layer kernel on Neon for generic cases
850 - Added an optimized depthwise convolution layer kernel for 5x5 filters (Neon only)
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100851 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
852 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini387259a2020-05-21 17:14:36 +0100853 - The CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
854 - The NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100855 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
856 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Sheri Zhangac6499a2021-02-10 15:32:38 +0000857 - 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 +0100858
Michalis Spyroua9c44722019-04-05 17:18:36 +0100859v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100860 - Various bug fixes.
861 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100862 - New Neon kernels / functions:
863 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100864 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100865 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100866 - @ref NEDepthwiseConvolutionAssemblyDispatch
867 - @ref NEFFTDigitReverseKernel
868 - @ref NEFFTRadixStageKernel
869 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100870 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +0000871 - NEHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100872 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100873 - @ref NEFFT1D
874 - @ref NEFFT2D
875 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100876 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100877 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Sheri Zhang7e20e292021-02-02 11:49:34 +0000878 - CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100879 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100880 - @ref CLFFTDigitReverseKernel
881 - @ref CLFFTRadixStageKernel
882 - @ref CLFFTScaleKernel
883 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
884 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +0000885 - CLHeightConcatenateLayerKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100886 - @ref CLDirectDeconvolutionLayer
887 - @ref CLFFT1D
888 - @ref CLFFT2D
889 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100890 - @ref CLGEMMDeconvolutionLayer
891 - New OpenGLES kernels / functions:
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +0000892 - GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100893 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100894 - GCDepthConcatenateLayer
895 - NEWidthConcatenateLayer
896 - NEDepthConcatenateLayer
897 - CLWidthConcatenateLayer
898 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100899 - CLGEMMInterleave4x4
900 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100901 - Support different quantization info in CLConcatLayer.
902 - Add checks on different input/output quantization info were not supported.
903 - Tensors have different quantization information.
904 - Add FP16 support checks.
905 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
906 - New graph examples:
907 - graph_convolution
908 - graph_fully_connected
909 - graph_depthwise_convolution
910 - Deepspeech v0.4.1
911 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
912 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
913 - Add support for QASYMM8 NEDeconvolution.
Sheri Zhangac6499a2021-02-10 15:32:38 +0000914 - Add support for DequantizationLayer for Neon/CL.
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100915 - Add support for dilation in CLDepthwiseConvolution.
916 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
917 - Optimize CLDeconvolution.
918 - Add StackLayer to the graph API.
919 - Add support for "reflect" padding mode in NEPad.
920 - Winograd 7x7 NHWC on OpenCL.
921 - Rework CL ML layers to run exclusively on CL.
922 - Support different quantization info in PoolingLayer.
923 - Implement and test import memory interfaces.
924 - Added new tests and removed old ones.
925 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100926
giuros01a69a88b2019-01-31 16:29:19 +0000927v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000928 - Various bug fixes.
929 - Various optimisations.
930 - New Neon kernels / functions:
931 - @ref NETileKernel / @ref NETile
932 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000933 - NEElementwiseOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000934 - @ref NEElementwiseMax
935 - @ref NEElementwiseMin
936 - @ref NEElementwiseSquaredDiff
937 - @ref NESelectKernel / @ref NESelect
938 - @ref NESplit
939 - @ref NESlice
940 - @ref NEUnstack
941 - @ref NEStridedSliceKernel / @ref NEStridedSlice
Sang-Hoon Park7249f152021-01-22 11:55:03 +0000942 - NEElementwiseUnaryKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000943 - @ref NERsqrtLayer
944 - @ref NEExpLayer
945 - @ref NEReverseKernel / @ref NEReverse
946 - @ref NEArgMinMaxLayer
947 - @ref NEStackLayerKernel / @ref NEStackLayer
948 - @ref NERangeKernel / @ref NERange
949 - @ref NEPadLayer
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +0000950 - NEMemsetKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000951 - @ref NEGatherKernel / @ref NEGather
952 - @ref NEElementwiseComparison
953 - @ref NEElementwiseComparisonStatic
Sang-Hoon Park63001ac2021-01-18 14:20:27 +0000954 - NEComparisonOperationKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000955 - @ref NEElementwiseDivision
956 - New OpenCL kernels / functions:
957 - @ref CLSelectKernel / @ref CLSelect
958 - @ref CLTileKernel / @ref CLTile
959 - @ref CLComparisonKernel / @ref CLComparison
960 - @ref CLArgMinMaxLayer
961 - @ref CLElementwiseMax
962 - @ref CLElementwiseMin
963 - @ref CLElementwiseSquaredDiff
964 - @ref CLStackLayerKernel / @ref CLStackLayer
965 - @ref CLReverse / @ref CLReverseKernel
966 - @ref CLRsqrtLayer
967 - @ref CLExpLayer
Michele Di Giorgioc9c89052021-01-26 10:20:17 +0000968 - CLElementWiseUnaryLayerKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000969 - @ref CLGEMMReshapeLHSMatrixKernel
970 - @ref CLGEMMReshapeRHSMatrixKernel
971 - @ref CLGEMMMatrixMultiplyReshapedKernel
972 - @ref CLRangeKernel / @ref CLRange
973 - @ref CLUnstack
974 - @ref CLGatherKernel / @ref CLGather
975 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
976 - New CPP kernels / functions:
977 - @ref CPPDetectionOutputLayer
978 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000979 - Added new examples:
980 - graph_ssd_mobilenet.cpp
981 - graph_mobilenet_v2.cpp
982 - graph_resnet12.cpp
983 - graph_srcnn955.cpp
984 - graph_vgg_vdsr.cpp
985 - graph_inception_resnet_v1.cpp
986 - Add 4D tensors support to
987 - @ref NESoftmaxLayer
988 - Fused activation in @ref CLWinogradConvolutionLayer
989 - Extented @ref NEPermute to support more cases
Sheri Zhangac6499a2021-02-10 15:32:38 +0000990 - Added Neon/SVE GEMM Hybrid kernels
Isabella Gottardi62538972019-02-12 19:52:44 +0000991 - Added u8 and s8 hybrid assembly kernels
992 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
993 - Improved @ref CLTuner
994 - Fused the bias addition within @ref CLGEMM
995 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
996 - Added NHWC data layout support to:
997 - @ref NEScale for F16
998 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
999 - @ref NEL2NormalizeLayer for FP32/FP16
1000 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
1001 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +00001002 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +00001003 - Added QASYMM8 support to the following kernels:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001004 - NEArithmeticAdditionKernel
Isabella Gottardi62538972019-02-12 19:52:44 +00001005 - @ref NEScale
1006 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +00001007 - Deprecated functions/interfaces
1008 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
1009
Isabella Gottardi8773d7c2018-11-20 09:56:46 +00001010v18.11 Public major release
1011 - Various bug fixes.
1012 - Various optimisations.
1013 - New Neon kernels / functions:
1014 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
1015 - @ref NEReduceMean
1016 - @ref NEReorgLayer / @ref NEReorgLayerKernel
1017 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +00001018 - NEUpsampleLayer / NEUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +00001019 - NEYOLOLayer / NEYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +00001020 - New OpenCL kernels / functions:
1021 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
1022 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +00001023 - @ref CLComputeAllAnchorsKernel
1024 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +00001025 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
1026 - @ref CLReorgLayer / @ref CLReorgLayerKernel
1027 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
1028 - @ref CLPadLayer
1029 - @ref CLReduceMean
1030 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
1031 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
1032 - @ref CLSlice
1033 - @ref CLSplit
1034 - @ref CLStridedSlice / @ref CLStridedSliceKernel
Georgios Pinitasc53266e2020-12-09 03:11:53 +00001035 - CLUpsampleLayer / CLUpsampleLayerKernel
Georgios Pinitas0b1c2db2020-12-04 15:51:34 +00001036 - CLYOLOLayer / CLYOLOLayerKernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +00001037 - New CPP kernels / functions:
1038 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
1039 - Added the validate method in:
1040 - @ref NEDepthConvertLayer
1041 - @ref NEFloor / @ref CLFloor
1042 - @ref NEGEMMMatrixAdditionKernel
1043 - @ref NEReshapeLayer / @ref CLReshapeLayer
1044 - @ref CLScale
1045 - Added new examples:
1046 - graph_shufflenet.cpp
1047 - graph_yolov3.cpp
1048 - Added documentation for add a new function or kernel.
1049 - Improved doxygen documentation adding a list of the existing functions.
1050 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +01001051 - CLWidthConcatenateLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +00001052 - CLFlattenLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +00001053 - @ref CLSoftmaxLayer
1054 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
1055 - Add SVE support
1056 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
1057 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
1058 - Added NHWC data layout support to:
1059 - @ref CLChannelShuffleLayer
1060 - @ref CLDeconvolutionLayer
1061 - @ref CLL2NormalizeLayer
1062 - Added QASYMM8 support to the following kernels:
Manuel Bottini3b131ab2021-02-19 18:16:44 +00001063 - CLScaleKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001064 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +00001065 - @ref CLPixelWiseMultiplicationKernel
1066 - Added FP16 support to the following kernels:
1067 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001068 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +00001069 - @ref CLNormalizePlanarYUVLayerKernel
1070 - @ref CLWinogradConvolutionLayer (5x5 kernel)
1071 - More tests added to both validation and benchmarking suites.
1072
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001073v18.08 Public major release
1074 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +01001075 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001076 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +01001077 - Removed support for QS8/QS16 data types.
1078 - Added support for grouped convolution in @ref CLConvolutionLayer.
1079 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +01001080 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +01001081 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
1082 - @ref CLDepthwiseConvolutionLayer
1083 - @ref CLDirectConvolutionLayer
1084 - @ref CLConvolutionLayer
1085 - @ref CLScale
1086 - @ref CLIm2ColKernel
1087 - New Neon kernels / functions:
1088 - @ref NERNNLayer
1089 - New OpenCL kernels / functions:
1090 - @ref CLArithmeticDivision
1091 - Introduced prepare() stage support in the graph API for GLES.
1092 - Added support for memory reusage when trying to allocate smaller CLTensors.
1093 - Enabled NHWC execution on graph examples.
1094 - Added JPEG accessor for validation purposes.
1095 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001096
1097v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001098 - Various bug fixes.
1099 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001100 - Major redesign in the interface for the neon kernels implemented in assembly.
1101 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
1102 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
1103 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Sheri Zhangac6499a2021-02-10 15:32:38 +00001104 - Moved neon assembly kernels to the folder src/core/Neon/kernels/arm_gemm.
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001105 - Improved doxygen documentation.
1106 - Improved memory management for layer's transitions.
1107 - Added support for NHWC data layout in tensors.
1108 - Added NHWC data layout support to:
1109 - @ref NEGEMMConvolutionLayer
1110 - @ref NEDirectConvolutionLayer
1111 - @ref NEPoolingLayer / @ref CLPoolingLayer
1112 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
1113 - @ref NEDepthwiseConvolutionLayer
1114 - @ref NEScale
Georgios Pinitasf7c5a412020-12-03 14:38:33 +00001115 - NEIm2Col
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001116 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
1117 - New OpenCL kernels / functions:
1118 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
1119 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
Sheri Zhang7e20e292021-02-02 11:49:34 +00001120 - @ref CLCopy / CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001121 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001122 - @ref CLRNNLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001123 - CLWidthConcatenateLayer / CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001124 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
1125 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
1126 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001127 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
1128 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
1129 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
1130 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
1131 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
1132 - Port mobilenet example to NHWC data layout.
1133 - Enabled Winograd method in @ref CLConvolutionLayer.
1134 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
Sheri Zhangac6499a2021-02-10 15:32:38 +00001135 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/Neon/kernels/arm_gemm.
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001136 - Added memory manager support in GLES functions.
1137 - Major refactoring of the graph API.
1138 - Added GLES backend in the graph API.
1139 - Added support for the memory manager in the graph API.
1140 - Enabled Winograd Convolution method in the graph API.
1141 - Added support for grouped convolutions in the graph API.
Manuel Bottini10b38262021-02-19 18:16:44 +00001142 - Replaced NEDeconvolutionLayerUpsampleKernel with NEScaleKernel in @ref NEDeconvolutionLayer.
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001143 - Added fast maths flag in @ref CLConvolutionLayer.
1144 - Added new tests and benchmarks in validation and benchmark frameworks
Sheri Zhangac6499a2021-02-10 15:32:38 +00001145 - Merge Activation layer with Convolution Layer (Neon. CL, GLES)
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001146 - Added support to OpenCL 2.0 SVM
1147 - Added support to import memory in OpenCL tensors.
1148 - Added the prepare() method to perform any one off pre-processing before running the function.
1149 - Added new examples:
1150 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001151 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001152 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001153
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001154v18.03 Public maintenance release
1155 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +00001156 - Fixed bug in @ref NEActivationLayer
1157 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001158 - Updated recommended NDK version to r16b (And fixed warnings).
1159 - Fixed bug in validation code.
1160 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001161 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001162
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001163v18.02 Public major release
Sheri Zhangac6499a2021-02-10 15:32:38 +00001164 - Various Neon / OpenCL / GLES optimisations.
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001165 - Various bug fixes.
1166 - Changed default number of threads on big LITTLE systems.
1167 - Refactored examples and added:
1168 - graph_mobilenet_qassym8
1169 - graph_resnet
1170 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +00001171 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
1172 - 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 +00001173 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001174 - @ref CLActivationLayer
1175 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001176 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001177 - @ref CLActivationLayer
1178 - @ref CLDepthwiseConvolutionLayer
1179 - @ref NEDepthwiseConvolutionLayer
1180 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001181 - Added FP16 support to:
Manuel Bottini387259a2020-05-21 17:14:36 +01001182 - CLDepthwiseConvolutionLayer3x3
Anthony Barbier3762e742018-03-02 11:49:33 +00001183 - @ref CLDepthwiseConvolutionLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001184 - Added broadcasting support to NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
Anthony Barbier3762e742018-03-02 11:49:33 +00001185 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
1186 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001187 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +01001188 - CLDirectConvolutionLayerOutputStageKernel
Sheri Zhangac6499a2021-02-10 15:32:38 +00001189 - New Neon kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001190 - Added name() method to all kernels.
1191 - Added support for Winograd 5x5.
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001192 - NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001193 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
1194 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
1195 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +01001196 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001197 - New GLES kernels / functions:
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00001198 - GCTensorShiftKernel / GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +00001199
Anthony Barbier64c95a02018-01-22 18:48:55 +00001200v18.01 Public maintenance release
1201 - Various bug fixes
1202 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +00001203 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
Sheri Zhang7e20e292021-02-02 11:49:34 +00001204 - Added CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +00001205 - Added method to clean the programs cache in the CL Kernel library.
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00001206 - Added GCArithmeticAdditionKernel / GCArithmeticAddition
1207 - Added GCDepthwiseConvolutionLayer3x3Kernel / GCDepthwiseConvolutionLayer3x3
1208 - Added GCNormalizePlanarYUVLayerKernel / GCNormalizePlanarYUVLayer
1209 - Added GCScaleKernel / GCScale
1210 - Added GCWeightsReshapeKernel / GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +00001211 - Added FP16 support to the following GLES compute kernels:
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00001212 - GCCol2ImKernel
1213 - GCGEMMInterleave4x4Kernel
1214 - GCGEMMTranspose1xWKernel
1215 - GCIm2ColKernel
Sheri Zhangac6499a2021-02-10 15:32:38 +00001216 - Refactored Neon Winograd (NEWinogradLayerKernel)
Anthony Barbier3762e742018-03-02 11:49:33 +00001217 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Sheri Zhangac6499a2021-02-10 15:32:38 +00001218 - Added QASYMM8 support to the following Neon kernels:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001219 - NEDepthwiseConvolutionLayer3x3Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001220 - @ref NEFillBorderKernel
Michele Di Giorgio19289042021-02-03 16:05:00 +00001221 - NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001222 - Added new examples:
1223 - graph_cl_mobilenet_qasymm8.cpp
1224 - graph_inception_v3.cpp
1225 - gc_dc.cpp
1226 - More tests added to both validation and benchmarking suites.
1227
Gian Marcoff850932017-12-11 12:37:17 +00001228v17.12 Public major release
1229 - Most machine learning functions on OpenCL support the new data type QASYMM8
1230 - Introduced logging interface
1231 - Introduced opencl timer
1232 - Reworked GEMMLowp interface
Sheri Zhangac6499a2021-02-10 15:32:38 +00001233 - Added new Neon assembly kernels for GEMMLowp, SGEMM and HGEMM
Gian Marcoff850932017-12-11 12:37:17 +00001234 - Added validation method for most Machine Learning kernels / functions
1235 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
1236 - Added sgemm example for OpenCL
1237 - Added absolute difference example for GLES compute
1238 - Added new tests and benchmarks in validation and benchmark frameworks
1239 - Added new kernels / functions for GLES compute
1240
1241 - New OpenGL ES kernels / functions
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00001242 - GCAbsoluteDifferenceKernel / GCAbsoluteDifference
1243 - GCActivationLayerKernel / GCActivationLayer
1244 - GCBatchNormalizationLayerKernel / GCBatchNormalizationLayer
1245 - GCCol2ImKernel
1246 - GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
1247 - GCDirectConvolutionLayerKernel / GCDirectConvolutionLayer
1248 - GCDropoutLayerKernel / GCDropoutLayer
1249 - GCFillBorderKernel / GCFillBorder
1250 - GCGEMMInterleave4x4Kernel / GCGEMMInterleave4x4
1251 - GCGEMMMatrixAccumulateBiasesKernel / GCGEMMMatrixAdditionKernel / GCGEMMMatrixMultiplyKernel / GCGEMM
1252 - GCGEMMTranspose1xWKernel / GCGEMMTranspose1xW
1253 - GCIm2ColKernel
1254 - GCNormalizationLayerKernel / GCNormalizationLayer
1255 - GCPixelWiseMultiplicationKernel / GCPixelWiseMultiplication
1256 - GCPoolingLayerKernel / GCPoolingLayer
1257 - GCLogits1DMaxKernel / GCLogits1DShiftExpSumKernel / GCLogits1DNormKernel / GCSoftmaxLayer
1258 - GCTransposeKernel / GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +00001259
Sheri Zhangac6499a2021-02-10 15:32:38 +00001260 - New Neon kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +00001261 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
1262 - arm_compute::NEHGEMMAArch64FP16Kernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001263 - NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001264 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
1265 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001266 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +00001267
1268 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001269 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
Michele Di Giorgioba14c922020-10-12 13:27:57 +01001270 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +00001271
Sheri Zhangac6499a2021-02-10 15:32:38 +00001272 - New graph nodes for Neon and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001273 - graph::BranchLayer
1274 - graph::DepthConvertLayer
1275 - graph::DepthwiseConvolutionLayer
1276 - graph::DequantizationLayer
1277 - graph::FlattenLayer
1278 - graph::QuantizationLayer
1279 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +00001280
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001281v17.10 Public maintenance release
1282 - Bug fixes:
1283 - Check the maximum local workgroup size supported by OpenCL devices
1284 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +00001285 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001286 - Added a few new Graph nodes, support for branches and grouping.
1287 - Automatically enable cl_printf in debug builds
1288 - Fixed bare metal builds for armv7a
1289 - Added AlexNet and cartoon effect examples
1290 - 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)
1291
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001292v17.09 Public major release
1293 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +00001294 - 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 +01001295 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
Sheri Zhangac6499a2021-02-10 15:32:38 +00001296 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both Neon and OpenCL.
1297 - New Neon kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +00001298 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Manuel Bottini00f4dfc2021-03-10 09:55:14 +00001299 - NEDequantizationLayerKernel / @ref NEDequantizationLayer
Georgios Pinitas70eb53b2021-01-06 19:42:21 +00001300 - NEFloorKernel / @ref NEFloor
Anthony Barbier3762e742018-03-02 11:49:33 +00001301 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
Manuel Bottini0ded4c42021-03-09 14:15:27 +00001302 - NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001303 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
1304 - @ref NEReductionOperationKernel / @ref NEReductionOperation
Georgios Pinitas0f7ef8a2021-01-10 04:23:52 +00001305 - NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001306
1307 - New OpenCL kernels / functions:
Manuel Bottini387259a2020-05-21 17:14:36 +01001308 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Manuel Bottini9e73c932021-03-02 17:40:42 +00001309 - CLDequantizationLayerKernel / CLDequantizationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001310 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
Georgios Pinitase2696b12020-12-03 20:37:43 +00001311 - CLFlattenLayer
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001312 - CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001313 - CLGEMMTranspose1xW
Michele Di Giorgioee82d342021-01-05 16:14:28 +00001314 - CLGEMMMatrixVectorMultiplyKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001315 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
Manuel Bottini5a1bf622021-03-01 17:39:36 +00001316 - CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001317 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
1318 - @ref CLReductionOperationKernel / @ref CLReductionOperation
Sheri Zhang7e20e292021-02-02 11:49:34 +00001319 - CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001320
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001321v17.06 Public major release
1322 - Various bug fixes
Sheri Zhangac6499a2021-02-10 15:32:38 +00001323 - Added support for fixed point 8 bit (QS8) to the various Neon machine learning kernels.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001324 - Added unit tests and benchmarks (AlexNet, LeNet)
1325 - Added support for sub tensors.
1326 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Sheri Zhangac6499a2021-02-10 15:32:38 +00001327 - Added @ref OMPScheduler (OpenMP) scheduler for Neon
1328 - Added @ref SingleThreadScheduler scheduler for Neon (For bare metal)
Anthony Barbier3762e742018-03-02 11:49:33 +00001329 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001330 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001331 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Michele Di Giorgio7d61ff02021-01-18 21:15:59 +00001332 - CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Michalis Spyrou473cb012021-02-23 11:48:12 +00001333 - CLHOGOrientationBinningKernel CLHOGBlockNormalizationKernel, CLHOGDetectorKernel / CLHOGDescriptor CLHOGDetector CLHOGGradient CLHOGMultiDetection
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001334 - CLLocallyConnectedMatrixMultiplyKernel / CLLocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001335 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001336 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001337 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Sheri Zhangac6499a2021-02-10 15:32:38 +00001338 - New Neon kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001339 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001340 - NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001341 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
Georgios Pinitas96b16b62020-12-01 17:41:34 +00001342 - NELocallyConnectedMatrixMultiplyKernel / NELocallyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001343 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001344
1345v17.05 Public bug fixes release
1346 - Various bug fixes
1347 - Remaining of the functions ported to use accurate padding.
1348 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
1349 - Added "free" method to allocator.
1350 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
1351
1352v17.04 Public bug fixes release
1353
1354 The following functions have been ported to use the new accurate padding:
Michalis Spyrou473cb012021-02-23 11:48:12 +00001355 - CLColorConvertKernel
1356 - CLEdgeNonMaxSuppressionKernel
1357 - CLEdgeTraceKernel
1358 - CLGaussianPyramidHorKernel
1359 - CLGaussianPyramidVertKernel
1360 - CLGradientKernel
Michalis Spyrou27e67f02021-02-16 11:34:39 +00001361 - NEChannelCombineKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001362 - @ref NEFillArrayKernel
Michalis Spyrou27e67f02021-02-16 11:34:39 +00001363 - NEGaussianPyramidHorKernel
1364 - NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +01001365 - NEHarrisScoreFP16Kernel
Michalis Spyrou27e67f02021-02-16 11:34:39 +00001366 - NEHarrisScoreKernel
1367 - NEHOGDetectorKernel
Michalis Spyrou373b4072021-01-20 16:41:12 +00001368 - NELogits1DMaxKernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001369 - NELogits1DShiftExpSumKernel
1370 - NELogits1DNormKernel
Michalis Spyrou473cb012021-02-23 11:48:12 +00001371 - NENonMaximaSuppression3x3FP16Kernel
1372 - NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001373
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001374v17.03.1 First Major public release of the sources
1375 - Renamed the library to arm_compute
Sheri Zhangac6499a2021-02-10 15:32:38 +00001376 - New CPP target introduced for C++ kernels shared between Neon and CL functions.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001377 - New padding calculation interface introduced and ported most kernels / functions to use it.
1378 - New OpenCL kernels / functions:
Gian Marco Iodiceeb65f6d2020-04-15 11:42:15 +01001379 - CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Sheri Zhangac6499a2021-02-10 15:32:38 +00001380 - New Neon kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001381 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
Teresa Charlind1dc09c2021-03-04 15:24:45 +00001382 - NETransposeKernel / @ref NETranspose
Michalis Spyrou373b4072021-01-20 16:41:12 +00001383 - NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001384 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +01001385 - NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001386 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001387
1388v17.03 Sources preview
1389 - New OpenCL kernels / functions:
Michalis Spyrou473cb012021-02-23 11:48:12 +00001390 - CLGradientKernel, CLEdgeNonMaxSuppressionKernel, CLEdgeTraceKernel / CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001391 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001392 - CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001393 - @ref CLTransposeKernel / @ref CLTranspose
Michalis Spyrou473cb012021-02-23 11:48:12 +00001394 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / CLOpticalFlow
Anthony Barbier3762e742018-03-02 11:49:33 +00001395 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
Michalis Spyrou473cb012021-02-23 11:48:12 +00001396 - CLLaplacianPyramid, CLLaplacianReconstruct
Sheri Zhangac6499a2021-02-10 15:32:38 +00001397 - New Neon kernels / functions:
Michele Di Giorgiobd2c8e12021-01-19 15:29:02 +00001398 - NEActivationLayerKernel / @ref NEActivationLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001399 - 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 +00001400 - NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001401
1402v17.02.1 Sources preview
1403 - New OpenCL kernels / functions:
Sang-Hoon Park201e0fe2021-01-27 13:14:56 +00001404 - CLLogits1DMaxKernel, CLLogits1DShiftExpSumKernel, CLLogits1DNormKernel / @ref CLSoftmaxLayer
Michele Di Giorgioe1314662021-02-01 17:09:32 +00001405 - CLPoolingLayerKernel / @ref CLPoolingLayer
Michalis Spyrou473cb012021-02-23 11:48:12 +00001406 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / CLConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001407 - @ref CLRemapKernel / @ref CLRemap
Michalis Spyrou473cb012021-02-23 11:48:12 +00001408 - CLGaussianPyramidHorKernel, CLGaussianPyramidVertKernel / CLGaussianPyramid, CLGaussianPyramidHalf, CLGaussianPyramidOrb
1409 - CLMinMaxKernel, CLMinMaxLocationKernel / CLMinMaxLocation
1410 - CLNonLinearFilterKernel / CLNonLinearFilter
Sheri Zhangac6499a2021-02-10 15:32:38 +00001411 - New Neon FP16 kernels (Requires armv8.2 CPU)
Michalis Spyrou27e67f02021-02-16 11:34:39 +00001412 - NEAccumulateWeightedFP16Kernel
1413 - NEBox3x3FP16Kernel
Michalis Spyrou473cb012021-02-23 11:48:12 +00001414 - NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001415
1416v17.02 Sources preview
1417 - New OpenCL kernels / functions:
Georgios Pinitasf47f7182021-01-15 09:29:50 +00001418 - CLActivationLayerKernel / @ref CLActivationLayer
Michalis Spyrou473cb012021-02-23 11:48:12 +00001419 - CLChannelCombineKernel / CLChannelCombine
1420 - CLDerivativeKernel / CLChannelExtract
1421 - CLFastCornersKernel / CLFastCorners
1422 - CLMeanStdDevKernel / CLMeanStdDev
Sheri Zhangac6499a2021-02-10 15:32:38 +00001423 - New Neon kernels / functions:
Michalis Spyrou27e67f02021-02-16 11:34:39 +00001424 - HOG / SVM: NEHOGOrientationBinningKernel, NEHOGBlockNormalizationKernel, NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / NEHOGDescriptor, NEHOGDetector, NEHOGGradient, NEHOGMultiDetection
1425 - NENonLinearFilterKernel / NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001426 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1427 - Switched all the kernels / functions to use tensors instead of images.
1428 - Updated documentation to include instructions to build the library from sources.
1429
1430v16.12 Binary preview release
1431 - Original release
1432
1433@section S3_how_to_build How to build the library and the examples
1434
1435@subsection S3_1_build_options Build options
1436
1437scons 2.3 or above is required to build the library.
1438To see the build options available simply run ```scons -h```:
1439
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001440 debug: Debug (yes|no)
1441 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001442
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001443 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1444 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001445
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001446 logging: Logging (this flag is forced to 1 for debug=1) (yes|no)
1447 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001448
Sang-Hoon Park50e98bb2021-01-14 14:54:14 +00001449 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 +00001450 default: armv7a
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001451
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001452 estate: Execution State (auto|32|64)
1453 default: auto
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001454
Georgios Pinitas45514032020-12-30 00:03:09 +00001455 os: Target OS (linux|android|macos|tizen|bare_metal)
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001456 default: linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001457
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001458 build: Build type (native|cross_compile|embed_only)
1459 default: cross_compile
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001460
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001461 examples: Build example programs (yes|no)
1462 default: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001463
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001464 gemm_tuner: Build gemm_tuner programs (yes|no)
1465 default: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001466
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001467 Werror: Enable/disable the -Werror compilation flag (yes|no)
1468 default: True
Anthony Barbier20dbb822017-12-13 21:19:39 +00001469
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001470 standalone: Builds the tests as standalone executables, links statically with libgcc, libstdc++ and libarm_compute (yes|no)
1471 default: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001472
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001473 opencl: Enable OpenCL support (yes|no)
1474 default: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001475
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001476 neon: Enable Neon support (yes|no)
1477 default: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001478
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00001479 embed_kernels: Embed OpenCL kernels in library binary (yes|no)
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001480 default: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001481
Georgios Pinitasea857272021-01-22 05:47:37 +00001482 compress_kernels: Compress embedded OpenCL kernels in library binary. Note embed_kernels should be enabled as well (yes|no)
1483 default: False
Georgios Pinitasea857272021-01-22 05:47:37 +00001484
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001485 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1486 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001487
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001488 tracing: Enable runtime tracing (yes|no)
1489 default: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001490
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001491 openmp: Enable OpenMP backend (yes|no)
1492 default: False
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001493
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001494 cppthreads: Enable C++11 threads backend (yes|no)
1495 default: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001496
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001497 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1498 default: .
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001499
1500 install_dir: Specify sub-folder for the install ( /path/to/install_dir )
1501 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001502
1503 exceptions: Enable/disable C++ exception support (yes|no)
1504 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001505
1506 linker_script: Use an external linker script ( /path/to/linker_script )
1507 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001508
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001509 custom_options: Custom options that can be used to turn on/off features
1510 (all|none|comma-separated list of names)
1511 allowed names: disable_mmla_fp
1512 default: none
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001513
1514 data_type_support: Enable a list of data types to support
1515 (all|none|comma-separated list of names)
1516 allowed names: qasymm8 qasymm8_signed qsymm16 fp16 fp32
1517 default: all
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001518
1519 toolchain_prefix: Override the toolchain prefix
1520 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001521
1522 compiler_prefix: Override the compiler prefix
1523 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001524
1525 extra_cxx_flags: Extra CXX flags to be appended to the build command
1526 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001527
1528 extra_link_flags: Extra LD flags to be appended to the build command
1529 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001530
1531 compiler_cache: Command to prefix to the C and C++ compiler (e.g ccache)
1532 default:
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001533
1534 specs_file: Specs file to use
1535 default: rdimon.specs
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001536
1537 benchmark_examples: Build benchmark examples programs (yes|no)
1538 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001539
1540 validate_examples: Build validate examples programs (yes|no)
1541 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001542
1543 reference_openmp: Build reference validation with openmp (yes|no)
1544 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001545
1546 validation_tests: Build validation test programs (yes|no)
1547 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001548
1549 benchmark_tests: Build benchmark test programs (yes|no)
1550 default: True
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001551
1552 test_filter: Pattern to specify the tests' filenames to be compiled
1553 default: *.cpp
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001554
1555 pmu: Enable PMU counters (yes|no)
1556 default: False
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001557
1558 mali: Enable Mali hardware counters (yes|no)
1559 default: False
Anthony Barbier79c61782017-06-23 11:48:24 +01001560
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001561 external_tests_dir: Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1562 default:
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001563
Anthony Barbier79c61782017-06-23 11:48:24 +01001564@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001565 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1566 - 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)
1567 - 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).
1568
Anthony Barbier79c61782017-06-23 11:48:24 +01001569@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 +01001570
Anthony Barbier79c61782017-06-23 11:48:24 +01001571@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Sheri Zhangac6499a2021-02-10 15:32:38 +00001572@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 +01001573
Anthony Barbier79c61782017-06-23 11:48:24 +01001574@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 +01001575
Sheri Zhangac6499a2021-02-10 15:32:38 +00001576@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 +01001577
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00001578There is also an 'embed_only' option which will generate all the .embed files for the OpenCL kernels. This might be useful if using a different build system to compile the library.
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001579
Georgios Pinitasea857272021-01-22 05:47:37 +00001580In 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.
1581
Michele Di Giorgioeca54a02021-02-16 15:37:59 +00001582@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 +01001583
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00001584@b opencl / @b neon: Choose which SIMD technology you want to target. (Neon for Arm Cortex-A CPUs or OpenCL for Arm Mali GPUs)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001585
Manuel Bottiniceaa0bf2021-02-16 15:15:19 +00001586@b embed_kernels: For OpenCL only: set embed_kernels=1 if you want the OpenCL 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 kernel files by calling CLKernelLibrary::init(). By default the path is set to "./cl_kernels".
Anthony Barbier79c61782017-06-23 11:48:24 +01001587
1588@b set_soname: Do you want to build the versioned version of the library ?
1589
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001590If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1591Example:
1592 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1593 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1594 libarm_compute_core.so.1.0.0
1595
1596@note This options is disabled by default as it requires SCons version 2.4 or above.
1597
Anthony Barbier79c61782017-06-23 11:48:24 +01001598@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1599
1600@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1601
1602@b examples: Build or not the examples
1603
1604@b validation_tests: Enable the build of the validation suite.
1605
Anthony Barbier79c61782017-06-23 11:48:24 +01001606@b benchmark_tests: Enable the build of the benchmark tests
1607
1608@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1609
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001610@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)
1611
Sheri Zhangac6499a2021-02-10 15:32:38 +00001612@b openmp Build in the OpenMP scheduler for Neon.
Anthony Barbier79c61782017-06-23 11:48:24 +01001613
1614@note Only works when building with g++ not clang++
1615
Sheri Zhangac6499a2021-02-10 15:32:38 +00001616@b cppthreads Build in the C++11 scheduler for Neon.
Anthony Barbier79c61782017-06-23 11:48:24 +01001617
Anthony Barbier3762e742018-03-02 11:49:33 +00001618@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001619
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001620@b external_tests_dir Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
1621
1622In order to use this option, the external tests directory must have the following structure:
1623
1624 EXTERNAL_TESTS_DIR:
1625 └── tests
1626 ├── benchmark
1627 │   ├── CL
1628 │   ├── datasets
1629 │   ├── fixtures
Sheri Zhangac6499a2021-02-10 15:32:38 +00001630 │   └── Neon
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001631 └── validation
1632    ├── CL
1633     ├── datasets
1634     ├── fixtures
Sheri Zhangac6499a2021-02-10 15:32:38 +00001635     └── Neon
Michele Di Giorgio72610dc2020-11-18 15:29:08 +00001636
1637Then, build the library with `external_tests_dir=<PATH_TO_EXTERNAL_TESTS_DIR>`.
1638
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001639@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001640
1641@subsubsection S3_2_1_library How to build the library ?
1642
1643For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1644
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001645 - gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
1646 - gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001647
Sheri Zhangac6499a2021-02-10 15:32:38 +00001648To cross-compile the library in debug mode, with Neon only support, for Linux 32bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001649
1650 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1651
1652To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1653
1654 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1655
Sheri Zhangac6499a2021-02-10 15:32:38 +00001656You can also compile the library natively on an Arm device by using <b>build=native</b>:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001657
1658 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1659 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1660
Sheri Zhangac6499a2021-02-10 15:32:38 +00001661@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 +01001662
1663For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1664
1665 apt-get install g++-arm-linux-gnueabihf
1666
1667Then run
1668
1669 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1670
1671or simply remove the build parameter as build=cross_compile is the default value:
1672
1673 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1674
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001675@subsubsection S3_2_2_examples How to manually build the examples ?
1676
1677The 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.
1678
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001679@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 +01001680
Sheri Zhangac6499a2021-02-10 15:32:38 +00001681To cross compile a Neon example for Linux 32bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001682
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001683 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 +01001684
Sheri Zhangac6499a2021-02-10 15:32:38 +00001685To cross compile a Neon example for Linux 64bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001686
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001687 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 +01001688
1689(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)
1690
1691To cross compile an OpenCL example for Linux 32bit:
1692
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001693 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 +01001694
1695To cross compile an OpenCL example for Linux 64bit:
1696
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001697 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 +01001698
1699(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)
1700
Anthony Barbier14c86a92017-12-14 16:27:41 +00001701To 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.
1702
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001703i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1704
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001705 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 +01001706
1707i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1708
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001709 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 +01001710
1711(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)
1712
Anthony Barbiere5007472017-10-27 15:01:44 +01001713@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1714
Sheri Zhangac6499a2021-02-10 15:32:38 +00001715To compile natively (i.e directly on an Arm device) for Neon for Linux 32bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001716
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001717 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 +01001718
Sheri Zhangac6499a2021-02-10 15:32:38 +00001719To compile natively (i.e directly on an Arm device) for Neon for Linux 64bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001720
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001721 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 +01001722
1723(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1724
Sheri Zhangac6499a2021-02-10 15:32:38 +00001725To compile natively (i.e directly on an Arm device) for OpenCL for Linux 32bit or Linux 64bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001726
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001727 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 +01001728
Anthony Barbier14c86a92017-12-14 16:27:41 +00001729To 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 +00001730
1731i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001732
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001733 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 +01001734
Anthony Barbier14c86a92017-12-14 16:27:41 +00001735i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001736
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001737 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 +01001738
1739(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 +01001740
Anthony Barbiere5007472017-10-27 15:01:44 +01001741@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1742
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001743@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 +00001744@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 +01001745
1746To run the built executable simply run:
1747
1748 LD_LIBRARY_PATH=build ./neon_convolution
1749
1750or
1751
1752 LD_LIBRARY_PATH=build ./cl_convolution
1753
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001754@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 +00001755
1756For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001757
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001758 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001759
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001760Below is a list of the common parameters among the graph examples :
1761@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001762
Manuel Bottinie5a9ad82020-11-18 16:22:16 +00001763@subsubsection S3_2_3_sve Build for SVE or SVE2
1764
1765In order to build for SVE or SVE2 you need a compiler that supports them. You can find more information in the following these links:
1766 -# GCC: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/sve-support
1767 -# LLVM: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/llvm-toolchain/sve-support
1768
1769@note You the need to indicate the toolchains using the scons "toolchain_prefix" parameter.
1770
1771An example build command with SVE is:
1772
1773 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-
1774
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001775@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001776
1777For Android, the library was successfully built and tested using Google's standalone toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001778 - clang++ from NDK r18b for armv7a
Giorgio Arenacd7d1782021-02-22 14:58:37 +00001779 - clang++ from NDK r20b for arm64-v8a
1780 - clang++ from NDK r20b for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001781
Giorgio Arena793daa12021-03-01 13:49:58 +00001782For NDK r18 or older, here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>:
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001783- Download the NDK r18b from here: https://developer.android.com/ndk/downloads/index.html to directory $NDK
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001784- Make sure you have Python 2.7 installed on your machine.
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001785- 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 +01001786
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001787 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b --stl libc++ --api 21
1788 $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 +01001789
Giorgio Arena793daa12021-03-01 13:49:58 +00001790For NDK r19 or newer, you can directly <a href="https://developer.android.com/ndk/downloads">Download</a> the NDK package for your development platform, without the need to launch the make_standalone_toolchain.py script. You can find all the prebuilt binaries inside $NDK/toolchains/llvm/prebuilt/$OS_ARCH/bin/.
1791@attention the building script will look for a binary named "aarch64-linux-android-clang++", while the prebuilt binaries will have their API version as a suffix to their filename (e.g. "aarch64-linux-android21-clang++"). You should copy/rename the binary removing this suffix, or - alternatively - create an alias for it.
1792
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001793@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 +01001794
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001795@note Make sure to add the toolchains to your PATH:
1796
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001797 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 +01001798
1799@subsubsection S3_3_1_library How to build the library ?
1800
Sheri Zhangac6499a2021-02-10 15:32:38 +00001801To cross-compile the library in debug mode, with Neon only support, for Android 32bit:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001802
1803 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1804
1805To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1806
Anthony Barbier14c86a92017-12-14 16:27:41 +00001807 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 +01001808
1809@subsubsection S3_3_2_examples How to manually build the examples ?
1810
1811The 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.
1812
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001813@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 +01001814
1815Once you've got your Android standalone toolchain built and added to your path you can do the following:
1816
Sheri Zhangac6499a2021-02-10 15:32:38 +00001817To cross compile a Neon example:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001818
1819 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001820 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 +01001821 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001822 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 +01001823
1824To cross compile an OpenCL example:
1825
1826 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001827 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 +01001828 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001829 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 +00001830
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001831To 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 +01001832
1833 #32 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001834 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 +01001835 #64 bit:
Georgios Pinitas40f51a62020-11-21 03:04:18 +00001836 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 +01001837
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001838@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 +00001839@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 +01001840
1841Then you need to do is upload the executable and the shared library to the device using ADB:
1842
1843 adb push neon_convolution_arm /data/local/tmp/
1844 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001845 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001846 adb shell chmod 777 -R /data/local/tmp/
1847
1848And finally to run the example:
1849
1850 adb shell /data/local/tmp/neon_convolution_arm
1851 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001852 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001853
1854For 64bit:
1855
1856 adb push neon_convolution_aarch64 /data/local/tmp/
1857 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001858 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001859 adb shell chmod 777 -R /data/local/tmp/
1860
1861And finally to run the example:
1862
1863 adb shell /data/local/tmp/neon_convolution_aarch64
1864 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001865 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001866
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001867@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 +00001868
1869For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001870 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001871
Sheri Zhangac6499a2021-02-10 15:32:38 +00001872In 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 +00001873
Georgios Pinitas45514032020-12-30 00:03:09 +00001874@subsection S3_4_macos Building for macOS
1875
1876The library was successfully natively built for Apple Silicon under macOS 11.1 using clang v12.0.0.
1877
1878To natively compile the library with accelerated CPU support:
1879
1880 scons Werror=1 -j8 neon=1 opencl=0 os=macos arch=arm64-v8a build=native
1881
1882@note Initial support disables feature discovery through HWCAPS and thread scheduling affinity controls
1883
1884@subsection S3_5_bare_metal Building for bare metal
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001885
Georgios Pinitas58216322020-02-26 11:13:13 +00001886For 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 +01001887 - arm-eabi for armv7a
1888 - aarch64-elf for arm64-v8a
1889
1890Download 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>.
1891
1892@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
1893
Georgios Pinitas45514032020-12-30 00:03:09 +00001894@subsubsection S3_5_1_library How to build the library ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001895
Sheri Zhangac6499a2021-02-10 15:32:38 +00001896To cross-compile the library with Neon support for baremetal arm64-v8a:
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001897
1898 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
1899
Georgios Pinitas45514032020-12-30 00:03:09 +00001900@subsubsection S3_5_2_examples How to manually build the examples ?
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001901
1902Examples 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>.
1903
Georgios Pinitas45514032020-12-30 00:03:09 +00001904@subsection S3_6_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001905
1906Using `scons` directly from the Windows command line is known to cause
1907problems. The reason seems to be that if `scons` is setup for cross-compilation
1908it gets confused about Windows style paths (using backslashes). Thus it is
1909recommended to follow one of the options outlined below.
1910
Georgios Pinitas45514032020-12-30 00:03:09 +00001911@subsubsection S3_6_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001912
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001913The best and easiest option is to use
1914<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001915This feature is still marked as *beta* and thus might not be available.
1916However, if it is building the library is as simple as opening a *Bash on
1917Ubuntu on Windows* shell and following the general guidelines given above.
1918
Georgios Pinitas45514032020-12-30 00:03:09 +00001919@subsubsection S3_6_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001920
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001921If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001922can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1923to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001924also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001925code of the library.) Linaro provides pre-built versions of
1926<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001927that can be used from the Cygwin terminal. When building for Android the
1928compiler is included in the Android standalone toolchain. After everything has
1929been set up in the Cygwin terminal the general guide on building the library
1930can be followed.
1931
Georgios Pinitas45514032020-12-30 00:03:09 +00001932@subsection S3_7_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001933
Georgios Pinitas45514032020-12-30 00:03:09 +00001934@subsubsection S3_7_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001935
1936Compute 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).
1937
1938Enabling 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.
1939
Georgios Pinitas45514032020-12-30 00:03:09 +00001940@subsubsection S3_7_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001941
1942Integer 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.
1943
1944OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1945
1946SVM 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 +01001947
Georgios Pinitas45514032020-12-30 00:03:09 +00001948@subsection S3_8_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001949
1950The 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).
1951The 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 +01001952The 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 +01001953In 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.
1954
1955If 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:
1956
1957https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1958
1959Tuning 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.
1960
1961CLTuner 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.
1962
1963 #Example: 2 unique Matrix Multiply configurations
1964@code{.cpp}
1965 TensorShape a0 = TensorShape(32,32);
1966 TensorShape b0 = TensorShape(32,32);
1967 TensorShape c0 = TensorShape(32,32);
1968 TensorShape a1 = TensorShape(64,64);
1969 TensorShape b1 = TensorShape(64,64);
1970 TensorShape c1 = TensorShape(64,64);
1971
1972 Tensor a0_tensor;
1973 Tensor b0_tensor;
1974 Tensor c0_tensor;
1975 Tensor a1_tensor;
1976 Tensor b1_tensor;
1977 Tensor c1_tensor;
1978
1979 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1980 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1981 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1982 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1983 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1984 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1985
1986 CLGEMM gemm0;
1987 CLGEMM gemm1;
1988
1989 // Configuration 0
1990 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1991
1992 // Configuration 1
1993 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1994@endcode
1995
Georgios Pinitas45514032020-12-30 00:03:09 +00001996@subsubsection S3_8_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001997
Michele Di Giorgio57f30a92020-09-08 14:03:51 +01001998All 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 +01001999
2000 #Enable CL tuner
2001 ./graph_mobilenet --enable-tuner –-target=CL
2002 ./arm_compute_benchmark --enable-tuner
2003
2004 #Export/Import to/from a file
2005 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
2006 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
2007
2008If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
2009
2010Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
2011
2012 -# Disable the power management
2013 -# Keep the GPU frequency constant
2014 -# Run multiple times the network (i.e. 10).
2015
2016If 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.
2017
2018@code{.cpp}
2019CLTuner tuner;
2020
2021// Setup Scheduler
2022CLScheduler::get().default_init(&tuner);
2023@endcode
2024
2025After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
2026- tuner.save_to_file("results.csv");
2027
2028This file can be also imported using the method "load_from_file("results.csv")".
2029- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01002030*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01002031} // namespace arm_compute