blob: 55c5fcb2b8fd982c1372c7d581d6ed92cb1d37ed [file] [log] [blame]
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00001///
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +00002/// Copyright (c) 2017-2020 ARM Limited.
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00003///
4/// SPDX-License-Identifier: MIT
5///
6/// Permission is hereby granted, free of charge, to any person obtaining a copy
7/// of this software and associated documentation files (the "Software"), to
8/// deal in the Software without restriction, including without limitation the
9/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10/// sell copies of the Software, and to permit persons to whom the Software is
11/// furnished to do so, subject to the following conditions:
12///
13/// The above copyright notice and this permission notice shall be included in all
14/// copies or substantial portions of the Software.
15///
16/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22/// SOFTWARE.
23///
Anthony Barbier3762e742018-03-02 11:49:33 +000024namespace arm_compute
25{
Anthony Barbier6ff3b192017-09-04 18:44:23 +010026/** @mainpage Introduction
27
28@tableofcontents
29
30The Computer Vision and Machine Learning library is a set of functions optimised for both ARM CPUs and GPUs using SIMD technologies.
31
32Several builds of the library are available using various configurations:
33 - OS: Linux, Android or bare metal.
34 - Architecture: armv7a (32bit) or arm64-v8a (64bit)
Anthony Barbier20dbb822017-12-13 21:19:39 +000035 - Technology: NEON / OpenCL / GLES_COMPUTE / NEON and OpenCL and GLES_COMPUTE
Anthony Barbier6ff3b192017-09-04 18:44:23 +010036 - Debug / Asserts / Release: Use a build with asserts enabled to debug your application and enable extra validation. Once you are sure your application works as expected you can switch to a release build of the library for maximum performance.
37
38@section S0_1_contact Contact / Support
39
40Please email developer@arm.com
41
42In order to facilitate the work of the support team please provide the build information of the library you are using. To get the version of the library you are using simply run:
43
44 $ strings android-armv7a-cl-asserts/libarm_compute.so | grep arm_compute_version
45 arm_compute_version=v16.12 Build options: {'embed_kernels': '1', 'opencl': '1', 'arch': 'armv7a', 'neon': '0', 'asserts': '1', 'debug': '0', 'os': 'android', 'Werror': '1'} Git hash=f51a545d4ea12a9059fe4e598a092f1fd06dc858
46
Anthony Barbier14c86a92017-12-14 16:27:41 +000047@section S0_2_prebuilt_binaries Pre-built binaries
48
49For each release we provide some pre-built binaries of the library [here](https://github.com/ARM-software/ComputeLibrary/releases)
50
51These binaries have been built using the following toolchains:
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
SiCong Li1f7f9882019-11-28 14:59:35 +000054 - Android armv7a: clang++ / libc++ NDK r17c
55 - Android am64-v8a: clang++ / libc++ NDK r17c
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
Georgios Pinitasfd7780d2020-03-17 11:41:00 +000081 │   │   │   ├── CL specialisation of all the generic interfaces (ICLTensor, ICLArray, etc.)
82 │   │   │   ├── gemm --> Folder containing all the configuration files for GEMM
Anthony Barbier6ff3b192017-09-04 18:44:23 +010083 │   │   │   ├── kernels --> Folder containing all the OpenCL kernels
84 │   │   │   │   └── CL*Kernel.h
85 │   │   │   └── OpenCL.h --> Wrapper to configure the Khronos OpenCL C++ header
86 │   │ ├── CPP
Anthony Barbier6a5627a2017-09-26 14:42:02 +010087 │   │   │   ├── CPPKernels.h --> Includes all the CPP kernels at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +010088 │   │ │   └── kernels --> Folder containing all the CPP kernels
Anthony Barbier6a5627a2017-09-26 14:42:02 +010089 │   │   │      └── CPP*Kernel.h
Anthony Barbier20dbb822017-12-13 21:19:39 +000090 │   │   ├── GLES_COMPUTE
91 │   │   │   ├── GCKernelLibrary.h --> Manages all the GLES kernels compilation and caching, provides accessors for the GLES Context.
92 │   │   │   ├── GCKernels.h --> Includes all the GLES kernels at once
Georgios Pinitasfd7780d2020-03-17 11:41:00 +000093 │   │   │   ├── GLES specialisation of all the generic interfaces (IGCTensor etc.)
Anthony Barbier20dbb822017-12-13 21:19:39 +000094 │   │   │   ├── kernels --> Folder containing all the GLES kernels
95 │   │   │   │   └── GC*Kernel.h
96 │   │   │   └── OpenGLES.h --> Wrapper to configure the Khronos EGL and OpenGL ES C header
Anthony Barbier6ff3b192017-09-04 18:44:23 +010097 │   │   ├── NEON
98 │   │   │   ├── kernels --> Folder containing all the NEON kernels
Anthony Barbier38e7f1f2018-05-21 13:37:47 +010099 │   │   │   │ ├── assembly --> headers for assembly optimised NEON kernels.
100 │   │   │   │ ├── convolution --> headers for convolution assembly optimised NEON kernels.
101 │   │   │   │   │   ├── common --> headers for code which is common to several convolution implementations.
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000102 │   │   │   │   │   ├── depthwise --> headers for Depthwise convolution assembly implementation
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100103 │   │   │   │   │   └── winograd --> headers for Winograd convolution assembly implementation
104 │   │   │   │ ├── detail --> Common code for several intrinsics implementations.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100105 │   │   │   │   └── NE*Kernel.h
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000106 │   │   │   ├── wrapper --> NEON wrapper used to simplify code
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000107 │   │   │   │ ├── intrinsics --> NEON intrinsics wrappers
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000108 │   │   │   │ ├── scalar --> Scalar operations
109 │   │   │   │ ├── traits.h --> Traits defined on NEON vectors
110 │   │   │   │   └── wrapper.h --> Includes all wrapper headers at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100111 │   │   │   └── NEKernels.h --> Includes all the NEON kernels at once
112 │   │   ├── All common basic types (Types.h, Window, Coordinates, Iterator, etc.)
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000113 │   │   ├── All generic interfaces (ITensor, IArray, etc.)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000114 │   │   └── Objects metadata classes (TensorInfo, MultiImageInfo)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100115 │   ├── graph
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000116 │   │   ├── algorithms --> Generic algorithms used by the graph backend (e.g Order of traversal)
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100117 │   │   ├── backends --> The backend specific code
118 │   │   │   ├── CL --> OpenCL specific operations
119 │   │   │   ├── GLES --> OpenGLES Compute Shaders specific operations
120 │   │   │   └── NEON --> NEON specific operations
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000121 │   │   ├── detail --> Collection of internal utilities.
122 │   │   ├── frontend --> Code related to the stream frontend interface.
123 │   │   ├── mutators --> Used to modify / optimise the Graph intermediate representation(Operator fusion, in place operations, etc.)
124 │   │   ├── nodes --> The various nodes supported by the graph API
125 │   │   ├── printers --> Debug printers
126 │   │   └── Graph objects interfaces (INode, ITensorAccessor, Graph, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100127 │   └── runtime
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000128 │   ├── common
129 │ │ └── Common utility code used by all backends
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100130 │   ├── CL
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000131 │   │   ├── CL objects & allocators (CLArray, CLTensor, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100132 │   │   ├── functions --> Folder containing all the OpenCL functions
133 │   │   │   └── CL*.h
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100134 │   │   ├── CLScheduler.h --> Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100135 │   │   ├── CLFunctions.h --> Includes all the OpenCL functions at once
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000136 │   │   ├── ICLTuner.h --> Interface used to tune the local work-group size of OpenCL kernels
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100137 │   │   └── tuners
138 │   │      └── Local workgroup size tuners for specific architectures / GPUs
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100139 │   ├── CPP
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100140 │      │   ├── CPPKernels.h --> Includes all the CPP functions at once.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100141 │   │   ├── CPPScheduler.h --> Basic pool of threads to execute CPP/NEON code on several cores in parallel
142 │   │   └── functions --> Folder containing all the CPP functions
143 │   │      └── CPP*.h
Anthony Barbier20dbb822017-12-13 21:19:39 +0000144 │   ├── GLES_COMPUTE
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000145 │   │   ├── GLES objects & allocators (GCArray, GCTensor, etc.)
Anthony Barbier20dbb822017-12-13 21:19:39 +0000146 │   │   ├── functions --> Folder containing all the GLES functions
147 │   │   │   └── GC*.h
148 │   │   ├── GCScheduler.h --> Interface to enqueue GLES kernels and get/set the GLES CommandQueue.
149 │   │   └── GCFunctions.h --> Includes all the GLES functions at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100150 │   ├── NEON
151 │   │ ├── functions --> Folder containing all the NEON functions
152 │   │ │   └── NE*.h
153 │   │ └── NEFunctions.h --> Includes all the NEON functions at once
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100154 │   ├── OMP
155 │   │   └── OMPScheduler.h --> OpenMP scheduler (Alternative to the CPPScheduler)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000156 │ ├── Memory & weights manager files (LifetimeManager, PoolManager, etc.)
157 │   └── Basic implementations of the generic object interfaces (Array, Tensor, etc.)
158 ├── data --> Contains test images and reference data dumps used by validation tests
159 ├── docs --> Contains Doxyfile and Doxygen sources used to generate the HTML pages in the documentation folder.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100160 ├── documentation
161 │   ├── index.xhtml
162 │   └── ...
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000163 ├── documentation.xhtml --> documentation/index.xhtml
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100164 ├── examples
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000165 │   ├── gemm_tuner
166 │   │ └── OpenCL GEMM tuner utility
Anthony Barbier20dbb822017-12-13 21:19:39 +0000167 │   ├── cl_*.cpp --> OpenCL examples
Anthony Barbier14c86a92017-12-14 16:27:41 +0000168 │   ├── gc_*.cpp --> GLES compute shaders examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000169 │   ├── graph_*.cpp --> Graph examples
170 │   ├── neoncl_*.cpp --> NEON / OpenCL interoperability examples
171 │   └── neon_*.cpp --> NEON examples
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100172 ├── include
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100173 │   ├── CL
174 │   │ └── Khronos OpenCL C headers and C++ wrapper
175 │   ├── half --> FP16 library available from http://half.sourceforge.net
Anthony Barbier14c86a92017-12-14 16:27:41 +0000176 │   ├── libnpy --> Library to load / write npy buffers, available from https://github.com/llohse/libnpy
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000177 │  ├── linux --> Headers only needed for Linux builds
178 │   │ └── Khronos EGL and OpenGLES headers
179 │ └── stb
180 │ └── stb_image.h --> Single header library to load image files, available from https://github.com/nothings/stb
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100181 ├── scripts
182 │   ├── caffe_data_extractor.py --> Basic script to export weights from Caffe to npy files
183 │   └── tensorflow_data_extractor.py --> Basic script to export weights from Tensor Flow to npy files
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100184 ├── src
185 │   ├── core
186 │ │ └── ... (Same structure as headers)
Anthony Barbier20dbb822017-12-13 21:19:39 +0000187 │   │ ├── CL
188 │   │ │ └── cl_kernels --> All the OpenCL kernels
189 │   │ └── GLES_COMPUTE
190 │   │ └── cs_shaders --> All the OpenGL ES Compute Shaders
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100191 │   ├── graph
192 │ │ └── ... (Same structure as headers)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100193 │ └── runtime
194 │ └── ... (Same structure as headers)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100195 ├── support
196 │ └── Various headers to work around toolchains / platform issues.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100197 ├── tests
198 │   ├── All test related files shared between validation and benchmark
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100199 │   ├── benchmark --> Sources for benchmarking
200 │ │ ├── Benchmark specific files
201 │   │ ├── fixtures
202 │ │ │ └── Backend agnostic fixtures to initialise and run the functions to test.
203 │ │ ├── CL --> OpenCL benchmarking tests
204 │ │ ├── GLES_COMPUTE --> GLES benchmarking tests
205 │ │ └── NEON --> NEON benchmarking tests
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000206 │ ├── benchmark_examples --> Sources needed to wrap examples to run through our benchmarking framework.
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100207 │   ├── CL --> OpenCL accessors
Anthony Barbier20dbb822017-12-13 21:19:39 +0000208 │   ├── GLES_COMPUTE --> GLES accessors
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100209 │   ├── NEON --> NEON accessors
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100210 │   ├── datasets
211 │ │ └── Datasets for all the validation / benchmark tests, layer configurations for various networks, etc.
212 │   ├── framework
213 │ │ └── Boiler plate code for both validation and benchmark test suites (Command line parsers, instruments, output loggers, etc.)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000214 │   ├── instruments --> User defined instruments that can be registered to the framework.
215 │ ├── validate_examples --> Sources needed to wrap examples to run through our validation framework.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100216 │   └── validation --> Sources for validation
217 │ ├── Validation specific files
218 │   ├── fixtures
219 │ │ └── Backend agnostic fixtures to initialise and run the functions to test.
220 │   ├── reference
221 │ │ └── Reference implementation used to validate the results of the various backends.
222 │ ├── CL --> OpenCL validation tests
223 │ ├── GLES_COMPUTE --> GLES validation tests
224 │ ├── CPP --> C++ reference implementations
225 │ └── NEON --> NEON validation tests
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100226 └── utils --> Boiler plate code used by examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000227 └── Various utilities to print types, load / store assets, etc.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100228
229@section S2_versions_changelog Release versions and changelog
230
231@subsection S2_1_versions Release versions
232
233All releases are numbered vYY.MM Where YY are the last two digits of the year, and MM the month number.
234If there is more than one release in a month then an extra sequential number is appended at the end:
235
236 v17.03 (First release of March 2017)
237 v17.03.1 (Second release of March 2017)
238 v17.04 (First release of April 2017)
239
240@note We're aiming at releasing one major public release with new features per quarter. All releases in between will only contain bug fixes.
241
242@subsection S2_2_changelog Changelog
243
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000244v20.05 Public major release
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000245 - Various bug fixes.
246 - Various optimisations.
247 - Added Bfloat16 type support
248 - Added Bfloat16 support in:
249 - @ref NEWeightsReshapeKernel
250 - @ref NEConvolutionLayerReshapeWeights
251 - @ref NEIm2ColKernel
252 - @ref NEIm2Col
253 - @ref NEDepthConvertLayerKernel
254 - @ref NEDepthConvertLayer
255 - @ref NEGEMMConvolutionLayer
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000256 - @ref NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000257 - Added new data type QASYMM8_SIGNED support for:
258 - @ref CLDirectConvolutionLayer
259 - @ref CLDeconvolutionLayer
260 - @ref CLDirectDeconvolutionLayer
261 - @ref CLGEMMDeconvolutionLayer
262 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
263 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
264 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
265 - @ref CLReductionOperation
266 - @ref CLReduceMean
267 - @ref NEUpsampleLayer
268 - @ref NECast
269 - @ref NEReductionOperation
270 - @ref NEReduceMean
271 - @ref NEArgMinMaxLayer
272 - @ref NEDeconvolutionLayer
273 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
274 - @ref CPPBoxWithNonMaximaSuppressionLimit
275 - @ref CPPDetectionPostProcessLayer
276 - @ref CPPPermuteKernel
277 - @ref CPPPermute
278 - @ref CPPTopKVKernel
279 - @ref CPPTopKV
280 - Deprecated OpenCL kernels / functions:
281 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
282 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
283 - Deprecated NEON kernels / functions:
284 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
285 - Removed CPP kernels / functions:
286 - CPPFlipWeightsKernel
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000287
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000288v20.02.1 Maintenance release
289 - Added Android-NN build script.
290
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000291v20.02 Public major release
292 - Various bug fixes.
293 - Various optimisations.
294 - Added new data type QASYMM8_SIGNED support for:
295 - @ref CLDepthwiseConvolutionLayer
296 - @ref CLDepthwiseConvolutionLayer3x3
297 - @ref CLGEMMConvolutionLayer
298 - @ref CLGEMMLowpMatrixMultiplyCore
299 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
300 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
301 - @ref NEActivationLayer
302 - @ref NEComparisonOperationKernel
303 - @ref NEConvolutionLayer
304 - @ref NEDepthwiseConvolutionLayer
305 - @ref NEDepthwiseConvolutionLayer3x3Kernel
306 - @ref NEDirectConvolutionLayerOutputStageKernel
307 - @ref NEElementwiseComparison
308 - @ref NEElementwiseMax
309 - @ref NEElementwiseMin
310 - @ref NEElementwiseSquaredDiff
311 - @ref NEFullyConnectedLayer
312 - @ref NEGEMMMatrixVectorMultiplyKernel
313 - @ref NEPixelWiseMultiplication
314 - @ref NEPoolingLayer
315 - @ref NEPReluLayer
316 - Added support for QSYMM8_PER_CHANNEL in:
317 - @ref NEDepthwiseConvolutionLayer3x3Kernel
318 - Added support for split sizes in:
319 - @ref CLSplit
320 - @ref NESplit
321 - New OpenCL kernels / functions:
322 - @ref CLFill
323 - @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
324 - New NEON kernels / functions:
325 - @ref NEFill
326 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
327 - Deprecated NEON functions / interfaces:
328 - @ref CLDepthwiseConvolutionLayer3x3
329 - @ref NEDepthwiseConvolutionLayerOptimized
330 - @ref PoolingLayerInfo constructors without Data Layout.
331 - Added support for quantization with multiplier greater than 1 on NEON and CL.
332 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
333 - Added the ability to build bootcode for bare metal.
334 - Added support for generating synthetic QASYMM8 graphs.
335 - Added support for F16 datatype in VGG16.
336 - Removed pre-built binaries for GLES.
337
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000338v19.11.1 Public maintenance release
339 - Fix offset calculation in NEReductionOperationKernel.
340 - Fix data layout in NEScaleKernel for nhwc.
341 - Retain configuration step data layout to avoid side-effects.
342 - Perform sqrt in double domain for L2 pooling.
343 - Fix output shape calculation for Reduce Mean
344 - Restrict cases where optimized NEPadLayer runs.
345
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100346v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000347 - Various bug fixes.
348 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000349 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000350 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100351 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
352 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000353 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100354 - CLDepthwiseVectorToTensorKernel
355 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000356 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100357 - NEDepthwiseWeightsReshapeKernel
358 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000359 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100360 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100361 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000362 - New OpenCL kernels / functions:
363 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
364 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
365 OpenCL kernels / functions)
366 - @ref CLLogSoftmaxLayer
367 - New NEON kernels / functions:
368 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
369 - @ref NEComputeAllAnchorsKernel / @ref NEComputeAllAnchors
370 - @ref NEDetectionPostProcessLayer
371 - @ref NEGenerateProposalsLayer
372 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
373 - @ref NELogSoftmaxLayer
374 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
375 - Added QASYMM8 support for:
376 - @ref CLGenerateProposalsLayer
377 - @ref CLROIAlignLayer
378 - @ref CPPBoxWithNonMaximaSuppressionLimit
379 - Added QASYMM16 support for:
380 - @ref CLBoundingBoxTransform
381 - Added FP16 support for:
382 - @ref CLGEMMMatrixMultiplyReshapedKernel
383 - Added new data type QASYMM8_PER_CHANNEL support for:
384 - @ref CLDequantizationLayer
385 - @ref NEDequantizationLayer
386 - Added new data type QSYMM8_PER_CHANNEL support for:
387 - @ref CLConvolutionLayer
388 - @ref NEConvolutionLayer
389 - @ref CLDepthwiseConvolutionLayer
390 - @ref NEDepthwiseConvolutionLayer
391 - Added FP16 mixed-precision support for:
392 - @ref CLGEMMMatrixMultiplyReshapedKernel
393 - @ref CLPoolingLayerKernel
394 - Added FP32 and FP16 ELU activation for:
395 - @ref CLActivationLayer
396 - @ref NEActivationLayer
397 - Added asymmetric padding support for:
398 - @ref CLDirectDeconvolutionLayer
399 - @ref CLGEMMDeconvolutionLayer
400 - @ref NEDeconvolutionLayer
401 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
402 - Replaced the calls to @ref NECopyKernel and @ref NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
403 - Replaced the calls to @ref CLCopyKernel and @ref CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
404 - Improved performance for CL Inception V3 - FP16.
405 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
406 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
407 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
408 - Optimized @ref CLPadLayer.
409 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
410 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100411
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000412v19.08.1 Public maintenance release
413 - Fix offset calculation in NEReductionOperationKernel.
414 - Fix data layout in NEScaleKernel for nhwc.
415 - Retain configuration step data layout to avoid side-effects.
416 - Perform sqrt in double domain for L2 pooling.
417 - Fix output shape calculation for Reduce Mean
418 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
419
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100420v19.08 Public major release
421 - Various bug fixes.
422 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100423 - Deprecated NEON functions
424 - NEDepthConcatenateLayer
425 - NEWidthConcatenateLayer
426 - Deprecated OpenCL kernels / functions
427 - CLDepthConcatenateLayer
428 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
429 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
430 - CLWidthConcatenateLayer
431 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100432 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100433 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100434 - @ref NEElementwisePower
435 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100436 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100437 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100438 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100439 - @ref NESinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100440 - @ref NEBatchConcatenateLayerKernel
441 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
442 - @ref NEDepthwiseConvolutionLayerNativeKernel
443 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
444 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
445 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
446 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100447 - @ref CLAbsLayer
448 - @ref CLElementwisePower
449 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100450 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100451 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100452 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100453 - @ref CLSinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100454 - @ref CLBatchConcatenateLayerKernel
455 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
456 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
457 - @ref CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
458 - @ref CLGEMMMatrixMultiplyNativeKernel
459 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
460 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
461 - New examples:
462 - neon_opticalflow
463 - cl_cache
464 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100465 - Added support for FP16 in @ref NEDeconvolutionLayer
466 - Added support for FP16 in @ref CLDeconvolutionLayer
467 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100468 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
469 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
470 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
471 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
472 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
473 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini05069f02019-09-26 17:18:26 +0100474 - The @ref CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
475 - The @ref NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100476 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
477 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100478 - 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 +0100479
Michalis Spyroua9c44722019-04-05 17:18:36 +0100480v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100481 - Various bug fixes.
482 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100483 - New Neon kernels / functions:
484 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100485 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100486 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100487 - @ref NEDepthwiseConvolutionAssemblyDispatch
488 - @ref NEFFTDigitReverseKernel
489 - @ref NEFFTRadixStageKernel
490 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100491 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
492 - @ref NEHeightConcatenateLayerKernel
493 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100494 - @ref NEFFT1D
495 - @ref NEFFT2D
496 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100497 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100498 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100499 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100500 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100501 - @ref CLFFTDigitReverseKernel
502 - @ref CLFFTRadixStageKernel
503 - @ref CLFFTScaleKernel
504 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
505 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
506 - @ref CLHeightConcatenateLayerKernel
507 - @ref CLDirectDeconvolutionLayer
508 - @ref CLFFT1D
509 - @ref CLFFT2D
510 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100511 - @ref CLGEMMDeconvolutionLayer
512 - New OpenGLES kernels / functions:
513 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100514 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100515 - GCDepthConcatenateLayer
516 - NEWidthConcatenateLayer
517 - NEDepthConcatenateLayer
518 - CLWidthConcatenateLayer
519 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100520 - CLGEMMInterleave4x4
521 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100522 - Support different quantization info in CLConcatLayer.
523 - Add checks on different input/output quantization info were not supported.
524 - Tensors have different quantization information.
525 - Add FP16 support checks.
526 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
527 - New graph examples:
528 - graph_convolution
529 - graph_fully_connected
530 - graph_depthwise_convolution
531 - Deepspeech v0.4.1
532 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
533 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
534 - Add support for QASYMM8 NEDeconvolution.
535 - Add support for DequantizationLayer for NEON/CL.
536 - Add support for dilation in CLDepthwiseConvolution.
537 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
538 - Optimize CLDeconvolution.
539 - Add StackLayer to the graph API.
540 - Add support for "reflect" padding mode in NEPad.
541 - Winograd 7x7 NHWC on OpenCL.
542 - Rework CL ML layers to run exclusively on CL.
543 - Support different quantization info in PoolingLayer.
544 - Implement and test import memory interfaces.
545 - Added new tests and removed old ones.
546 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100547
giuros01a69a88b2019-01-31 16:29:19 +0000548v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000549 - Various bug fixes.
550 - Various optimisations.
551 - New Neon kernels / functions:
552 - @ref NETileKernel / @ref NETile
553 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
554 - @ref NEElementwiseOperationKernel
555 - @ref NEElementwiseMax
556 - @ref NEElementwiseMin
557 - @ref NEElementwiseSquaredDiff
558 - @ref NESelectKernel / @ref NESelect
559 - @ref NESplit
560 - @ref NESlice
561 - @ref NEUnstack
562 - @ref NEStridedSliceKernel / @ref NEStridedSlice
563 - @ref NEElementwiseUnaryKernel
564 - @ref NERsqrtLayer
565 - @ref NEExpLayer
566 - @ref NEReverseKernel / @ref NEReverse
567 - @ref NEArgMinMaxLayer
568 - @ref NEStackLayerKernel / @ref NEStackLayer
569 - @ref NERangeKernel / @ref NERange
570 - @ref NEPadLayer
571 - @ref NEMemsetKernel
572 - @ref NEGatherKernel / @ref NEGather
573 - @ref NEElementwiseComparison
574 - @ref NEElementwiseComparisonStatic
575 - @ref NEComparisonOperationKernel
576 - @ref NEElementwiseDivision
577 - New OpenCL kernels / functions:
578 - @ref CLSelectKernel / @ref CLSelect
579 - @ref CLTileKernel / @ref CLTile
580 - @ref CLComparisonKernel / @ref CLComparison
581 - @ref CLArgMinMaxLayer
582 - @ref CLElementwiseMax
583 - @ref CLElementwiseMin
584 - @ref CLElementwiseSquaredDiff
585 - @ref CLStackLayerKernel / @ref CLStackLayer
586 - @ref CLReverse / @ref CLReverseKernel
587 - @ref CLRsqrtLayer
588 - @ref CLExpLayer
589 - @ref CLElementWiseUnaryLayerKernel
590 - @ref CLGEMMReshapeLHSMatrixKernel
591 - @ref CLGEMMReshapeRHSMatrixKernel
592 - @ref CLGEMMMatrixMultiplyReshapedKernel
593 - @ref CLRangeKernel / @ref CLRange
594 - @ref CLUnstack
595 - @ref CLGatherKernel / @ref CLGather
596 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
597 - New CPP kernels / functions:
598 - @ref CPPDetectionOutputLayer
599 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000600 - Added new examples:
601 - graph_ssd_mobilenet.cpp
602 - graph_mobilenet_v2.cpp
603 - graph_resnet12.cpp
604 - graph_srcnn955.cpp
605 - graph_vgg_vdsr.cpp
606 - graph_inception_resnet_v1.cpp
607 - Add 4D tensors support to
608 - @ref NESoftmaxLayer
609 - Fused activation in @ref CLWinogradConvolutionLayer
610 - Extented @ref NEPermute to support more cases
611 - Added NEON/SVE GEMM Hybrid kernels
612 - Added u8 and s8 hybrid assembly kernels
613 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
614 - Improved @ref CLTuner
615 - Fused the bias addition within @ref CLGEMM
616 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
617 - Added NHWC data layout support to:
618 - @ref NEScale for F16
619 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
620 - @ref NEL2NormalizeLayer for FP32/FP16
621 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
622 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000623 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000624 - Added QASYMM8 support to the following kernels:
625 - @ref NEArithmeticAdditionKernel
626 - @ref NEScale
627 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000628 - Deprecated functions/interfaces
629 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
630
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000631v18.11 Public major release
632 - Various bug fixes.
633 - Various optimisations.
634 - New Neon kernels / functions:
635 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
636 - @ref NEReduceMean
637 - @ref NEReorgLayer / @ref NEReorgLayerKernel
638 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
639 - @ref NEUpsampleLayer / @ref NEUpsampleLayerKernel
640 - @ref NEYOLOLayer / @ref NEYOLOLayerKernel
641 - New OpenCL kernels / functions:
642 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
643 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000644 - @ref CLComputeAllAnchorsKernel
645 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000646 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
647 - @ref CLReorgLayer / @ref CLReorgLayerKernel
648 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
649 - @ref CLPadLayer
650 - @ref CLReduceMean
651 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
652 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
653 - @ref CLSlice
654 - @ref CLSplit
655 - @ref CLStridedSlice / @ref CLStridedSliceKernel
656 - @ref CLUpsampleLayer / @ref CLUpsampleLayerKernel
657 - @ref CLYOLOLayer / @ref CLYOLOLayerKernel
658 - New CPP kernels / functions:
659 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
660 - Added the validate method in:
661 - @ref NEDepthConvertLayer
662 - @ref NEFloor / @ref CLFloor
663 - @ref NEGEMMMatrixAdditionKernel
664 - @ref NEReshapeLayer / @ref CLReshapeLayer
665 - @ref CLScale
666 - Added new examples:
667 - graph_shufflenet.cpp
668 - graph_yolov3.cpp
669 - Added documentation for add a new function or kernel.
670 - Improved doxygen documentation adding a list of the existing functions.
671 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100672 - CLWidthConcatenateLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000673 - @ref CLFlattenLayer
674 - @ref CLSoftmaxLayer
675 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
676 - Add SVE support
677 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
678 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
679 - Added NHWC data layout support to:
680 - @ref CLChannelShuffleLayer
681 - @ref CLDeconvolutionLayer
682 - @ref CLL2NormalizeLayer
683 - Added QASYMM8 support to the following kernels:
684 - @ref CLScaleKernel
685 - @ref NEDepthwiseConvolutionLayer3x3Kernel
686 - @ref CLPixelWiseMultiplicationKernel
687 - Added FP16 support to the following kernels:
688 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
689 - @ref NEDepthwiseConvolutionLayer3x3Kernel
690 - @ref CLNormalizePlanarYUVLayerKernel
691 - @ref CLWinogradConvolutionLayer (5x5 kernel)
692 - More tests added to both validation and benchmarking suites.
693
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100694v18.08 Public major release
695 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100696 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100697 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100698 - Removed support for QS8/QS16 data types.
699 - Added support for grouped convolution in @ref CLConvolutionLayer.
700 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100701 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100702 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
703 - @ref CLDepthwiseConvolutionLayer
704 - @ref CLDirectConvolutionLayer
705 - @ref CLConvolutionLayer
706 - @ref CLScale
707 - @ref CLIm2ColKernel
708 - New Neon kernels / functions:
709 - @ref NERNNLayer
710 - New OpenCL kernels / functions:
711 - @ref CLArithmeticDivision
712 - Introduced prepare() stage support in the graph API for GLES.
713 - Added support for memory reusage when trying to allocate smaller CLTensors.
714 - Enabled NHWC execution on graph examples.
715 - Added JPEG accessor for validation purposes.
716 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100717
718v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100719 - Various bug fixes.
720 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000721 - Major redesign in the interface for the neon kernels implemented in assembly.
722 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
723 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
724 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100725 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
726 - Improved doxygen documentation.
727 - Improved memory management for layer's transitions.
728 - Added support for NHWC data layout in tensors.
729 - Added NHWC data layout support to:
730 - @ref NEGEMMConvolutionLayer
731 - @ref NEDirectConvolutionLayer
732 - @ref NEPoolingLayer / @ref CLPoolingLayer
733 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
734 - @ref NEDepthwiseConvolutionLayer
735 - @ref NEScale
736 - @ref NEIm2Col
737 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
738 - New OpenCL kernels / functions:
739 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
740 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
741 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100742 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100743 - @ref CLRNNLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100744 - CLWidthConcatenateLayer / @ref CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100745 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
746 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
747 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100748 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
749 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
750 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
751 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
752 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
753 - Port mobilenet example to NHWC data layout.
754 - Enabled Winograd method in @ref CLConvolutionLayer.
755 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
756 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
757 - Added memory manager support in GLES functions.
758 - Major refactoring of the graph API.
759 - Added GLES backend in the graph API.
760 - Added support for the memory manager in the graph API.
761 - Enabled Winograd Convolution method in the graph API.
762 - Added support for grouped convolutions in the graph API.
763 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
764 - Added fast maths flag in @ref CLConvolutionLayer.
765 - Added new tests and benchmarks in validation and benchmark frameworks
766 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
767 - Added support to OpenCL 2.0 SVM
768 - Added support to import memory in OpenCL tensors.
769 - Added the prepare() method to perform any one off pre-processing before running the function.
770 - Added new examples:
771 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100772 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100773 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000774
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000775v18.03 Public maintenance release
776 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +0000777 - Fixed bug in @ref NEActivationLayer
778 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000779 - Updated recommended NDK version to r16b (And fixed warnings).
780 - Fixed bug in validation code.
781 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100782 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000783
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000784v18.02 Public major release
785 - Various NEON / OpenCL / GLES optimisations.
786 - Various bug fixes.
787 - Changed default number of threads on big LITTLE systems.
788 - Refactored examples and added:
789 - graph_mobilenet_qassym8
790 - graph_resnet
791 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +0000792 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
793 - 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 +0000794 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000795 - @ref CLActivationLayer
796 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000797 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000798 - @ref CLActivationLayer
799 - @ref CLDepthwiseConvolutionLayer
800 - @ref NEDepthwiseConvolutionLayer
801 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000802 - Added FP16 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000803 - @ref CLDepthwiseConvolutionLayer3x3
804 - @ref CLDepthwiseConvolutionLayer
805 - Added broadcasting support to @ref NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
806 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
807 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000808 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100809 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +0000810 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000811 - Added name() method to all kernels.
812 - Added support for Winograd 5x5.
Anthony Barbier3762e742018-03-02 11:49:33 +0000813 - @ref NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100814 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
815 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
816 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +0100817 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000818 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000819 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +0000820
Anthony Barbier64c95a02018-01-22 18:48:55 +0000821v18.01 Public maintenance release
822 - Various bug fixes
823 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +0000824 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
825 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +0000826 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +0000827 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
828 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
829 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
830 - Added @ref GCScaleKernel / @ref GCScale
831 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +0000832 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000833 - @ref GCCol2ImKernel
834 - @ref GCGEMMInterleave4x4Kernel
835 - @ref GCGEMMTranspose1xWKernel
836 - @ref GCIm2ColKernel
837 - Refactored NEON Winograd (NEWinogradLayerKernel)
838 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000839 - Added QASYMM8 support to the following NEON kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000840 - @ref NEDepthwiseConvolutionLayer3x3Kernel
841 - @ref NEFillBorderKernel
842 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000843 - Added new examples:
844 - graph_cl_mobilenet_qasymm8.cpp
845 - graph_inception_v3.cpp
846 - gc_dc.cpp
847 - More tests added to both validation and benchmarking suites.
848
Gian Marcoff850932017-12-11 12:37:17 +0000849v17.12 Public major release
850 - Most machine learning functions on OpenCL support the new data type QASYMM8
851 - Introduced logging interface
852 - Introduced opencl timer
853 - Reworked GEMMLowp interface
854 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
855 - Added validation method for most Machine Learning kernels / functions
856 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
857 - Added sgemm example for OpenCL
858 - Added absolute difference example for GLES compute
859 - Added new tests and benchmarks in validation and benchmark frameworks
860 - Added new kernels / functions for GLES compute
861
862 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000863 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
864 - @ref GCActivationLayerKernel / @ref GCActivationLayer
865 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
866 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +0100867 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000868 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
869 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
870 - @ref GCFillBorderKernel / @ref GCFillBorder
871 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
872 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
873 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
874 - @ref GCIm2ColKernel
875 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
876 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
877 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
878 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
879 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +0000880
881 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +0000882 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
883 - arm_compute::NEHGEMMAArch64FP16Kernel
Giorgio Arenad93e2632019-10-15 11:09:33 +0100884 - @ref NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / @ref NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000885 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
886 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100887 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +0000888
889 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000890 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
891 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +0000892
893 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +0100894 - graph::BranchLayer
895 - graph::DepthConvertLayer
896 - graph::DepthwiseConvolutionLayer
897 - graph::DequantizationLayer
898 - graph::FlattenLayer
899 - graph::QuantizationLayer
900 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +0000901
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100902v17.10 Public maintenance release
903 - Bug fixes:
904 - Check the maximum local workgroup size supported by OpenCL devices
905 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +0000906 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100907 - Added a few new Graph nodes, support for branches and grouping.
908 - Automatically enable cl_printf in debug builds
909 - Fixed bare metal builds for armv7a
910 - Added AlexNet and cartoon effect examples
911 - 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)
912
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100913v17.09 Public major release
914 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +0000915 - 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 +0100916 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
917 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
918 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +0000919 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000920 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
921 - @ref NEFloorKernel / @ref NEFloor
922 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
923 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
924 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
925 - @ref NEReductionOperationKernel / @ref NEReductionOperation
926 - @ref NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100927
928 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100929 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / @ref CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000930 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
931 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
932 - @ref CLFlattenLayer
933 - @ref CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100934 - CLGEMMTranspose1xW
Anthony Barbier3762e742018-03-02 11:49:33 +0000935 - @ref CLGEMMMatrixVectorMultiplyKernel
936 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
937 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
938 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
939 - @ref CLReductionOperationKernel / @ref CLReductionOperation
940 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100941
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100942v17.06 Public major release
943 - Various bug fixes
944 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
945 - Added unit tests and benchmarks (AlexNet, LeNet)
946 - Added support for sub tensors.
947 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +0000948 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
949 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
950 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100951 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000952 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100953 - @ref CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000954 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
955 - @ref CLLocallyConnectedMatrixMultiplyKernel / @ref CLLocallyConnectedLayer
956 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100957 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000958 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100959 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000960 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100961 - @ref NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000962 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
963 - @ref NELocallyConnectedMatrixMultiplyKernel / @ref NELocallyConnectedLayer
964 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100965
966v17.05 Public bug fixes release
967 - Various bug fixes
968 - Remaining of the functions ported to use accurate padding.
969 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
970 - Added "free" method to allocator.
971 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
972
973v17.04 Public bug fixes release
974
975 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +0000976 - @ref CLColorConvertKernel
977 - @ref CLEdgeNonMaxSuppressionKernel
978 - @ref CLEdgeTraceKernel
979 - @ref CLGaussianPyramidHorKernel
980 - @ref CLGaussianPyramidVertKernel
981 - @ref CLGradientKernel
982 - @ref NEChannelCombineKernel
983 - @ref NEFillArrayKernel
984 - @ref NEGaussianPyramidHorKernel
985 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +0100986 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000987 - @ref NEHarrisScoreKernel
988 - @ref NEHOGDetectorKernel
989 - @ref NELogits1DMaxKernel
990 - NELogits1DShiftExpSumKernel
991 - NELogits1DNormKernel
992 - @ref NENonMaximaSuppression3x3FP16Kernel
993 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100994
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100995v17.03.1 First Major public release of the sources
996 - Renamed the library to arm_compute
997 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
998 - New padding calculation interface introduced and ported most kernels / functions to use it.
999 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001000 - @ref CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001001 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001002 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
1003 - @ref NETransposeKernel / @ref NETranspose
1004 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
1005 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
1006 - @ref NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
1007 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001008
1009v17.03 Sources preview
1010 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001011 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001012 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Anthony Barbier3762e742018-03-02 11:49:33 +00001013 - @ref CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
1014 - @ref CLTransposeKernel / @ref CLTranspose
1015 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
1016 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
1017 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001018 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001019 - @ref NEActivationLayerKernel / @ref NEActivationLayer
1020 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
1021 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001022
1023v17.02.1 Sources preview
1024 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001025 - @ref CLLogits1DMaxKernel, @ref CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
1026 - @ref CLPoolingLayerKernel / @ref CLPoolingLayer
1027 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
1028 - @ref CLRemapKernel / @ref CLRemap
1029 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
1030 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
1031 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001032 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +00001033 - @ref NEAccumulateWeightedFP16Kernel
1034 - @ref NEBox3x3FP16Kernel
1035 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001036
1037v17.02 Sources preview
1038 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001039 - @ref CLActivationLayerKernel / @ref CLActivationLayer
1040 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1041 - @ref CLDerivativeKernel / @ref CLChannelExtract
1042 - @ref CLFastCornersKernel / @ref CLFastCorners
1043 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001044 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001045 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1046 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001047 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1048 - Switched all the kernels / functions to use tensors instead of images.
1049 - Updated documentation to include instructions to build the library from sources.
1050
1051v16.12 Binary preview release
1052 - Original release
1053
1054@section S3_how_to_build How to build the library and the examples
1055
1056@subsection S3_1_build_options Build options
1057
1058scons 2.3 or above is required to build the library.
1059To see the build options available simply run ```scons -h```:
1060
Anthony Barbier79c61782017-06-23 11:48:24 +01001061 debug: Debug (yes|no)
1062 default: False
1063 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001064
Anthony Barbier79c61782017-06-23 11:48:24 +01001065 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1066 default: False
1067 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001068
Anthony Barbier79c61782017-06-23 11:48:24 +01001069 arch: Target Architecture (armv7a|arm64-v8a|arm64-v8.2-a|x86_32|x86_64)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001070 default: armv7a
1071 actual: armv7a
1072
Anthony Barbier79c61782017-06-23 11:48:24 +01001073 os: Target OS (linux|android|bare_metal)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001074 default: linux
1075 actual: linux
1076
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001077 build: Build type (native|cross_compile|embed_only)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001078 default: cross_compile
1079 actual: cross_compile
1080
Anthony Barbier79c61782017-06-23 11:48:24 +01001081 examples: Build example programs (yes|no)
1082 default: True
1083 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001084
Anthony Barbier79c61782017-06-23 11:48:24 +01001085 Werror: Enable/disable the -Werror compilation flag (yes|no)
1086 default: True
1087 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001088
Anthony Barbier79c61782017-06-23 11:48:24 +01001089 opencl: Enable OpenCL support (yes|no)
1090 default: True
1091 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001092
Anthony Barbier79c61782017-06-23 11:48:24 +01001093 neon: Enable Neon support (yes|no)
1094 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001095 actual: False
1096
Anthony Barbier20dbb822017-12-13 21:19:39 +00001097 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1098 default: False
1099 actual: False
1100
1101 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shader in library binary (yes|no)
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001102 default: True
1103 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001104
1105 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1106 default: False
1107 actual: False
1108
1109 openmp: Enable OpenMP backend (yes|no)
1110 default: False
1111 actual: False
1112
1113 cppthreads: Enable C++11 threads backend (yes|no)
1114 default: True
1115 actual: True
1116
1117 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1118 default: .
1119 actual: .
1120
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001121 extra_cxx_flags: Extra CXX flags to be appended to the build command
1122 default:
1123 actual:
1124
Anthony Barbier79c61782017-06-23 11:48:24 +01001125 pmu: Enable PMU counters (yes|no)
1126 default: False
1127 actual: False
1128
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001129 mali: Enable Mali hardware counters (yes|no)
1130 default: False
1131 actual: False
1132
Anthony Barbier79c61782017-06-23 11:48:24 +01001133 validation_tests: Build validation test programs (yes|no)
1134 default: False
1135 actual: False
1136
1137 benchmark_tests: Build benchmark test programs (yes|no)
1138 default: False
1139 actual: False
1140
1141@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001142 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1143 - 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)
1144 - 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).
1145
Anthony Barbier79c61782017-06-23 11:48:24 +01001146@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 +01001147
Anthony Barbier79c61782017-06-23 11:48:24 +01001148@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001149@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1150
Anthony Barbier79c61782017-06-23 11:48:24 +01001151@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 +01001152
Anthony Barbier79c61782017-06-23 11:48:24 +01001153@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 +01001154
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001155There 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.
1156
Anthony Barbier79c61782017-06-23 11:48:24 +01001157@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 +01001158
Anthony Barbier20dbb822017-12-13 21:19:39 +00001159@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 +01001160
Anthony Barbier20dbb822017-12-13 21:19:39 +00001161@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 +01001162
1163@b set_soname: Do you want to build the versioned version of the library ?
1164
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001165If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1166Example:
1167 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1168 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1169 libarm_compute_core.so.1.0.0
1170
1171@note This options is disabled by default as it requires SCons version 2.4 or above.
1172
Anthony Barbier79c61782017-06-23 11:48:24 +01001173@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1174
1175@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1176
1177@b examples: Build or not the examples
1178
1179@b validation_tests: Enable the build of the validation suite.
1180
Anthony Barbier79c61782017-06-23 11:48:24 +01001181@b benchmark_tests: Enable the build of the benchmark tests
1182
1183@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1184
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001185@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)
1186
Anthony Barbier79c61782017-06-23 11:48:24 +01001187@b openmp Build in the OpenMP scheduler for NEON.
1188
1189@note Only works when building with g++ not clang++
1190
1191@b cppthreads Build in the C++11 scheduler for NEON.
1192
Anthony Barbier3762e742018-03-02 11:49:33 +00001193@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001194
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001195@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001196
1197@subsubsection S3_2_1_library How to build the library ?
1198
1199For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1200
Michele Di Giorgio6513ccb2018-08-28 14:38:35 +01001201 - gcc-linaro-4.9-2016.02-x86_64_arm-linux-gnueabihf
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001202 - gcc-linaro-4.9-2016.02-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001203
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001204To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1205
1206 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1207
1208To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1209
1210 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1211
Anthony Barbier20dbb822017-12-13 21:19:39 +00001212To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1213
1214 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1215
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001216You can also compile the library natively on an ARM device by using <b>build=native</b>:
1217
1218 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1219 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1220
1221@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.
1222
1223For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1224
1225 apt-get install g++-arm-linux-gnueabihf
1226
1227Then run
1228
1229 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1230
1231or simply remove the build parameter as build=cross_compile is the default value:
1232
1233 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1234
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001235@subsubsection S3_2_2_examples How to manually build the examples ?
1236
1237The 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.
1238
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001239@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 +01001240
1241To cross compile a NEON example for Linux 32bit:
1242
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001243 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 +01001244
1245To cross compile a NEON example for Linux 64bit:
1246
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001247 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 +01001248
1249(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)
1250
1251To cross compile an OpenCL example for Linux 32bit:
1252
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001253 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 +01001254
1255To cross compile an OpenCL example for Linux 64bit:
1256
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001257 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 +01001258
Anthony Barbier14c86a92017-12-14 16:27:41 +00001259To cross compile a GLES example for Linux 32bit:
1260
1261 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
1262
1263To cross compile a GLES example for Linux 64bit:
1264
1265 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
1266
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001267(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)
1268
Anthony Barbier14c86a92017-12-14 16:27:41 +00001269To 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.
1270
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001271i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1272
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001273 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 +01001274
1275i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1276
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001277 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 +01001278
1279(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)
1280
Anthony Barbiere5007472017-10-27 15:01:44 +01001281@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1282
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001283To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1284
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001285 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 +01001286
1287To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1288
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001289 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 +01001290
1291(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1292
1293To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1294
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001295 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 +01001296
Anthony Barbier14c86a92017-12-14 16:27:41 +00001297To 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 +01001298
Anthony Barbier14c86a92017-12-14 16:27:41 +00001299 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
1300
1301To compile natively the examples with the Graph API, such as graph_lenet.cpp, you need to link the examples against arm_compute_graph.so too.
Anthony Barbier14c86a92017-12-14 16:27:41 +00001302
1303i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001304
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001305 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 +01001306
Anthony Barbier14c86a92017-12-14 16:27:41 +00001307i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001308
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001309 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 +01001310
1311(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 +01001312
Anthony Barbiere5007472017-10-27 15:01:44 +01001313@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1314
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001315@note These two commands assume libarm_compute.so is available in your library path, if not add the path to it using -L
Georgios Pinitas58216322020-02-26 11:13:13 +00001316@note You might need to export the path to OpenCL library as well in your LD_LIBRARY_PATH if Compute Library was built with OpenCL enabled.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001317
1318To run the built executable simply run:
1319
1320 LD_LIBRARY_PATH=build ./neon_convolution
1321
1322or
1323
1324 LD_LIBRARY_PATH=build ./cl_convolution
1325
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001326@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 +00001327
1328For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001329
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001330 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001331
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001332Below is a list of the common parameters among the graph examples :
1333@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001334
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001335@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001336
1337For Android, the library was successfully built and tested using Google's standalone toolchains:
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001338 - clang++ from NDK r17c for armv7a
1339 - clang++ from NDK r17c for arm64-v8a
Anthony Barbier3a6163e2018-08-10 17:36:36 +01001340 - clang++ from NDK r18-beta1 for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001341
1342Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1343
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001344- Download the NDK r17c from here: https://developer.android.com/ndk/downloads/index.html
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001345- Make sure you have Python 2.7 installed on your machine.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001346- Generate the 32 and/or 64 toolchains by running the following commands:
1347
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001348
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001349 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r17c --stl libc++ --api 21
1350 $NDK/build/tools/make_standalone_toolchain.py --arch arm --install-dir $MY_TOOLCHAINS/arm-linux-android-ndk-r17c --stl libc++ --api 21
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001351
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001352@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 +01001353
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001354@note Make sure to add the toolchains to your PATH:
1355
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001356 export PATH=$PATH:$MY_TOOLCHAINS/aarch64-linux-android-ndk-r17c/bin:$MY_TOOLCHAINS/arm-linux-android-ndk-r17c/bin
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001357
1358@subsubsection S3_3_1_library How to build the library ?
1359
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001360To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1361
1362 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1363
1364To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1365
Anthony Barbier14c86a92017-12-14 16:27:41 +00001366 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 +01001367
Anthony Barbier20dbb822017-12-13 21:19:39 +00001368To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1369
Anthony Barbier14c86a92017-12-14 16:27:41 +00001370 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 +00001371
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001372@subsubsection S3_3_2_examples How to manually build the examples ?
1373
1374The 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.
1375
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001376@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 +01001377
1378Once you've got your Android standalone toolchain built and added to your path you can do the following:
1379
1380To cross compile a NEON example:
1381
1382 #32 bit:
Georgios Pinitas9873ea32017-12-05 15:28:55 +00001383 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 +01001384 #64 bit:
Anthony Barbier14c86a92017-12-14 16:27:41 +00001385 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 +01001386
1387To cross compile an OpenCL example:
1388
1389 #32 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001390 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 +01001391 #64 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001392 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 +00001393
1394To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001395
Anthony Barbier14c86a92017-12-14 16:27:41 +00001396 #32 bit:
1397 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
1398 #64 bit:
1399 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 +01001400
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001401To cross compile the examples with the Graph API, such as graph_lenet.cpp, you need to link the library arm_compute_graph also.
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001402
1403 #32 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001404 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 +01001405 #64 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001406 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 +01001407
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001408@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 +00001409@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 +01001410
1411Then you need to do is upload the executable and the shared library to the device using ADB:
1412
1413 adb push neon_convolution_arm /data/local/tmp/
1414 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001415 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001416 adb shell chmod 777 -R /data/local/tmp/
1417
1418And finally to run the example:
1419
1420 adb shell /data/local/tmp/neon_convolution_arm
1421 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001422 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001423
1424For 64bit:
1425
1426 adb push neon_convolution_aarch64 /data/local/tmp/
1427 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001428 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001429 adb shell chmod 777 -R /data/local/tmp/
1430
1431And finally to run the example:
1432
1433 adb shell /data/local/tmp/neon_convolution_aarch64
1434 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001435 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001436
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001437@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 +00001438
1439For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001440 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001441
1442In 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.
1443
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001444@subsection S3_4_bare_metal Building for bare metal
1445
Georgios Pinitas58216322020-02-26 11:13:13 +00001446For bare metal, the library was successfully built using linaro's latest (gcc-linaro-6.3.1-2017.05) bare metal toolchains:
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001447 - arm-eabi for armv7a
1448 - aarch64-elf for arm64-v8a
1449
1450Download 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>.
1451
1452@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
1453
1454@subsubsection S3_4_1_library How to build the library ?
1455
1456To cross-compile the library with NEON support for baremetal arm64-v8a:
1457
1458 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
1459
1460@subsubsection S3_4_2_examples How to manually build the examples ?
1461
1462Examples 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>.
1463
1464@subsection S3_5_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001465
1466Using `scons` directly from the Windows command line is known to cause
1467problems. The reason seems to be that if `scons` is setup for cross-compilation
1468it gets confused about Windows style paths (using backslashes). Thus it is
1469recommended to follow one of the options outlined below.
1470
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001471@subsubsection S3_5_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001472
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001473The best and easiest option is to use
1474<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001475This feature is still marked as *beta* and thus might not be available.
1476However, if it is building the library is as simple as opening a *Bash on
1477Ubuntu on Windows* shell and following the general guidelines given above.
1478
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001479@subsubsection S3_5_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001480
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001481If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001482can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1483to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001484also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001485code of the library.) Linaro provides pre-built versions of
1486<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001487that can be used from the Cygwin terminal. When building for Android the
1488compiler is included in the Android standalone toolchain. After everything has
1489been set up in the Cygwin terminal the general guide on building the library
1490can be followed.
1491
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001492@subsection S3_6_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001493
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001494@subsubsection S3_6_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001495
1496Compute 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).
1497
1498Enabling 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.
1499
1500Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1501
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001502@subsubsection S3_6_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001503
1504Integer 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.
1505
1506OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1507
1508SVM 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 +01001509
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001510@subsection S3_7_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001511
1512The 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).
1513The 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 +01001514The 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 +01001515In 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.
1516
1517If 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:
1518
1519https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1520
1521Tuning 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.
1522
1523CLTuner 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.
1524
1525 #Example: 2 unique Matrix Multiply configurations
1526@code{.cpp}
1527 TensorShape a0 = TensorShape(32,32);
1528 TensorShape b0 = TensorShape(32,32);
1529 TensorShape c0 = TensorShape(32,32);
1530 TensorShape a1 = TensorShape(64,64);
1531 TensorShape b1 = TensorShape(64,64);
1532 TensorShape c1 = TensorShape(64,64);
1533
1534 Tensor a0_tensor;
1535 Tensor b0_tensor;
1536 Tensor c0_tensor;
1537 Tensor a1_tensor;
1538 Tensor b1_tensor;
1539 Tensor c1_tensor;
1540
1541 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1542 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1543 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1544 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1545 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1546 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1547
1548 CLGEMM gemm0;
1549 CLGEMM gemm1;
1550
1551 // Configuration 0
1552 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1553
1554 // Configuration 1
1555 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1556@endcode
1557
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001558@subsubsection S3_7_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001559
1560All 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
1561
1562 #Enable CL tuner
1563 ./graph_mobilenet --enable-tuner –-target=CL
1564 ./arm_compute_benchmark --enable-tuner
1565
1566 #Export/Import to/from a file
1567 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1568 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1569
1570If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1571
1572Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1573
1574 -# Disable the power management
1575 -# Keep the GPU frequency constant
1576 -# Run multiple times the network (i.e. 10).
1577
1578If 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.
1579
1580@code{.cpp}
1581CLTuner tuner;
1582
1583// Setup Scheduler
1584CLScheduler::get().default_init(&tuner);
1585@endcode
1586
1587After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1588- tuner.save_to_file("results.csv");
1589
1590This file can be also imported using the method "load_from_file("results.csv")".
1591- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001592*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001593} // namespace arm_compute