blob: a0018b2935239b4f694124ebb89bb047274098db [file] [log] [blame]
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00001///
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +00002/// Copyright (c) 2017-2020 ARM Limited.
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00003///
4/// SPDX-License-Identifier: MIT
5///
6/// Permission is hereby granted, free of charge, to any person obtaining a copy
7/// of this software and associated documentation files (the "Software"), to
8/// deal in the Software without restriction, including without limitation the
9/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10/// sell copies of the Software, and to permit persons to whom the Software is
11/// furnished to do so, subject to the following conditions:
12///
13/// The above copyright notice and this permission notice shall be included in all
14/// copies or substantial portions of the Software.
15///
16/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22/// SOFTWARE.
23///
Anthony Barbier3762e742018-03-02 11:49:33 +000024namespace arm_compute
25{
Anthony Barbier6ff3b192017-09-04 18:44:23 +010026/** @mainpage Introduction
27
28@tableofcontents
29
30The Computer Vision and Machine Learning library is a set of functions optimised for both ARM CPUs and GPUs using SIMD technologies.
31
32Several builds of the library are available using various configurations:
33 - OS: Linux, Android or bare metal.
34 - Architecture: armv7a (32bit) or arm64-v8a (64bit)
Anthony Barbier20dbb822017-12-13 21:19:39 +000035 - Technology: NEON / OpenCL / GLES_COMPUTE / NEON and OpenCL and GLES_COMPUTE
Anthony Barbier6ff3b192017-09-04 18:44:23 +010036 - Debug / Asserts / Release: Use a build with asserts enabled to debug your application and enable extra validation. Once you are sure your application works as expected you can switch to a release build of the library for maximum performance.
37
38@section S0_1_contact Contact / Support
39
40Please email developer@arm.com
41
42In order to facilitate the work of the support team please provide the build information of the library you are using. To get the version of the library you are using simply run:
43
44 $ strings android-armv7a-cl-asserts/libarm_compute.so | grep arm_compute_version
45 arm_compute_version=v16.12 Build options: {'embed_kernels': '1', 'opencl': '1', 'arch': 'armv7a', 'neon': '0', 'asserts': '1', 'debug': '0', 'os': 'android', 'Werror': '1'} Git hash=f51a545d4ea12a9059fe4e598a092f1fd06dc858
46
Anthony Barbier14c86a92017-12-14 16:27:41 +000047@section S0_2_prebuilt_binaries Pre-built binaries
48
49For each release we provide some pre-built binaries of the library [here](https://github.com/ARM-software/ComputeLibrary/releases)
50
51These binaries have been built using the following toolchains:
Isabella Gottardibe2de402018-11-21 15:23:49 +000052 - Linux armv7a: gcc-linaro-4.9-2016.02-x86_64_arm-linux-gnueabihf
Anthony Barbier14c86a92017-12-14 16:27:41 +000053 - Linux arm64-v8a: gcc-linaro-4.9-2016.02-x86_64_aarch64-linux-gnu
SiCong Li1f7f9882019-11-28 14:59:35 +000054 - Android armv7a: clang++ / libc++ NDK r17c
55 - Android am64-v8a: clang++ / libc++ NDK r17c
Anthony Barbier14c86a92017-12-14 16:27:41 +000056
57@warning Make sure to use a compatible toolchain to build your application or you will get some std::bad_alloc errors at runtime.
58
Anthony Barbier6ff3b192017-09-04 18:44:23 +010059@section S1_file_organisation File organisation
60
61This archive contains:
62 - The arm_compute header and source files
63 - The latest Khronos OpenCL 1.2 C headers from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a>
64 - The latest Khronos cl2.hpp from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a> (API version 2.1 when this document was written)
Anthony Barbier20dbb822017-12-13 21:19:39 +000065 - The latest Khronos OpenGL ES 3.1 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos OpenGL ES registry</a>
66 - The latest Khronos EGL 1.5 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos EGL registry</a>
67 - The sources for a stub version of libOpenCL.so, libGLESv1_CM.so, libGLESv2.so and libEGL.so to help you build your application.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010068 - An examples folder containing a few examples to compile and link against the library.
69 - A @ref utils folder containing headers with some boiler plate code used by the examples.
70 - This documentation.
71
72You should have the following file organisation:
73
74 .
75 ├── arm_compute --> All the arm_compute headers
Georgios Pinitasf112ede2019-03-01 19:11:20 +000076 │ ├── graph.h --> Includes all the Graph headers at once.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010077 │   ├── core
78 │   │   ├── CL
Georgios Pinitas5ca23952020-01-20 19:03:06 +000079 │ │ │ ├── CLCoreRuntimeContext.h --> Manages all core OpenCL objects needed for kernel execution (cl_context, cl_kernel, cl_command_queue, etc).
Anthony Barbier6a5627a2017-09-26 14:42:02 +010080 │   │   │   ├── CLKernelLibrary.h --> Manages all the OpenCL kernels compilation and caching, provides accessors for the OpenCL Context.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010081 │   │   │   ├── CLKernels.h --> Includes all the OpenCL kernels at once
Georgios Pinitas5ca23952020-01-20 19:03:06 +000082 │   │   │   ├── CL specialisation of all the generic objects interfaces (ICLTensor, ICLArray, etc.)
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
Georgios Pinitas5ca23952020-01-20 19:03:06 +000091 │ │ │ ├── GCCoreRuntimeContext.h --> Manages all core GLES objects needed for kernel execution.
Anthony Barbier20dbb822017-12-13 21:19:39 +000092 │   │   │   ├── GCKernelLibrary.h --> Manages all the GLES kernels compilation and caching, provides accessors for the GLES Context.
93 │   │   │   ├── GCKernels.h --> Includes all the GLES kernels at once
Georgios Pinitas5ca23952020-01-20 19:03:06 +000094 │   │   │   ├── GLES specialisation of all the generic objects interfaces (IGCTensor etc.)
Anthony Barbier20dbb822017-12-13 21:19:39 +000095 │   │   │   ├── kernels --> Folder containing all the GLES kernels
96 │   │   │   │   └── GC*Kernel.h
97 │   │   │   └── OpenGLES.h --> Wrapper to configure the Khronos EGL and OpenGL ES C header
Anthony Barbier6ff3b192017-09-04 18:44:23 +010098 │   │   ├── NEON
99 │   │   │   ├── kernels --> Folder containing all the NEON kernels
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100100 │   │   │   │ ├── assembly --> headers for assembly optimised NEON kernels.
101 │   │   │   │ ├── convolution --> headers for convolution assembly optimised NEON kernels.
102 │   │   │   │   │   ├── common --> headers for code which is common to several convolution implementations.
103 │   │   │   │   │   ├── depthwise --> headers for Depthwise convolultion assembly implementation
104 │   │   │   │   │   └── winograd --> headers for Winograd convolution assembly implementation
105 │   │   │   │ ├── detail --> Common code for several intrinsics implementations.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100106 │   │   │   │   └── NE*Kernel.h
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000107 │   │   │   ├── wrapper --> NEON wrapper used to simplify code
108 │   │   │   │ ├── intrinsics --> NEON instrincs' wrappers
109 │   │   │   │ ├── scalar --> Scalar operations
110 │   │   │   │ ├── traits.h --> Traits defined on NEON vectors
111 │   │   │   │   └── wrapper.h --> Includes all wrapper headers at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100112 │   │   │   └── NEKernels.h --> Includes all the NEON kernels at once
113 │   │   ├── All common basic types (Types.h, Window, Coordinates, Iterator, etc.)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000114 │   │   ├── All generic objects interfaces (ITensor, IArray, etc.)
115 │   │   └── Objects metadata classes (TensorInfo, MultiImageInfo)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100116 │   ├── graph
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100117 │   │   ├── algorithms
118 │   │   │   └── Generic algorithms used by the graph backend (e.g Order of traversal)
119 │   │   ├── backends --> The backend specific code
120 │   │   │   ├── CL --> OpenCL specific operations
121 │   │   │   ├── GLES --> OpenGLES Compute Shaders specific operations
122 │   │   │   └── NEON --> NEON specific operations
123 │   │   ├── detail
124 │   │   │   └── Collection of internal utilities.
125 │   │   ├── frontend
126 │   │   │   └── Code related to the stream frontend interface.
127 │   │   ├── mutators
128 │   │   │   └── Used to modify / optimise the Graph intermediate representation(Operator fusion, in place operations, etc.)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100129 │   │   ├── nodes
130 │   │   │   └── The various nodes supported by the graph API
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100131 │   │   ├── printers
132 │   │   │   └── Debug printers
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100133 │   │   └── Graph objects ( INode, ITensorAccessor, Graph, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100134 │   └── runtime
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000135 │   ├── common
136 │ │ └── Common utility code used by all backends
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100137 │   ├── CL
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000138 │   │   ├── CL objects & allocators (CLArray, CLTensor, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100139 │   │   ├── functions --> Folder containing all the OpenCL functions
140 │   │   │   └── CL*.h
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100141 │   │   ├── CLScheduler.h --> Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100142 │   │   ├── CLFunctions.h --> Includes all the OpenCL functions at once
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000143 │   │   ├── ICLTuner.h --> Interface used to tune the local work-group size of OpenCL kernels
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100144 │   │   └── tuners
145 │   │      └── Local workgroup size tuners for specific architectures / GPUs
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100146 │   ├── CPP
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100147 │      │   ├── CPPKernels.h --> Includes all the CPP functions at once.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100148 │   │   ├── CPPScheduler.h --> Basic pool of threads to execute CPP/NEON code on several cores in parallel
149 │   │   └── functions --> Folder containing all the CPP functions
150 │   │      └── CPP*.h
Anthony Barbier20dbb822017-12-13 21:19:39 +0000151 │   ├── GLES_COMPUTE
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000152 │   │   ├── GLES objects & allocators (GCArray, GCTensor, etc.)
Anthony Barbier20dbb822017-12-13 21:19:39 +0000153 │   │   ├── functions --> Folder containing all the GLES functions
154 │   │   │   └── GC*.h
155 │   │   ├── GCScheduler.h --> Interface to enqueue GLES kernels and get/set the GLES CommandQueue.
156 │   │   └── GCFunctions.h --> Includes all the GLES functions at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100157 │   ├── NEON
158 │   │ ├── functions --> Folder containing all the NEON functions
159 │   │ │   └── NE*.h
160 │   │ └── NEFunctions.h --> Includes all the NEON functions at once
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100161 │   ├── OMP
162 │   │   └── OMPScheduler.h --> OpenMP scheduler (Alternative to the CPPScheduler)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000163 │ ├── Memory & weights manager files (LifetimeManager, PoolManager, etc.)
164 │   └── Basic implementations of the generic object interfaces (Array, Tensor, etc.)
165 ├── data --> Contains test images and reference data dumps used by validation tests
166 ├── docs --> Contains Doxyfile and Doxygen sources used to generate the HTML pages in the documentation folder.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100167 ├── documentation
168 │   ├── index.xhtml
169 │   └── ...
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000170 ├── documentation.xhtml --> documentation/index.xhtml
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100171 ├── examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000172 │   ├── cl_*.cpp --> OpenCL examples
Anthony Barbier14c86a92017-12-14 16:27:41 +0000173 │   ├── gc_*.cpp --> GLES compute shaders examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000174 │   ├── graph_*.cpp --> Graph examples
175 │   ├── neoncl_*.cpp --> NEON / OpenCL interoperability examples
176 │   └── neon_*.cpp --> NEON examples
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100177 ├── include
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100178 │   ├── CL
179 │   │ └── Khronos OpenCL C headers and C++ wrapper
180 │   ├── half --> FP16 library available from http://half.sourceforge.net
Anthony Barbier14c86a92017-12-14 16:27:41 +0000181 │   ├── libnpy --> Library to load / write npy buffers, available from https://github.com/llohse/libnpy
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000182 │  ├── linux --> Headers only needed for Linux builds
183 │   │ └── Khronos EGL and OpenGLES headers
184 │ └── stb
185 │ └── stb_image.h --> Single header library to load image files, available from https://github.com/nothings/stb
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100186 ├── scripts
187 │   ├── caffe_data_extractor.py --> Basic script to export weights from Caffe to npy files
188 │   └── tensorflow_data_extractor.py --> Basic script to export weights from Tensor Flow to npy files
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100189 ├── src
190 │   ├── core
191 │ │ └── ... (Same structure as headers)
Anthony Barbier20dbb822017-12-13 21:19:39 +0000192 │   │ ├── CL
193 │   │ │ └── cl_kernels --> All the OpenCL kernels
194 │   │ └── GLES_COMPUTE
195 │   │ └── cs_shaders --> All the OpenGL ES Compute Shaders
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100196 │   ├── graph
197 │ │ └── ... (Same structure as headers)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100198 │ └── runtime
199 │ └── ... (Same structure as headers)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100200 ├── support
201 │ └── Various headers to work around toolchains / platform issues.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100202 ├── tests
203 │   ├── All test related files shared between validation and benchmark
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100204 │   ├── benchmark --> Sources for benchmarking
205 │ │ ├── Benchmark specific files
206 │   │ ├── fixtures
207 │ │ │ └── Backend agnostic fixtures to initialise and run the functions to test.
208 │ │ ├── CL --> OpenCL benchmarking tests
209 │ │ ├── GLES_COMPUTE --> GLES benchmarking tests
210 │ │ └── NEON --> NEON benchmarking tests
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000211 │ ├── benchmark_examples --> Sources needed to wrap examples to run through our benchmarking framework.
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100212 │   ├── CL --> OpenCL accessors
Anthony Barbier20dbb822017-12-13 21:19:39 +0000213 │   ├── GLES_COMPUTE --> GLES accessors
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100214 │   ├── NEON --> NEON accessors
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100215 │   ├── datasets
216 │ │ └── Datasets for all the validation / benchmark tests, layer configurations for various networks, etc.
217 │   ├── framework
218 │ │ └── Boiler plate code for both validation and benchmark test suites (Command line parsers, instruments, output loggers, etc.)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000219 │   ├── instruments --> User defined instruments that can be registered to the framework.
220 │ ├── validate_examples --> Sources needed to wrap examples to run through our validation framework.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100221 │   └── validation --> Sources for validation
222 │ ├── Validation specific files
223 │   ├── fixtures
224 │ │ └── Backend agnostic fixtures to initialise and run the functions to test.
225 │   ├── reference
226 │ │ └── Reference implementation used to validate the results of the various backends.
227 │ ├── CL --> OpenCL validation tests
228 │ ├── GLES_COMPUTE --> GLES validation tests
229 │ ├── CPP --> C++ reference implementations
230 │ └── NEON --> NEON validation tests
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100231 └── utils --> Boiler plate code used by examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000232 └── Various utilities to print types, load / store assets, etc.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100233
234@section S2_versions_changelog Release versions and changelog
235
236@subsection S2_1_versions Release versions
237
238All releases are numbered vYY.MM Where YY are the last two digits of the year, and MM the month number.
239If there is more than one release in a month then an extra sequential number is appended at the end:
240
241 v17.03 (First release of March 2017)
242 v17.03.1 (Second release of March 2017)
243 v17.04 (First release of April 2017)
244
245@note We're aiming at releasing one major public release with new features per quarter. All releases in between will only contain bug fixes.
246
247@subsection S2_2_changelog Changelog
248
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000249v20.02.1 Maintenance release
250 - Added Android-NN build script.
251
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000252v20.02 Public major release
253 - Various bug fixes.
254 - Various optimisations.
255 - Added new data type QASYMM8_SIGNED support for:
256 - @ref CLDepthwiseConvolutionLayer
257 - @ref CLDepthwiseConvolutionLayer3x3
258 - @ref CLGEMMConvolutionLayer
259 - @ref CLGEMMLowpMatrixMultiplyCore
260 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
261 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
262 - @ref NEActivationLayer
263 - @ref NEComparisonOperationKernel
264 - @ref NEConvolutionLayer
265 - @ref NEDepthwiseConvolutionLayer
266 - @ref NEDepthwiseConvolutionLayer3x3Kernel
267 - @ref NEDirectConvolutionLayerOutputStageKernel
268 - @ref NEElementwiseComparison
269 - @ref NEElementwiseMax
270 - @ref NEElementwiseMin
271 - @ref NEElementwiseSquaredDiff
272 - @ref NEFullyConnectedLayer
273 - @ref NEGEMMMatrixVectorMultiplyKernel
274 - @ref NEPixelWiseMultiplication
275 - @ref NEPoolingLayer
276 - @ref NEPReluLayer
277 - Added support for QSYMM8_PER_CHANNEL in:
278 - @ref NEDepthwiseConvolutionLayer3x3Kernel
279 - Added support for split sizes in:
280 - @ref CLSplit
281 - @ref NESplit
282 - New OpenCL kernels / functions:
283 - @ref CLFill
284 - @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
285 - New NEON kernels / functions:
286 - @ref NEFill
287 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
288 - Deprecated NEON functions / interfaces:
289 - @ref CLDepthwiseConvolutionLayer3x3
290 - @ref NEDepthwiseConvolutionLayerOptimized
291 - @ref PoolingLayerInfo constructors without Data Layout.
292 - Added support for quantization with multiplier greater than 1 on NEON and CL.
293 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
294 - Added the ability to build bootcode for bare metal.
295 - Added support for generating synthetic QASYMM8 graphs.
296 - Added support for F16 datatype in VGG16.
297 - Removed pre-built binaries for GLES.
298
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000299v19.11.1 Public maintenance release
300 - Fix offset calculation in NEReductionOperationKernel.
301 - Fix data layout in NEScaleKernel for nhwc.
302 - Retain configuration step data layout to avoid side-effects.
303 - Perform sqrt in double domain for L2 pooling.
304 - Fix output shape calculation for Reduce Mean
305 - Restrict cases where optimized NEPadLayer runs.
306
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100307v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000308 - Various bug fixes.
309 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000310 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000311 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100312 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
313 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000314 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100315 - CLDepthwiseVectorToTensorKernel
316 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000317 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100318 - NEDepthwiseWeightsReshapeKernel
319 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000320 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100321 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100322 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000323 - New OpenCL kernels / functions:
324 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
325 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
326 OpenCL kernels / functions)
327 - @ref CLLogSoftmaxLayer
328 - New NEON kernels / functions:
329 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
330 - @ref NEComputeAllAnchorsKernel / @ref NEComputeAllAnchors
331 - @ref NEDetectionPostProcessLayer
332 - @ref NEGenerateProposalsLayer
333 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
334 - @ref NELogSoftmaxLayer
335 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
336 - Added QASYMM8 support for:
337 - @ref CLGenerateProposalsLayer
338 - @ref CLROIAlignLayer
339 - @ref CPPBoxWithNonMaximaSuppressionLimit
340 - Added QASYMM16 support for:
341 - @ref CLBoundingBoxTransform
342 - Added FP16 support for:
343 - @ref CLGEMMMatrixMultiplyReshapedKernel
344 - Added new data type QASYMM8_PER_CHANNEL support for:
345 - @ref CLDequantizationLayer
346 - @ref NEDequantizationLayer
347 - Added new data type QSYMM8_PER_CHANNEL support for:
348 - @ref CLConvolutionLayer
349 - @ref NEConvolutionLayer
350 - @ref CLDepthwiseConvolutionLayer
351 - @ref NEDepthwiseConvolutionLayer
352 - Added FP16 mixed-precision support for:
353 - @ref CLGEMMMatrixMultiplyReshapedKernel
354 - @ref CLPoolingLayerKernel
355 - Added FP32 and FP16 ELU activation for:
356 - @ref CLActivationLayer
357 - @ref NEActivationLayer
358 - Added asymmetric padding support for:
359 - @ref CLDirectDeconvolutionLayer
360 - @ref CLGEMMDeconvolutionLayer
361 - @ref NEDeconvolutionLayer
362 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
363 - Replaced the calls to @ref NECopyKernel and @ref NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
364 - Replaced the calls to @ref CLCopyKernel and @ref CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
365 - Improved performance for CL Inception V3 - FP16.
366 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
367 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
368 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
369 - Optimized @ref CLPadLayer.
370 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
371 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100372
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000373v19.08.1 Public maintenance release
374 - Fix offset calculation in NEReductionOperationKernel.
375 - Fix data layout in NEScaleKernel for nhwc.
376 - Retain configuration step data layout to avoid side-effects.
377 - Perform sqrt in double domain for L2 pooling.
378 - Fix output shape calculation for Reduce Mean
379 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
380
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100381v19.08 Public major release
382 - Various bug fixes.
383 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100384 - Deprecated NEON functions
385 - NEDepthConcatenateLayer
386 - NEWidthConcatenateLayer
387 - Deprecated OpenCL kernels / functions
388 - CLDepthConcatenateLayer
389 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
390 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
391 - CLWidthConcatenateLayer
392 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100393 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100394 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100395 - @ref NEElementwisePower
396 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100397 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100398 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100399 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100400 - @ref NESinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100401 - @ref NEBatchConcatenateLayerKernel
402 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
403 - @ref NEDepthwiseConvolutionLayerNativeKernel
404 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
405 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
406 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
407 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100408 - @ref CLAbsLayer
409 - @ref CLElementwisePower
410 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100411 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100412 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100413 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100414 - @ref CLSinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100415 - @ref CLBatchConcatenateLayerKernel
416 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
417 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
418 - @ref CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
419 - @ref CLGEMMMatrixMultiplyNativeKernel
420 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
421 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
422 - New examples:
423 - neon_opticalflow
424 - cl_cache
425 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100426 - Added support for FP16 in @ref NEDeconvolutionLayer
427 - Added support for FP16 in @ref CLDeconvolutionLayer
428 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100429 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
430 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
431 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
432 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
433 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
434 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini05069f02019-09-26 17:18:26 +0100435 - The @ref CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
436 - The @ref NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100437 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
438 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100439 - 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 +0100440
Michalis Spyroua9c44722019-04-05 17:18:36 +0100441v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100442 - Various bug fixes.
443 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100444 - New Neon kernels / functions:
445 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100446 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100447 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100448 - @ref NEDepthwiseConvolutionAssemblyDispatch
449 - @ref NEFFTDigitReverseKernel
450 - @ref NEFFTRadixStageKernel
451 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100452 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
453 - @ref NEHeightConcatenateLayerKernel
454 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100455 - @ref NEFFT1D
456 - @ref NEFFT2D
457 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100458 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100459 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100460 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100461 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100462 - @ref CLFFTDigitReverseKernel
463 - @ref CLFFTRadixStageKernel
464 - @ref CLFFTScaleKernel
465 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
466 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
467 - @ref CLHeightConcatenateLayerKernel
468 - @ref CLDirectDeconvolutionLayer
469 - @ref CLFFT1D
470 - @ref CLFFT2D
471 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100472 - @ref CLGEMMDeconvolutionLayer
473 - New OpenGLES kernels / functions:
474 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100475 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100476 - GCDepthConcatenateLayer
477 - NEWidthConcatenateLayer
478 - NEDepthConcatenateLayer
479 - CLWidthConcatenateLayer
480 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100481 - CLGEMMInterleave4x4
482 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100483 - Support different quantization info in CLConcatLayer.
484 - Add checks on different input/output quantization info were not supported.
485 - Tensors have different quantization information.
486 - Add FP16 support checks.
487 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
488 - New graph examples:
489 - graph_convolution
490 - graph_fully_connected
491 - graph_depthwise_convolution
492 - Deepspeech v0.4.1
493 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
494 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
495 - Add support for QASYMM8 NEDeconvolution.
496 - Add support for DequantizationLayer for NEON/CL.
497 - Add support for dilation in CLDepthwiseConvolution.
498 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
499 - Optimize CLDeconvolution.
500 - Add StackLayer to the graph API.
501 - Add support for "reflect" padding mode in NEPad.
502 - Winograd 7x7 NHWC on OpenCL.
503 - Rework CL ML layers to run exclusively on CL.
504 - Support different quantization info in PoolingLayer.
505 - Implement and test import memory interfaces.
506 - Added new tests and removed old ones.
507 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100508
giuros01a69a88b2019-01-31 16:29:19 +0000509v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000510 - Various bug fixes.
511 - Various optimisations.
512 - New Neon kernels / functions:
513 - @ref NETileKernel / @ref NETile
514 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
515 - @ref NEElementwiseOperationKernel
516 - @ref NEElementwiseMax
517 - @ref NEElementwiseMin
518 - @ref NEElementwiseSquaredDiff
519 - @ref NESelectKernel / @ref NESelect
520 - @ref NESplit
521 - @ref NESlice
522 - @ref NEUnstack
523 - @ref NEStridedSliceKernel / @ref NEStridedSlice
524 - @ref NEElementwiseUnaryKernel
525 - @ref NERsqrtLayer
526 - @ref NEExpLayer
527 - @ref NEReverseKernel / @ref NEReverse
528 - @ref NEArgMinMaxLayer
529 - @ref NEStackLayerKernel / @ref NEStackLayer
530 - @ref NERangeKernel / @ref NERange
531 - @ref NEPadLayer
532 - @ref NEMemsetKernel
533 - @ref NEGatherKernel / @ref NEGather
534 - @ref NEElementwiseComparison
535 - @ref NEElementwiseComparisonStatic
536 - @ref NEComparisonOperationKernel
537 - @ref NEElementwiseDivision
538 - New OpenCL kernels / functions:
539 - @ref CLSelectKernel / @ref CLSelect
540 - @ref CLTileKernel / @ref CLTile
541 - @ref CLComparisonKernel / @ref CLComparison
542 - @ref CLArgMinMaxLayer
543 - @ref CLElementwiseMax
544 - @ref CLElementwiseMin
545 - @ref CLElementwiseSquaredDiff
546 - @ref CLStackLayerKernel / @ref CLStackLayer
547 - @ref CLReverse / @ref CLReverseKernel
548 - @ref CLRsqrtLayer
549 - @ref CLExpLayer
550 - @ref CLElementWiseUnaryLayerKernel
551 - @ref CLGEMMReshapeLHSMatrixKernel
552 - @ref CLGEMMReshapeRHSMatrixKernel
553 - @ref CLGEMMMatrixMultiplyReshapedKernel
554 - @ref CLRangeKernel / @ref CLRange
555 - @ref CLUnstack
556 - @ref CLGatherKernel / @ref CLGather
557 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
558 - New CPP kernels / functions:
559 - @ref CPPDetectionOutputLayer
560 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000561 - Added new examples:
562 - graph_ssd_mobilenet.cpp
563 - graph_mobilenet_v2.cpp
564 - graph_resnet12.cpp
565 - graph_srcnn955.cpp
566 - graph_vgg_vdsr.cpp
567 - graph_inception_resnet_v1.cpp
568 - Add 4D tensors support to
569 - @ref NESoftmaxLayer
570 - Fused activation in @ref CLWinogradConvolutionLayer
571 - Extented @ref NEPermute to support more cases
572 - Added NEON/SVE GEMM Hybrid kernels
573 - Added u8 and s8 hybrid assembly kernels
574 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
575 - Improved @ref CLTuner
576 - Fused the bias addition within @ref CLGEMM
577 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
578 - Added NHWC data layout support to:
579 - @ref NEScale for F16
580 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
581 - @ref NEL2NormalizeLayer for FP32/FP16
582 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
583 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000584 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000585 - Added QASYMM8 support to the following kernels:
586 - @ref NEArithmeticAdditionKernel
587 - @ref NEScale
588 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000589 - Deprecated functions/interfaces
590 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
591
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000592v18.11 Public major release
593 - Various bug fixes.
594 - Various optimisations.
595 - New Neon kernels / functions:
596 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
597 - @ref NEReduceMean
598 - @ref NEReorgLayer / @ref NEReorgLayerKernel
599 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
600 - @ref NEUpsampleLayer / @ref NEUpsampleLayerKernel
601 - @ref NEYOLOLayer / @ref NEYOLOLayerKernel
602 - New OpenCL kernels / functions:
603 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
604 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000605 - @ref CLComputeAllAnchorsKernel
606 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000607 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
608 - @ref CLReorgLayer / @ref CLReorgLayerKernel
609 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
610 - @ref CLPadLayer
611 - @ref CLReduceMean
612 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
613 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
614 - @ref CLSlice
615 - @ref CLSplit
616 - @ref CLStridedSlice / @ref CLStridedSliceKernel
617 - @ref CLUpsampleLayer / @ref CLUpsampleLayerKernel
618 - @ref CLYOLOLayer / @ref CLYOLOLayerKernel
619 - New CPP kernels / functions:
620 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
621 - Added the validate method in:
622 - @ref NEDepthConvertLayer
623 - @ref NEFloor / @ref CLFloor
624 - @ref NEGEMMMatrixAdditionKernel
625 - @ref NEReshapeLayer / @ref CLReshapeLayer
626 - @ref CLScale
627 - Added new examples:
628 - graph_shufflenet.cpp
629 - graph_yolov3.cpp
630 - Added documentation for add a new function or kernel.
631 - Improved doxygen documentation adding a list of the existing functions.
632 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100633 - CLWidthConcatenateLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000634 - @ref CLFlattenLayer
635 - @ref CLSoftmaxLayer
636 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
637 - Add SVE support
638 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
639 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
640 - Added NHWC data layout support to:
641 - @ref CLChannelShuffleLayer
642 - @ref CLDeconvolutionLayer
643 - @ref CLL2NormalizeLayer
644 - Added QASYMM8 support to the following kernels:
645 - @ref CLScaleKernel
646 - @ref NEDepthwiseConvolutionLayer3x3Kernel
647 - @ref CLPixelWiseMultiplicationKernel
648 - Added FP16 support to the following kernels:
649 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
650 - @ref NEDepthwiseConvolutionLayer3x3Kernel
651 - @ref CLNormalizePlanarYUVLayerKernel
652 - @ref CLWinogradConvolutionLayer (5x5 kernel)
653 - More tests added to both validation and benchmarking suites.
654
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100655v18.08 Public major release
656 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100657 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100658 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100659 - Removed support for QS8/QS16 data types.
660 - Added support for grouped convolution in @ref CLConvolutionLayer.
661 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100662 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100663 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
664 - @ref CLDepthwiseConvolutionLayer
665 - @ref CLDirectConvolutionLayer
666 - @ref CLConvolutionLayer
667 - @ref CLScale
668 - @ref CLIm2ColKernel
669 - New Neon kernels / functions:
670 - @ref NERNNLayer
671 - New OpenCL kernels / functions:
672 - @ref CLArithmeticDivision
673 - Introduced prepare() stage support in the graph API for GLES.
674 - Added support for memory reusage when trying to allocate smaller CLTensors.
675 - Enabled NHWC execution on graph examples.
676 - Added JPEG accessor for validation purposes.
677 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100678
679v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100680 - Various bug fixes.
681 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000682 - Major redesign in the interface for the neon kernels implemented in assembly.
683 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
684 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
685 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100686 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
687 - Improved doxygen documentation.
688 - Improved memory management for layer's transitions.
689 - Added support for NHWC data layout in tensors.
690 - Added NHWC data layout support to:
691 - @ref NEGEMMConvolutionLayer
692 - @ref NEDirectConvolutionLayer
693 - @ref NEPoolingLayer / @ref CLPoolingLayer
694 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
695 - @ref NEDepthwiseConvolutionLayer
696 - @ref NEScale
697 - @ref NEIm2Col
698 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
699 - New OpenCL kernels / functions:
700 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
701 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
702 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100703 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100704 - @ref CLRNNLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100705 - CLWidthConcatenateLayer / @ref CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100706 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
707 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
708 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100709 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
710 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
711 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
712 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
713 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
714 - Port mobilenet example to NHWC data layout.
715 - Enabled Winograd method in @ref CLConvolutionLayer.
716 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
717 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
718 - Added memory manager support in GLES functions.
719 - Major refactoring of the graph API.
720 - Added GLES backend in the graph API.
721 - Added support for the memory manager in the graph API.
722 - Enabled Winograd Convolution method in the graph API.
723 - Added support for grouped convolutions in the graph API.
724 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
725 - Added fast maths flag in @ref CLConvolutionLayer.
726 - Added new tests and benchmarks in validation and benchmark frameworks
727 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
728 - Added support to OpenCL 2.0 SVM
729 - Added support to import memory in OpenCL tensors.
730 - Added the prepare() method to perform any one off pre-processing before running the function.
731 - Added new examples:
732 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100733 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100734 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000735
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000736v18.03 Public maintenance release
737 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +0000738 - Fixed bug in @ref NEActivationLayer
739 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000740 - Updated recommended NDK version to r16b (And fixed warnings).
741 - Fixed bug in validation code.
742 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100743 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000744
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000745v18.02 Public major release
746 - Various NEON / OpenCL / GLES optimisations.
747 - Various bug fixes.
748 - Changed default number of threads on big LITTLE systems.
749 - Refactored examples and added:
750 - graph_mobilenet_qassym8
751 - graph_resnet
752 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +0000753 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
754 - 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 +0000755 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000756 - @ref CLActivationLayer
757 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000758 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000759 - @ref CLActivationLayer
760 - @ref CLDepthwiseConvolutionLayer
761 - @ref NEDepthwiseConvolutionLayer
762 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000763 - Added FP16 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000764 - @ref CLDepthwiseConvolutionLayer3x3
765 - @ref CLDepthwiseConvolutionLayer
766 - Added broadcasting support to @ref NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
767 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
768 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000769 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100770 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +0000771 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000772 - Added name() method to all kernels.
773 - Added support for Winograd 5x5.
Anthony Barbier3762e742018-03-02 11:49:33 +0000774 - @ref NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100775 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
776 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
777 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +0100778 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000779 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000780 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +0000781
Anthony Barbier64c95a02018-01-22 18:48:55 +0000782v18.01 Public maintenance release
783 - Various bug fixes
784 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +0000785 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
786 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +0000787 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +0000788 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
789 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
790 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
791 - Added @ref GCScaleKernel / @ref GCScale
792 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +0000793 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000794 - @ref GCCol2ImKernel
795 - @ref GCGEMMInterleave4x4Kernel
796 - @ref GCGEMMTranspose1xWKernel
797 - @ref GCIm2ColKernel
798 - Refactored NEON Winograd (NEWinogradLayerKernel)
799 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000800 - Added QASYMM8 support to the following NEON kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000801 - @ref NEDepthwiseConvolutionLayer3x3Kernel
802 - @ref NEFillBorderKernel
803 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000804 - Added new examples:
805 - graph_cl_mobilenet_qasymm8.cpp
806 - graph_inception_v3.cpp
807 - gc_dc.cpp
808 - More tests added to both validation and benchmarking suites.
809
Gian Marcoff850932017-12-11 12:37:17 +0000810v17.12 Public major release
811 - Most machine learning functions on OpenCL support the new data type QASYMM8
812 - Introduced logging interface
813 - Introduced opencl timer
814 - Reworked GEMMLowp interface
815 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
816 - Added validation method for most Machine Learning kernels / functions
817 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
818 - Added sgemm example for OpenCL
819 - Added absolute difference example for GLES compute
820 - Added new tests and benchmarks in validation and benchmark frameworks
821 - Added new kernels / functions for GLES compute
822
823 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000824 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
825 - @ref GCActivationLayerKernel / @ref GCActivationLayer
826 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
827 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +0100828 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000829 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
830 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
831 - @ref GCFillBorderKernel / @ref GCFillBorder
832 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
833 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
834 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
835 - @ref GCIm2ColKernel
836 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
837 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
838 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
839 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
840 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +0000841
842 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +0000843 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
844 - arm_compute::NEHGEMMAArch64FP16Kernel
Giorgio Arenad93e2632019-10-15 11:09:33 +0100845 - @ref NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / @ref NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000846 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
847 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
848 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8Scale
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100849 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +0000850
851 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000852 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
853 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
854 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8Scale
Gian Marcoff850932017-12-11 12:37:17 +0000855
856 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +0100857 - graph::BranchLayer
858 - graph::DepthConvertLayer
859 - graph::DepthwiseConvolutionLayer
860 - graph::DequantizationLayer
861 - graph::FlattenLayer
862 - graph::QuantizationLayer
863 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +0000864
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100865v17.10 Public maintenance release
866 - Bug fixes:
867 - Check the maximum local workgroup size supported by OpenCL devices
868 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +0000869 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100870 - Added a few new Graph nodes, support for branches and grouping.
871 - Automatically enable cl_printf in debug builds
872 - Fixed bare metal builds for armv7a
873 - Added AlexNet and cartoon effect examples
874 - 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)
875
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100876v17.09 Public major release
877 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +0000878 - 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 +0100879 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
880 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
881 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +0000882 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000883 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
884 - @ref NEFloorKernel / @ref NEFloor
885 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
886 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
887 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
888 - @ref NEReductionOperationKernel / @ref NEReductionOperation
889 - @ref NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100890
891 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100892 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / @ref CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000893 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
894 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
895 - @ref CLFlattenLayer
896 - @ref CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100897 - CLGEMMTranspose1xW
Anthony Barbier3762e742018-03-02 11:49:33 +0000898 - @ref CLGEMMMatrixVectorMultiplyKernel
899 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
900 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
901 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
902 - @ref CLReductionOperationKernel / @ref CLReductionOperation
903 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100904
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100905v17.06 Public major release
906 - Various bug fixes
907 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
908 - Added unit tests and benchmarks (AlexNet, LeNet)
909 - Added support for sub tensors.
910 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +0000911 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
912 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
913 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100914 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000915 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100916 - @ref CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000917 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
918 - @ref CLLocallyConnectedMatrixMultiplyKernel / @ref CLLocallyConnectedLayer
919 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100920 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000921 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100922 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000923 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100924 - @ref NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000925 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
926 - @ref NELocallyConnectedMatrixMultiplyKernel / @ref NELocallyConnectedLayer
927 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100928
929v17.05 Public bug fixes release
930 - Various bug fixes
931 - Remaining of the functions ported to use accurate padding.
932 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
933 - Added "free" method to allocator.
934 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
935
936v17.04 Public bug fixes release
937
938 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +0000939 - @ref CLColorConvertKernel
940 - @ref CLEdgeNonMaxSuppressionKernel
941 - @ref CLEdgeTraceKernel
942 - @ref CLGaussianPyramidHorKernel
943 - @ref CLGaussianPyramidVertKernel
944 - @ref CLGradientKernel
945 - @ref NEChannelCombineKernel
946 - @ref NEFillArrayKernel
947 - @ref NEGaussianPyramidHorKernel
948 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +0100949 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000950 - @ref NEHarrisScoreKernel
951 - @ref NEHOGDetectorKernel
952 - @ref NELogits1DMaxKernel
953 - NELogits1DShiftExpSumKernel
954 - NELogits1DNormKernel
955 - @ref NENonMaximaSuppression3x3FP16Kernel
956 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100957
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100958v17.03.1 First Major public release of the sources
959 - Renamed the library to arm_compute
960 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
961 - New padding calculation interface introduced and ported most kernels / functions to use it.
962 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000963 - @ref CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100964 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000965 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
966 - @ref NETransposeKernel / @ref NETranspose
967 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
968 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
969 - @ref NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
970 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100971
972v17.03 Sources preview
973 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000974 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +0100975 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Anthony Barbier3762e742018-03-02 11:49:33 +0000976 - @ref CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
977 - @ref CLTransposeKernel / @ref CLTranspose
978 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
979 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
980 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100981 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000982 - @ref NEActivationLayerKernel / @ref NEActivationLayer
983 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
984 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100985
986v17.02.1 Sources preview
987 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000988 - @ref CLLogits1DMaxKernel, @ref CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
989 - @ref CLPoolingLayerKernel / @ref CLPoolingLayer
990 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
991 - @ref CLRemapKernel / @ref CLRemap
992 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
993 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
994 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100995 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +0000996 - @ref NEAccumulateWeightedFP16Kernel
997 - @ref NEBox3x3FP16Kernel
998 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100999
1000v17.02 Sources preview
1001 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001002 - @ref CLActivationLayerKernel / @ref CLActivationLayer
1003 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1004 - @ref CLDerivativeKernel / @ref CLChannelExtract
1005 - @ref CLFastCornersKernel / @ref CLFastCorners
1006 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001007 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001008 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1009 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001010 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1011 - Switched all the kernels / functions to use tensors instead of images.
1012 - Updated documentation to include instructions to build the library from sources.
1013
1014v16.12 Binary preview release
1015 - Original release
1016
1017@section S3_how_to_build How to build the library and the examples
1018
1019@subsection S3_1_build_options Build options
1020
1021scons 2.3 or above is required to build the library.
1022To see the build options available simply run ```scons -h```:
1023
Anthony Barbier79c61782017-06-23 11:48:24 +01001024 debug: Debug (yes|no)
1025 default: False
1026 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001027
Anthony Barbier79c61782017-06-23 11:48:24 +01001028 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1029 default: False
1030 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001031
Anthony Barbier79c61782017-06-23 11:48:24 +01001032 arch: Target Architecture (armv7a|arm64-v8a|arm64-v8.2-a|x86_32|x86_64)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001033 default: armv7a
1034 actual: armv7a
1035
Anthony Barbier79c61782017-06-23 11:48:24 +01001036 os: Target OS (linux|android|bare_metal)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001037 default: linux
1038 actual: linux
1039
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001040 build: Build type (native|cross_compile|embed_only)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001041 default: cross_compile
1042 actual: cross_compile
1043
Anthony Barbier79c61782017-06-23 11:48:24 +01001044 examples: Build example programs (yes|no)
1045 default: True
1046 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001047
Anthony Barbier79c61782017-06-23 11:48:24 +01001048 Werror: Enable/disable the -Werror compilation flag (yes|no)
1049 default: True
1050 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001051
Anthony Barbier79c61782017-06-23 11:48:24 +01001052 opencl: Enable OpenCL support (yes|no)
1053 default: True
1054 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001055
Anthony Barbier79c61782017-06-23 11:48:24 +01001056 neon: Enable Neon support (yes|no)
1057 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001058 actual: False
1059
Anthony Barbier20dbb822017-12-13 21:19:39 +00001060 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1061 default: False
1062 actual: False
1063
1064 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shader in library binary (yes|no)
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001065 default: True
1066 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001067
1068 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1069 default: False
1070 actual: False
1071
1072 openmp: Enable OpenMP backend (yes|no)
1073 default: False
1074 actual: False
1075
1076 cppthreads: Enable C++11 threads backend (yes|no)
1077 default: True
1078 actual: True
1079
1080 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1081 default: .
1082 actual: .
1083
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001084 extra_cxx_flags: Extra CXX flags to be appended to the build command
1085 default:
1086 actual:
1087
Anthony Barbier79c61782017-06-23 11:48:24 +01001088 pmu: Enable PMU counters (yes|no)
1089 default: False
1090 actual: False
1091
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001092 mali: Enable Mali hardware counters (yes|no)
1093 default: False
1094 actual: False
1095
Anthony Barbier79c61782017-06-23 11:48:24 +01001096 validation_tests: Build validation test programs (yes|no)
1097 default: False
1098 actual: False
1099
1100 benchmark_tests: Build benchmark test programs (yes|no)
1101 default: False
1102 actual: False
1103
1104@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001105 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1106 - 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)
1107 - 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).
1108
Anthony Barbier79c61782017-06-23 11:48:24 +01001109@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 +01001110
Anthony Barbier79c61782017-06-23 11:48:24 +01001111@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001112@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1113
Anthony Barbier79c61782017-06-23 11:48:24 +01001114@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 +01001115
Anthony Barbier79c61782017-06-23 11:48:24 +01001116@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 +01001117
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001118There 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.
1119
Anthony Barbier79c61782017-06-23 11:48:24 +01001120@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 +01001121
Anthony Barbier20dbb822017-12-13 21:19:39 +00001122@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 +01001123
Anthony Barbier20dbb822017-12-13 21:19:39 +00001124@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 +01001125
1126@b set_soname: Do you want to build the versioned version of the library ?
1127
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001128If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1129Example:
1130 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1131 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1132 libarm_compute_core.so.1.0.0
1133
1134@note This options is disabled by default as it requires SCons version 2.4 or above.
1135
Anthony Barbier79c61782017-06-23 11:48:24 +01001136@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1137
1138@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1139
1140@b examples: Build or not the examples
1141
1142@b validation_tests: Enable the build of the validation suite.
1143
Anthony Barbier79c61782017-06-23 11:48:24 +01001144@b benchmark_tests: Enable the build of the benchmark tests
1145
1146@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1147
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001148@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)
1149
Anthony Barbier79c61782017-06-23 11:48:24 +01001150@b openmp Build in the OpenMP scheduler for NEON.
1151
1152@note Only works when building with g++ not clang++
1153
1154@b cppthreads Build in the C++11 scheduler for NEON.
1155
Anthony Barbier3762e742018-03-02 11:49:33 +00001156@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001157
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001158@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001159
1160@subsubsection S3_2_1_library How to build the library ?
1161
1162For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1163
Michele Di Giorgio6513ccb2018-08-28 14:38:35 +01001164 - gcc-linaro-4.9-2016.02-x86_64_arm-linux-gnueabihf
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001165 - gcc-linaro-4.9-2016.02-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001166
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001167To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1168
1169 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1170
1171To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1172
1173 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1174
Anthony Barbier20dbb822017-12-13 21:19:39 +00001175To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1176
1177 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1178
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001179You can also compile the library natively on an ARM device by using <b>build=native</b>:
1180
1181 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1182 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1183
1184@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.
1185
1186For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1187
1188 apt-get install g++-arm-linux-gnueabihf
1189
1190Then run
1191
1192 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1193
1194or simply remove the build parameter as build=cross_compile is the default value:
1195
1196 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1197
1198@attention To cross compile with opencl=1 you need to make sure to have a version of libOpenCL matching your target architecture.
1199
1200@subsubsection S3_2_2_examples How to manually build the examples ?
1201
1202The 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.
1203
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001204@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 +01001205
1206To cross compile a NEON example for Linux 32bit:
1207
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001208 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 +01001209
1210To cross compile a NEON example for Linux 64bit:
1211
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001212 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 +01001213
1214(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)
1215
1216To cross compile an OpenCL example for Linux 32bit:
1217
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001218 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 +01001219
1220To cross compile an OpenCL example for Linux 64bit:
1221
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001222 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 +01001223
Anthony Barbier14c86a92017-12-14 16:27:41 +00001224To cross compile a GLES example for Linux 32bit:
1225
1226 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
1227
1228To cross compile a GLES example for Linux 64bit:
1229
1230 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
1231
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001232(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)
1233
Anthony Barbier14c86a92017-12-14 16:27:41 +00001234To 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.
1235
1236@note The compute library must currently be built with both neon and opencl enabled - neon=1 and opencl=1
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001237
1238i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1239
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001240 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 +01001241
1242i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1243
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001244 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 +01001245
1246(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)
1247
Anthony Barbiere5007472017-10-27 15:01:44 +01001248@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1249
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001250To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1251
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001252 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 +01001253
1254To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1255
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001256 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 +01001257
1258(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1259
1260To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1261
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001262 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 +01001263
Anthony Barbier14c86a92017-12-14 16:27:41 +00001264To 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 +01001265
Anthony Barbier14c86a92017-12-14 16:27:41 +00001266 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
1267
1268To 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.
1269@note The compute library must currently be built with both neon and opencl enabled - neon=1 and opencl=1
1270
1271i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001272
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001273 g++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++11 -mfpu=neon -L. -larm_compute_graph -larm_compute -larm_compute_core -Wl,--allow-shlib-undefined -o graph_lenet
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001274
Anthony Barbier14c86a92017-12-14 16:27:41 +00001275i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001276
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001277 g++ examples/graph_lenet.cpp utils/Utils.cpp utils/GraphUtils.cpp utils/CommonGraphOptions.cpp -I. -Iinclude -std=c++11 L. -larm_compute_graph -larm_compute -larm_compute_core -Wl,--allow-shlib-undefined -o graph_lenet
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001278
1279(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001280
Anthony Barbiere5007472017-10-27 15:01:44 +01001281@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1282
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001283@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 +00001284@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 +01001285
1286To run the built executable simply run:
1287
1288 LD_LIBRARY_PATH=build ./neon_convolution
1289
1290or
1291
1292 LD_LIBRARY_PATH=build ./cl_convolution
1293
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001294@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 +00001295
1296For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001297
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001298 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001299
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001300Below is a list of the common parameters among the graph examples :
1301@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001302
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001303@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001304
1305For Android, the library was successfully built and tested using Google's standalone toolchains:
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001306 - clang++ from NDK r17c for armv7a
1307 - clang++ from NDK r17c for arm64-v8a
Anthony Barbier3a6163e2018-08-10 17:36:36 +01001308 - clang++ from NDK r18-beta1 for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001309
1310Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1311
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001312- Download the NDK r17c from here: https://developer.android.com/ndk/downloads/index.html
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001313- Make sure you have Python 2.7 installed on your machine.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001314- Generate the 32 and/or 64 toolchains by running the following commands:
1315
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001316
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001317 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r17c --stl libc++ --api 21
1318 $NDK/build/tools/make_standalone_toolchain.py --arch arm --install-dir $MY_TOOLCHAINS/arm-linux-android-ndk-r17c --stl libc++ --api 21
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001319
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001320@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 +01001321
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001322@note Make sure to add the toolchains to your PATH:
1323
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001324 export PATH=$PATH:$MY_TOOLCHAINS/aarch64-linux-android-ndk-r17c/bin:$MY_TOOLCHAINS/arm-linux-android-ndk-r17c/bin
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001325
1326@subsubsection S3_3_1_library How to build the library ?
1327
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001328To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1329
1330 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1331
1332To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1333
Anthony Barbier14c86a92017-12-14 16:27:41 +00001334 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 +01001335
Anthony Barbier20dbb822017-12-13 21:19:39 +00001336To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1337
Anthony Barbier14c86a92017-12-14 16:27:41 +00001338 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 +00001339
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001340@subsubsection S3_3_2_examples How to manually build the examples ?
1341
1342The 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.
1343
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001344@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 +01001345
1346Once you've got your Android standalone toolchain built and added to your path you can do the following:
1347
1348To cross compile a NEON example:
1349
1350 #32 bit:
Georgios Pinitas9873ea32017-12-05 15:28:55 +00001351 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 +01001352 #64 bit:
Anthony Barbier14c86a92017-12-14 16:27:41 +00001353 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 +01001354
1355To cross compile an OpenCL example:
1356
1357 #32 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001358 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 +01001359 #64 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001360 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 +00001361
1362To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001363
Anthony Barbier14c86a92017-12-14 16:27:41 +00001364 #32 bit:
1365 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
1366 #64 bit:
1367 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 +01001368
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001369To cross compile the examples with the Graph API, such as graph_lenet.cpp, you need to link the library arm_compute_graph also.
1370(notice the compute library has to be built with both neon and opencl enabled - neon=1 and opencl=1)
1371
1372 #32 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001373 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 +01001374 #64 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001375 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 +01001376
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001377@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 +00001378@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 +01001379
1380Then you need to do is upload the executable and the shared library to the device using ADB:
1381
1382 adb push neon_convolution_arm /data/local/tmp/
1383 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001384 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001385 adb shell chmod 777 -R /data/local/tmp/
1386
1387And finally to run the example:
1388
1389 adb shell /data/local/tmp/neon_convolution_arm
1390 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001391 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001392
1393For 64bit:
1394
1395 adb push neon_convolution_aarch64 /data/local/tmp/
1396 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001397 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001398 adb shell chmod 777 -R /data/local/tmp/
1399
1400And finally to run the example:
1401
1402 adb shell /data/local/tmp/neon_convolution_aarch64
1403 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001404 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001405
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001406@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 +00001407
1408For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001409 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001410
1411In 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.
1412
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001413@subsection S3_4_bare_metal Building for bare metal
1414
Georgios Pinitas58216322020-02-26 11:13:13 +00001415For 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 +01001416 - arm-eabi for armv7a
1417 - aarch64-elf for arm64-v8a
1418
1419Download 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>.
1420
1421@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
1422
1423@subsubsection S3_4_1_library How to build the library ?
1424
1425To cross-compile the library with NEON support for baremetal arm64-v8a:
1426
1427 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
1428
1429@subsubsection S3_4_2_examples How to manually build the examples ?
1430
1431Examples 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>.
1432
1433@subsection S3_5_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001434
1435Using `scons` directly from the Windows command line is known to cause
1436problems. The reason seems to be that if `scons` is setup for cross-compilation
1437it gets confused about Windows style paths (using backslashes). Thus it is
1438recommended to follow one of the options outlined below.
1439
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001440@subsubsection S3_5_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001441
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001442The best and easiest option is to use
1443<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001444This feature is still marked as *beta* and thus might not be available.
1445However, if it is building the library is as simple as opening a *Bash on
1446Ubuntu on Windows* shell and following the general guidelines given above.
1447
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001448@subsubsection S3_5_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001449
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001450If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001451can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1452to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001453also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001454code of the library.) Linaro provides pre-built versions of
1455<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001456that can be used from the Cygwin terminal. When building for Android the
1457compiler is included in the Android standalone toolchain. After everything has
1458been set up in the Cygwin terminal the general guide on building the library
1459can be followed.
1460
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001461@subsection S3_6_cl_stub_library The OpenCL stub library
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001462
1463In the opencl-1.2-stubs folder you will find the sources to build a stub OpenCL library which then can be used to link your application or arm_compute against.
1464
1465If you preferred you could retrieve the OpenCL library from your device and link against this one but often this library will have dependencies on a range of system libraries forcing you to link your application against those too even though it is not using them.
1466
1467@warning This OpenCL library provided is a stub and *not* a real implementation. You can use it to resolve OpenCL's symbols in arm_compute while building the example but you must make sure the real libOpenCL.so is in your PATH when running the example or it will not work.
1468
1469To cross-compile the stub OpenCL library simply run:
1470
1471 <target-prefix>-gcc -o libOpenCL.so -Iinclude opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1472
1473For example:
1474
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001475 #Linux 32bit
1476 arm-linux-gnueabihf-gcc -o libOpenCL.so -Iinclude opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1477 #Linux 64bit
1478 aarch64-linux-gnu-gcc -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC
1479 #Android 32bit
1480 arm-linux-androideabi-clang -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1481 #Android 64bit
Anthony Barbier14c86a92017-12-14 16:27:41 +00001482 aarch64-linux-android-clang -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1483
1484@subsection S3_7_gles_stub_library The Linux OpenGLES and EGL stub libraries
1485
1486In the opengles-3.1-stubs folder you will find the sources to build stub EGL and OpenGLES libraries which then can be used to link your Linux application of arm_compute against.
1487
1488@note The stub libraries are only needed on Linux. For Android, the NDK toolchains already provide the meta-EGL and meta-GLES libraries.
1489
1490To cross-compile the stub OpenGLES and EGL libraries simply run:
1491
1492 <target-prefix>-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1493 <target-prefix>-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
1494
1495 #Linux 32bit
1496 arm-linux-gnueabihf-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1497 arm-linux-gnueabihf-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
1498
1499 #Linux 64bit
1500 aarch64-linux-gnu-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1501 aarch64-linux-gnu-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001502
1503@subsection S3_8_cl_requirements OpenCL DDK Requirements
1504
1505@subsubsection S3_8_1_cl_hard_requirements Hard Requirements
1506
1507Compute 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).
1508
1509Enabling 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.
1510
1511Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1512
1513@subsubsection S3_8_2_cl_performance_requirements Performance improvements
1514
1515Integer 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.
1516
1517OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1518
1519SVM 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 +01001520
1521@subsection S3_9_cl_tuner OpenCL Tuner
1522
1523The 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).
1524The 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 +01001525The 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 +01001526In 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.
1527
1528If 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:
1529
1530https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1531
1532Tuning 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.
1533
1534CLTuner 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.
1535
1536 #Example: 2 unique Matrix Multiply configurations
1537@code{.cpp}
1538 TensorShape a0 = TensorShape(32,32);
1539 TensorShape b0 = TensorShape(32,32);
1540 TensorShape c0 = TensorShape(32,32);
1541 TensorShape a1 = TensorShape(64,64);
1542 TensorShape b1 = TensorShape(64,64);
1543 TensorShape c1 = TensorShape(64,64);
1544
1545 Tensor a0_tensor;
1546 Tensor b0_tensor;
1547 Tensor c0_tensor;
1548 Tensor a1_tensor;
1549 Tensor b1_tensor;
1550 Tensor c1_tensor;
1551
1552 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1553 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1554 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1555 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1556 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1557 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1558
1559 CLGEMM gemm0;
1560 CLGEMM gemm1;
1561
1562 // Configuration 0
1563 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1564
1565 // Configuration 1
1566 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1567@endcode
1568
1569@subsubsection S3_9_1_cl_tuner_how_to How to use it
1570
1571All 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
1572
1573 #Enable CL tuner
1574 ./graph_mobilenet --enable-tuner –-target=CL
1575 ./arm_compute_benchmark --enable-tuner
1576
1577 #Export/Import to/from a file
1578 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1579 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1580
1581If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1582
1583Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1584
1585 -# Disable the power management
1586 -# Keep the GPU frequency constant
1587 -# Run multiple times the network (i.e. 10).
1588
1589If 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.
1590
1591@code{.cpp}
1592CLTuner tuner;
1593
1594// Setup Scheduler
1595CLScheduler::get().default_init(&tuner);
1596@endcode
1597
1598After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1599- tuner.save_to_file("results.csv");
1600
1601This file can be also imported using the method "load_from_file("results.csv")".
1602- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001603*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001604} // namespace arm_compute