blob: 24e119c277cb2c78bee0370ed2f1eaa15e13ea14 [file] [log] [blame]
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00001///
SiCong Lice80c552019-11-21 18:22:38 +00002/// Copyright (c) 2017-2019 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:
Isabella Gottardibe2de402018-11-21 15:23:49 +000052 - Linux armv7a: gcc-linaro-4.9-2016.02-x86_64_arm-linux-gnueabihf
Anthony Barbier14c86a92017-12-14 16:27:41 +000053 - Linux arm64-v8a: gcc-linaro-4.9-2016.02-x86_64_aarch64-linux-gnu
Anthony Barbierd51ea0a2018-08-07 17:48:03 +010054 - Android armv7a: clang++ / libc++ NDK r17b
55 - Android am64-v8a: clang++ / libc++ NDK r17b
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
72You should have the following file organisation:
73
74 .
75 ├── arm_compute --> All the arm_compute headers
Georgios Pinitasf112ede2019-03-01 19:11:20 +000076 │ ├── graph.h --> Includes all the Graph headers at once.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010077 │   ├── core
78 │   │   ├── CL
Anthony Barbier6a5627a2017-09-26 14:42:02 +010079 │   │   │   ├── CLKernelLibrary.h --> Manages all the OpenCL kernels compilation and caching, provides accessors for the OpenCL Context.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010080 │   │   │   ├── CLKernels.h --> Includes all the OpenCL kernels at once
81 │   │   │   ├── CL specialisation of all the generic objects interfaces (ICLTensor, ICLImage, etc.)
82 │   │   │   ├── kernels --> Folder containing all the OpenCL kernels
83 │   │   │   │   └── CL*Kernel.h
84 │   │   │   └── OpenCL.h --> Wrapper to configure the Khronos OpenCL C++ header
85 │   │ ├── CPP
Anthony Barbier6a5627a2017-09-26 14:42:02 +010086 │   │   │   ├── CPPKernels.h --> Includes all the CPP kernels at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +010087 │   │ │   └── kernels --> Folder containing all the CPP kernels
Anthony Barbier6a5627a2017-09-26 14:42:02 +010088 │   │   │      └── CPP*Kernel.h
Anthony Barbier20dbb822017-12-13 21:19:39 +000089 │   │   ├── GLES_COMPUTE
90 │   │   │   ├── GCKernelLibrary.h --> Manages all the GLES kernels compilation and caching, provides accessors for the GLES Context.
91 │   │   │   ├── GCKernels.h --> Includes all the GLES kernels at once
92 │   │   │   ├── GLES specialisation of all the generic objects interfaces (IGCTensor, IGCImage, etc.)
93 │   │   │   ├── kernels --> Folder containing all the GLES kernels
94 │   │   │   │   └── GC*Kernel.h
95 │   │   │   └── OpenGLES.h --> Wrapper to configure the Khronos EGL and OpenGL ES C header
Anthony Barbier6ff3b192017-09-04 18:44:23 +010096 │   │   ├── NEON
97 │   │   │   ├── kernels --> Folder containing all the NEON kernels
Anthony Barbier38e7f1f2018-05-21 13:37:47 +010098 │   │   │   │ ├── assembly --> headers for assembly optimised NEON kernels.
99 │   │   │   │ ├── convolution --> headers for convolution assembly optimised NEON kernels.
100 │   │   │   │   │   ├── common --> headers for code which is common to several convolution implementations.
101 │   │   │   │   │   ├── depthwise --> headers for Depthwise convolultion assembly implementation
102 │   │   │   │   │   └── winograd --> headers for Winograd convolution assembly implementation
103 │   │   │   │ ├── detail --> Common code for several intrinsics implementations.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100104 │   │   │   │   └── NE*Kernel.h
105 │   │   │   └── NEKernels.h --> Includes all the NEON kernels at once
106 │   │   ├── All common basic types (Types.h, Window, Coordinates, Iterator, etc.)
107 │   │   ├── All generic objects interfaces (ITensor, IImage, etc.)
108 │   │   └── Objects metadata classes (ImageInfo, TensorInfo, MultiImageInfo)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100109 │   ├── graph
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100110 │   │   ├── algorithms
111 │   │   │   └── Generic algorithms used by the graph backend (e.g Order of traversal)
112 │   │   ├── backends --> The backend specific code
113 │   │   │   ├── CL --> OpenCL specific operations
114 │   │   │   ├── GLES --> OpenGLES Compute Shaders specific operations
115 │   │   │   └── NEON --> NEON specific operations
116 │   │   ├── detail
117 │   │   │   └── Collection of internal utilities.
118 │   │   ├── frontend
119 │   │   │   └── Code related to the stream frontend interface.
120 │   │   ├── mutators
121 │   │   │   └── Used to modify / optimise the Graph intermediate representation(Operator fusion, in place operations, etc.)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100122 │   │   ├── nodes
123 │   │   │   └── The various nodes supported by the graph API
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100124 │   │   ├── printers
125 │   │   │   └── Debug printers
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100126 │   │   └── Graph objects ( INode, ITensorAccessor, Graph, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100127 │   └── runtime
128 │   ├── CL
129 │   │   ├── CL objects & allocators (CLArray, CLImage, CLTensor, etc.)
130 │   │   ├── functions --> Folder containing all the OpenCL functions
131 │   │   │   └── CL*.h
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100132 │   │   ├── CLScheduler.h --> Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100133 │   │   ├── CLFunctions.h --> Includes all the OpenCL functions at once
134 │   │   └── tuners
135 │   │      └── Local workgroup size tuners for specific architectures / GPUs
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100136 │   ├── CPP
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100137 │      │   ├── CPPKernels.h --> Includes all the CPP functions at once.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100138 │   │   ├── CPPScheduler.h --> Basic pool of threads to execute CPP/NEON code on several cores in parallel
139 │   │   └── functions --> Folder containing all the CPP functions
140 │   │      └── CPP*.h
Anthony Barbier20dbb822017-12-13 21:19:39 +0000141 │   ├── GLES_COMPUTE
142 │   │   ├── GLES objects & allocators (GCArray, GCImage, GCTensor, etc.)
143 │   │   ├── functions --> Folder containing all the GLES functions
144 │   │   │   └── GC*.h
145 │   │   ├── GCScheduler.h --> Interface to enqueue GLES kernels and get/set the GLES CommandQueue.
146 │   │   └── GCFunctions.h --> Includes all the GLES functions at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100147 │   ├── NEON
148 │   │ ├── functions --> Folder containing all the NEON functions
149 │   │ │   └── NE*.h
150 │   │ └── NEFunctions.h --> Includes all the NEON functions at once
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100151 │   ├── OMP
152 │   │   └── OMPScheduler.h --> OpenMP scheduler (Alternative to the CPPScheduler)
153 │ ├── Memory manager files (LifetimeManager, PoolManager, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100154 │   └── Basic implementations of the generic object interfaces (Array, Image, Tensor, etc.)
Anthony Barbiera8a28f62018-02-26 19:16:32 +0000155 ├── data -> Contains test images and reference data dumps used by validation tests
156 ├── docs -> Contains Doxyfile and Doxygen sources used to generate the HTML pages in the documentation folder.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100157 ├── documentation
158 │   ├── index.xhtml
159 │   └── ...
160 ├── documentation.xhtml -> documentation/index.xhtml
161 ├── examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000162 │   ├── cl_*.cpp --> OpenCL examples
Anthony Barbier14c86a92017-12-14 16:27:41 +0000163 │   ├── gc_*.cpp --> GLES compute shaders examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000164 │   ├── graph_*.cpp --> Graph examples
165 │   ├── neoncl_*.cpp --> NEON / OpenCL interoperability examples
166 │   └── neon_*.cpp --> NEON examples
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100167 ├── include
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100168 │   ├── CL
169 │   │ └── Khronos OpenCL C headers and C++ wrapper
170 │   ├── half --> FP16 library available from http://half.sourceforge.net
Anthony Barbier14c86a92017-12-14 16:27:41 +0000171 │   ├── libnpy --> Library to load / write npy buffers, available from https://github.com/llohse/libnpy
172 │  └── linux --> Headers only needed for Linux builds
173 │   └── Khronos EGL and OpenGLES headers
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100174 ├── opencl-1.2-stubs
Anthony Barbier14c86a92017-12-14 16:27:41 +0000175 │ └── opencl_stubs.c --> OpenCL stubs implementation
176 ├── opengles-3.1-stubs
177 │   ├── EGL.c --> EGL stubs implementation
178 │   └── GLESv2.c --> GLESv2 stubs implementation
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100179 ├── scripts
180 │   ├── caffe_data_extractor.py --> Basic script to export weights from Caffe to npy files
181 │   └── tensorflow_data_extractor.py --> Basic script to export weights from Tensor Flow to npy files
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100182 ├── src
183 │   ├── core
184 │ │ └── ... (Same structure as headers)
Anthony Barbier20dbb822017-12-13 21:19:39 +0000185 │   │ ├── CL
186 │   │ │ └── cl_kernels --> All the OpenCL kernels
187 │   │ └── GLES_COMPUTE
188 │   │ └── cs_shaders --> All the OpenGL ES Compute Shaders
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100189 │   ├── graph
190 │ │ └── ... (Same structure as headers)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100191 │ └── runtime
192 │ └── ... (Same structure as headers)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100193 ├── support
194 │ └── Various headers to work around toolchains / platform issues.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100195 ├── tests
196 │   ├── All test related files shared between validation and benchmark
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100197 │   ├── benchmark --> Sources for benchmarking
198 │ │ ├── Benchmark specific files
199 │   │ ├── fixtures
200 │ │ │ └── Backend agnostic fixtures to initialise and run the functions to test.
201 │ │ ├── CL --> OpenCL benchmarking tests
202 │ │ ├── GLES_COMPUTE --> GLES benchmarking tests
203 │ │ └── NEON --> NEON benchmarking tests
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100204 │   ├── CL --> OpenCL accessors
Anthony Barbier20dbb822017-12-13 21:19:39 +0000205 │   ├── GLES_COMPUTE --> GLES accessors
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100206 │   ├── NEON --> NEON accessors
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100207 │   ├── datasets
208 │ │ └── Datasets for all the validation / benchmark tests, layer configurations for various networks, etc.
209 │   ├── framework
210 │ │ └── Boiler plate code for both validation and benchmark test suites (Command line parsers, instruments, output loggers, etc.)
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100211 │   └── validation --> Sources for validation
212 │ ├── Validation specific files
213 │   ├── fixtures
214 │ │ └── Backend agnostic fixtures to initialise and run the functions to test.
215 │   ├── reference
216 │ │ └── Reference implementation used to validate the results of the various backends.
217 │ ├── CL --> OpenCL validation tests
218 │ ├── GLES_COMPUTE --> GLES validation tests
219 │ ├── CPP --> C++ reference implementations
220 │ └── NEON --> NEON validation tests
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100221 └── utils --> Boiler plate code used by examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000222 └── Various utilities to print types, load / store assets, etc.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100223
224@section S2_versions_changelog Release versions and changelog
225
226@subsection S2_1_versions Release versions
227
228All releases are numbered vYY.MM Where YY are the last two digits of the year, and MM the month number.
229If there is more than one release in a month then an extra sequential number is appended at the end:
230
231 v17.03 (First release of March 2017)
232 v17.03.1 (Second release of March 2017)
233 v17.04 (First release of April 2017)
234
235@note We're aiming at releasing one major public release with new features per quarter. All releases in between will only contain bug fixes.
236
237@subsection S2_2_changelog Changelog
238
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100239v19.11 Public major release
SiCong Li407c1022019-11-25 19:15:56 +0000240 - Various bug fixes.
241 - Various optimisations.
242 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100243 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
244 - CLDepthwiseIm2ColKernel
SiCong Li407c1022019-11-25 19:15:56 +0000245 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100246 - CLDepthwiseVectorToTensorKernel
247 - CLDirectConvolutionLayerOutputStageKernel
SiCong Li407c1022019-11-25 19:15:56 +0000248 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100249 - NEDepthwiseWeightsReshapeKernel
250 - NEDepthwiseIm2ColKernel
SiCong Li407c1022019-11-25 19:15:56 +0000251 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100252 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100253 - NEDepthwiseConvolutionLayer3x3
SiCong Li407c1022019-11-25 19:15:56 +0000254 - New OpenCL kernels / functions:
255 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
256 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
257 OpenCL kernels / functions)
258 - @ref CLLogSoftmaxLayer
259 - New NEON kernels / functions:
260 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
261 - @ref NEComputeAllAnchorsKernel / @ref NEComputeAllAnchors
262 - @ref NEDetectionPostProcessLayer
263 - @ref NEGenerateProposalsLayer
264 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
265 - @ref NELogSoftmaxLayer
266 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
267 - Added QASYMM8 support for:
268 - @ref CLGenerateProposalsLayer
269 - @ref CLROIAlignLayer
270 - @ref CPPBoxWithNonMaximaSuppressionLimit
271 - Added QASYMM16 support for:
272 - @ref CLBoundingBoxTransform
273 - Added FP16 support for:
274 - @ref CLGEMMMatrixMultiplyReshapedKernel
275 - Added new data type QASYMM8_PER_CHANNEL support for:
276 - @ref CLDequantizationLayer
277 - @ref NEDequantizationLayer
278 - Added new data type QSYMM8_PER_CHANNEL support for:
279 - @ref CLConvolutionLayer
280 - @ref NEConvolutionLayer
281 - @ref CLDepthwiseConvolutionLayer
282 - @ref NEDepthwiseConvolutionLayer
283 - Added FP16 mixed-precision support for:
284 - @ref CLGEMMMatrixMultiplyReshapedKernel
285 - @ref CLPoolingLayerKernel
286 - Added FP32 and FP16 ELU activation for:
287 - @ref CLActivationLayer
288 - @ref NEActivationLayer
289 - Added asymmetric padding support for:
290 - @ref CLDirectDeconvolutionLayer
291 - @ref CLGEMMDeconvolutionLayer
292 - @ref NEDeconvolutionLayer
293 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
294 - Replaced the calls to @ref NECopyKernel and @ref NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposals.
295 - Replaced the calls to @ref CLCopyKernel and @ref CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposals.
296 - Improved performance for CL Inception V3 - FP16.
297 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
298 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
299 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
300 - Optimized @ref CLPadLayer.
301 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
302 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100303
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100304v19.08 Public major release
305 - Various bug fixes.
306 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100307 - Deprecated NEON functions
308 - NEDepthConcatenateLayer
309 - NEWidthConcatenateLayer
310 - Deprecated OpenCL kernels / functions
311 - CLDepthConcatenateLayer
312 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
313 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
314 - CLWidthConcatenateLayer
315 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100316 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100317 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100318 - @ref NEElementwisePower
319 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100320 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100321 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100322 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100323 - @ref NESinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100324 - @ref NEBatchConcatenateLayerKernel
325 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
326 - @ref NEDepthwiseConvolutionLayerNativeKernel
327 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
328 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
329 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
330 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100331 - @ref CLAbsLayer
332 - @ref CLElementwisePower
333 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100334 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100335 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100336 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100337 - @ref CLSinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100338 - @ref CLBatchConcatenateLayerKernel
339 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
340 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
341 - @ref CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
342 - @ref CLGEMMMatrixMultiplyNativeKernel
343 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
344 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
345 - New examples:
346 - neon_opticalflow
347 - cl_cache
348 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100349 - Added support for FP16 in @ref NEDeconvolutionLayer
350 - Added support for FP16 in @ref CLDeconvolutionLayer
351 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100352 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
353 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
354 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
355 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
356 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
357 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini05069f02019-09-26 17:18:26 +0100358 - The @ref CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
359 - The @ref NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100360 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
361 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100362 - 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 +0100363
Michalis Spyroua9c44722019-04-05 17:18:36 +0100364v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100365 - Various bug fixes.
366 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100367 - New Neon kernels / functions:
368 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100369 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100370 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100371 - @ref NEDepthwiseConvolutionAssemblyDispatch
372 - @ref NEFFTDigitReverseKernel
373 - @ref NEFFTRadixStageKernel
374 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100375 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
376 - @ref NEHeightConcatenateLayerKernel
377 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100378 - @ref NEFFT1D
379 - @ref NEFFT2D
380 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100381 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100382 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100383 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100384 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100385 - @ref CLFFTDigitReverseKernel
386 - @ref CLFFTRadixStageKernel
387 - @ref CLFFTScaleKernel
388 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
389 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
390 - @ref CLHeightConcatenateLayerKernel
391 - @ref CLDirectDeconvolutionLayer
392 - @ref CLFFT1D
393 - @ref CLFFT2D
394 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100395 - @ref CLGEMMDeconvolutionLayer
396 - New OpenGLES kernels / functions:
397 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100398 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100399 - GCDepthConcatenateLayer
400 - NEWidthConcatenateLayer
401 - NEDepthConcatenateLayer
402 - CLWidthConcatenateLayer
403 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100404 - CLGEMMInterleave4x4
405 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100406 - Support different quantization info in CLConcatLayer.
407 - Add checks on different input/output quantization info were not supported.
408 - Tensors have different quantization information.
409 - Add FP16 support checks.
410 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
411 - New graph examples:
412 - graph_convolution
413 - graph_fully_connected
414 - graph_depthwise_convolution
415 - Deepspeech v0.4.1
416 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
417 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
418 - Add support for QASYMM8 NEDeconvolution.
419 - Add support for DequantizationLayer for NEON/CL.
420 - Add support for dilation in CLDepthwiseConvolution.
421 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
422 - Optimize CLDeconvolution.
423 - Add StackLayer to the graph API.
424 - Add support for "reflect" padding mode in NEPad.
425 - Winograd 7x7 NHWC on OpenCL.
426 - Rework CL ML layers to run exclusively on CL.
427 - Support different quantization info in PoolingLayer.
428 - Implement and test import memory interfaces.
429 - Added new tests and removed old ones.
430 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100431
giuros01a69a88b2019-01-31 16:29:19 +0000432v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000433 - Various bug fixes.
434 - Various optimisations.
435 - New Neon kernels / functions:
436 - @ref NETileKernel / @ref NETile
437 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
438 - @ref NEElementwiseOperationKernel
439 - @ref NEElementwiseMax
440 - @ref NEElementwiseMin
441 - @ref NEElementwiseSquaredDiff
442 - @ref NESelectKernel / @ref NESelect
443 - @ref NESplit
444 - @ref NESlice
445 - @ref NEUnstack
446 - @ref NEStridedSliceKernel / @ref NEStridedSlice
447 - @ref NEElementwiseUnaryKernel
448 - @ref NERsqrtLayer
449 - @ref NEExpLayer
450 - @ref NEReverseKernel / @ref NEReverse
451 - @ref NEArgMinMaxLayer
452 - @ref NEStackLayerKernel / @ref NEStackLayer
453 - @ref NERangeKernel / @ref NERange
454 - @ref NEPadLayer
455 - @ref NEMemsetKernel
456 - @ref NEGatherKernel / @ref NEGather
457 - @ref NEElementwiseComparison
458 - @ref NEElementwiseComparisonStatic
459 - @ref NEComparisonOperationKernel
460 - @ref NEElementwiseDivision
461 - New OpenCL kernels / functions:
462 - @ref CLSelectKernel / @ref CLSelect
463 - @ref CLTileKernel / @ref CLTile
464 - @ref CLComparisonKernel / @ref CLComparison
465 - @ref CLArgMinMaxLayer
466 - @ref CLElementwiseMax
467 - @ref CLElementwiseMin
468 - @ref CLElementwiseSquaredDiff
469 - @ref CLStackLayerKernel / @ref CLStackLayer
470 - @ref CLReverse / @ref CLReverseKernel
471 - @ref CLRsqrtLayer
472 - @ref CLExpLayer
473 - @ref CLElementWiseUnaryLayerKernel
474 - @ref CLGEMMReshapeLHSMatrixKernel
475 - @ref CLGEMMReshapeRHSMatrixKernel
476 - @ref CLGEMMMatrixMultiplyReshapedKernel
477 - @ref CLRangeKernel / @ref CLRange
478 - @ref CLUnstack
479 - @ref CLGatherKernel / @ref CLGather
480 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
481 - New CPP kernels / functions:
482 - @ref CPPDetectionOutputLayer
483 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000484 - Added new examples:
485 - graph_ssd_mobilenet.cpp
486 - graph_mobilenet_v2.cpp
487 - graph_resnet12.cpp
488 - graph_srcnn955.cpp
489 - graph_vgg_vdsr.cpp
490 - graph_inception_resnet_v1.cpp
491 - Add 4D tensors support to
492 - @ref NESoftmaxLayer
493 - Fused activation in @ref CLWinogradConvolutionLayer
494 - Extented @ref NEPermute to support more cases
495 - Added NEON/SVE GEMM Hybrid kernels
496 - Added u8 and s8 hybrid assembly kernels
497 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
498 - Improved @ref CLTuner
499 - Fused the bias addition within @ref CLGEMM
500 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
501 - Added NHWC data layout support to:
502 - @ref NEScale for F16
503 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
504 - @ref NEL2NormalizeLayer for FP32/FP16
505 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
506 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000507 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000508 - Added QASYMM8 support to the following kernels:
509 - @ref NEArithmeticAdditionKernel
510 - @ref NEScale
511 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000512 - Deprecated functions/interfaces
513 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
514
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000515v18.11 Public major release
516 - Various bug fixes.
517 - Various optimisations.
518 - New Neon kernels / functions:
519 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
520 - @ref NEReduceMean
521 - @ref NEReorgLayer / @ref NEReorgLayerKernel
522 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
523 - @ref NEUpsampleLayer / @ref NEUpsampleLayerKernel
524 - @ref NEYOLOLayer / @ref NEYOLOLayerKernel
525 - New OpenCL kernels / functions:
526 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
527 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000528 - @ref CLComputeAllAnchorsKernel
529 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000530 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
531 - @ref CLReorgLayer / @ref CLReorgLayerKernel
532 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
533 - @ref CLPadLayer
534 - @ref CLReduceMean
535 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
536 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
537 - @ref CLSlice
538 - @ref CLSplit
539 - @ref CLStridedSlice / @ref CLStridedSliceKernel
540 - @ref CLUpsampleLayer / @ref CLUpsampleLayerKernel
541 - @ref CLYOLOLayer / @ref CLYOLOLayerKernel
542 - New CPP kernels / functions:
543 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
544 - Added the validate method in:
545 - @ref NEDepthConvertLayer
546 - @ref NEFloor / @ref CLFloor
547 - @ref NEGEMMMatrixAdditionKernel
548 - @ref NEReshapeLayer / @ref CLReshapeLayer
549 - @ref CLScale
550 - Added new examples:
551 - graph_shufflenet.cpp
552 - graph_yolov3.cpp
553 - Added documentation for add a new function or kernel.
554 - Improved doxygen documentation adding a list of the existing functions.
555 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100556 - CLWidthConcatenateLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000557 - @ref CLFlattenLayer
558 - @ref CLSoftmaxLayer
559 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
560 - Add SVE support
561 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
562 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
563 - Added NHWC data layout support to:
564 - @ref CLChannelShuffleLayer
565 - @ref CLDeconvolutionLayer
566 - @ref CLL2NormalizeLayer
567 - Added QASYMM8 support to the following kernels:
568 - @ref CLScaleKernel
569 - @ref NEDepthwiseConvolutionLayer3x3Kernel
570 - @ref CLPixelWiseMultiplicationKernel
571 - Added FP16 support to the following kernels:
572 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
573 - @ref NEDepthwiseConvolutionLayer3x3Kernel
574 - @ref CLNormalizePlanarYUVLayerKernel
575 - @ref CLWinogradConvolutionLayer (5x5 kernel)
576 - More tests added to both validation and benchmarking suites.
577
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100578v18.08 Public major release
579 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100580 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100581 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100582 - Removed support for QS8/QS16 data types.
583 - Added support for grouped convolution in @ref CLConvolutionLayer.
584 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100585 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100586 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
587 - @ref CLDepthwiseConvolutionLayer
588 - @ref CLDirectConvolutionLayer
589 - @ref CLConvolutionLayer
590 - @ref CLScale
591 - @ref CLIm2ColKernel
592 - New Neon kernels / functions:
593 - @ref NERNNLayer
594 - New OpenCL kernels / functions:
595 - @ref CLArithmeticDivision
596 - Introduced prepare() stage support in the graph API for GLES.
597 - Added support for memory reusage when trying to allocate smaller CLTensors.
598 - Enabled NHWC execution on graph examples.
599 - Added JPEG accessor for validation purposes.
600 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100601
602v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100603 - Various bug fixes.
604 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000605 - Major redesign in the interface for the neon kernels implemented in assembly.
606 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
607 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
608 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100609 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
610 - Improved doxygen documentation.
611 - Improved memory management for layer's transitions.
612 - Added support for NHWC data layout in tensors.
613 - Added NHWC data layout support to:
614 - @ref NEGEMMConvolutionLayer
615 - @ref NEDirectConvolutionLayer
616 - @ref NEPoolingLayer / @ref CLPoolingLayer
617 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
618 - @ref NEDepthwiseConvolutionLayer
619 - @ref NEScale
620 - @ref NEIm2Col
621 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
622 - New OpenCL kernels / functions:
623 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
624 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
625 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100626 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100627 - @ref CLRNNLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100628 - CLWidthConcatenateLayer / @ref CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100629 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
630 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
631 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100632 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
633 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
634 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
635 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
636 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
637 - Port mobilenet example to NHWC data layout.
638 - Enabled Winograd method in @ref CLConvolutionLayer.
639 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
640 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
641 - Added memory manager support in GLES functions.
642 - Major refactoring of the graph API.
643 - Added GLES backend in the graph API.
644 - Added support for the memory manager in the graph API.
645 - Enabled Winograd Convolution method in the graph API.
646 - Added support for grouped convolutions in the graph API.
647 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
648 - Added fast maths flag in @ref CLConvolutionLayer.
649 - Added new tests and benchmarks in validation and benchmark frameworks
650 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
651 - Added support to OpenCL 2.0 SVM
652 - Added support to import memory in OpenCL tensors.
653 - Added the prepare() method to perform any one off pre-processing before running the function.
654 - Added new examples:
655 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100656 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100657 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000658
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000659v18.03 Public maintenance release
660 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +0000661 - Fixed bug in @ref NEActivationLayer
662 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000663 - Updated recommended NDK version to r16b (And fixed warnings).
664 - Fixed bug in validation code.
665 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100666 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000667
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000668v18.02 Public major release
669 - Various NEON / OpenCL / GLES optimisations.
670 - Various bug fixes.
671 - Changed default number of threads on big LITTLE systems.
672 - Refactored examples and added:
673 - graph_mobilenet_qassym8
674 - graph_resnet
675 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +0000676 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
677 - 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 +0000678 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000679 - @ref CLActivationLayer
680 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000681 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000682 - @ref CLActivationLayer
683 - @ref CLDepthwiseConvolutionLayer
684 - @ref NEDepthwiseConvolutionLayer
685 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000686 - Added FP16 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000687 - @ref CLDepthwiseConvolutionLayer3x3
688 - @ref CLDepthwiseConvolutionLayer
689 - Added broadcasting support to @ref NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
690 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
691 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000692 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100693 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +0000694 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000695 - Added name() method to all kernels.
696 - Added support for Winograd 5x5.
Anthony Barbier3762e742018-03-02 11:49:33 +0000697 - @ref NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100698 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
699 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
700 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +0100701 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000702 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000703 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +0000704
Anthony Barbier64c95a02018-01-22 18:48:55 +0000705v18.01 Public maintenance release
706 - Various bug fixes
707 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +0000708 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
709 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +0000710 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +0000711 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
712 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
713 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
714 - Added @ref GCScaleKernel / @ref GCScale
715 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +0000716 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000717 - @ref GCCol2ImKernel
718 - @ref GCGEMMInterleave4x4Kernel
719 - @ref GCGEMMTranspose1xWKernel
720 - @ref GCIm2ColKernel
721 - Refactored NEON Winograd (NEWinogradLayerKernel)
722 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000723 - Added QASYMM8 support to the following NEON kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000724 - @ref NEDepthwiseConvolutionLayer3x3Kernel
725 - @ref NEFillBorderKernel
726 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000727 - Added new examples:
728 - graph_cl_mobilenet_qasymm8.cpp
729 - graph_inception_v3.cpp
730 - gc_dc.cpp
731 - More tests added to both validation and benchmarking suites.
732
Gian Marcoff850932017-12-11 12:37:17 +0000733v17.12 Public major release
734 - Most machine learning functions on OpenCL support the new data type QASYMM8
735 - Introduced logging interface
736 - Introduced opencl timer
737 - Reworked GEMMLowp interface
738 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
739 - Added validation method for most Machine Learning kernels / functions
740 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
741 - Added sgemm example for OpenCL
742 - Added absolute difference example for GLES compute
743 - Added new tests and benchmarks in validation and benchmark frameworks
744 - Added new kernels / functions for GLES compute
745
746 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000747 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
748 - @ref GCActivationLayerKernel / @ref GCActivationLayer
749 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
750 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +0100751 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000752 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
753 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
754 - @ref GCFillBorderKernel / @ref GCFillBorder
755 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
756 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
757 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
758 - @ref GCIm2ColKernel
759 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
760 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
761 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
762 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
763 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +0000764
765 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +0000766 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
767 - arm_compute::NEHGEMMAArch64FP16Kernel
Giorgio Arenad93e2632019-10-15 11:09:33 +0100768 - @ref NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / @ref NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000769 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
770 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
771 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8Scale
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100772 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +0000773
774 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000775 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
776 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
777 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8Scale
Gian Marcoff850932017-12-11 12:37:17 +0000778
779 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +0100780 - graph::BranchLayer
781 - graph::DepthConvertLayer
782 - graph::DepthwiseConvolutionLayer
783 - graph::DequantizationLayer
784 - graph::FlattenLayer
785 - graph::QuantizationLayer
786 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +0000787
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100788v17.10 Public maintenance release
789 - Bug fixes:
790 - Check the maximum local workgroup size supported by OpenCL devices
791 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +0000792 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100793 - Added a few new Graph nodes, support for branches and grouping.
794 - Automatically enable cl_printf in debug builds
795 - Fixed bare metal builds for armv7a
796 - Added AlexNet and cartoon effect examples
797 - 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)
798
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100799v17.09 Public major release
800 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +0000801 - 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 +0100802 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
803 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
804 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +0000805 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000806 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
807 - @ref NEFloorKernel / @ref NEFloor
808 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
809 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
810 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
811 - @ref NEReductionOperationKernel / @ref NEReductionOperation
812 - @ref NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100813
814 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100815 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / @ref CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000816 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
817 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
818 - @ref CLFlattenLayer
819 - @ref CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100820 - CLGEMMTranspose1xW
Anthony Barbier3762e742018-03-02 11:49:33 +0000821 - @ref CLGEMMMatrixVectorMultiplyKernel
822 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
823 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
824 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
825 - @ref CLReductionOperationKernel / @ref CLReductionOperation
826 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100827
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100828v17.06 Public major release
829 - Various bug fixes
830 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
831 - Added unit tests and benchmarks (AlexNet, LeNet)
832 - Added support for sub tensors.
833 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +0000834 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
835 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
836 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100837 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000838 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100839 - @ref CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000840 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
841 - @ref CLLocallyConnectedMatrixMultiplyKernel / @ref CLLocallyConnectedLayer
842 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100843 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000844 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100845 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000846 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100847 - @ref NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000848 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
849 - @ref NELocallyConnectedMatrixMultiplyKernel / @ref NELocallyConnectedLayer
850 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100851
852v17.05 Public bug fixes release
853 - Various bug fixes
854 - Remaining of the functions ported to use accurate padding.
855 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
856 - Added "free" method to allocator.
857 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
858
859v17.04 Public bug fixes release
860
861 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +0000862 - @ref CLColorConvertKernel
863 - @ref CLEdgeNonMaxSuppressionKernel
864 - @ref CLEdgeTraceKernel
865 - @ref CLGaussianPyramidHorKernel
866 - @ref CLGaussianPyramidVertKernel
867 - @ref CLGradientKernel
868 - @ref NEChannelCombineKernel
869 - @ref NEFillArrayKernel
870 - @ref NEGaussianPyramidHorKernel
871 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +0100872 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000873 - @ref NEHarrisScoreKernel
874 - @ref NEHOGDetectorKernel
875 - @ref NELogits1DMaxKernel
876 - NELogits1DShiftExpSumKernel
877 - NELogits1DNormKernel
878 - @ref NENonMaximaSuppression3x3FP16Kernel
879 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100880
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100881v17.03.1 First Major public release of the sources
882 - Renamed the library to arm_compute
883 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
884 - New padding calculation interface introduced and ported most kernels / functions to use it.
885 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000886 - @ref CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100887 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000888 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
889 - @ref NETransposeKernel / @ref NETranspose
890 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
891 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
892 - @ref NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
893 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100894
895v17.03 Sources preview
896 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000897 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +0100898 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Anthony Barbier3762e742018-03-02 11:49:33 +0000899 - @ref CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
900 - @ref CLTransposeKernel / @ref CLTranspose
901 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
902 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
903 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100904 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000905 - @ref NEActivationLayerKernel / @ref NEActivationLayer
906 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
907 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100908
909v17.02.1 Sources preview
910 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000911 - @ref CLLogits1DMaxKernel, @ref CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
912 - @ref CLPoolingLayerKernel / @ref CLPoolingLayer
913 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
914 - @ref CLRemapKernel / @ref CLRemap
915 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
916 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
917 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100918 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +0000919 - @ref NEAccumulateWeightedFP16Kernel
920 - @ref NEBox3x3FP16Kernel
921 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100922
923v17.02 Sources preview
924 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000925 - @ref CLActivationLayerKernel / @ref CLActivationLayer
926 - @ref CLChannelCombineKernel / @ref CLChannelCombine
927 - @ref CLDerivativeKernel / @ref CLChannelExtract
928 - @ref CLFastCornersKernel / @ref CLFastCorners
929 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100930 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000931 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
932 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100933 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
934 - Switched all the kernels / functions to use tensors instead of images.
935 - Updated documentation to include instructions to build the library from sources.
936
937v16.12 Binary preview release
938 - Original release
939
940@section S3_how_to_build How to build the library and the examples
941
942@subsection S3_1_build_options Build options
943
944scons 2.3 or above is required to build the library.
945To see the build options available simply run ```scons -h```:
946
Anthony Barbier79c61782017-06-23 11:48:24 +0100947 debug: Debug (yes|no)
948 default: False
949 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100950
Anthony Barbier79c61782017-06-23 11:48:24 +0100951 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
952 default: False
953 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100954
Anthony Barbier79c61782017-06-23 11:48:24 +0100955 arch: Target Architecture (armv7a|arm64-v8a|arm64-v8.2-a|x86_32|x86_64)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100956 default: armv7a
957 actual: armv7a
958
Anthony Barbier79c61782017-06-23 11:48:24 +0100959 os: Target OS (linux|android|bare_metal)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100960 default: linux
961 actual: linux
962
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000963 build: Build type (native|cross_compile|embed_only)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100964 default: cross_compile
965 actual: cross_compile
966
Anthony Barbier79c61782017-06-23 11:48:24 +0100967 examples: Build example programs (yes|no)
968 default: True
969 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100970
Anthony Barbier79c61782017-06-23 11:48:24 +0100971 Werror: Enable/disable the -Werror compilation flag (yes|no)
972 default: True
973 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100974
Anthony Barbier79c61782017-06-23 11:48:24 +0100975 opencl: Enable OpenCL support (yes|no)
976 default: True
977 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100978
Anthony Barbier79c61782017-06-23 11:48:24 +0100979 neon: Enable Neon support (yes|no)
980 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100981 actual: False
982
Anthony Barbier20dbb822017-12-13 21:19:39 +0000983 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
984 default: False
985 actual: False
986
987 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shader in library binary (yes|no)
Anthony Barbiercc0a80b2017-12-15 11:37:29 +0000988 default: True
989 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +0100990
991 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
992 default: False
993 actual: False
994
995 openmp: Enable OpenMP backend (yes|no)
996 default: False
997 actual: False
998
999 cppthreads: Enable C++11 threads backend (yes|no)
1000 default: True
1001 actual: True
1002
1003 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1004 default: .
1005 actual: .
1006
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001007 extra_cxx_flags: Extra CXX flags to be appended to the build command
1008 default:
1009 actual:
1010
Anthony Barbier79c61782017-06-23 11:48:24 +01001011 pmu: Enable PMU counters (yes|no)
1012 default: False
1013 actual: False
1014
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001015 mali: Enable Mali hardware counters (yes|no)
1016 default: False
1017 actual: False
1018
Anthony Barbier79c61782017-06-23 11:48:24 +01001019 validation_tests: Build validation test programs (yes|no)
1020 default: False
1021 actual: False
1022
1023 benchmark_tests: Build benchmark test programs (yes|no)
1024 default: False
1025 actual: False
1026
1027@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001028 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1029 - 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)
1030 - 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).
1031
Anthony Barbier79c61782017-06-23 11:48:24 +01001032@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 +01001033
Anthony Barbier79c61782017-06-23 11:48:24 +01001034@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001035@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1036
Anthony Barbier79c61782017-06-23 11:48:24 +01001037@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 +01001038
Anthony Barbier79c61782017-06-23 11:48:24 +01001039@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 +01001040
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001041There 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.
1042
Anthony Barbier79c61782017-06-23 11:48:24 +01001043@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 +01001044
Anthony Barbier20dbb822017-12-13 21:19:39 +00001045@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 +01001046
Anthony Barbier20dbb822017-12-13 21:19:39 +00001047@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 +01001048
1049@b set_soname: Do you want to build the versioned version of the library ?
1050
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001051If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1052Example:
1053 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1054 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1055 libarm_compute_core.so.1.0.0
1056
1057@note This options is disabled by default as it requires SCons version 2.4 or above.
1058
Anthony Barbier79c61782017-06-23 11:48:24 +01001059@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1060
1061@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1062
1063@b examples: Build or not the examples
1064
1065@b validation_tests: Enable the build of the validation suite.
1066
Anthony Barbier79c61782017-06-23 11:48:24 +01001067@b benchmark_tests: Enable the build of the benchmark tests
1068
1069@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1070
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001071@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)
1072
Anthony Barbier79c61782017-06-23 11:48:24 +01001073@b openmp Build in the OpenMP scheduler for NEON.
1074
1075@note Only works when building with g++ not clang++
1076
1077@b cppthreads Build in the C++11 scheduler for NEON.
1078
Anthony Barbier3762e742018-03-02 11:49:33 +00001079@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001080
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001081@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001082
1083@subsubsection S3_2_1_library How to build the library ?
1084
1085For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1086
Michele Di Giorgio6513ccb2018-08-28 14:38:35 +01001087 - gcc-linaro-4.9-2016.02-x86_64_arm-linux-gnueabihf
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001088 - gcc-linaro-4.9-2016.02-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001089
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001090To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1091
1092 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1093
1094To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1095
1096 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1097
Anthony Barbier20dbb822017-12-13 21:19:39 +00001098To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1099
1100 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1101
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001102You can also compile the library natively on an ARM device by using <b>build=native</b>:
1103
1104 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1105 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1106
1107@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.
1108
1109For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1110
1111 apt-get install g++-arm-linux-gnueabihf
1112
1113Then run
1114
1115 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1116
1117or simply remove the build parameter as build=cross_compile is the default value:
1118
1119 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1120
1121@attention To cross compile with opencl=1 you need to make sure to have a version of libOpenCL matching your target architecture.
1122
1123@subsubsection S3_2_2_examples How to manually build the examples ?
1124
1125The 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.
1126
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001127@note The following command lines assume the arm_compute binaries 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 library 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 +01001128
1129To cross compile a NEON example for Linux 32bit:
1130
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001131 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 +01001132
1133To cross compile a NEON example for Linux 64bit:
1134
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001135 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 +01001136
1137(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)
1138
1139To cross compile an OpenCL example for Linux 32bit:
1140
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001141 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 +01001142
1143To cross compile an OpenCL example for Linux 64bit:
1144
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001145 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 +01001146
Anthony Barbier14c86a92017-12-14 16:27:41 +00001147To cross compile a GLES example for Linux 32bit:
1148
1149 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
1150
1151To cross compile a GLES example for Linux 64bit:
1152
1153 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
1154
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001155(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)
1156
Anthony Barbier14c86a92017-12-14 16:27:41 +00001157To 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.
1158
1159@note The compute library must currently be built with both neon and opencl enabled - neon=1 and opencl=1
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001160
1161i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1162
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001163 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 +01001164
1165i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1166
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001167 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 +01001168
1169(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)
1170
Anthony Barbiere5007472017-10-27 15:01:44 +01001171@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1172
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001173To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1174
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001175 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 +01001176
1177To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1178
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001179 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 +01001180
1181(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1182
1183To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1184
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001185 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 +01001186
Anthony Barbier14c86a92017-12-14 16:27:41 +00001187To 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 +01001188
Anthony Barbier14c86a92017-12-14 16:27:41 +00001189 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
1190
1191To 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.
1192@note The compute library must currently be built with both neon and opencl enabled - neon=1 and opencl=1
1193
1194i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001195
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001196 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 +01001197
Anthony Barbier14c86a92017-12-14 16:27:41 +00001198i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001199
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001200 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 +01001201
1202(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 +01001203
Anthony Barbiere5007472017-10-27 15:01:44 +01001204@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1205
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001206@note These two commands assume libarm_compute.so is available in your library path, if not add the path to it using -L
1207
1208To run the built executable simply run:
1209
1210 LD_LIBRARY_PATH=build ./neon_convolution
1211
1212or
1213
1214 LD_LIBRARY_PATH=build ./cl_convolution
1215
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001216@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 +00001217
1218For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001219
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001220 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001221
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001222Below is a list of the common parameters among the graph examples :
1223@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001224
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001225@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001226
1227For Android, the library was successfully built and tested using Google's standalone toolchains:
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001228 - clang++ from NDK r17b for armv7a
1229 - clang++ from NDK r17b for arm64-v8a
Anthony Barbier3a6163e2018-08-10 17:36:36 +01001230 - clang++ from NDK r18-beta1 for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001231
1232Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1233
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001234- Download the NDK r17b from here: https://developer.android.com/ndk/downloads/index.html
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001235- Make sure you have Python 2.7 installed on your machine.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001236- Generate the 32 and/or 64 toolchains by running the following commands:
1237
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001238
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001239 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r17b --stl libc++ --api 21
1240 $NDK/build/tools/make_standalone_toolchain.py --arch arm --install-dir $MY_TOOLCHAINS/arm-linux-android-ndk-r17b --stl libc++ --api 21
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001241
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001242@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 +01001243
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001244@note Make sure to add the toolchains to your PATH:
1245
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001246 export PATH=$PATH:$MY_TOOLCHAINS/aarch64-linux-android-ndk-r17b/bin:$MY_TOOLCHAINS/arm-linux-android-ndk-r17b/bin
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001247
1248@subsubsection S3_3_1_library How to build the library ?
1249
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001250To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1251
1252 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1253
1254To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1255
Anthony Barbier14c86a92017-12-14 16:27:41 +00001256 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 +01001257
Anthony Barbier20dbb822017-12-13 21:19:39 +00001258To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1259
Anthony Barbier14c86a92017-12-14 16:27:41 +00001260 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 +00001261
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001262@subsubsection S3_3_2_examples How to manually build the examples ?
1263
1264The 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.
1265
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001266@note The following command lines assume the arm_compute binaries 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 library 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 +01001267
1268Once you've got your Android standalone toolchain built and added to your path you can do the following:
1269
1270To cross compile a NEON example:
1271
1272 #32 bit:
Georgios Pinitas9873ea32017-12-05 15:28:55 +00001273 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 +01001274 #64 bit:
Anthony Barbier14c86a92017-12-14 16:27:41 +00001275 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 +01001276
1277To cross compile an OpenCL example:
1278
1279 #32 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001280 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 +01001281 #64 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001282 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 +00001283
1284To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001285
Anthony Barbier14c86a92017-12-14 16:27:41 +00001286 #32 bit:
1287 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
1288 #64 bit:
1289 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 +01001290
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001291To cross compile the examples with the Graph API, such as graph_lenet.cpp, you need to link the library arm_compute_graph also.
1292(notice the compute library has to be built with both neon and opencl enabled - neon=1 and opencl=1)
1293
1294 #32 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001295 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 +01001296 #64 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001297 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 +01001298
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001299@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 +00001300@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 +01001301
1302Then you need to do is upload the executable and the shared library to the device using ADB:
1303
1304 adb push neon_convolution_arm /data/local/tmp/
1305 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001306 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001307 adb shell chmod 777 -R /data/local/tmp/
1308
1309And finally to run the example:
1310
1311 adb shell /data/local/tmp/neon_convolution_arm
1312 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001313 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001314
1315For 64bit:
1316
1317 adb push neon_convolution_aarch64 /data/local/tmp/
1318 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001319 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001320 adb shell chmod 777 -R /data/local/tmp/
1321
1322And finally to run the example:
1323
1324 adb shell /data/local/tmp/neon_convolution_aarch64
1325 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001326 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001327
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001328@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 +00001329
1330For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001331 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001332
1333In 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.
1334
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001335@subsection S3_4_bare_metal Building for bare metal
1336
1337For bare metal, the library was successfully built using linaros's latest (gcc-linaro-6.3.1-2017.05) bare metal toolchains:
1338 - arm-eabi for armv7a
1339 - aarch64-elf for arm64-v8a
1340
1341Download 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>.
1342
1343@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
1344
1345@subsubsection S3_4_1_library How to build the library ?
1346
1347To cross-compile the library with NEON support for baremetal arm64-v8a:
1348
1349 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
1350
1351@subsubsection S3_4_2_examples How to manually build the examples ?
1352
1353Examples 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>.
1354
1355@subsection S3_5_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001356
1357Using `scons` directly from the Windows command line is known to cause
1358problems. The reason seems to be that if `scons` is setup for cross-compilation
1359it gets confused about Windows style paths (using backslashes). Thus it is
1360recommended to follow one of the options outlined below.
1361
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001362@subsubsection S3_5_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001363
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001364The best and easiest option is to use
1365<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001366This feature is still marked as *beta* and thus might not be available.
1367However, if it is building the library is as simple as opening a *Bash on
1368Ubuntu on Windows* shell and following the general guidelines given above.
1369
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001370@subsubsection S3_5_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001371
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001372If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001373can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1374to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001375also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001376code of the library.) Linaro provides pre-built versions of
1377<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001378that can be used from the Cygwin terminal. When building for Android the
1379compiler is included in the Android standalone toolchain. After everything has
1380been set up in the Cygwin terminal the general guide on building the library
1381can be followed.
1382
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001383@subsection S3_6_cl_stub_library The OpenCL stub library
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001384
1385In the opencl-1.2-stubs folder you will find the sources to build a stub OpenCL library which then can be used to link your application or arm_compute against.
1386
1387If you preferred you could retrieve the OpenCL library from your device and link against this one but often this library will have dependencies on a range of system libraries forcing you to link your application against those too even though it is not using them.
1388
1389@warning This OpenCL library provided is a stub and *not* a real implementation. You can use it to resolve OpenCL's symbols in arm_compute while building the example but you must make sure the real libOpenCL.so is in your PATH when running the example or it will not work.
1390
1391To cross-compile the stub OpenCL library simply run:
1392
1393 <target-prefix>-gcc -o libOpenCL.so -Iinclude opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1394
1395For example:
1396
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001397 #Linux 32bit
1398 arm-linux-gnueabihf-gcc -o libOpenCL.so -Iinclude opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1399 #Linux 64bit
1400 aarch64-linux-gnu-gcc -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC
1401 #Android 32bit
1402 arm-linux-androideabi-clang -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1403 #Android 64bit
Anthony Barbier14c86a92017-12-14 16:27:41 +00001404 aarch64-linux-android-clang -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1405
1406@subsection S3_7_gles_stub_library The Linux OpenGLES and EGL stub libraries
1407
1408In the opengles-3.1-stubs folder you will find the sources to build stub EGL and OpenGLES libraries which then can be used to link your Linux application of arm_compute against.
1409
1410@note The stub libraries are only needed on Linux. For Android, the NDK toolchains already provide the meta-EGL and meta-GLES libraries.
1411
1412To cross-compile the stub OpenGLES and EGL libraries simply run:
1413
1414 <target-prefix>-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1415 <target-prefix>-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
1416
1417 #Linux 32bit
1418 arm-linux-gnueabihf-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1419 arm-linux-gnueabihf-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
1420
1421 #Linux 64bit
1422 aarch64-linux-gnu-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1423 aarch64-linux-gnu-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001424
1425@subsection S3_8_cl_requirements OpenCL DDK Requirements
1426
1427@subsubsection S3_8_1_cl_hard_requirements Hard Requirements
1428
1429Compute 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).
1430
1431Enabling 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.
1432
1433Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1434
1435@subsubsection S3_8_2_cl_performance_requirements Performance improvements
1436
1437Integer 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.
1438
1439OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1440
1441SVM 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 +01001442
1443@subsection S3_9_cl_tuner OpenCL Tuner
1444
1445The 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).
1446The 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 +01001447The 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 +01001448In 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.
1449
1450If 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:
1451
1452https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1453
1454Tuning 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.
1455
1456CLTuner 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.
1457
1458 #Example: 2 unique Matrix Multiply configurations
1459@code{.cpp}
1460 TensorShape a0 = TensorShape(32,32);
1461 TensorShape b0 = TensorShape(32,32);
1462 TensorShape c0 = TensorShape(32,32);
1463 TensorShape a1 = TensorShape(64,64);
1464 TensorShape b1 = TensorShape(64,64);
1465 TensorShape c1 = TensorShape(64,64);
1466
1467 Tensor a0_tensor;
1468 Tensor b0_tensor;
1469 Tensor c0_tensor;
1470 Tensor a1_tensor;
1471 Tensor b1_tensor;
1472 Tensor c1_tensor;
1473
1474 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1475 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1476 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1477 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1478 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1479 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1480
1481 CLGEMM gemm0;
1482 CLGEMM gemm1;
1483
1484 // Configuration 0
1485 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1486
1487 // Configuration 1
1488 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1489@endcode
1490
1491@subsubsection S3_9_1_cl_tuner_how_to How to use it
1492
1493All the graph examples in the ACL'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
1494
1495 #Enable CL tuner
1496 ./graph_mobilenet --enable-tuner –-target=CL
1497 ./arm_compute_benchmark --enable-tuner
1498
1499 #Export/Import to/from a file
1500 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1501 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1502
1503If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1504
1505Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1506
1507 -# Disable the power management
1508 -# Keep the GPU frequency constant
1509 -# Run multiple times the network (i.e. 10).
1510
1511If 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.
1512
1513@code{.cpp}
1514CLTuner tuner;
1515
1516// Setup Scheduler
1517CLScheduler::get().default_init(&tuner);
1518@endcode
1519
1520After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1521- tuner.save_to_file("results.csv");
1522
1523This file can be also imported using the method "load_from_file("results.csv")".
1524- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001525*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001526} // namespace arm_compute