blob: 3321b399928af23460ff9db70ce6996c0078ffbd [file] [log] [blame]
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00001///
Michele Di Giorgiod9eaf612020-07-08 11:12:57 +01002/// Copyright (c) 2017-2020 Arm Limited.
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00003///
4/// SPDX-License-Identifier: MIT
5///
6/// Permission is hereby granted, free of charge, to any person obtaining a copy
7/// of this software and associated documentation files (the "Software"), to
8/// deal in the Software without restriction, including without limitation the
9/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10/// sell copies of the Software, and to permit persons to whom the Software is
11/// furnished to do so, subject to the following conditions:
12///
13/// The above copyright notice and this permission notice shall be included in all
14/// copies or substantial portions of the Software.
15///
16/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22/// SOFTWARE.
23///
Anthony Barbier3762e742018-03-02 11:49:33 +000024namespace arm_compute
25{
Anthony Barbier6ff3b192017-09-04 18:44:23 +010026/** @mainpage Introduction
27
28@tableofcontents
29
30The Computer Vision and Machine Learning library is a set of functions optimised for both ARM CPUs and GPUs using SIMD technologies.
31
32Several builds of the library are available using various configurations:
33 - OS: Linux, Android or bare metal.
34 - Architecture: armv7a (32bit) or arm64-v8a (64bit)
Anthony Barbier20dbb822017-12-13 21:19:39 +000035 - Technology: NEON / OpenCL / GLES_COMPUTE / NEON and OpenCL and GLES_COMPUTE
Anthony Barbier6ff3b192017-09-04 18:44:23 +010036 - Debug / Asserts / Release: Use a build with asserts enabled to debug your application and enable extra validation. Once you are sure your application works as expected you can switch to a release build of the library for maximum performance.
37
38@section S0_1_contact Contact / Support
39
40Please email developer@arm.com
41
42In order to facilitate the work of the support team please provide the build information of the library you are using. To get the version of the library you are using simply run:
43
44 $ strings android-armv7a-cl-asserts/libarm_compute.so | grep arm_compute_version
45 arm_compute_version=v16.12 Build options: {'embed_kernels': '1', 'opencl': '1', 'arch': 'armv7a', 'neon': '0', 'asserts': '1', 'debug': '0', 'os': 'android', 'Werror': '1'} Git hash=f51a545d4ea12a9059fe4e598a092f1fd06dc858
46
Anthony Barbier14c86a92017-12-14 16:27:41 +000047@section S0_2_prebuilt_binaries Pre-built binaries
48
49For each release we provide some pre-built binaries of the library [here](https://github.com/ARM-software/ComputeLibrary/releases)
50
51These binaries have been built using the following toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +010052 - Linux armv7a: gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
53 - Linux arm64-v8a: gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
54 - Android armv7a: clang++ / libc++ NDK r18b
55 - Android am64-v8a: clang++ / libc++ NDK r18b
Anthony Barbier14c86a92017-12-14 16:27:41 +000056
57@warning Make sure to use a compatible toolchain to build your application or you will get some std::bad_alloc errors at runtime.
58
Anthony Barbier6ff3b192017-09-04 18:44:23 +010059@section S1_file_organisation File organisation
60
61This archive contains:
62 - The arm_compute header and source files
63 - The latest Khronos OpenCL 1.2 C headers from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a>
64 - The latest Khronos cl2.hpp from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a> (API version 2.1 when this document was written)
Anthony Barbier20dbb822017-12-13 21:19:39 +000065 - The latest Khronos OpenGL ES 3.1 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos OpenGL ES registry</a>
66 - The latest Khronos EGL 1.5 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos EGL registry</a>
67 - The sources for a stub version of libOpenCL.so, libGLESv1_CM.so, libGLESv2.so and libEGL.so to help you build your application.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010068 - An examples folder containing a few examples to compile and link against the library.
69 - A @ref utils folder containing headers with some boiler plate code used by the examples.
70 - This documentation.
71
Michele Di Giorgio552e11d2020-09-23 15:08:38 +010072 For detailed information about file organization, please refer to Files -> File List section of this documentation.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010073
74@section S2_versions_changelog Release versions and changelog
75
76@subsection S2_1_versions Release versions
77
78All releases are numbered vYY.MM Where YY are the last two digits of the year, and MM the month number.
79If there is more than one release in a month then an extra sequential number is appended at the end:
80
81 v17.03 (First release of March 2017)
82 v17.03.1 (Second release of March 2017)
83 v17.04 (First release of April 2017)
84
85@note We're aiming at releasing one major public release with new features per quarter. All releases in between will only contain bug fixes.
86
87@subsection S2_2_changelog Changelog
88
SiCong Li96209c72020-08-21 12:28:30 +010089v20.11 Public major release
morgolock0e728492020-11-20 11:03:33 +000090 - Performance regressions can be noted when executing Depthwise Convolution on Neon with a multiplier > 1.
91 This is planned to be resolved in 21.02 release.
SiCong Li903f8cc2020-08-27 10:17:10 +010092 - Added new data type S32 support for:
93 - @ref NEArithmeticSubtraction
94 - @ref NEArithmeticSubtractionKernel
SiCong Libb88f892020-08-28 11:18:47 +010095 - @ref NEPixelWiseMultiplication
96 - @ref NEPixelWiseMultiplicationKernel
Georgios Pinitas18134222020-09-03 21:00:23 +010097 - @ref NEElementwiseDivision
98 - @ref NEDivisionOperationKernel
SiCong Li96209c72020-08-21 12:28:30 +010099 - Interface change
100 - Properly support softmax axis to have the same meaning as other major frameworks. That is, axis now defines the dimension
101 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.
102 The supported value range of axis is [-rank, rank).
103 This change applies to the following functions:
104 - @ref NESoftmaxLayer
105 - @ref NELogSoftmaxLayer
106 - @ref CLSoftmaxLayer
107 - @ref CLLogSoftmaxLayer
108 - @ref GCSoftmaxLayer
Sheri Zhang824061d2020-10-26 15:46:37 +0000109 - New OpenCL kernels / functions:
110 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
morgolock0e728492020-11-20 11:03:33 +0000111 - @ref CLLogicalNot
112 - @ref CLLogicalAnd
113 - @ref CLLogicalOr
114 - New NEON kernels / functions:
115 - @ref NELogicalNot
116 - @ref NELogicalAnd
117 - @ref NELogicalOr
Sheri Zhang824061d2020-10-26 15:46:37 +0000118 - Removed padding from NEON kernels:
Sheri Zhanged367132020-10-08 15:46:16 +0100119 - @ref NEComplexPixelWiseMultiplicationKernel
120 - @ref NENonMaximaSuppression3x3Kernel
121 - @ref NERemapKernel
122 - @ref NEGEMMInterleave4x4Kernel
123 - @ref NEDirectConvolutionLayerKernel
124 - @ref NEScaleKernel
125 - @ref NELocallyConnectedMatrixMultiplyKernel
126 - @ref NEGEMMLowpOffsetContributionKernel
127 - @ref NEGEMMTranspose1xWKernel
128 - @ref NEPoolingLayerKernel
129 - @ref NEConvolutionKernel
130 - @ref NEDepthwiseConvolutionLayerNativeKernel
131 - @ref NEGEMMLowpMatrixMultiplyKernel
132 - @ref NEGEMMMatrixMultiplyKernel
133 - @ref NEDirectConvolutionLayerOutputStageKernel
134 - @ref NEReductionOperationKernel
135 - @ref NEGEMMLowpMatrixAReductionKernel
136 - @ref NEGEMMLowpMatrixBReductionKernel
Sheri Zhang824061d2020-10-26 15:46:37 +0000137 - Removed padding from OpenCL kernels:
138 - @ref CLBatchConcatenateLayerKernel
139 - @ref CLElementwiseOperationKernel
140 - @ref CLBatchNormalizationLayerKernel
141 - @ref CLPoolingLayerKernel
142 - @ref CLWinogradInputTransformKernel
143 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
144 - @ref CLGEMMLowpMatrixAReductionKernel
145 - @ref CLGEMMLowpMatrixBReductionKernel
146 - @ref CLGEMMLowpOffsetContributionOutputStageKernel
147 - @ref CLGEMMLowpOffsetContributionKernel
148 - @ref CLWinogradOutputTransformKernel
149 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
150 - @ref CLFuseBatchNormalizationKernel
151 - @ref CLDepthwiseConvolutionLayerNativeKernel
152 - @ref CLDepthConvertLayerKernel
153 - @ref CLCopyKernel
154 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
155 - @ref CLActivationLayerKernel
156 - @ref CLWinogradFilterTransformKernel
157 - @ref CLWidthConcatenateLayerKernel
158 - @ref CLWidthConcatenate4TensorsKernel
159 - @ref CLWidthConcatenate2TensorsKernel
160 - @ref CLLogits1DMaxShiftExpSumKernel
161 - @ref CLLogits1DNormKernel
162 - @ref CLHeightConcatenateLayerKernel
163 - @ref CLGEMMMatrixMultiplyKernel
164 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
165 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
166 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
167 - @ref CLDepthConcatenateLayerKernel
168 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFixedPointKernel
169 - Removed OpenCL kernels / functions:
170 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
171 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel
172 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel
morgolock00c76012020-11-06 10:40:12 +0000173 - 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 +0100174 - CLLocallyConnectedLayer
175 - CLLocallyConnectedMatrixMultiplyKernel
morgolock00c76012020-11-06 10:40:12 +0000176 - CLAbsoluteDifference
177 - CLAbsoluteDifferenceKernel
178 - CLAccumulate
179 - CLAccumulateKernel
180 - CLAccumulateSquared
181 - CLAccumulateSquaredKernel
182 - CLAccumulateWeighted
183 - CLAccumulateWeightedKernel
184 - CLAccumulateWeightedFP16Kernel
185 - CLBox3x3
186 - CLBox3x3Kernel
187 - CLBox3x3FP16Kernel
188 - CLCannyEdge
189 - CLChannelCombine
190 - CLChannelCombineKernel
191 - CLChannelExtract
192 - CLChannelExtractKernel
193 - CLColorConvert
194 - CLColorConvertKernel
195 - CLConvolution3x3
196 - CLConvolutionRectangle
197 - CLConvolutionRectangleKernel
198 - CLConvolutionSquare
199 - CLConvolutionKernel
200 - CLDerivative
201 - CLDerivativeKernel
202 - CLDilate
203 - CLDilateKernel
204 - CLEqualizeHistogram
205 - CLErode
206 - CLErodeKernel
207 - CLFastCorners
208 - CLFastCornersKernel
209 - CLGaussian3x3
210 - CLGaussian3x3Kernel
211 - CLGaussian5x5
212 - CLGaussian5x5HorKernel
213 - CLGaussian5x5VertKernel
214 - CLGaussianPyramid
215 - CLGaussianPyramidHalf
216 - CLGaussianPyramidOrb
217 - CLHarrisCorners
218 - CLHarrisScoreKernel
219 - CLHarrisScoreFP16Kernel
220 - CLHistogram
221 - CLHistogramKernel
222 - CLHOGOrientationBinningKernel
223 - CLHOGBlockNormalizationKernel
224 - CLHOGDetectorKernel
225 - CLHOGNonMaximaSuppressionKernel
226 - CLHOGDescriptor
227 - CLHOGDetector
228 - CLHOGGradient
229 - CLHOGMultiDetection
230 - CLHOGOrientationBinningKernel
231 - CLHOGBlockNormalizationKernel
232 - CLHOGDetectorKernel
233 - CLIntegralImage
234 - CLIntegralImageKernel
235 - CLLaplacianReconstruct
236 - CLLaplacianPyramid
237 - CLMagnitude
238 - CLMagnitudePhaseKernel
239 - CLMedian3x3
240 - CLMedian3x3Kernel
241 - CLMinMaxLocation
242 - CLMinMaxLocationKernel
243 - CLNonLinearFilter
244 - CLNonLinearFilterKernel
245 - CLNonMaximaSuppression3x3
246 - CLNonMaximaSuppression3x3FP16Kernel
247 - CLNonMaximaSuppression3x3Kernel
248 - CLOpticalFlow
249 - CLPhase
250 - CLRemap
251 - CLRemapKernel
252 - CLScharr3x3
253 - CLScharr3x3Kernel
254 - CLSobel3x3
255 - CLSobel3x3Kernel
256 - CLSobel5x5
257 - CLSobel5x5HorKernel
258 - CLSobel5x5VertKernel
259 - CLSobel7x7
260 - CLSobel7x7HorKernel
261 - CLSobel7x7VertKernel
262 - CLThreshold
263 - CLThresholdKernel
264 - CLWarpAffine
265 - CLWarpAffineKernel
266 - CLWarpPerspective
267 - CLWarpPerspectiveKernel
268 - 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 +0100269 - NELocallyConnectedLayer
270 - NELocallyConnectedMatrixMultiplyKernel
morgolock0c862652020-11-06 08:59:45 +0000271 - NEAbsoluteDifference
272 - NEAbsoluteDifferenceKernel
273 - NEAccumulate
274 - NEAccumulateKernel
275 - NEAccumulateSquared
276 - NEAccumulateSquaredKernel
277 - NEAccumulateWeighted
278 - NEAccumulateWeightedKernel
279 - NEAccumulateWeightedFP16Kernel
280 - NEBox3x3
281 - NEBox3x3Kernel
282 - NEBox3x3FP16Kernel
283 - NECannyEdge
284 - NEChannelCombine
285 - NEChannelCombineKernel
286 - NEChannelExtract
287 - NEChannelExtractKernel
288 - NEColorConvert
289 - NEColorConvertKernel
290 - NEConvolution3x3
291 - NEConvolutionRectangle
292 - NEConvolutionRectangleKernel
293 - NEConvolutionSquare
294 - NEConvolutionKernel
295 - NEDerivative
296 - NEDerivativeKernel
297 - NEDilate
298 - NEDilateKernel
299 - NEEqualizeHistogram
300 - NEErode
301 - NEErodeKernel
302 - NEFastCorners
303 - NEFastCornersKernel
304 - NEGaussian3x3
305 - NEGaussian3x3Kernel
306 - NEGaussian5x5
307 - NEGaussian5x5HorKernel
308 - NEGaussian5x5VertKernel
309 - NEGaussianPyramid
310 - NEGaussianPyramidHalf
311 - NEGaussianPyramidOrb
312 - NEHarrisCorners
313 - NEHarrisScoreKernel
314 - NEHarrisScoreFP16Kernel
315 - NEHistogram
316 - NEHistogramKernel
317 - NEHOGOrientationBinningKernel
318 - NEHOGBlockNormalizationKernel
319 - NEHOGDetectorKernel
320 - NEHOGNonMaximaSuppressionKernel
321 - NEHOGDescriptor
322 - NEHOGDetector
323 - NEHOGGradient
324 - NEHOGMultiDetection
325 - NEHOGOrientationBinningKernel
326 - NEHOGBlockNormalizationKernel
327 - NEHOGDetectorKernel
328 - NEIntegralImage
329 - NEIntegralImageKernel
330 - NELaplacianReconstruct
331 - NELaplacianPyramid
332 - NEMagnitude
333 - NEMagnitudePhaseKernel
334 - NEMedian3x3
335 - NEMedian3x3Kernel
336 - NEMinMaxLocation
337 - NEMinMaxLocationKernel
338 - NENonLinearFilter
339 - NENonLinearFilterKernel
340 - NENonMaximaSuppression3x3
341 - NENonMaximaSuppression3x3FP16Kernel
342 - NENonMaximaSuppression3x3Kernel
343 - NEOpticalFlow
344 - NEPhase
345 - NERemap
346 - NERemapKernel
347 - NEScharr3x3
348 - NEScharr3x3Kernel
349 - NESobel3x3
350 - NESobel3x3Kernel
351 - NESobel5x5
352 - NESobel5x5HorKernel
353 - NESobel5x5VertKernel
354 - NESobel7x7
355 - NESobel7x7HorKernel
356 - NESobel7x7VertKernel
357 - NEThreshold
358 - NEThresholdKernel
359 - NEWarpAffine
360 - NEWarpAffineKernel
361 - NEWarpPerspective
362 - NEWarpPerspectiveKernel
morgolockd6ee9ed2020-11-19 10:07:14 +0000363 - Deprecated GLES kernels / functions (If a kernel is used only by the function that is being deprecated, the kernel is deprecated together):
364 - GCAbsoluteDifference
365 - GCActivationLayer
366 - GCArithmeticAddition
367 - GCBatchNormalizationLayer
368 - GCConcatenateLayer
369 - GCConvolutionLayer
370 - GCDepthwiseConvolutionLayer
371 - GCDirectConvolutionLayer
372 - GCDropoutLayer
373 - GCFillBorder
374 - GCFullyConnectedLayer
375 - GCGEMM
376 - GCGEMMInterleave4x4
377 - GCGEMMTranspose1xW
378 - GCNormalizationLayer
379 - GCNormalizePlanarYUVLayer
380 - GCPixelWiseMultiplication
381 - GCPoolingLayer
382 - GCScale
383 - GCSoftmaxLayer
384 - GCTensorShift
385 - GCTranspose
386
SiCong Li96209c72020-08-21 12:28:30 +0100387
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100388v20.08 Public major release
389 - Various bug fixes.
390 - Various optimisations.
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100391 - Added new data type QASYMM8_SIGNED support for:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100392 - @ref CLArgMinMaxLayer
393 - @ref CLArgMinMaxLayerKernel
394 - Added new data type U8 support for:
395 - @ref NECropKernel
396 - @ref CLCropKernel
397 - Added aligh_corner support for nearest neighbor interpolation in:
398 - @ref NEScaleKernel
399 - @ref CLScaleKernel
400 - New OpenCL kernels / functions:
401 - @ref CLMaxUnpoolingLayerKernel
402 - New NEON kernels / functions:
403 - @ref NEMaxUnpoolingLayerKernel
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100404 - New graph example:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100405 - graph_yolov3_output_detector
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100406 - GEMMTuner improvements:
407 - Added fp16 support
408 - Output json files for easier integration
409 - Enabled tuning for export_to_cl_image_rhs option for RHS tensors
410 - More robust script for running benchmarks
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100411 - Removed padding from:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100412 - @ref NEPixelWiseMultiplicationKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100413 - @ref NEHeightConcatenateLayerKernel
414 - @ref NEThresholdKernel
415 - @ref NEBatchConcatenateLayerKernel
416 - @ref NETransposeKernel
417 - @ref NEBatchNormalizationLayerKernel
418 - @ref NEArithmeticSubtractionKernel
419 - @ref NEBoundingBoxTransformKernel
420 - @ref NELogits1DMaxKernel
421 - @ref NELogits1DSoftmaxKernel
422 - @ref NEROIPoolingLayerKernel
423 - @ref NEROIAlignLayerKernel
424 - @ref NEYOLOLayerKernel
425 - @ref NEUpsampleLayerKernel
426 - @ref NEFloorKernel
427 - @ref NEWidthConcatenateLayerKernel
428 - @ref NEDepthConcatenateLayerKernel
429 - @ref NENormalizationLayerKernel
430 - @ref NEL2NormalizeLayerKernel
431 - @ref NEFillArrayKernel
432 - @ref NEDepthConvertLayerKernel
433 - @ref NERangeKernel
434 - @ref NEPriorBoxLayer
Sheri Zhanged367132020-10-08 15:46:16 +0100435 - Removed OpenCL kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100436 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
437 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Sang-Hoon Parka45abfd2020-08-17 13:50:15 +0100438 - Removed NEON kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100439 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
440 - NEGEMMMatrixAccumulateBiasesKernel
SiCong Lid004a7a2020-05-28 15:26:41 +0100441 - Deprecated functions / interfaces:
442 - Non-descriptor based interfaces for @ref NEThreshold, @ref CLThreshold
Sang-Hoon Park97c1a672020-08-18 11:44:13 +0100443 - Non-descriptor based interfaces for @ref NEScale, @ref CLScale and @ref GCScale
SiCong Lid004a7a2020-05-28 15:26:41 +0100444 - In @ref NESoftmaxLayer, @ref NELogSoftmaxLayer, @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer :
morgolock9c7fed82020-08-05 12:30:56 +0100445 The default "axis" value for @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer is changed from 1 to 0.
446 Only axis 0 is supported.
447 The default "axis" value for @ref NESoftmaxLayer, @ref NELogSoftmaxLayer is changed from 1 to 0.
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100448 Only axis 0 is supported.
Sang-Hoon Parka0205b92020-07-07 09:36:09 +0100449 - The support for quantized data types has been removed from @ref CLLogSoftmaxLayer due to implementation complexity.
Gian Marco Iodice547b2e72020-08-12 10:25:29 +0100450 - 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 +0100451 - This change allows to use @ref CLGEMMConvolutionLayer without extra padding for the input and output.
452 - Only the weights/bias of @ref CLGEMMConvolutionLayer could require padding for the computation.
453 - 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 +0100454 - 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 +0100455 - This support allows to export the OpenCL buffer used for the reshaped RHS matrix to the OpenCL image object.
456 - The padding requirement for the OpenCL image object is considered into the @ref CLGEMMReshapeRHSMatrixKernel.
457 - The reshaped RHS matrix stores the weights when GEMM is used to accelerate @ref CLGEMMConvolutionLayer.
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100458
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000459v20.05 Public major release
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000460 - Various bug fixes.
461 - Various optimisations.
Michele Di Giorgio36a551f2020-04-23 11:55:29 +0100462 - Updated recommended NDK version to r18b.
463 - Updated recommended gcc version to Linaro 6.3.1.
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000464 - Added Bfloat16 type support
465 - Added Bfloat16 support in:
466 - @ref NEWeightsReshapeKernel
467 - @ref NEConvolutionLayerReshapeWeights
468 - @ref NEIm2ColKernel
469 - @ref NEIm2Col
470 - @ref NEDepthConvertLayerKernel
471 - @ref NEDepthConvertLayer
472 - @ref NEGEMMConvolutionLayer
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000473 - @ref NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000474 - Added new data type QASYMM8_SIGNED support for:
475 - @ref CLDirectConvolutionLayer
476 - @ref CLDeconvolutionLayer
477 - @ref CLDirectDeconvolutionLayer
478 - @ref CLGEMMDeconvolutionLayer
479 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
480 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
481 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
482 - @ref CLReductionOperation
483 - @ref CLReduceMean
Sheri Zhang359c48e2020-04-30 22:53:39 +0100484 - @ref NEScale
485 - @ref NEScaleKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000486 - @ref NEUpsampleLayer
487 - @ref NECast
488 - @ref NEReductionOperation
489 - @ref NEReduceMean
490 - @ref NEArgMinMaxLayer
491 - @ref NEDeconvolutionLayer
492 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
493 - @ref CPPBoxWithNonMaximaSuppressionLimit
494 - @ref CPPDetectionPostProcessLayer
495 - @ref CPPPermuteKernel
496 - @ref CPPPermute
497 - @ref CPPTopKVKernel
498 - @ref CPPTopKV
Sheri Zhang359c48e2020-04-30 22:53:39 +0100499 - @ref CPPUpsample
500 - @ref CPPUpsampleKernel
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100501 - New OpenCL kernels / functions:
502 - @ref CLQLSTMLayer
503 - @ref CLQLSTMLayerNormalizationKernel
504 - New NEON kernels / functions:
505 - @ref NEQLSTMLayer
506 - @ref NEQLSTMLayerNormalizationKernel
507 - Added HARD_SWISH support in:
508 - @ref CLActivationLayerKernel
509 - @ref NEActivationLayerKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000510 - Deprecated OpenCL kernels / functions:
511 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
512 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
513 - Deprecated NEON kernels / functions:
514 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
515 - Removed CPP kernels / functions:
516 - CPPFlipWeightsKernel
Manuel Bottini387259a2020-05-21 17:14:36 +0100517 - Removed PoolingLayerInfo constructors without Data Layout.
518 - Removed CLDepthwiseConvolutionLayer3x3
519 - Removed NEDepthwiseConvolutionLayerOptimized
Manuel Bottini075253a2020-05-22 12:57:18 +0100520 - Added support for Winograd 3x3,4x4 on NEON FP16:
521 - @ref NEWinogradConvolutionLayer
522 - @ref NEWinogradLayerTransformInputKernel
523 - @ref NEWinogradLayerTransformOutputKernel
524 - @ref NEWinogradLayerTransformWeightsKernel
525 - Added CLCompileContext
526 - Added NEON GEMM kernel with 2D window support
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000527
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000528v20.02.1 Maintenance release
529 - Added Android-NN build script.
530
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000531v20.02 Public major release
532 - Various bug fixes.
533 - Various optimisations.
534 - Added new data type QASYMM8_SIGNED support for:
535 - @ref CLDepthwiseConvolutionLayer
Manuel Bottini387259a2020-05-21 17:14:36 +0100536 - CLDepthwiseConvolutionLayer3x3
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000537 - @ref CLGEMMConvolutionLayer
538 - @ref CLGEMMLowpMatrixMultiplyCore
539 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
540 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
541 - @ref NEActivationLayer
542 - @ref NEComparisonOperationKernel
543 - @ref NEConvolutionLayer
544 - @ref NEDepthwiseConvolutionLayer
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100545 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000546 - @ref NEDirectConvolutionLayerOutputStageKernel
547 - @ref NEElementwiseComparison
548 - @ref NEElementwiseMax
549 - @ref NEElementwiseMin
550 - @ref NEElementwiseSquaredDiff
551 - @ref NEFullyConnectedLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +0100552 - NEGEMMMatrixVectorMultiplyKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000553 - @ref NEPixelWiseMultiplication
554 - @ref NEPoolingLayer
555 - @ref NEPReluLayer
556 - Added support for QSYMM8_PER_CHANNEL in:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100557 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000558 - Added support for split sizes in:
559 - @ref CLSplit
560 - @ref NESplit
561 - New OpenCL kernels / functions:
562 - @ref CLFill
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100563 - CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000564 - New NEON kernels / functions:
565 - @ref NEFill
566 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
567 - Deprecated NEON functions / interfaces:
Manuel Bottini387259a2020-05-21 17:14:36 +0100568 - CLDepthwiseConvolutionLayer3x3
569 - NEDepthwiseConvolutionLayerOptimized
570 - PoolingLayerInfo constructors without Data Layout.
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000571 - Added support for quantization with multiplier greater than 1 on NEON and CL.
572 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
573 - Added the ability to build bootcode for bare metal.
574 - Added support for generating synthetic QASYMM8 graphs.
575 - Added support for F16 datatype in VGG16.
576 - Removed pre-built binaries for GLES.
577
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000578v19.11.1 Public maintenance release
579 - Fix offset calculation in NEReductionOperationKernel.
580 - Fix data layout in NEScaleKernel for nhwc.
581 - Retain configuration step data layout to avoid side-effects.
582 - Perform sqrt in double domain for L2 pooling.
583 - Fix output shape calculation for Reduce Mean
584 - Restrict cases where optimized NEPadLayer runs.
585
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100586v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000587 - Various bug fixes.
588 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000589 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000590 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100591 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
592 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000593 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100594 - CLDepthwiseVectorToTensorKernel
595 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000596 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100597 - NEDepthwiseWeightsReshapeKernel
598 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000599 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100600 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100601 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000602 - New OpenCL kernels / functions:
603 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
604 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
605 OpenCL kernels / functions)
606 - @ref CLLogSoftmaxLayer
607 - New NEON kernels / functions:
608 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
609 - @ref NEComputeAllAnchorsKernel / @ref NEComputeAllAnchors
610 - @ref NEDetectionPostProcessLayer
611 - @ref NEGenerateProposalsLayer
612 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
613 - @ref NELogSoftmaxLayer
614 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
615 - Added QASYMM8 support for:
616 - @ref CLGenerateProposalsLayer
617 - @ref CLROIAlignLayer
618 - @ref CPPBoxWithNonMaximaSuppressionLimit
619 - Added QASYMM16 support for:
620 - @ref CLBoundingBoxTransform
621 - Added FP16 support for:
622 - @ref CLGEMMMatrixMultiplyReshapedKernel
623 - Added new data type QASYMM8_PER_CHANNEL support for:
624 - @ref CLDequantizationLayer
625 - @ref NEDequantizationLayer
626 - Added new data type QSYMM8_PER_CHANNEL support for:
627 - @ref CLConvolutionLayer
628 - @ref NEConvolutionLayer
629 - @ref CLDepthwiseConvolutionLayer
630 - @ref NEDepthwiseConvolutionLayer
631 - Added FP16 mixed-precision support for:
632 - @ref CLGEMMMatrixMultiplyReshapedKernel
633 - @ref CLPoolingLayerKernel
634 - Added FP32 and FP16 ELU activation for:
635 - @ref CLActivationLayer
636 - @ref NEActivationLayer
637 - Added asymmetric padding support for:
638 - @ref CLDirectDeconvolutionLayer
639 - @ref CLGEMMDeconvolutionLayer
640 - @ref NEDeconvolutionLayer
641 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
642 - Replaced the calls to @ref NECopyKernel and @ref NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
643 - Replaced the calls to @ref CLCopyKernel and @ref CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
644 - Improved performance for CL Inception V3 - FP16.
645 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
646 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
647 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
648 - Optimized @ref CLPadLayer.
649 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
650 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100651
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000652v19.08.1 Public maintenance release
653 - Fix offset calculation in NEReductionOperationKernel.
654 - Fix data layout in NEScaleKernel for nhwc.
655 - Retain configuration step data layout to avoid side-effects.
656 - Perform sqrt in double domain for L2 pooling.
657 - Fix output shape calculation for Reduce Mean
658 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
659
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100660v19.08 Public major release
661 - Various bug fixes.
662 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100663 - Deprecated NEON functions
664 - NEDepthConcatenateLayer
665 - NEWidthConcatenateLayer
666 - Deprecated OpenCL kernels / functions
667 - CLDepthConcatenateLayer
668 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
669 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
670 - CLWidthConcatenateLayer
671 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100672 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100673 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100674 - @ref NEElementwisePower
675 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100676 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100677 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100678 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100679 - @ref NESinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100680 - @ref NEBatchConcatenateLayerKernel
681 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
682 - @ref NEDepthwiseConvolutionLayerNativeKernel
683 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
684 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
685 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
686 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100687 - @ref CLAbsLayer
688 - @ref CLElementwisePower
689 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100690 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100691 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100692 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100693 - @ref CLSinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100694 - @ref CLBatchConcatenateLayerKernel
695 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
696 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
Michele Di Giorgioba14c922020-10-12 13:27:57 +0100697 - CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100698 - @ref CLGEMMMatrixMultiplyNativeKernel
699 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
700 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
701 - New examples:
702 - neon_opticalflow
703 - cl_cache
704 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100705 - Added support for FP16 in @ref NEDeconvolutionLayer
706 - Added support for FP16 in @ref CLDeconvolutionLayer
707 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100708 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
709 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
710 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
711 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
712 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
713 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini387259a2020-05-21 17:14:36 +0100714 - The CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
715 - The NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100716 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
717 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100718 - 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 +0100719
Michalis Spyroua9c44722019-04-05 17:18:36 +0100720v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100721 - Various bug fixes.
722 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100723 - New Neon kernels / functions:
724 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100725 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100726 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100727 - @ref NEDepthwiseConvolutionAssemblyDispatch
728 - @ref NEFFTDigitReverseKernel
729 - @ref NEFFTRadixStageKernel
730 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100731 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
732 - @ref NEHeightConcatenateLayerKernel
733 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100734 - @ref NEFFT1D
735 - @ref NEFFT2D
736 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100737 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100738 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100739 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100740 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100741 - @ref CLFFTDigitReverseKernel
742 - @ref CLFFTRadixStageKernel
743 - @ref CLFFTScaleKernel
744 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
745 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
746 - @ref CLHeightConcatenateLayerKernel
747 - @ref CLDirectDeconvolutionLayer
748 - @ref CLFFT1D
749 - @ref CLFFT2D
750 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100751 - @ref CLGEMMDeconvolutionLayer
752 - New OpenGLES kernels / functions:
753 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100754 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100755 - GCDepthConcatenateLayer
756 - NEWidthConcatenateLayer
757 - NEDepthConcatenateLayer
758 - CLWidthConcatenateLayer
759 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100760 - CLGEMMInterleave4x4
761 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100762 - Support different quantization info in CLConcatLayer.
763 - Add checks on different input/output quantization info were not supported.
764 - Tensors have different quantization information.
765 - Add FP16 support checks.
766 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
767 - New graph examples:
768 - graph_convolution
769 - graph_fully_connected
770 - graph_depthwise_convolution
771 - Deepspeech v0.4.1
772 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
773 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
774 - Add support for QASYMM8 NEDeconvolution.
775 - Add support for DequantizationLayer for NEON/CL.
776 - Add support for dilation in CLDepthwiseConvolution.
777 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
778 - Optimize CLDeconvolution.
779 - Add StackLayer to the graph API.
780 - Add support for "reflect" padding mode in NEPad.
781 - Winograd 7x7 NHWC on OpenCL.
782 - Rework CL ML layers to run exclusively on CL.
783 - Support different quantization info in PoolingLayer.
784 - Implement and test import memory interfaces.
785 - Added new tests and removed old ones.
786 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100787
giuros01a69a88b2019-01-31 16:29:19 +0000788v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000789 - Various bug fixes.
790 - Various optimisations.
791 - New Neon kernels / functions:
792 - @ref NETileKernel / @ref NETile
793 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
794 - @ref NEElementwiseOperationKernel
795 - @ref NEElementwiseMax
796 - @ref NEElementwiseMin
797 - @ref NEElementwiseSquaredDiff
798 - @ref NESelectKernel / @ref NESelect
799 - @ref NESplit
800 - @ref NESlice
801 - @ref NEUnstack
802 - @ref NEStridedSliceKernel / @ref NEStridedSlice
803 - @ref NEElementwiseUnaryKernel
804 - @ref NERsqrtLayer
805 - @ref NEExpLayer
806 - @ref NEReverseKernel / @ref NEReverse
807 - @ref NEArgMinMaxLayer
808 - @ref NEStackLayerKernel / @ref NEStackLayer
809 - @ref NERangeKernel / @ref NERange
810 - @ref NEPadLayer
811 - @ref NEMemsetKernel
812 - @ref NEGatherKernel / @ref NEGather
813 - @ref NEElementwiseComparison
814 - @ref NEElementwiseComparisonStatic
815 - @ref NEComparisonOperationKernel
816 - @ref NEElementwiseDivision
817 - New OpenCL kernels / functions:
818 - @ref CLSelectKernel / @ref CLSelect
819 - @ref CLTileKernel / @ref CLTile
820 - @ref CLComparisonKernel / @ref CLComparison
821 - @ref CLArgMinMaxLayer
822 - @ref CLElementwiseMax
823 - @ref CLElementwiseMin
824 - @ref CLElementwiseSquaredDiff
825 - @ref CLStackLayerKernel / @ref CLStackLayer
826 - @ref CLReverse / @ref CLReverseKernel
827 - @ref CLRsqrtLayer
828 - @ref CLExpLayer
829 - @ref CLElementWiseUnaryLayerKernel
830 - @ref CLGEMMReshapeLHSMatrixKernel
831 - @ref CLGEMMReshapeRHSMatrixKernel
832 - @ref CLGEMMMatrixMultiplyReshapedKernel
833 - @ref CLRangeKernel / @ref CLRange
834 - @ref CLUnstack
835 - @ref CLGatherKernel / @ref CLGather
836 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
837 - New CPP kernels / functions:
838 - @ref CPPDetectionOutputLayer
839 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000840 - Added new examples:
841 - graph_ssd_mobilenet.cpp
842 - graph_mobilenet_v2.cpp
843 - graph_resnet12.cpp
844 - graph_srcnn955.cpp
845 - graph_vgg_vdsr.cpp
846 - graph_inception_resnet_v1.cpp
847 - Add 4D tensors support to
848 - @ref NESoftmaxLayer
849 - Fused activation in @ref CLWinogradConvolutionLayer
850 - Extented @ref NEPermute to support more cases
851 - Added NEON/SVE GEMM Hybrid kernels
852 - Added u8 and s8 hybrid assembly kernels
853 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
854 - Improved @ref CLTuner
855 - Fused the bias addition within @ref CLGEMM
856 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
857 - Added NHWC data layout support to:
858 - @ref NEScale for F16
859 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
860 - @ref NEL2NormalizeLayer for FP32/FP16
861 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
862 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000863 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000864 - Added QASYMM8 support to the following kernels:
865 - @ref NEArithmeticAdditionKernel
866 - @ref NEScale
867 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000868 - Deprecated functions/interfaces
869 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
870
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000871v18.11 Public major release
872 - Various bug fixes.
873 - Various optimisations.
874 - New Neon kernels / functions:
875 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
876 - @ref NEReduceMean
877 - @ref NEReorgLayer / @ref NEReorgLayerKernel
878 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
879 - @ref NEUpsampleLayer / @ref NEUpsampleLayerKernel
880 - @ref NEYOLOLayer / @ref NEYOLOLayerKernel
881 - New OpenCL kernels / functions:
882 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
883 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000884 - @ref CLComputeAllAnchorsKernel
885 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000886 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
887 - @ref CLReorgLayer / @ref CLReorgLayerKernel
888 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
889 - @ref CLPadLayer
890 - @ref CLReduceMean
891 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
892 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
893 - @ref CLSlice
894 - @ref CLSplit
895 - @ref CLStridedSlice / @ref CLStridedSliceKernel
896 - @ref CLUpsampleLayer / @ref CLUpsampleLayerKernel
897 - @ref CLYOLOLayer / @ref CLYOLOLayerKernel
898 - New CPP kernels / functions:
899 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
900 - Added the validate method in:
901 - @ref NEDepthConvertLayer
902 - @ref NEFloor / @ref CLFloor
903 - @ref NEGEMMMatrixAdditionKernel
904 - @ref NEReshapeLayer / @ref CLReshapeLayer
905 - @ref CLScale
906 - Added new examples:
907 - graph_shufflenet.cpp
908 - graph_yolov3.cpp
909 - Added documentation for add a new function or kernel.
910 - Improved doxygen documentation adding a list of the existing functions.
911 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100912 - CLWidthConcatenateLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000913 - @ref CLFlattenLayer
914 - @ref CLSoftmaxLayer
915 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
916 - Add SVE support
917 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
918 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
919 - Added NHWC data layout support to:
920 - @ref CLChannelShuffleLayer
921 - @ref CLDeconvolutionLayer
922 - @ref CLL2NormalizeLayer
923 - Added QASYMM8 support to the following kernels:
924 - @ref CLScaleKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100925 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000926 - @ref CLPixelWiseMultiplicationKernel
927 - Added FP16 support to the following kernels:
928 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100929 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000930 - @ref CLNormalizePlanarYUVLayerKernel
931 - @ref CLWinogradConvolutionLayer (5x5 kernel)
932 - More tests added to both validation and benchmarking suites.
933
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100934v18.08 Public major release
935 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100936 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100937 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100938 - Removed support for QS8/QS16 data types.
939 - Added support for grouped convolution in @ref CLConvolutionLayer.
940 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100941 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100942 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
943 - @ref CLDepthwiseConvolutionLayer
944 - @ref CLDirectConvolutionLayer
945 - @ref CLConvolutionLayer
946 - @ref CLScale
947 - @ref CLIm2ColKernel
948 - New Neon kernels / functions:
949 - @ref NERNNLayer
950 - New OpenCL kernels / functions:
951 - @ref CLArithmeticDivision
952 - Introduced prepare() stage support in the graph API for GLES.
953 - Added support for memory reusage when trying to allocate smaller CLTensors.
954 - Enabled NHWC execution on graph examples.
955 - Added JPEG accessor for validation purposes.
956 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100957
958v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100959 - Various bug fixes.
960 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000961 - Major redesign in the interface for the neon kernels implemented in assembly.
962 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
963 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
964 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100965 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
966 - Improved doxygen documentation.
967 - Improved memory management for layer's transitions.
968 - Added support for NHWC data layout in tensors.
969 - Added NHWC data layout support to:
970 - @ref NEGEMMConvolutionLayer
971 - @ref NEDirectConvolutionLayer
972 - @ref NEPoolingLayer / @ref CLPoolingLayer
973 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
974 - @ref NEDepthwiseConvolutionLayer
975 - @ref NEScale
976 - @ref NEIm2Col
977 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
978 - New OpenCL kernels / functions:
979 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
980 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
981 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100982 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100983 - @ref CLRNNLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100984 - CLWidthConcatenateLayer / @ref CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100985 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
986 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
987 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100988 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
989 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
990 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
991 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
992 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
993 - Port mobilenet example to NHWC data layout.
994 - Enabled Winograd method in @ref CLConvolutionLayer.
995 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
996 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
997 - Added memory manager support in GLES functions.
998 - Major refactoring of the graph API.
999 - Added GLES backend in the graph API.
1000 - Added support for the memory manager in the graph API.
1001 - Enabled Winograd Convolution method in the graph API.
1002 - Added support for grouped convolutions in the graph API.
1003 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
1004 - Added fast maths flag in @ref CLConvolutionLayer.
1005 - Added new tests and benchmarks in validation and benchmark frameworks
1006 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
1007 - Added support to OpenCL 2.0 SVM
1008 - Added support to import memory in OpenCL tensors.
1009 - Added the prepare() method to perform any one off pre-processing before running the function.
1010 - Added new examples:
1011 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001012 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +01001013 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +00001014
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001015v18.03 Public maintenance release
1016 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +00001017 - Fixed bug in @ref NEActivationLayer
1018 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001019 - Updated recommended NDK version to r16b (And fixed warnings).
1020 - Fixed bug in validation code.
1021 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001022 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +00001023
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001024v18.02 Public major release
1025 - Various NEON / OpenCL / GLES optimisations.
1026 - Various bug fixes.
1027 - Changed default number of threads on big LITTLE systems.
1028 - Refactored examples and added:
1029 - graph_mobilenet_qassym8
1030 - graph_resnet
1031 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +00001032 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
1033 - 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 +00001034 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001035 - @ref CLActivationLayer
1036 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001037 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +00001038 - @ref CLActivationLayer
1039 - @ref CLDepthwiseConvolutionLayer
1040 - @ref NEDepthwiseConvolutionLayer
1041 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001042 - Added FP16 support to:
Manuel Bottini387259a2020-05-21 17:14:36 +01001043 - CLDepthwiseConvolutionLayer3x3
Anthony Barbier3762e742018-03-02 11:49:33 +00001044 - @ref CLDepthwiseConvolutionLayer
1045 - Added broadcasting support to @ref NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
1046 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
1047 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001048 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +01001049 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +00001050 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001051 - Added name() method to all kernels.
1052 - Added support for Winograd 5x5.
Anthony Barbier3762e742018-03-02 11:49:33 +00001053 - @ref NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001054 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
1055 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
1056 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +01001057 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001058 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001059 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +00001060
Anthony Barbier64c95a02018-01-22 18:48:55 +00001061v18.01 Public maintenance release
1062 - Various bug fixes
1063 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +00001064 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
1065 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +00001066 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +00001067 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
1068 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
1069 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
1070 - Added @ref GCScaleKernel / @ref GCScale
1071 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +00001072 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001073 - @ref GCCol2ImKernel
1074 - @ref GCGEMMInterleave4x4Kernel
1075 - @ref GCGEMMTranspose1xWKernel
1076 - @ref GCIm2ColKernel
1077 - Refactored NEON Winograd (NEWinogradLayerKernel)
1078 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001079 - Added QASYMM8 support to the following NEON kernels:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001080 - NEDepthwiseConvolutionLayer3x3Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001081 - @ref NEFillBorderKernel
1082 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +00001083 - Added new examples:
1084 - graph_cl_mobilenet_qasymm8.cpp
1085 - graph_inception_v3.cpp
1086 - gc_dc.cpp
1087 - More tests added to both validation and benchmarking suites.
1088
Gian Marcoff850932017-12-11 12:37:17 +00001089v17.12 Public major release
1090 - Most machine learning functions on OpenCL support the new data type QASYMM8
1091 - Introduced logging interface
1092 - Introduced opencl timer
1093 - Reworked GEMMLowp interface
1094 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
1095 - Added validation method for most Machine Learning kernels / functions
1096 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
1097 - Added sgemm example for OpenCL
1098 - Added absolute difference example for GLES compute
1099 - Added new tests and benchmarks in validation and benchmark frameworks
1100 - Added new kernels / functions for GLES compute
1101
1102 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001103 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
1104 - @ref GCActivationLayerKernel / @ref GCActivationLayer
1105 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
1106 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +01001107 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001108 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
1109 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
1110 - @ref GCFillBorderKernel / @ref GCFillBorder
1111 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
1112 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
1113 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
1114 - @ref GCIm2ColKernel
1115 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
1116 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
1117 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
1118 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
1119 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +00001120
1121 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +00001122 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
1123 - arm_compute::NEHGEMMAArch64FP16Kernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +01001124 - NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001125 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
1126 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001127 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +00001128
1129 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001130 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
Michele Di Giorgioba14c922020-10-12 13:27:57 +01001131 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +00001132
1133 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001134 - graph::BranchLayer
1135 - graph::DepthConvertLayer
1136 - graph::DepthwiseConvolutionLayer
1137 - graph::DequantizationLayer
1138 - graph::FlattenLayer
1139 - graph::QuantizationLayer
1140 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +00001141
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001142v17.10 Public maintenance release
1143 - Bug fixes:
1144 - Check the maximum local workgroup size supported by OpenCL devices
1145 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +00001146 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001147 - Added a few new Graph nodes, support for branches and grouping.
1148 - Automatically enable cl_printf in debug builds
1149 - Fixed bare metal builds for armv7a
1150 - Added AlexNet and cartoon effect examples
1151 - 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)
1152
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001153v17.09 Public major release
1154 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +00001155 - 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 +01001156 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
1157 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
1158 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +00001159 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001160 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
1161 - @ref NEFloorKernel / @ref NEFloor
1162 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
1163 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
1164 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
1165 - @ref NEReductionOperationKernel / @ref NEReductionOperation
1166 - @ref NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001167
1168 - New OpenCL kernels / functions:
Manuel Bottini387259a2020-05-21 17:14:36 +01001169 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001170 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
1171 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
1172 - @ref CLFlattenLayer
1173 - @ref CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001174 - CLGEMMTranspose1xW
Anthony Barbier3762e742018-03-02 11:49:33 +00001175 - @ref CLGEMMMatrixVectorMultiplyKernel
1176 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
1177 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
1178 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
1179 - @ref CLReductionOperationKernel / @ref CLReductionOperation
1180 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001181
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001182v17.06 Public major release
1183 - Various bug fixes
1184 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
1185 - Added unit tests and benchmarks (AlexNet, LeNet)
1186 - Added support for sub tensors.
1187 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +00001188 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
1189 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
1190 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001191 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001192 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +01001193 - @ref CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001194 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
1195 - @ref CLLocallyConnectedMatrixMultiplyKernel / @ref CLLocallyConnectedLayer
1196 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001197 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001198 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001199 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001200 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +01001201 - @ref NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001202 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
1203 - @ref NELocallyConnectedMatrixMultiplyKernel / @ref NELocallyConnectedLayer
1204 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001205
1206v17.05 Public bug fixes release
1207 - Various bug fixes
1208 - Remaining of the functions ported to use accurate padding.
1209 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
1210 - Added "free" method to allocator.
1211 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
1212
1213v17.04 Public bug fixes release
1214
1215 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +00001216 - @ref CLColorConvertKernel
1217 - @ref CLEdgeNonMaxSuppressionKernel
1218 - @ref CLEdgeTraceKernel
1219 - @ref CLGaussianPyramidHorKernel
1220 - @ref CLGaussianPyramidVertKernel
1221 - @ref CLGradientKernel
1222 - @ref NEChannelCombineKernel
1223 - @ref NEFillArrayKernel
1224 - @ref NEGaussianPyramidHorKernel
1225 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +01001226 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001227 - @ref NEHarrisScoreKernel
1228 - @ref NEHOGDetectorKernel
1229 - @ref NELogits1DMaxKernel
1230 - NELogits1DShiftExpSumKernel
1231 - NELogits1DNormKernel
1232 - @ref NENonMaximaSuppression3x3FP16Kernel
1233 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001234
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001235v17.03.1 First Major public release of the sources
1236 - Renamed the library to arm_compute
1237 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
1238 - New padding calculation interface introduced and ported most kernels / functions to use it.
1239 - New OpenCL kernels / functions:
Gian Marco Iodiceeb65f6d2020-04-15 11:42:15 +01001240 - CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001241 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001242 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
1243 - @ref NETransposeKernel / @ref NETranspose
1244 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
1245 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +01001246 - NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001247 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001248
1249v17.03 Sources preview
1250 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001251 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001252 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001253 - CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001254 - @ref CLTransposeKernel / @ref CLTranspose
1255 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
1256 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
1257 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001258 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001259 - @ref NEActivationLayerKernel / @ref NEActivationLayer
1260 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
1261 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001262
1263v17.02.1 Sources preview
1264 - New OpenCL kernels / functions:
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001265 - CLLogits1DMaxKernel, CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001266 - @ref CLPoolingLayerKernel / @ref CLPoolingLayer
1267 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
1268 - @ref CLRemapKernel / @ref CLRemap
1269 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
1270 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
1271 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001272 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +00001273 - @ref NEAccumulateWeightedFP16Kernel
1274 - @ref NEBox3x3FP16Kernel
1275 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001276
1277v17.02 Sources preview
1278 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001279 - @ref CLActivationLayerKernel / @ref CLActivationLayer
1280 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1281 - @ref CLDerivativeKernel / @ref CLChannelExtract
1282 - @ref CLFastCornersKernel / @ref CLFastCorners
1283 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001284 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001285 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1286 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001287 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1288 - Switched all the kernels / functions to use tensors instead of images.
1289 - Updated documentation to include instructions to build the library from sources.
1290
1291v16.12 Binary preview release
1292 - Original release
1293
1294@section S3_how_to_build How to build the library and the examples
1295
1296@subsection S3_1_build_options Build options
1297
1298scons 2.3 or above is required to build the library.
1299To see the build options available simply run ```scons -h```:
1300
Anthony Barbier79c61782017-06-23 11:48:24 +01001301 debug: Debug (yes|no)
1302 default: False
1303 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001304
Anthony Barbier79c61782017-06-23 11:48:24 +01001305 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1306 default: False
1307 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001308
Anthony Barbier79c61782017-06-23 11:48:24 +01001309 arch: Target Architecture (armv7a|arm64-v8a|arm64-v8.2-a|x86_32|x86_64)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001310 default: armv7a
1311 actual: armv7a
1312
Anthony Barbier79c61782017-06-23 11:48:24 +01001313 os: Target OS (linux|android|bare_metal)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001314 default: linux
1315 actual: linux
1316
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001317 build: Build type (native|cross_compile|embed_only)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001318 default: cross_compile
1319 actual: cross_compile
1320
Anthony Barbier79c61782017-06-23 11:48:24 +01001321 examples: Build example programs (yes|no)
1322 default: True
1323 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001324
Anthony Barbier79c61782017-06-23 11:48:24 +01001325 Werror: Enable/disable the -Werror compilation flag (yes|no)
1326 default: True
1327 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001328
Anthony Barbier79c61782017-06-23 11:48:24 +01001329 opencl: Enable OpenCL support (yes|no)
1330 default: True
1331 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001332
Anthony Barbier79c61782017-06-23 11:48:24 +01001333 neon: Enable Neon support (yes|no)
1334 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001335 actual: False
1336
Anthony Barbier20dbb822017-12-13 21:19:39 +00001337 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1338 default: False
1339 actual: False
1340
1341 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shader in library binary (yes|no)
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001342 default: True
1343 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001344
1345 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1346 default: False
1347 actual: False
1348
1349 openmp: Enable OpenMP backend (yes|no)
1350 default: False
1351 actual: False
1352
1353 cppthreads: Enable C++11 threads backend (yes|no)
1354 default: True
1355 actual: True
1356
1357 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1358 default: .
1359 actual: .
1360
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001361 extra_cxx_flags: Extra CXX flags to be appended to the build command
1362 default:
1363 actual:
1364
Anthony Barbier79c61782017-06-23 11:48:24 +01001365 pmu: Enable PMU counters (yes|no)
1366 default: False
1367 actual: False
1368
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001369 mali: Enable Mali hardware counters (yes|no)
1370 default: False
1371 actual: False
1372
Anthony Barbier79c61782017-06-23 11:48:24 +01001373 validation_tests: Build validation test programs (yes|no)
1374 default: False
1375 actual: False
1376
1377 benchmark_tests: Build benchmark test programs (yes|no)
1378 default: False
1379 actual: False
1380
1381@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001382 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1383 - 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)
1384 - 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).
1385
Anthony Barbier79c61782017-06-23 11:48:24 +01001386@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 +01001387
Anthony Barbier79c61782017-06-23 11:48:24 +01001388@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001389@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1390
Anthony Barbier79c61782017-06-23 11:48:24 +01001391@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 +01001392
Anthony Barbier79c61782017-06-23 11:48:24 +01001393@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 +01001394
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001395There is also an 'embed_only' option which will generate all the .embed files for the OpenCL kernels and / or OpenGLES compute shaders. This might be useful if using a different build system to compile the library.
1396
Anthony Barbier79c61782017-06-23 11:48:24 +01001397@b Werror: If you are compiling using the same toolchains as the ones used in this guide then there shouldn't be any warning and therefore you should be able to keep Werror=1. If with a different compiler version the library fails to build because of warnings interpreted as errors then, if you are sure the warnings are not important, you might want to try to build with Werror=0 (But please do report the issue either on Github or by an email to developer@arm.com so that the issue can be addressed).
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001398
Anthony Barbier20dbb822017-12-13 21:19:39 +00001399@b opencl / @b neon / @b gles_compute: Choose which SIMD technology you want to target. (NEON for ARM Cortex-A CPUs or OpenCL / GLES_COMPUTE for ARM Mali GPUs)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001400
Anthony Barbier20dbb822017-12-13 21:19:39 +00001401@b embed_kernels: For OpenCL / GLES_COMPUTE only: set embed_kernels=1 if you want the OpenCL / GLES_COMPUTE kernels to be built in the library's binaries instead of being read from separate ".cl" / ".cs" files. If embed_kernels is set to 0 then the application can set the path to the folder containing the OpenCL / GLES_COMPUTE kernel files by calling CLKernelLibrary::init() / GCKernelLibrary::init(). By default the path is set to "./cl_kernels" / "./cs_shaders".
Anthony Barbier79c61782017-06-23 11:48:24 +01001402
1403@b set_soname: Do you want to build the versioned version of the library ?
1404
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001405If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1406Example:
1407 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1408 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1409 libarm_compute_core.so.1.0.0
1410
1411@note This options is disabled by default as it requires SCons version 2.4 or above.
1412
Anthony Barbier79c61782017-06-23 11:48:24 +01001413@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1414
1415@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1416
1417@b examples: Build or not the examples
1418
1419@b validation_tests: Enable the build of the validation suite.
1420
Anthony Barbier79c61782017-06-23 11:48:24 +01001421@b benchmark_tests: Enable the build of the benchmark tests
1422
1423@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1424
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001425@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)
1426
Anthony Barbier79c61782017-06-23 11:48:24 +01001427@b openmp Build in the OpenMP scheduler for NEON.
1428
1429@note Only works when building with g++ not clang++
1430
1431@b cppthreads Build in the C++11 scheduler for NEON.
1432
Anthony Barbier3762e742018-03-02 11:49:33 +00001433@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001434
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001435@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001436
1437@subsubsection S3_2_1_library How to build the library ?
1438
1439For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1440
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001441 - gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
1442 - gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001443
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001444To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1445
1446 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1447
1448To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1449
1450 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1451
Anthony Barbier20dbb822017-12-13 21:19:39 +00001452To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1453
1454 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1455
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001456You can also compile the library natively on an ARM device by using <b>build=native</b>:
1457
1458 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1459 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1460
1461@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.
1462
1463For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1464
1465 apt-get install g++-arm-linux-gnueabihf
1466
1467Then run
1468
1469 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1470
1471or simply remove the build parameter as build=cross_compile is the default value:
1472
1473 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1474
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001475@subsubsection S3_2_2_examples How to manually build the examples ?
1476
1477The 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.
1478
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001479@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 +01001480
1481To cross compile a NEON example for Linux 32bit:
1482
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001483 arm-linux-gnueabihf-g++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -mfpu=neon -L. -larm_compute -larm_compute_core -o neon_convolution
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001484
1485To cross compile a NEON example for Linux 64bit:
1486
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001487 aarch64-linux-gnu-g++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -L. -larm_compute -larm_compute_core -o neon_convolution
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001488
1489(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)
1490
1491To cross compile an OpenCL example for Linux 32bit:
1492
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001493 arm-linux-gnueabihf-g++ examples/cl_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -mfpu=neon -L. -larm_compute -larm_compute_core -o cl_convolution -DARM_COMPUTE_CL
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001494
1495To cross compile an OpenCL example for Linux 64bit:
1496
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001497 aarch64-linux-gnu-g++ examples/cl_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -L. -larm_compute -larm_compute_core -o cl_convolution -DARM_COMPUTE_CL
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001498
Anthony Barbier14c86a92017-12-14 16:27:41 +00001499To cross compile a GLES example for Linux 32bit:
1500
1501 arm-linux-gnueabihf-g++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude/ -L. -larm_compute -larm_compute_core -std=c++11 -mfpu=neon -DARM_COMPUTE_GC -Iinclude/linux/ -o gc_absdiff
1502
1503To cross compile a GLES example for Linux 64bit:
1504
1505 aarch64-linux-gnu-g++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude/ -L. -larm_compute -larm_compute_core -std=c++11 -DARM_COMPUTE_GC -Iinclude/linux/ -o gc_absdiff
1506
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001507(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)
1508
Anthony Barbier14c86a92017-12-14 16:27:41 +00001509To 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.
1510
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001511i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1512
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001513 arm-linux-gnueabihf-g++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++11 -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 +01001514
1515i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1516
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001517 aarch64-linux-gnu-g++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++11 -L. -larm_compute_graph -larm_compute -larm_compute_core -Wl,--allow-shlib-undefined -o graph_lenet
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001518
1519(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)
1520
Anthony Barbiere5007472017-10-27 15:01:44 +01001521@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1522
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001523To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1524
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001525 g++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -mfpu=neon -larm_compute -larm_compute_core -o neon_convolution
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001526
1527To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1528
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001529 g++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -larm_compute -larm_compute_core -o neon_convolution
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001530
1531(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1532
1533To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1534
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001535 g++ examples/cl_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -larm_compute -larm_compute_core -o cl_convolution -DARM_COMPUTE_CL
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001536
Anthony Barbier14c86a92017-12-14 16:27:41 +00001537To compile natively (i.e directly on an ARM device) for GLES for Linux 32bit or Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001538
Anthony Barbier14c86a92017-12-14 16:27:41 +00001539 g++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude/ -L. -larm_compute -larm_compute_core -std=c++11 -DARM_COMPUTE_GC -Iinclude/linux/ -o gc_absdiff
1540
1541To 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 +00001542
1543i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001544
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001545 g++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++11 -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 +01001546
Anthony Barbier14c86a92017-12-14 16:27:41 +00001547i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001548
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001549 g++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++11 -L. -larm_compute_graph -larm_compute -larm_compute_core -Wl,--allow-shlib-undefined -o graph_lenet
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001550
1551(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 +01001552
Anthony Barbiere5007472017-10-27 15:01:44 +01001553@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1554
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001555@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 +00001556@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 +01001557
1558To run the built executable simply run:
1559
1560 LD_LIBRARY_PATH=build ./neon_convolution
1561
1562or
1563
1564 LD_LIBRARY_PATH=build ./cl_convolution
1565
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001566@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 +00001567
1568For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001569
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001570 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001571
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001572Below is a list of the common parameters among the graph examples :
1573@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001574
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001575@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001576
1577For Android, the library was successfully built and tested using Google's standalone toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001578 - clang++ from NDK r18b for armv7a
1579 - clang++ from NDK r18b for arm64-v8a
1580 - clang++ from NDK r18b for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001581
1582Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1583
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001584- Download the NDK r18b from here: https://developer.android.com/ndk/downloads/index.html to directory $NDK
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001585- Make sure you have Python 2.7 installed on your machine.
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001586- 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 +01001587
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001588
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001589 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b --stl libc++ --api 21
1590 $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 +01001591
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001592@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 +01001593
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001594@note Make sure to add the toolchains to your PATH:
1595
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001596 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 +01001597
1598@subsubsection S3_3_1_library How to build the library ?
1599
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001600To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1601
1602 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1603
1604To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1605
Anthony Barbier14c86a92017-12-14 16:27:41 +00001606 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 +01001607
Anthony Barbier20dbb822017-12-13 21:19:39 +00001608To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1609
Anthony Barbier14c86a92017-12-14 16:27:41 +00001610 CXX=clang++ CC=clang scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=android arch=arm64-v8a
Anthony Barbier20dbb822017-12-13 21:19:39 +00001611
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001612@subsubsection S3_3_2_examples How to manually build the examples ?
1613
1614The 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.
1615
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001616@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 +01001617
1618Once you've got your Android standalone toolchain built and added to your path you can do the following:
1619
1620To cross compile a NEON example:
1621
1622 #32 bit:
Georgios Pinitas9873ea32017-12-05 15:28:55 +00001623 arm-linux-androideabi-clang++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -larm_compute-static -larm_compute_core-static -L. -o neon_convolution_arm -static-libstdc++ -pie
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001624 #64 bit:
Anthony Barbier14c86a92017-12-14 16:27:41 +00001625 aarch64-linux-android-clang++ examples/neon_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -larm_compute-static -larm_compute_core-static -L. -o neon_convolution_aarch64 -static-libstdc++ -pie
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001626
1627To cross compile an OpenCL example:
1628
1629 #32 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001630 arm-linux-androideabi-clang++ examples/cl_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -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 +01001631 #64 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001632 aarch64-linux-android-clang++ examples/cl_convolution.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -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 +00001633
1634To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001635
Anthony Barbier14c86a92017-12-14 16:27:41 +00001636 #32 bit:
1637 arm-linux-androideabi-clang++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -larm_compute-static -larm_compute_core-static -L. -o gc_absdiff_arm -static-libstdc++ -pie -DARM_COMPUTE_GC
1638 #64 bit:
1639 aarch64-linux-android-clang++ examples/gc_absdiff.cpp utils/Utils.cpp -I. -Iinclude -std=c++11 -larm_compute-static -larm_compute_core-static -L. -o gc_absdiff_aarch64 -static-libstdc++ -pie -DARM_COMPUTE_GC
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001640
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001641To 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 +01001642
1643 #32 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001644 arm-linux-androideabi-clang++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++11 -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 +01001645 #64 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001646 aarch64-linux-android-clang++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++11 -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 +01001647
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001648@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 +00001649@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 +01001650
1651Then you need to do is upload the executable and the shared library to the device using ADB:
1652
1653 adb push neon_convolution_arm /data/local/tmp/
1654 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001655 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001656 adb shell chmod 777 -R /data/local/tmp/
1657
1658And finally to run the example:
1659
1660 adb shell /data/local/tmp/neon_convolution_arm
1661 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001662 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001663
1664For 64bit:
1665
1666 adb push neon_convolution_aarch64 /data/local/tmp/
1667 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001668 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001669 adb shell chmod 777 -R /data/local/tmp/
1670
1671And finally to run the example:
1672
1673 adb shell /data/local/tmp/neon_convolution_aarch64
1674 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001675 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001676
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001677@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 +00001678
1679For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001680 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001681
1682In 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.
1683
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001684@subsection S3_4_bare_metal Building for bare metal
1685
Georgios Pinitas58216322020-02-26 11:13:13 +00001686For 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 +01001687 - arm-eabi for armv7a
1688 - aarch64-elf for arm64-v8a
1689
1690Download 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>.
1691
1692@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
1693
1694@subsubsection S3_4_1_library How to build the library ?
1695
1696To cross-compile the library with NEON support for baremetal arm64-v8a:
1697
1698 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
1699
1700@subsubsection S3_4_2_examples How to manually build the examples ?
1701
1702Examples 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>.
1703
1704@subsection S3_5_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001705
1706Using `scons` directly from the Windows command line is known to cause
1707problems. The reason seems to be that if `scons` is setup for cross-compilation
1708it gets confused about Windows style paths (using backslashes). Thus it is
1709recommended to follow one of the options outlined below.
1710
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001711@subsubsection S3_5_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001712
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001713The best and easiest option is to use
1714<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001715This feature is still marked as *beta* and thus might not be available.
1716However, if it is building the library is as simple as opening a *Bash on
1717Ubuntu on Windows* shell and following the general guidelines given above.
1718
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001719@subsubsection S3_5_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001720
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001721If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001722can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1723to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001724also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001725code of the library.) Linaro provides pre-built versions of
1726<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001727that can be used from the Cygwin terminal. When building for Android the
1728compiler is included in the Android standalone toolchain. After everything has
1729been set up in the Cygwin terminal the general guide on building the library
1730can be followed.
1731
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001732@subsection S3_6_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001733
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001734@subsubsection S3_6_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001735
1736Compute 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).
1737
1738Enabling 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.
1739
1740Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1741
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001742@subsubsection S3_6_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001743
1744Integer 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.
1745
1746OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1747
1748SVM 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 +01001749
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001750@subsection S3_7_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001751
1752The 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).
1753The 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 +01001754The 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 +01001755In 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.
1756
1757If 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:
1758
1759https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1760
1761Tuning 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.
1762
1763CLTuner 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.
1764
1765 #Example: 2 unique Matrix Multiply configurations
1766@code{.cpp}
1767 TensorShape a0 = TensorShape(32,32);
1768 TensorShape b0 = TensorShape(32,32);
1769 TensorShape c0 = TensorShape(32,32);
1770 TensorShape a1 = TensorShape(64,64);
1771 TensorShape b1 = TensorShape(64,64);
1772 TensorShape c1 = TensorShape(64,64);
1773
1774 Tensor a0_tensor;
1775 Tensor b0_tensor;
1776 Tensor c0_tensor;
1777 Tensor a1_tensor;
1778 Tensor b1_tensor;
1779 Tensor c1_tensor;
1780
1781 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1782 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1783 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1784 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1785 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1786 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1787
1788 CLGEMM gemm0;
1789 CLGEMM gemm1;
1790
1791 // Configuration 0
1792 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1793
1794 // Configuration 1
1795 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1796@endcode
1797
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001798@subsubsection S3_7_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001799
Michele Di Giorgio57f30a92020-09-08 14:03:51 +01001800All 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 +01001801
1802 #Enable CL tuner
1803 ./graph_mobilenet --enable-tuner –-target=CL
1804 ./arm_compute_benchmark --enable-tuner
1805
1806 #Export/Import to/from a file
1807 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1808 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1809
1810If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1811
1812Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1813
1814 -# Disable the power management
1815 -# Keep the GPU frequency constant
1816 -# Run multiple times the network (i.e. 10).
1817
1818If 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.
1819
1820@code{.cpp}
1821CLTuner tuner;
1822
1823// Setup Scheduler
1824CLScheduler::get().default_init(&tuner);
1825@endcode
1826
1827After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1828- tuner.save_to_file("results.csv");
1829
1830This file can be also imported using the method "load_from_file("results.csv")".
1831- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001832*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001833} // namespace arm_compute