blob: 6fed3080f9037ebbf509b19684afaa3d4d5a7452 [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:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +010052 - Linux armv7a: gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
53 - Linux arm64-v8a: gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
54 - Android armv7a: clang++ / libc++ NDK r18b
55 - Android am64-v8a: clang++ / libc++ NDK r18b
Anthony Barbier14c86a92017-12-14 16:27:41 +000056
57@warning Make sure to use a compatible toolchain to build your application or you will get some std::bad_alloc errors at runtime.
58
Anthony Barbier6ff3b192017-09-04 18:44:23 +010059@section S1_file_organisation File organisation
60
61This archive contains:
62 - The arm_compute header and source files
63 - The latest Khronos OpenCL 1.2 C headers from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a>
64 - The latest Khronos cl2.hpp from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a> (API version 2.1 when this document was written)
Anthony Barbier20dbb822017-12-13 21:19:39 +000065 - The latest Khronos OpenGL ES 3.1 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos OpenGL ES registry</a>
66 - The latest Khronos EGL 1.5 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos EGL registry</a>
67 - The sources for a stub version of libOpenCL.so, libGLESv1_CM.so, libGLESv2.so and libEGL.so to help you build your application.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010068 - An examples folder containing a few examples to compile and link against the library.
69 - A @ref utils folder containing headers with some boiler plate code used by the examples.
70 - This documentation.
71
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.
Michele Di Giorgio36a551f2020-04-23 11:55:29 +0100247 - Updated recommended NDK version to r18b.
248 - Updated recommended gcc version to Linaro 6.3.1.
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000249 - Added Bfloat16 type support
250 - Added Bfloat16 support in:
251 - @ref NEWeightsReshapeKernel
252 - @ref NEConvolutionLayerReshapeWeights
253 - @ref NEIm2ColKernel
254 - @ref NEIm2Col
255 - @ref NEDepthConvertLayerKernel
256 - @ref NEDepthConvertLayer
257 - @ref NEGEMMConvolutionLayer
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000258 - @ref NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000259 - Added new data type QASYMM8_SIGNED support for:
260 - @ref CLDirectConvolutionLayer
261 - @ref CLDeconvolutionLayer
262 - @ref CLDirectDeconvolutionLayer
263 - @ref CLGEMMDeconvolutionLayer
264 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
265 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
266 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
267 - @ref CLReductionOperation
268 - @ref CLReduceMean
Sheri Zhang359c48e2020-04-30 22:53:39 +0100269 - @ref NEScale
270 - @ref NEScaleKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000271 - @ref NEUpsampleLayer
272 - @ref NECast
273 - @ref NEReductionOperation
274 - @ref NEReduceMean
275 - @ref NEArgMinMaxLayer
276 - @ref NEDeconvolutionLayer
277 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
278 - @ref CPPBoxWithNonMaximaSuppressionLimit
279 - @ref CPPDetectionPostProcessLayer
280 - @ref CPPPermuteKernel
281 - @ref CPPPermute
282 - @ref CPPTopKVKernel
283 - @ref CPPTopKV
Sheri Zhang359c48e2020-04-30 22:53:39 +0100284 - @ref CPPUpsample
285 - @ref CPPUpsampleKernel
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100286 - New OpenCL kernels / functions:
287 - @ref CLQLSTMLayer
288 - @ref CLQLSTMLayerNormalizationKernel
289 - New NEON kernels / functions:
290 - @ref NEQLSTMLayer
291 - @ref NEQLSTMLayerNormalizationKernel
292 - Added HARD_SWISH support in:
293 - @ref CLActivationLayerKernel
294 - @ref NEActivationLayerKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000295 - Deprecated OpenCL kernels / functions:
296 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
297 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
298 - Deprecated NEON kernels / functions:
299 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
300 - Removed CPP kernels / functions:
301 - CPPFlipWeightsKernel
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000302
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000303v20.02.1 Maintenance release
304 - Added Android-NN build script.
305
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000306v20.02 Public major release
307 - Various bug fixes.
308 - Various optimisations.
309 - Added new data type QASYMM8_SIGNED support for:
310 - @ref CLDepthwiseConvolutionLayer
311 - @ref CLDepthwiseConvolutionLayer3x3
312 - @ref CLGEMMConvolutionLayer
313 - @ref CLGEMMLowpMatrixMultiplyCore
314 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
315 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
316 - @ref NEActivationLayer
317 - @ref NEComparisonOperationKernel
318 - @ref NEConvolutionLayer
319 - @ref NEDepthwiseConvolutionLayer
320 - @ref NEDepthwiseConvolutionLayer3x3Kernel
321 - @ref NEDirectConvolutionLayerOutputStageKernel
322 - @ref NEElementwiseComparison
323 - @ref NEElementwiseMax
324 - @ref NEElementwiseMin
325 - @ref NEElementwiseSquaredDiff
326 - @ref NEFullyConnectedLayer
327 - @ref NEGEMMMatrixVectorMultiplyKernel
328 - @ref NEPixelWiseMultiplication
329 - @ref NEPoolingLayer
330 - @ref NEPReluLayer
331 - Added support for QSYMM8_PER_CHANNEL in:
332 - @ref NEDepthwiseConvolutionLayer3x3Kernel
333 - Added support for split sizes in:
334 - @ref CLSplit
335 - @ref NESplit
336 - New OpenCL kernels / functions:
337 - @ref CLFill
338 - @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
339 - New NEON kernels / functions:
340 - @ref NEFill
341 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
342 - Deprecated NEON functions / interfaces:
343 - @ref CLDepthwiseConvolutionLayer3x3
344 - @ref NEDepthwiseConvolutionLayerOptimized
345 - @ref PoolingLayerInfo constructors without Data Layout.
346 - Added support for quantization with multiplier greater than 1 on NEON and CL.
347 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
348 - Added the ability to build bootcode for bare metal.
349 - Added support for generating synthetic QASYMM8 graphs.
350 - Added support for F16 datatype in VGG16.
351 - Removed pre-built binaries for GLES.
352
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000353v19.11.1 Public maintenance release
354 - Fix offset calculation in NEReductionOperationKernel.
355 - Fix data layout in NEScaleKernel for nhwc.
356 - Retain configuration step data layout to avoid side-effects.
357 - Perform sqrt in double domain for L2 pooling.
358 - Fix output shape calculation for Reduce Mean
359 - Restrict cases where optimized NEPadLayer runs.
360
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100361v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000362 - Various bug fixes.
363 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000364 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000365 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100366 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
367 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000368 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100369 - CLDepthwiseVectorToTensorKernel
370 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000371 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100372 - NEDepthwiseWeightsReshapeKernel
373 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000374 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100375 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100376 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000377 - New OpenCL kernels / functions:
378 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
379 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
380 OpenCL kernels / functions)
381 - @ref CLLogSoftmaxLayer
382 - New NEON kernels / functions:
383 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
384 - @ref NEComputeAllAnchorsKernel / @ref NEComputeAllAnchors
385 - @ref NEDetectionPostProcessLayer
386 - @ref NEGenerateProposalsLayer
387 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
388 - @ref NELogSoftmaxLayer
389 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
390 - Added QASYMM8 support for:
391 - @ref CLGenerateProposalsLayer
392 - @ref CLROIAlignLayer
393 - @ref CPPBoxWithNonMaximaSuppressionLimit
394 - Added QASYMM16 support for:
395 - @ref CLBoundingBoxTransform
396 - Added FP16 support for:
397 - @ref CLGEMMMatrixMultiplyReshapedKernel
398 - Added new data type QASYMM8_PER_CHANNEL support for:
399 - @ref CLDequantizationLayer
400 - @ref NEDequantizationLayer
401 - Added new data type QSYMM8_PER_CHANNEL support for:
402 - @ref CLConvolutionLayer
403 - @ref NEConvolutionLayer
404 - @ref CLDepthwiseConvolutionLayer
405 - @ref NEDepthwiseConvolutionLayer
406 - Added FP16 mixed-precision support for:
407 - @ref CLGEMMMatrixMultiplyReshapedKernel
408 - @ref CLPoolingLayerKernel
409 - Added FP32 and FP16 ELU activation for:
410 - @ref CLActivationLayer
411 - @ref NEActivationLayer
412 - Added asymmetric padding support for:
413 - @ref CLDirectDeconvolutionLayer
414 - @ref CLGEMMDeconvolutionLayer
415 - @ref NEDeconvolutionLayer
416 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
417 - Replaced the calls to @ref NECopyKernel and @ref NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
418 - Replaced the calls to @ref CLCopyKernel and @ref CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
419 - Improved performance for CL Inception V3 - FP16.
420 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
421 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
422 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
423 - Optimized @ref CLPadLayer.
424 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
425 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100426
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000427v19.08.1 Public maintenance release
428 - Fix offset calculation in NEReductionOperationKernel.
429 - Fix data layout in NEScaleKernel for nhwc.
430 - Retain configuration step data layout to avoid side-effects.
431 - Perform sqrt in double domain for L2 pooling.
432 - Fix output shape calculation for Reduce Mean
433 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
434
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100435v19.08 Public major release
436 - Various bug fixes.
437 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100438 - Deprecated NEON functions
439 - NEDepthConcatenateLayer
440 - NEWidthConcatenateLayer
441 - Deprecated OpenCL kernels / functions
442 - CLDepthConcatenateLayer
443 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
444 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
445 - CLWidthConcatenateLayer
446 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100447 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100448 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100449 - @ref NEElementwisePower
450 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100451 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100452 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100453 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100454 - @ref NESinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100455 - @ref NEBatchConcatenateLayerKernel
456 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
457 - @ref NEDepthwiseConvolutionLayerNativeKernel
458 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
459 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
460 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
461 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100462 - @ref CLAbsLayer
463 - @ref CLElementwisePower
464 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100465 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100466 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100467 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100468 - @ref CLSinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100469 - @ref CLBatchConcatenateLayerKernel
470 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
471 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
472 - @ref CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
473 - @ref CLGEMMMatrixMultiplyNativeKernel
474 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
475 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
476 - New examples:
477 - neon_opticalflow
478 - cl_cache
479 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100480 - Added support for FP16 in @ref NEDeconvolutionLayer
481 - Added support for FP16 in @ref CLDeconvolutionLayer
482 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100483 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
484 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
485 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
486 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
487 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
488 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini05069f02019-09-26 17:18:26 +0100489 - The @ref CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
490 - The @ref NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100491 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
492 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100493 - 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 +0100494
Michalis Spyroua9c44722019-04-05 17:18:36 +0100495v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100496 - Various bug fixes.
497 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100498 - New Neon kernels / functions:
499 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100500 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100501 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100502 - @ref NEDepthwiseConvolutionAssemblyDispatch
503 - @ref NEFFTDigitReverseKernel
504 - @ref NEFFTRadixStageKernel
505 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100506 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
507 - @ref NEHeightConcatenateLayerKernel
508 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100509 - @ref NEFFT1D
510 - @ref NEFFT2D
511 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100512 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100513 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100514 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100515 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100516 - @ref CLFFTDigitReverseKernel
517 - @ref CLFFTRadixStageKernel
518 - @ref CLFFTScaleKernel
519 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
520 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
521 - @ref CLHeightConcatenateLayerKernel
522 - @ref CLDirectDeconvolutionLayer
523 - @ref CLFFT1D
524 - @ref CLFFT2D
525 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100526 - @ref CLGEMMDeconvolutionLayer
527 - New OpenGLES kernels / functions:
528 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100529 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100530 - GCDepthConcatenateLayer
531 - NEWidthConcatenateLayer
532 - NEDepthConcatenateLayer
533 - CLWidthConcatenateLayer
534 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100535 - CLGEMMInterleave4x4
536 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100537 - Support different quantization info in CLConcatLayer.
538 - Add checks on different input/output quantization info were not supported.
539 - Tensors have different quantization information.
540 - Add FP16 support checks.
541 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
542 - New graph examples:
543 - graph_convolution
544 - graph_fully_connected
545 - graph_depthwise_convolution
546 - Deepspeech v0.4.1
547 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
548 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
549 - Add support for QASYMM8 NEDeconvolution.
550 - Add support for DequantizationLayer for NEON/CL.
551 - Add support for dilation in CLDepthwiseConvolution.
552 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
553 - Optimize CLDeconvolution.
554 - Add StackLayer to the graph API.
555 - Add support for "reflect" padding mode in NEPad.
556 - Winograd 7x7 NHWC on OpenCL.
557 - Rework CL ML layers to run exclusively on CL.
558 - Support different quantization info in PoolingLayer.
559 - Implement and test import memory interfaces.
560 - Added new tests and removed old ones.
561 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100562
giuros01a69a88b2019-01-31 16:29:19 +0000563v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000564 - Various bug fixes.
565 - Various optimisations.
566 - New Neon kernels / functions:
567 - @ref NETileKernel / @ref NETile
568 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
569 - @ref NEElementwiseOperationKernel
570 - @ref NEElementwiseMax
571 - @ref NEElementwiseMin
572 - @ref NEElementwiseSquaredDiff
573 - @ref NESelectKernel / @ref NESelect
574 - @ref NESplit
575 - @ref NESlice
576 - @ref NEUnstack
577 - @ref NEStridedSliceKernel / @ref NEStridedSlice
578 - @ref NEElementwiseUnaryKernel
579 - @ref NERsqrtLayer
580 - @ref NEExpLayer
581 - @ref NEReverseKernel / @ref NEReverse
582 - @ref NEArgMinMaxLayer
583 - @ref NEStackLayerKernel / @ref NEStackLayer
584 - @ref NERangeKernel / @ref NERange
585 - @ref NEPadLayer
586 - @ref NEMemsetKernel
587 - @ref NEGatherKernel / @ref NEGather
588 - @ref NEElementwiseComparison
589 - @ref NEElementwiseComparisonStatic
590 - @ref NEComparisonOperationKernel
591 - @ref NEElementwiseDivision
592 - New OpenCL kernels / functions:
593 - @ref CLSelectKernel / @ref CLSelect
594 - @ref CLTileKernel / @ref CLTile
595 - @ref CLComparisonKernel / @ref CLComparison
596 - @ref CLArgMinMaxLayer
597 - @ref CLElementwiseMax
598 - @ref CLElementwiseMin
599 - @ref CLElementwiseSquaredDiff
600 - @ref CLStackLayerKernel / @ref CLStackLayer
601 - @ref CLReverse / @ref CLReverseKernel
602 - @ref CLRsqrtLayer
603 - @ref CLExpLayer
604 - @ref CLElementWiseUnaryLayerKernel
605 - @ref CLGEMMReshapeLHSMatrixKernel
606 - @ref CLGEMMReshapeRHSMatrixKernel
607 - @ref CLGEMMMatrixMultiplyReshapedKernel
608 - @ref CLRangeKernel / @ref CLRange
609 - @ref CLUnstack
610 - @ref CLGatherKernel / @ref CLGather
611 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
612 - New CPP kernels / functions:
613 - @ref CPPDetectionOutputLayer
614 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000615 - Added new examples:
616 - graph_ssd_mobilenet.cpp
617 - graph_mobilenet_v2.cpp
618 - graph_resnet12.cpp
619 - graph_srcnn955.cpp
620 - graph_vgg_vdsr.cpp
621 - graph_inception_resnet_v1.cpp
622 - Add 4D tensors support to
623 - @ref NESoftmaxLayer
624 - Fused activation in @ref CLWinogradConvolutionLayer
625 - Extented @ref NEPermute to support more cases
626 - Added NEON/SVE GEMM Hybrid kernels
627 - Added u8 and s8 hybrid assembly kernels
628 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
629 - Improved @ref CLTuner
630 - Fused the bias addition within @ref CLGEMM
631 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
632 - Added NHWC data layout support to:
633 - @ref NEScale for F16
634 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
635 - @ref NEL2NormalizeLayer for FP32/FP16
636 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
637 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000638 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000639 - Added QASYMM8 support to the following kernels:
640 - @ref NEArithmeticAdditionKernel
641 - @ref NEScale
642 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000643 - Deprecated functions/interfaces
644 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
645
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000646v18.11 Public major release
647 - Various bug fixes.
648 - Various optimisations.
649 - New Neon kernels / functions:
650 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
651 - @ref NEReduceMean
652 - @ref NEReorgLayer / @ref NEReorgLayerKernel
653 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
654 - @ref NEUpsampleLayer / @ref NEUpsampleLayerKernel
655 - @ref NEYOLOLayer / @ref NEYOLOLayerKernel
656 - New OpenCL kernels / functions:
657 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
658 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000659 - @ref CLComputeAllAnchorsKernel
660 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000661 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
662 - @ref CLReorgLayer / @ref CLReorgLayerKernel
663 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
664 - @ref CLPadLayer
665 - @ref CLReduceMean
666 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
667 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
668 - @ref CLSlice
669 - @ref CLSplit
670 - @ref CLStridedSlice / @ref CLStridedSliceKernel
671 - @ref CLUpsampleLayer / @ref CLUpsampleLayerKernel
672 - @ref CLYOLOLayer / @ref CLYOLOLayerKernel
673 - New CPP kernels / functions:
674 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
675 - Added the validate method in:
676 - @ref NEDepthConvertLayer
677 - @ref NEFloor / @ref CLFloor
678 - @ref NEGEMMMatrixAdditionKernel
679 - @ref NEReshapeLayer / @ref CLReshapeLayer
680 - @ref CLScale
681 - Added new examples:
682 - graph_shufflenet.cpp
683 - graph_yolov3.cpp
684 - Added documentation for add a new function or kernel.
685 - Improved doxygen documentation adding a list of the existing functions.
686 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100687 - CLWidthConcatenateLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000688 - @ref CLFlattenLayer
689 - @ref CLSoftmaxLayer
690 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
691 - Add SVE support
692 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
693 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
694 - Added NHWC data layout support to:
695 - @ref CLChannelShuffleLayer
696 - @ref CLDeconvolutionLayer
697 - @ref CLL2NormalizeLayer
698 - Added QASYMM8 support to the following kernels:
699 - @ref CLScaleKernel
700 - @ref NEDepthwiseConvolutionLayer3x3Kernel
701 - @ref CLPixelWiseMultiplicationKernel
702 - Added FP16 support to the following kernels:
703 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
704 - @ref NEDepthwiseConvolutionLayer3x3Kernel
705 - @ref CLNormalizePlanarYUVLayerKernel
706 - @ref CLWinogradConvolutionLayer (5x5 kernel)
707 - More tests added to both validation and benchmarking suites.
708
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100709v18.08 Public major release
710 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100711 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100712 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100713 - Removed support for QS8/QS16 data types.
714 - Added support for grouped convolution in @ref CLConvolutionLayer.
715 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100716 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100717 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
718 - @ref CLDepthwiseConvolutionLayer
719 - @ref CLDirectConvolutionLayer
720 - @ref CLConvolutionLayer
721 - @ref CLScale
722 - @ref CLIm2ColKernel
723 - New Neon kernels / functions:
724 - @ref NERNNLayer
725 - New OpenCL kernels / functions:
726 - @ref CLArithmeticDivision
727 - Introduced prepare() stage support in the graph API for GLES.
728 - Added support for memory reusage when trying to allocate smaller CLTensors.
729 - Enabled NHWC execution on graph examples.
730 - Added JPEG accessor for validation purposes.
731 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100732
733v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100734 - Various bug fixes.
735 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000736 - Major redesign in the interface for the neon kernels implemented in assembly.
737 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
738 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
739 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100740 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
741 - Improved doxygen documentation.
742 - Improved memory management for layer's transitions.
743 - Added support for NHWC data layout in tensors.
744 - Added NHWC data layout support to:
745 - @ref NEGEMMConvolutionLayer
746 - @ref NEDirectConvolutionLayer
747 - @ref NEPoolingLayer / @ref CLPoolingLayer
748 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
749 - @ref NEDepthwiseConvolutionLayer
750 - @ref NEScale
751 - @ref NEIm2Col
752 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
753 - New OpenCL kernels / functions:
754 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
755 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
756 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100757 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100758 - @ref CLRNNLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100759 - CLWidthConcatenateLayer / @ref CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100760 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
761 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
762 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100763 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
764 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
765 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
766 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
767 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
768 - Port mobilenet example to NHWC data layout.
769 - Enabled Winograd method in @ref CLConvolutionLayer.
770 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
771 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
772 - Added memory manager support in GLES functions.
773 - Major refactoring of the graph API.
774 - Added GLES backend in the graph API.
775 - Added support for the memory manager in the graph API.
776 - Enabled Winograd Convolution method in the graph API.
777 - Added support for grouped convolutions in the graph API.
778 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
779 - Added fast maths flag in @ref CLConvolutionLayer.
780 - Added new tests and benchmarks in validation and benchmark frameworks
781 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
782 - Added support to OpenCL 2.0 SVM
783 - Added support to import memory in OpenCL tensors.
784 - Added the prepare() method to perform any one off pre-processing before running the function.
785 - Added new examples:
786 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100787 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100788 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000789
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000790v18.03 Public maintenance release
791 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +0000792 - Fixed bug in @ref NEActivationLayer
793 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000794 - Updated recommended NDK version to r16b (And fixed warnings).
795 - Fixed bug in validation code.
796 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100797 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000798
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000799v18.02 Public major release
800 - Various NEON / OpenCL / GLES optimisations.
801 - Various bug fixes.
802 - Changed default number of threads on big LITTLE systems.
803 - Refactored examples and added:
804 - graph_mobilenet_qassym8
805 - graph_resnet
806 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +0000807 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
808 - 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 +0000809 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000810 - @ref CLActivationLayer
811 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000812 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000813 - @ref CLActivationLayer
814 - @ref CLDepthwiseConvolutionLayer
815 - @ref NEDepthwiseConvolutionLayer
816 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000817 - Added FP16 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000818 - @ref CLDepthwiseConvolutionLayer3x3
819 - @ref CLDepthwiseConvolutionLayer
820 - Added broadcasting support to @ref NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
821 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
822 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000823 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100824 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +0000825 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000826 - Added name() method to all kernels.
827 - Added support for Winograd 5x5.
Anthony Barbier3762e742018-03-02 11:49:33 +0000828 - @ref NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100829 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
830 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
831 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +0100832 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000833 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000834 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +0000835
Anthony Barbier64c95a02018-01-22 18:48:55 +0000836v18.01 Public maintenance release
837 - Various bug fixes
838 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +0000839 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
840 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +0000841 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +0000842 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
843 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
844 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
845 - Added @ref GCScaleKernel / @ref GCScale
846 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +0000847 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000848 - @ref GCCol2ImKernel
849 - @ref GCGEMMInterleave4x4Kernel
850 - @ref GCGEMMTranspose1xWKernel
851 - @ref GCIm2ColKernel
852 - Refactored NEON Winograd (NEWinogradLayerKernel)
853 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000854 - Added QASYMM8 support to the following NEON kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000855 - @ref NEDepthwiseConvolutionLayer3x3Kernel
856 - @ref NEFillBorderKernel
857 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000858 - Added new examples:
859 - graph_cl_mobilenet_qasymm8.cpp
860 - graph_inception_v3.cpp
861 - gc_dc.cpp
862 - More tests added to both validation and benchmarking suites.
863
Gian Marcoff850932017-12-11 12:37:17 +0000864v17.12 Public major release
865 - Most machine learning functions on OpenCL support the new data type QASYMM8
866 - Introduced logging interface
867 - Introduced opencl timer
868 - Reworked GEMMLowp interface
869 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
870 - Added validation method for most Machine Learning kernels / functions
871 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
872 - Added sgemm example for OpenCL
873 - Added absolute difference example for GLES compute
874 - Added new tests and benchmarks in validation and benchmark frameworks
875 - Added new kernels / functions for GLES compute
876
877 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000878 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
879 - @ref GCActivationLayerKernel / @ref GCActivationLayer
880 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
881 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +0100882 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000883 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
884 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
885 - @ref GCFillBorderKernel / @ref GCFillBorder
886 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
887 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
888 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
889 - @ref GCIm2ColKernel
890 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
891 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
892 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
893 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
894 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +0000895
896 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +0000897 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
898 - arm_compute::NEHGEMMAArch64FP16Kernel
Giorgio Arenad93e2632019-10-15 11:09:33 +0100899 - @ref NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / @ref NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000900 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
901 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100902 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +0000903
904 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000905 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
906 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +0000907
908 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +0100909 - graph::BranchLayer
910 - graph::DepthConvertLayer
911 - graph::DepthwiseConvolutionLayer
912 - graph::DequantizationLayer
913 - graph::FlattenLayer
914 - graph::QuantizationLayer
915 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +0000916
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100917v17.10 Public maintenance release
918 - Bug fixes:
919 - Check the maximum local workgroup size supported by OpenCL devices
920 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +0000921 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100922 - Added a few new Graph nodes, support for branches and grouping.
923 - Automatically enable cl_printf in debug builds
924 - Fixed bare metal builds for armv7a
925 - Added AlexNet and cartoon effect examples
926 - 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)
927
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100928v17.09 Public major release
929 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +0000930 - 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 +0100931 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
932 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
933 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +0000934 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000935 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
936 - @ref NEFloorKernel / @ref NEFloor
937 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
938 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
939 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
940 - @ref NEReductionOperationKernel / @ref NEReductionOperation
941 - @ref NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100942
943 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100944 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / @ref CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000945 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
946 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
947 - @ref CLFlattenLayer
948 - @ref CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100949 - CLGEMMTranspose1xW
Anthony Barbier3762e742018-03-02 11:49:33 +0000950 - @ref CLGEMMMatrixVectorMultiplyKernel
951 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
952 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
953 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
954 - @ref CLReductionOperationKernel / @ref CLReductionOperation
955 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100956
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100957v17.06 Public major release
958 - Various bug fixes
959 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
960 - Added unit tests and benchmarks (AlexNet, LeNet)
961 - Added support for sub tensors.
962 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +0000963 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
964 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
965 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100966 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000967 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100968 - @ref CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000969 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
970 - @ref CLLocallyConnectedMatrixMultiplyKernel / @ref CLLocallyConnectedLayer
971 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100972 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000973 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100974 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000975 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100976 - @ref NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000977 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
978 - @ref NELocallyConnectedMatrixMultiplyKernel / @ref NELocallyConnectedLayer
979 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100980
981v17.05 Public bug fixes release
982 - Various bug fixes
983 - Remaining of the functions ported to use accurate padding.
984 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
985 - Added "free" method to allocator.
986 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
987
988v17.04 Public bug fixes release
989
990 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +0000991 - @ref CLColorConvertKernel
992 - @ref CLEdgeNonMaxSuppressionKernel
993 - @ref CLEdgeTraceKernel
994 - @ref CLGaussianPyramidHorKernel
995 - @ref CLGaussianPyramidVertKernel
996 - @ref CLGradientKernel
997 - @ref NEChannelCombineKernel
998 - @ref NEFillArrayKernel
999 - @ref NEGaussianPyramidHorKernel
1000 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +01001001 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001002 - @ref NEHarrisScoreKernel
1003 - @ref NEHOGDetectorKernel
1004 - @ref NELogits1DMaxKernel
1005 - NELogits1DShiftExpSumKernel
1006 - NELogits1DNormKernel
1007 - @ref NENonMaximaSuppression3x3FP16Kernel
1008 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001009
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001010v17.03.1 First Major public release of the sources
1011 - Renamed the library to arm_compute
1012 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
1013 - New padding calculation interface introduced and ported most kernels / functions to use it.
1014 - New OpenCL kernels / functions:
Gian Marco Iodiceeb65f6d2020-04-15 11:42:15 +01001015 - CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001016 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001017 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
1018 - @ref NETransposeKernel / @ref NETranspose
1019 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
1020 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
1021 - @ref NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
1022 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001023
1024v17.03 Sources preview
1025 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001026 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001027 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Anthony Barbier3762e742018-03-02 11:49:33 +00001028 - @ref CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
1029 - @ref CLTransposeKernel / @ref CLTranspose
1030 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
1031 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
1032 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001033 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001034 - @ref NEActivationLayerKernel / @ref NEActivationLayer
1035 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
1036 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001037
1038v17.02.1 Sources preview
1039 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001040 - @ref CLLogits1DMaxKernel, @ref CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
1041 - @ref CLPoolingLayerKernel / @ref CLPoolingLayer
1042 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
1043 - @ref CLRemapKernel / @ref CLRemap
1044 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
1045 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
1046 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001047 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +00001048 - @ref NEAccumulateWeightedFP16Kernel
1049 - @ref NEBox3x3FP16Kernel
1050 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001051
1052v17.02 Sources preview
1053 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001054 - @ref CLActivationLayerKernel / @ref CLActivationLayer
1055 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1056 - @ref CLDerivativeKernel / @ref CLChannelExtract
1057 - @ref CLFastCornersKernel / @ref CLFastCorners
1058 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001059 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001060 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1061 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001062 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1063 - Switched all the kernels / functions to use tensors instead of images.
1064 - Updated documentation to include instructions to build the library from sources.
1065
1066v16.12 Binary preview release
1067 - Original release
1068
1069@section S3_how_to_build How to build the library and the examples
1070
1071@subsection S3_1_build_options Build options
1072
1073scons 2.3 or above is required to build the library.
1074To see the build options available simply run ```scons -h```:
1075
Anthony Barbier79c61782017-06-23 11:48:24 +01001076 debug: Debug (yes|no)
1077 default: False
1078 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001079
Anthony Barbier79c61782017-06-23 11:48:24 +01001080 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1081 default: False
1082 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001083
Anthony Barbier79c61782017-06-23 11:48:24 +01001084 arch: Target Architecture (armv7a|arm64-v8a|arm64-v8.2-a|x86_32|x86_64)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001085 default: armv7a
1086 actual: armv7a
1087
Anthony Barbier79c61782017-06-23 11:48:24 +01001088 os: Target OS (linux|android|bare_metal)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001089 default: linux
1090 actual: linux
1091
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001092 build: Build type (native|cross_compile|embed_only)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001093 default: cross_compile
1094 actual: cross_compile
1095
Anthony Barbier79c61782017-06-23 11:48:24 +01001096 examples: Build example programs (yes|no)
1097 default: True
1098 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001099
Anthony Barbier79c61782017-06-23 11:48:24 +01001100 Werror: Enable/disable the -Werror compilation flag (yes|no)
1101 default: True
1102 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001103
Anthony Barbier79c61782017-06-23 11:48:24 +01001104 opencl: Enable OpenCL support (yes|no)
1105 default: True
1106 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001107
Anthony Barbier79c61782017-06-23 11:48:24 +01001108 neon: Enable Neon support (yes|no)
1109 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001110 actual: False
1111
Anthony Barbier20dbb822017-12-13 21:19:39 +00001112 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1113 default: False
1114 actual: False
1115
1116 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shader in library binary (yes|no)
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001117 default: True
1118 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001119
1120 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1121 default: False
1122 actual: False
1123
1124 openmp: Enable OpenMP backend (yes|no)
1125 default: False
1126 actual: False
1127
1128 cppthreads: Enable C++11 threads backend (yes|no)
1129 default: True
1130 actual: True
1131
1132 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1133 default: .
1134 actual: .
1135
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001136 extra_cxx_flags: Extra CXX flags to be appended to the build command
1137 default:
1138 actual:
1139
Anthony Barbier79c61782017-06-23 11:48:24 +01001140 pmu: Enable PMU counters (yes|no)
1141 default: False
1142 actual: False
1143
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001144 mali: Enable Mali hardware counters (yes|no)
1145 default: False
1146 actual: False
1147
Anthony Barbier79c61782017-06-23 11:48:24 +01001148 validation_tests: Build validation test programs (yes|no)
1149 default: False
1150 actual: False
1151
1152 benchmark_tests: Build benchmark test programs (yes|no)
1153 default: False
1154 actual: False
1155
1156@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001157 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1158 - 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)
1159 - 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).
1160
Anthony Barbier79c61782017-06-23 11:48:24 +01001161@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 +01001162
Anthony Barbier79c61782017-06-23 11:48:24 +01001163@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001164@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1165
Anthony Barbier79c61782017-06-23 11:48:24 +01001166@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 +01001167
Anthony Barbier79c61782017-06-23 11:48:24 +01001168@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 +01001169
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001170There 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.
1171
Anthony Barbier79c61782017-06-23 11:48:24 +01001172@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 +01001173
Anthony Barbier20dbb822017-12-13 21:19:39 +00001174@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 +01001175
Anthony Barbier20dbb822017-12-13 21:19:39 +00001176@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 +01001177
1178@b set_soname: Do you want to build the versioned version of the library ?
1179
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001180If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1181Example:
1182 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1183 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1184 libarm_compute_core.so.1.0.0
1185
1186@note This options is disabled by default as it requires SCons version 2.4 or above.
1187
Anthony Barbier79c61782017-06-23 11:48:24 +01001188@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1189
1190@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1191
1192@b examples: Build or not the examples
1193
1194@b validation_tests: Enable the build of the validation suite.
1195
Anthony Barbier79c61782017-06-23 11:48:24 +01001196@b benchmark_tests: Enable the build of the benchmark tests
1197
1198@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1199
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001200@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)
1201
Anthony Barbier79c61782017-06-23 11:48:24 +01001202@b openmp Build in the OpenMP scheduler for NEON.
1203
1204@note Only works when building with g++ not clang++
1205
1206@b cppthreads Build in the C++11 scheduler for NEON.
1207
Anthony Barbier3762e742018-03-02 11:49:33 +00001208@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001209
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001210@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001211
1212@subsubsection S3_2_1_library How to build the library ?
1213
1214For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1215
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001216 - gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
1217 - gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001218
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001219To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1220
1221 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1222
1223To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1224
1225 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1226
Anthony Barbier20dbb822017-12-13 21:19:39 +00001227To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1228
1229 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1230
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001231You can also compile the library natively on an ARM device by using <b>build=native</b>:
1232
1233 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1234 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1235
1236@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.
1237
1238For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1239
1240 apt-get install g++-arm-linux-gnueabihf
1241
1242Then run
1243
1244 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1245
1246or simply remove the build parameter as build=cross_compile is the default value:
1247
1248 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1249
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001250@subsubsection S3_2_2_examples How to manually build the examples ?
1251
1252The 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.
1253
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001254@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 +01001255
1256To cross compile a NEON example for Linux 32bit:
1257
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001258 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 +01001259
1260To cross compile a NEON example for Linux 64bit:
1261
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001262 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 +01001263
1264(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)
1265
1266To cross compile an OpenCL example for Linux 32bit:
1267
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001268 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 +01001269
1270To cross compile an OpenCL example for Linux 64bit:
1271
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001272 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 +01001273
Anthony Barbier14c86a92017-12-14 16:27:41 +00001274To cross compile a GLES example for Linux 32bit:
1275
1276 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
1277
1278To cross compile a GLES example for Linux 64bit:
1279
1280 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
1281
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001282(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)
1283
Anthony Barbier14c86a92017-12-14 16:27:41 +00001284To 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.
1285
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001286i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1287
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001288 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 +01001289
1290i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1291
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001292 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 +01001293
1294(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)
1295
Anthony Barbiere5007472017-10-27 15:01:44 +01001296@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1297
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001298To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1299
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001300 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 +01001301
1302To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1303
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001304 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 +01001305
1306(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1307
1308To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1309
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001310 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 +01001311
Anthony Barbier14c86a92017-12-14 16:27:41 +00001312To 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 +01001313
Anthony Barbier14c86a92017-12-14 16:27:41 +00001314 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
1315
1316To 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 +00001317
1318i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001319
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001320 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 +01001321
Anthony Barbier14c86a92017-12-14 16:27:41 +00001322i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001323
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001324 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 +01001325
1326(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 +01001327
Anthony Barbiere5007472017-10-27 15:01:44 +01001328@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1329
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001330@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 +00001331@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 +01001332
1333To run the built executable simply run:
1334
1335 LD_LIBRARY_PATH=build ./neon_convolution
1336
1337or
1338
1339 LD_LIBRARY_PATH=build ./cl_convolution
1340
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001341@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 +00001342
1343For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001344
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001345 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001346
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001347Below is a list of the common parameters among the graph examples :
1348@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001349
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001350@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001351
1352For Android, the library was successfully built and tested using Google's standalone toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001353 - clang++ from NDK r18b for armv7a
1354 - clang++ from NDK r18b for arm64-v8a
1355 - clang++ from NDK r18b for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001356
1357Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1358
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001359- Download the NDK r18b from here: https://developer.android.com/ndk/downloads/index.html
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001360- Make sure you have Python 2.7 installed on your machine.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001361- Generate the 32 and/or 64 toolchains by running the following commands:
1362
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001363
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001364 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b --stl libc++ --api 21
1365 $NDK/build/tools/make_standalone_toolchain.py --arch arm --install-dir $MY_TOOLCHAINS/arm-linux-android-ndk-r18b --stl libc++ --api 21
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001366
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001367@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 +01001368
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001369@note Make sure to add the toolchains to your PATH:
1370
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001371 export PATH=$PATH:$MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b/bin:$MY_TOOLCHAINS/arm-linux-android-ndk-r18b/bin
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001372
1373@subsubsection S3_3_1_library How to build the library ?
1374
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001375To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1376
1377 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1378
1379To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1380
Anthony Barbier14c86a92017-12-14 16:27:41 +00001381 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 +01001382
Anthony Barbier20dbb822017-12-13 21:19:39 +00001383To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1384
Anthony Barbier14c86a92017-12-14 16:27:41 +00001385 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 +00001386
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001387@subsubsection S3_3_2_examples How to manually build the examples ?
1388
1389The 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.
1390
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001391@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 +01001392
1393Once you've got your Android standalone toolchain built and added to your path you can do the following:
1394
1395To cross compile a NEON example:
1396
1397 #32 bit:
Georgios Pinitas9873ea32017-12-05 15:28:55 +00001398 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 +01001399 #64 bit:
Anthony Barbier14c86a92017-12-14 16:27:41 +00001400 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 +01001401
1402To cross compile an OpenCL example:
1403
1404 #32 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001405 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 +01001406 #64 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001407 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 +00001408
1409To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001410
Anthony Barbier14c86a92017-12-14 16:27:41 +00001411 #32 bit:
1412 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
1413 #64 bit:
1414 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 +01001415
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001416To 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 +01001417
1418 #32 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001419 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 +01001420 #64 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001421 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 +01001422
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001423@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 +00001424@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 +01001425
1426Then you need to do is upload the executable and the shared library to the device using ADB:
1427
1428 adb push neon_convolution_arm /data/local/tmp/
1429 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001430 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001431 adb shell chmod 777 -R /data/local/tmp/
1432
1433And finally to run the example:
1434
1435 adb shell /data/local/tmp/neon_convolution_arm
1436 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001437 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001438
1439For 64bit:
1440
1441 adb push neon_convolution_aarch64 /data/local/tmp/
1442 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001443 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001444 adb shell chmod 777 -R /data/local/tmp/
1445
1446And finally to run the example:
1447
1448 adb shell /data/local/tmp/neon_convolution_aarch64
1449 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001450 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001451
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001452@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 +00001453
1454For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001455 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001456
1457In 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.
1458
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001459@subsection S3_4_bare_metal Building for bare metal
1460
Georgios Pinitas58216322020-02-26 11:13:13 +00001461For 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 +01001462 - arm-eabi for armv7a
1463 - aarch64-elf for arm64-v8a
1464
1465Download 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>.
1466
1467@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
1468
1469@subsubsection S3_4_1_library How to build the library ?
1470
1471To cross-compile the library with NEON support for baremetal arm64-v8a:
1472
1473 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
1474
1475@subsubsection S3_4_2_examples How to manually build the examples ?
1476
1477Examples 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>.
1478
1479@subsection S3_5_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001480
1481Using `scons` directly from the Windows command line is known to cause
1482problems. The reason seems to be that if `scons` is setup for cross-compilation
1483it gets confused about Windows style paths (using backslashes). Thus it is
1484recommended to follow one of the options outlined below.
1485
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001486@subsubsection S3_5_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001487
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001488The best and easiest option is to use
1489<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001490This feature is still marked as *beta* and thus might not be available.
1491However, if it is building the library is as simple as opening a *Bash on
1492Ubuntu on Windows* shell and following the general guidelines given above.
1493
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001494@subsubsection S3_5_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001495
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001496If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001497can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1498to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001499also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001500code of the library.) Linaro provides pre-built versions of
1501<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001502that can be used from the Cygwin terminal. When building for Android the
1503compiler is included in the Android standalone toolchain. After everything has
1504been set up in the Cygwin terminal the general guide on building the library
1505can be followed.
1506
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001507@subsection S3_6_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001508
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001509@subsubsection S3_6_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001510
1511Compute 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).
1512
1513Enabling 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.
1514
1515Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1516
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001517@subsubsection S3_6_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001518
1519Integer 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.
1520
1521OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1522
1523SVM 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 +01001524
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001525@subsection S3_7_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001526
1527The 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).
1528The 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 +01001529The 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 +01001530In 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.
1531
1532If 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:
1533
1534https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1535
1536Tuning 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.
1537
1538CLTuner 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.
1539
1540 #Example: 2 unique Matrix Multiply configurations
1541@code{.cpp}
1542 TensorShape a0 = TensorShape(32,32);
1543 TensorShape b0 = TensorShape(32,32);
1544 TensorShape c0 = TensorShape(32,32);
1545 TensorShape a1 = TensorShape(64,64);
1546 TensorShape b1 = TensorShape(64,64);
1547 TensorShape c1 = TensorShape(64,64);
1548
1549 Tensor a0_tensor;
1550 Tensor b0_tensor;
1551 Tensor c0_tensor;
1552 Tensor a1_tensor;
1553 Tensor b1_tensor;
1554 Tensor c1_tensor;
1555
1556 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1557 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1558 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1559 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1560 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1561 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1562
1563 CLGEMM gemm0;
1564 CLGEMM gemm1;
1565
1566 // Configuration 0
1567 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1568
1569 // Configuration 1
1570 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1571@endcode
1572
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001573@subsubsection S3_7_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001574
1575All 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
1576
1577 #Enable CL tuner
1578 ./graph_mobilenet --enable-tuner –-target=CL
1579 ./arm_compute_benchmark --enable-tuner
1580
1581 #Export/Import to/from a file
1582 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1583 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1584
1585If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1586
1587Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1588
1589 -# Disable the power management
1590 -# Keep the GPU frequency constant
1591 -# Run multiple times the network (i.e. 10).
1592
1593If 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.
1594
1595@code{.cpp}
1596CLTuner tuner;
1597
1598// Setup Scheduler
1599CLScheduler::get().default_init(&tuner);
1600@endcode
1601
1602After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1603- tuner.save_to_file("results.csv");
1604
1605This file can be also imported using the method "load_from_file("results.csv")".
1606- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001607*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001608} // namespace arm_compute