blob: 906ddf27bf6baef4e51ac4d7e36a9e5f66b49acd [file] [log] [blame]
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00001///
Michele Di Giorgiod9eaf612020-07-08 11:12:57 +01002/// Copyright (c) 2017-2020 Arm Limited.
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00003///
4/// SPDX-License-Identifier: MIT
5///
6/// Permission is hereby granted, free of charge, to any person obtaining a copy
7/// of this software and associated documentation files (the "Software"), to
8/// deal in the Software without restriction, including without limitation the
9/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10/// sell copies of the Software, and to permit persons to whom the Software is
11/// furnished to do so, subject to the following conditions:
12///
13/// The above copyright notice and this permission notice shall be included in all
14/// copies or substantial portions of the Software.
15///
16/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22/// SOFTWARE.
23///
Anthony Barbier3762e742018-03-02 11:49:33 +000024namespace arm_compute
25{
Anthony Barbier6ff3b192017-09-04 18:44:23 +010026/** @mainpage Introduction
27
28@tableofcontents
29
30The Computer Vision and Machine Learning library is a set of functions optimised for both ARM CPUs and GPUs using SIMD technologies.
31
32Several builds of the library are available using various configurations:
33 - OS: Linux, Android or bare metal.
34 - Architecture: armv7a (32bit) or arm64-v8a (64bit)
Anthony Barbier20dbb822017-12-13 21:19:39 +000035 - Technology: NEON / OpenCL / GLES_COMPUTE / NEON and OpenCL and GLES_COMPUTE
Anthony Barbier6ff3b192017-09-04 18:44:23 +010036 - Debug / Asserts / Release: Use a build with asserts enabled to debug your application and enable extra validation. Once you are sure your application works as expected you can switch to a release build of the library for maximum performance.
37
38@section S0_1_contact Contact / Support
39
40Please email developer@arm.com
41
42In order to facilitate the work of the support team please provide the build information of the library you are using. To get the version of the library you are using simply run:
43
44 $ strings android-armv7a-cl-asserts/libarm_compute.so | grep arm_compute_version
45 arm_compute_version=v16.12 Build options: {'embed_kernels': '1', 'opencl': '1', 'arch': 'armv7a', 'neon': '0', 'asserts': '1', 'debug': '0', 'os': 'android', 'Werror': '1'} Git hash=f51a545d4ea12a9059fe4e598a092f1fd06dc858
46
Anthony Barbier14c86a92017-12-14 16:27:41 +000047@section S0_2_prebuilt_binaries Pre-built binaries
48
49For each release we provide some pre-built binaries of the library [here](https://github.com/ARM-software/ComputeLibrary/releases)
50
51These binaries have been built using the following toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +010052 - Linux armv7a: gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
53 - Linux arm64-v8a: gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
54 - Android armv7a: clang++ / libc++ NDK r18b
55 - Android am64-v8a: clang++ / libc++ NDK r18b
Anthony Barbier14c86a92017-12-14 16:27:41 +000056
57@warning Make sure to use a compatible toolchain to build your application or you will get some std::bad_alloc errors at runtime.
58
Anthony Barbier6ff3b192017-09-04 18:44:23 +010059@section S1_file_organisation File organisation
60
61This archive contains:
62 - The arm_compute header and source files
63 - The latest Khronos OpenCL 1.2 C headers from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a>
64 - The latest Khronos cl2.hpp from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a> (API version 2.1 when this document was written)
Anthony Barbier20dbb822017-12-13 21:19:39 +000065 - The latest Khronos OpenGL ES 3.1 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos OpenGL ES registry</a>
66 - The latest Khronos EGL 1.5 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos EGL registry</a>
67 - The sources for a stub version of libOpenCL.so, libGLESv1_CM.so, libGLESv2.so and libEGL.so to help you build your application.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010068 - An examples folder containing a few examples to compile and link against the library.
69 - A @ref utils folder containing headers with some boiler plate code used by the examples.
70 - This documentation.
71
72You should have the following file organisation:
73
74 .
75 ├── arm_compute --> All the arm_compute headers
Georgios Pinitasf112ede2019-03-01 19:11:20 +000076 │ ├── graph.h --> Includes all the Graph headers at once.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010077 │   ├── core
78 │   │   ├── CL
Anthony Barbier6a5627a2017-09-26 14:42:02 +010079 │   │   │   ├── CLKernelLibrary.h --> Manages all the OpenCL kernels compilation and caching, provides accessors for the OpenCL Context.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010080 │   │   │   ├── CLKernels.h --> Includes all the OpenCL kernels at once
Georgios Pinitasfd7780d2020-03-17 11:41:00 +000081 │   │   │   ├── CL specialisation of all the generic interfaces (ICLTensor, ICLArray, etc.)
82 │   │   │   ├── gemm --> Folder containing all the configuration files for GEMM
Anthony Barbier6ff3b192017-09-04 18:44:23 +010083 │   │   │   ├── kernels --> Folder containing all the OpenCL kernels
84 │   │   │   │   └── CL*Kernel.h
85 │   │   │   └── OpenCL.h --> Wrapper to configure the Khronos OpenCL C++ header
86 │   │ ├── CPP
Anthony Barbier6a5627a2017-09-26 14:42:02 +010087 │   │   │   ├── CPPKernels.h --> Includes all the CPP kernels at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +010088 │   │ │   └── kernels --> Folder containing all the CPP kernels
Anthony Barbier6a5627a2017-09-26 14:42:02 +010089 │   │   │      └── CPP*Kernel.h
Anthony Barbier20dbb822017-12-13 21:19:39 +000090 │   │   ├── GLES_COMPUTE
91 │   │   │   ├── GCKernelLibrary.h --> Manages all the GLES kernels compilation and caching, provides accessors for the GLES Context.
92 │   │   │   ├── GCKernels.h --> Includes all the GLES kernels at once
Georgios Pinitasfd7780d2020-03-17 11:41:00 +000093 │   │   │   ├── GLES specialisation of all the generic interfaces (IGCTensor etc.)
Anthony Barbier20dbb822017-12-13 21:19:39 +000094 │   │   │   ├── kernels --> Folder containing all the GLES kernels
95 │   │   │   │   └── GC*Kernel.h
96 │   │   │   └── OpenGLES.h --> Wrapper to configure the Khronos EGL and OpenGL ES C header
Anthony Barbier6ff3b192017-09-04 18:44:23 +010097 │   │   ├── NEON
98 │   │   │   ├── kernels --> Folder containing all the NEON kernels
Anthony Barbier38e7f1f2018-05-21 13:37:47 +010099 │   │   │   │ ├── assembly --> headers for assembly optimised NEON kernels.
100 │   │   │   │ ├── convolution --> headers for convolution assembly optimised NEON kernels.
101 │   │   │   │   │   ├── common --> headers for code which is common to several convolution implementations.
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000102 │   │   │   │   │   ├── depthwise --> headers for Depthwise convolution assembly implementation
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100103 │   │   │   │   │   └── winograd --> headers for Winograd convolution assembly implementation
104 │   │   │   │ ├── detail --> Common code for several intrinsics implementations.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100105 │   │   │   │   └── NE*Kernel.h
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000106 │   │   │   ├── wrapper --> NEON wrapper used to simplify code
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000107 │   │   │   │ ├── intrinsics --> NEON intrinsics wrappers
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000108 │   │   │   │ ├── scalar --> Scalar operations
109 │   │   │   │ ├── traits.h --> Traits defined on NEON vectors
110 │   │   │   │   └── wrapper.h --> Includes all wrapper headers at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100111 │   │   │   └── NEKernels.h --> Includes all the NEON kernels at once
112 │   │   ├── All common basic types (Types.h, Window, Coordinates, Iterator, etc.)
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000113 │   │   ├── All generic interfaces (ITensor, IArray, etc.)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000114 │   │   └── Objects metadata classes (TensorInfo, MultiImageInfo)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100115 │   ├── graph
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000116 │   │   ├── algorithms --> Generic algorithms used by the graph backend (e.g Order of traversal)
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100117 │   │   ├── backends --> The backend specific code
118 │   │   │   ├── CL --> OpenCL specific operations
119 │   │   │   ├── GLES --> OpenGLES Compute Shaders specific operations
120 │   │   │   └── NEON --> NEON specific operations
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000121 │   │   ├── detail --> Collection of internal utilities.
122 │   │   ├── frontend --> Code related to the stream frontend interface.
123 │   │   ├── mutators --> Used to modify / optimise the Graph intermediate representation(Operator fusion, in place operations, etc.)
124 │   │   ├── nodes --> The various nodes supported by the graph API
125 │   │   ├── printers --> Debug printers
126 │   │   └── Graph objects interfaces (INode, ITensorAccessor, Graph, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100127 │   └── runtime
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000128 │   ├── common
129 │ │ └── Common utility code used by all backends
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100130 │   ├── CL
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000131 │   │   ├── CL objects & allocators (CLArray, CLTensor, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100132 │   │   ├── functions --> Folder containing all the OpenCL functions
133 │   │   │   └── CL*.h
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100134 │   │   ├── CLScheduler.h --> Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100135 │   │   ├── CLFunctions.h --> Includes all the OpenCL functions at once
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000136 │   │   ├── ICLTuner.h --> Interface used to tune the local work-group size of OpenCL kernels
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100137 │   │   └── tuners
138 │   │      └── Local workgroup size tuners for specific architectures / GPUs
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100139 │   ├── CPP
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100140 │      │   ├── CPPKernels.h --> Includes all the CPP functions at once.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100141 │   │   ├── CPPScheduler.h --> Basic pool of threads to execute CPP/NEON code on several cores in parallel
142 │   │   └── functions --> Folder containing all the CPP functions
143 │   │      └── CPP*.h
Anthony Barbier20dbb822017-12-13 21:19:39 +0000144 │   ├── GLES_COMPUTE
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000145 │   │   ├── GLES objects & allocators (GCArray, GCTensor, etc.)
Anthony Barbier20dbb822017-12-13 21:19:39 +0000146 │   │   ├── functions --> Folder containing all the GLES functions
147 │   │   │   └── GC*.h
148 │   │   ├── GCScheduler.h --> Interface to enqueue GLES kernels and get/set the GLES CommandQueue.
149 │   │   └── GCFunctions.h --> Includes all the GLES functions at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100150 │   ├── NEON
151 │   │ ├── functions --> Folder containing all the NEON functions
152 │   │ │   └── NE*.h
153 │   │ └── NEFunctions.h --> Includes all the NEON functions at once
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100154 │   ├── OMP
155 │   │   └── OMPScheduler.h --> OpenMP scheduler (Alternative to the CPPScheduler)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000156 │ ├── Memory & weights manager files (LifetimeManager, PoolManager, etc.)
157 │   └── Basic implementations of the generic object interfaces (Array, Tensor, etc.)
158 ├── data --> Contains test images and reference data dumps used by validation tests
Michele Di Giorgio37d1ef92020-05-27 17:03:49 +0100159 ├── docs --> Contains Doxyfile and Doxygen sources used to generate the HTML pages.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100160 ├── examples
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000161 │   ├── gemm_tuner
162 │   │ └── OpenCL GEMM tuner utility
Anthony Barbier20dbb822017-12-13 21:19:39 +0000163 │   ├── cl_*.cpp --> OpenCL examples
Anthony Barbier14c86a92017-12-14 16:27:41 +0000164 │   ├── gc_*.cpp --> GLES compute shaders examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000165 │   ├── graph_*.cpp --> Graph examples
166 │   ├── neoncl_*.cpp --> NEON / OpenCL interoperability examples
167 │   └── neon_*.cpp --> NEON examples
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100168 ├── include
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100169 │   ├── CL
170 │   │ └── Khronos OpenCL C headers and C++ wrapper
171 │   ├── half --> FP16 library available from http://half.sourceforge.net
Anthony Barbier14c86a92017-12-14 16:27:41 +0000172 │   ├── libnpy --> Library to load / write npy buffers, available from https://github.com/llohse/libnpy
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000173 │  ├── linux --> Headers only needed for Linux builds
174 │   │ └── Khronos EGL and OpenGLES headers
175 │ └── stb
176 │ └── stb_image.h --> Single header library to load image files, available from https://github.com/nothings/stb
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100177 ├── scripts
178 │   ├── caffe_data_extractor.py --> Basic script to export weights from Caffe to npy files
179 │   └── tensorflow_data_extractor.py --> Basic script to export weights from Tensor Flow to npy files
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100180 ├── src
181 │   ├── core
182 │ │ └── ... (Same structure as headers)
Anthony Barbier20dbb822017-12-13 21:19:39 +0000183 │   │ ├── CL
184 │   │ │ └── cl_kernels --> All the OpenCL kernels
185 │   │ └── GLES_COMPUTE
186 │   │ └── cs_shaders --> All the OpenGL ES Compute Shaders
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100187 │   ├── graph
188 │ │ └── ... (Same structure as headers)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100189 │ └── runtime
190 │ └── ... (Same structure as headers)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100191 ├── support
192 │ └── Various headers to work around toolchains / platform issues.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100193 ├── tests
194 │   ├── All test related files shared between validation and benchmark
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100195 │   ├── benchmark --> Sources for benchmarking
196 │ │ ├── Benchmark specific files
197 │   │ ├── fixtures
198 │ │ │ └── Backend agnostic fixtures to initialise and run the functions to test.
199 │ │ ├── CL --> OpenCL benchmarking tests
200 │ │ ├── GLES_COMPUTE --> GLES benchmarking tests
201 │ │ └── NEON --> NEON benchmarking tests
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000202 │ ├── benchmark_examples --> Sources needed to wrap examples to run through our benchmarking framework.
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100203 │   ├── CL --> OpenCL accessors
Anthony Barbier20dbb822017-12-13 21:19:39 +0000204 │   ├── GLES_COMPUTE --> GLES accessors
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100205 │   ├── NEON --> NEON accessors
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100206 │   ├── datasets
207 │ │ └── Datasets for all the validation / benchmark tests, layer configurations for various networks, etc.
208 │   ├── framework
209 │ │ └── Boiler plate code for both validation and benchmark test suites (Command line parsers, instruments, output loggers, etc.)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000210 │   ├── instruments --> User defined instruments that can be registered to the framework.
211 │ ├── validate_examples --> Sources needed to wrap examples to run through our validation framework.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100212 │   └── validation --> Sources for validation
213 │ ├── Validation specific files
214 │   ├── fixtures
215 │ │ └── Backend agnostic fixtures to initialise and run the functions to test.
216 │   ├── reference
217 │ │ └── Reference implementation used to validate the results of the various backends.
218 │ ├── CL --> OpenCL validation tests
219 │ ├── GLES_COMPUTE --> GLES validation tests
220 │ ├── CPP --> C++ reference implementations
221 │ └── NEON --> NEON validation tests
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100222 └── utils --> Boiler plate code used by examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000223 └── Various utilities to print types, load / store assets, etc.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100224
225@section S2_versions_changelog Release versions and changelog
226
227@subsection S2_1_versions Release versions
228
229All releases are numbered vYY.MM Where YY are the last two digits of the year, and MM the month number.
230If there is more than one release in a month then an extra sequential number is appended at the end:
231
232 v17.03 (First release of March 2017)
233 v17.03.1 (Second release of March 2017)
234 v17.04 (First release of April 2017)
235
236@note We're aiming at releasing one major public release with new features per quarter. All releases in between will only contain bug fixes.
237
238@subsection S2_2_changelog Changelog
239
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100240v20.08 Public major release
241 - Various bug fixes.
242 - Various optimisations.
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100243 - Added new data type QASYMM8_SIGNED support for:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100244 - @ref CLArgMinMaxLayer
245 - @ref CLArgMinMaxLayerKernel
246 - Added new data type U8 support for:
247 - @ref NECropKernel
248 - @ref CLCropKernel
249 - Added aligh_corner support for nearest neighbor interpolation in:
250 - @ref NEScaleKernel
251 - @ref CLScaleKernel
252 - New OpenCL kernels / functions:
253 - @ref CLMaxUnpoolingLayerKernel
254 - New NEON kernels / functions:
255 - @ref NEMaxUnpoolingLayerKernel
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100256 - New graph example:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100257 - graph_yolov3_output_detector
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100258 - Removed padding from:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100259 - @ref NEPixelWiseMultiplicationKernel
SiCong Lid004a7a2020-05-28 15:26:41 +0100260 - Deprecated functions / interfaces:
261 - Non-descriptor based interfaces for @ref NEThreshold, @ref CLThreshold
262 - In @ref NESoftmaxLayer, @ref NELogSoftmaxLayer, @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer :
morgolock9c7fed82020-08-05 12:30:56 +0100263 The default "axis" value for @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer is changed from 1 to 0.
264 Only axis 0 is supported.
265 The default "axis" value for @ref NESoftmaxLayer, @ref NELogSoftmaxLayer is changed from 1 to 0.
266 Only axis 0 is supported.
Sang-Hoon Parka0205b92020-07-07 09:36:09 +0100267 - The support for quantized data types has been removed from @ref CLLogSoftmaxLayer due to implementation complexity.
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100268
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000269v20.05 Public major release
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000270 - Various bug fixes.
271 - Various optimisations.
Michele Di Giorgio36a551f2020-04-23 11:55:29 +0100272 - Updated recommended NDK version to r18b.
273 - Updated recommended gcc version to Linaro 6.3.1.
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000274 - Added Bfloat16 type support
275 - Added Bfloat16 support in:
276 - @ref NEWeightsReshapeKernel
277 - @ref NEConvolutionLayerReshapeWeights
278 - @ref NEIm2ColKernel
279 - @ref NEIm2Col
280 - @ref NEDepthConvertLayerKernel
281 - @ref NEDepthConvertLayer
282 - @ref NEGEMMConvolutionLayer
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000283 - @ref NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000284 - Added new data type QASYMM8_SIGNED support for:
285 - @ref CLDirectConvolutionLayer
286 - @ref CLDeconvolutionLayer
287 - @ref CLDirectDeconvolutionLayer
288 - @ref CLGEMMDeconvolutionLayer
289 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
290 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
291 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
292 - @ref CLReductionOperation
293 - @ref CLReduceMean
Sheri Zhang359c48e2020-04-30 22:53:39 +0100294 - @ref NEScale
295 - @ref NEScaleKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000296 - @ref NEUpsampleLayer
297 - @ref NECast
298 - @ref NEReductionOperation
299 - @ref NEReduceMean
300 - @ref NEArgMinMaxLayer
301 - @ref NEDeconvolutionLayer
302 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
303 - @ref CPPBoxWithNonMaximaSuppressionLimit
304 - @ref CPPDetectionPostProcessLayer
305 - @ref CPPPermuteKernel
306 - @ref CPPPermute
307 - @ref CPPTopKVKernel
308 - @ref CPPTopKV
Sheri Zhang359c48e2020-04-30 22:53:39 +0100309 - @ref CPPUpsample
310 - @ref CPPUpsampleKernel
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100311 - New OpenCL kernels / functions:
312 - @ref CLQLSTMLayer
313 - @ref CLQLSTMLayerNormalizationKernel
314 - New NEON kernels / functions:
315 - @ref NEQLSTMLayer
316 - @ref NEQLSTMLayerNormalizationKernel
317 - Added HARD_SWISH support in:
318 - @ref CLActivationLayerKernel
319 - @ref NEActivationLayerKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000320 - Deprecated OpenCL kernels / functions:
321 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
322 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
323 - Deprecated NEON kernels / functions:
324 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
325 - Removed CPP kernels / functions:
326 - CPPFlipWeightsKernel
Manuel Bottini387259a2020-05-21 17:14:36 +0100327 - Removed PoolingLayerInfo constructors without Data Layout.
328 - Removed CLDepthwiseConvolutionLayer3x3
329 - Removed NEDepthwiseConvolutionLayerOptimized
Manuel Bottini075253a2020-05-22 12:57:18 +0100330 - Added support for Winograd 3x3,4x4 on NEON FP16:
331 - @ref NEWinogradConvolutionLayer
332 - @ref NEWinogradLayerTransformInputKernel
333 - @ref NEWinogradLayerTransformOutputKernel
334 - @ref NEWinogradLayerTransformWeightsKernel
335 - Added CLCompileContext
336 - Added NEON GEMM kernel with 2D window support
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000337
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000338v20.02.1 Maintenance release
339 - Added Android-NN build script.
340
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000341v20.02 Public major release
342 - Various bug fixes.
343 - Various optimisations.
344 - Added new data type QASYMM8_SIGNED support for:
345 - @ref CLDepthwiseConvolutionLayer
Manuel Bottini387259a2020-05-21 17:14:36 +0100346 - CLDepthwiseConvolutionLayer3x3
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000347 - @ref CLGEMMConvolutionLayer
348 - @ref CLGEMMLowpMatrixMultiplyCore
349 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
350 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
351 - @ref NEActivationLayer
352 - @ref NEComparisonOperationKernel
353 - @ref NEConvolutionLayer
354 - @ref NEDepthwiseConvolutionLayer
355 - @ref NEDepthwiseConvolutionLayer3x3Kernel
356 - @ref NEDirectConvolutionLayerOutputStageKernel
357 - @ref NEElementwiseComparison
358 - @ref NEElementwiseMax
359 - @ref NEElementwiseMin
360 - @ref NEElementwiseSquaredDiff
361 - @ref NEFullyConnectedLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +0100362 - NEGEMMMatrixVectorMultiplyKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000363 - @ref NEPixelWiseMultiplication
364 - @ref NEPoolingLayer
365 - @ref NEPReluLayer
366 - Added support for QSYMM8_PER_CHANNEL in:
367 - @ref NEDepthwiseConvolutionLayer3x3Kernel
368 - Added support for split sizes in:
369 - @ref CLSplit
370 - @ref NESplit
371 - New OpenCL kernels / functions:
372 - @ref CLFill
373 - @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
374 - New NEON kernels / functions:
375 - @ref NEFill
376 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
377 - Deprecated NEON functions / interfaces:
Manuel Bottini387259a2020-05-21 17:14:36 +0100378 - CLDepthwiseConvolutionLayer3x3
379 - NEDepthwiseConvolutionLayerOptimized
380 - PoolingLayerInfo constructors without Data Layout.
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000381 - Added support for quantization with multiplier greater than 1 on NEON and CL.
382 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
383 - Added the ability to build bootcode for bare metal.
384 - Added support for generating synthetic QASYMM8 graphs.
385 - Added support for F16 datatype in VGG16.
386 - Removed pre-built binaries for GLES.
387
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000388v19.11.1 Public maintenance release
389 - Fix offset calculation in NEReductionOperationKernel.
390 - Fix data layout in NEScaleKernel for nhwc.
391 - Retain configuration step data layout to avoid side-effects.
392 - Perform sqrt in double domain for L2 pooling.
393 - Fix output shape calculation for Reduce Mean
394 - Restrict cases where optimized NEPadLayer runs.
395
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100396v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000397 - Various bug fixes.
398 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000399 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000400 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100401 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
402 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000403 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100404 - CLDepthwiseVectorToTensorKernel
405 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000406 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100407 - NEDepthwiseWeightsReshapeKernel
408 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000409 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100410 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100411 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000412 - New OpenCL kernels / functions:
413 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
414 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
415 OpenCL kernels / functions)
416 - @ref CLLogSoftmaxLayer
417 - New NEON kernels / functions:
418 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
419 - @ref NEComputeAllAnchorsKernel / @ref NEComputeAllAnchors
420 - @ref NEDetectionPostProcessLayer
421 - @ref NEGenerateProposalsLayer
422 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
423 - @ref NELogSoftmaxLayer
424 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
425 - Added QASYMM8 support for:
426 - @ref CLGenerateProposalsLayer
427 - @ref CLROIAlignLayer
428 - @ref CPPBoxWithNonMaximaSuppressionLimit
429 - Added QASYMM16 support for:
430 - @ref CLBoundingBoxTransform
431 - Added FP16 support for:
432 - @ref CLGEMMMatrixMultiplyReshapedKernel
433 - Added new data type QASYMM8_PER_CHANNEL support for:
434 - @ref CLDequantizationLayer
435 - @ref NEDequantizationLayer
436 - Added new data type QSYMM8_PER_CHANNEL support for:
437 - @ref CLConvolutionLayer
438 - @ref NEConvolutionLayer
439 - @ref CLDepthwiseConvolutionLayer
440 - @ref NEDepthwiseConvolutionLayer
441 - Added FP16 mixed-precision support for:
442 - @ref CLGEMMMatrixMultiplyReshapedKernel
443 - @ref CLPoolingLayerKernel
444 - Added FP32 and FP16 ELU activation for:
445 - @ref CLActivationLayer
446 - @ref NEActivationLayer
447 - Added asymmetric padding support for:
448 - @ref CLDirectDeconvolutionLayer
449 - @ref CLGEMMDeconvolutionLayer
450 - @ref NEDeconvolutionLayer
451 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
452 - Replaced the calls to @ref NECopyKernel and @ref NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
453 - Replaced the calls to @ref CLCopyKernel and @ref CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
454 - Improved performance for CL Inception V3 - FP16.
455 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
456 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
457 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
458 - Optimized @ref CLPadLayer.
459 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
460 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100461
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000462v19.08.1 Public maintenance release
463 - Fix offset calculation in NEReductionOperationKernel.
464 - Fix data layout in NEScaleKernel for nhwc.
465 - Retain configuration step data layout to avoid side-effects.
466 - Perform sqrt in double domain for L2 pooling.
467 - Fix output shape calculation for Reduce Mean
468 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
469
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100470v19.08 Public major release
471 - Various bug fixes.
472 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100473 - Deprecated NEON functions
474 - NEDepthConcatenateLayer
475 - NEWidthConcatenateLayer
476 - Deprecated OpenCL kernels / functions
477 - CLDepthConcatenateLayer
478 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
479 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
480 - CLWidthConcatenateLayer
481 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100482 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100483 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100484 - @ref NEElementwisePower
485 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100486 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100487 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100488 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100489 - @ref NESinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100490 - @ref NEBatchConcatenateLayerKernel
491 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
492 - @ref NEDepthwiseConvolutionLayerNativeKernel
493 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
494 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
495 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
496 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100497 - @ref CLAbsLayer
498 - @ref CLElementwisePower
499 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100500 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100501 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100502 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100503 - @ref CLSinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100504 - @ref CLBatchConcatenateLayerKernel
505 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
506 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
507 - @ref CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
508 - @ref CLGEMMMatrixMultiplyNativeKernel
509 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
510 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
511 - New examples:
512 - neon_opticalflow
513 - cl_cache
514 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100515 - Added support for FP16 in @ref NEDeconvolutionLayer
516 - Added support for FP16 in @ref CLDeconvolutionLayer
517 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100518 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
519 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
520 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
521 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
522 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
523 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini387259a2020-05-21 17:14:36 +0100524 - The CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
525 - The NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100526 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
527 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100528 - 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 +0100529
Michalis Spyroua9c44722019-04-05 17:18:36 +0100530v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100531 - Various bug fixes.
532 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100533 - New Neon kernels / functions:
534 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100535 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100536 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100537 - @ref NEDepthwiseConvolutionAssemblyDispatch
538 - @ref NEFFTDigitReverseKernel
539 - @ref NEFFTRadixStageKernel
540 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100541 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
542 - @ref NEHeightConcatenateLayerKernel
543 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100544 - @ref NEFFT1D
545 - @ref NEFFT2D
546 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100547 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100548 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100549 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100550 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100551 - @ref CLFFTDigitReverseKernel
552 - @ref CLFFTRadixStageKernel
553 - @ref CLFFTScaleKernel
554 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
555 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
556 - @ref CLHeightConcatenateLayerKernel
557 - @ref CLDirectDeconvolutionLayer
558 - @ref CLFFT1D
559 - @ref CLFFT2D
560 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100561 - @ref CLGEMMDeconvolutionLayer
562 - New OpenGLES kernels / functions:
563 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100564 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100565 - GCDepthConcatenateLayer
566 - NEWidthConcatenateLayer
567 - NEDepthConcatenateLayer
568 - CLWidthConcatenateLayer
569 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100570 - CLGEMMInterleave4x4
571 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100572 - Support different quantization info in CLConcatLayer.
573 - Add checks on different input/output quantization info were not supported.
574 - Tensors have different quantization information.
575 - Add FP16 support checks.
576 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
577 - New graph examples:
578 - graph_convolution
579 - graph_fully_connected
580 - graph_depthwise_convolution
581 - Deepspeech v0.4.1
582 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
583 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
584 - Add support for QASYMM8 NEDeconvolution.
585 - Add support for DequantizationLayer for NEON/CL.
586 - Add support for dilation in CLDepthwiseConvolution.
587 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
588 - Optimize CLDeconvolution.
589 - Add StackLayer to the graph API.
590 - Add support for "reflect" padding mode in NEPad.
591 - Winograd 7x7 NHWC on OpenCL.
592 - Rework CL ML layers to run exclusively on CL.
593 - Support different quantization info in PoolingLayer.
594 - Implement and test import memory interfaces.
595 - Added new tests and removed old ones.
596 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100597
giuros01a69a88b2019-01-31 16:29:19 +0000598v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000599 - Various bug fixes.
600 - Various optimisations.
601 - New Neon kernels / functions:
602 - @ref NETileKernel / @ref NETile
603 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
604 - @ref NEElementwiseOperationKernel
605 - @ref NEElementwiseMax
606 - @ref NEElementwiseMin
607 - @ref NEElementwiseSquaredDiff
608 - @ref NESelectKernel / @ref NESelect
609 - @ref NESplit
610 - @ref NESlice
611 - @ref NEUnstack
612 - @ref NEStridedSliceKernel / @ref NEStridedSlice
613 - @ref NEElementwiseUnaryKernel
614 - @ref NERsqrtLayer
615 - @ref NEExpLayer
616 - @ref NEReverseKernel / @ref NEReverse
617 - @ref NEArgMinMaxLayer
618 - @ref NEStackLayerKernel / @ref NEStackLayer
619 - @ref NERangeKernel / @ref NERange
620 - @ref NEPadLayer
621 - @ref NEMemsetKernel
622 - @ref NEGatherKernel / @ref NEGather
623 - @ref NEElementwiseComparison
624 - @ref NEElementwiseComparisonStatic
625 - @ref NEComparisonOperationKernel
626 - @ref NEElementwiseDivision
627 - New OpenCL kernels / functions:
628 - @ref CLSelectKernel / @ref CLSelect
629 - @ref CLTileKernel / @ref CLTile
630 - @ref CLComparisonKernel / @ref CLComparison
631 - @ref CLArgMinMaxLayer
632 - @ref CLElementwiseMax
633 - @ref CLElementwiseMin
634 - @ref CLElementwiseSquaredDiff
635 - @ref CLStackLayerKernel / @ref CLStackLayer
636 - @ref CLReverse / @ref CLReverseKernel
637 - @ref CLRsqrtLayer
638 - @ref CLExpLayer
639 - @ref CLElementWiseUnaryLayerKernel
640 - @ref CLGEMMReshapeLHSMatrixKernel
641 - @ref CLGEMMReshapeRHSMatrixKernel
642 - @ref CLGEMMMatrixMultiplyReshapedKernel
643 - @ref CLRangeKernel / @ref CLRange
644 - @ref CLUnstack
645 - @ref CLGatherKernel / @ref CLGather
646 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
647 - New CPP kernels / functions:
648 - @ref CPPDetectionOutputLayer
649 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000650 - Added new examples:
651 - graph_ssd_mobilenet.cpp
652 - graph_mobilenet_v2.cpp
653 - graph_resnet12.cpp
654 - graph_srcnn955.cpp
655 - graph_vgg_vdsr.cpp
656 - graph_inception_resnet_v1.cpp
657 - Add 4D tensors support to
658 - @ref NESoftmaxLayer
659 - Fused activation in @ref CLWinogradConvolutionLayer
660 - Extented @ref NEPermute to support more cases
661 - Added NEON/SVE GEMM Hybrid kernels
662 - Added u8 and s8 hybrid assembly kernels
663 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
664 - Improved @ref CLTuner
665 - Fused the bias addition within @ref CLGEMM
666 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
667 - Added NHWC data layout support to:
668 - @ref NEScale for F16
669 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
670 - @ref NEL2NormalizeLayer for FP32/FP16
671 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
672 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000673 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000674 - Added QASYMM8 support to the following kernels:
675 - @ref NEArithmeticAdditionKernel
676 - @ref NEScale
677 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000678 - Deprecated functions/interfaces
679 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
680
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000681v18.11 Public major release
682 - Various bug fixes.
683 - Various optimisations.
684 - New Neon kernels / functions:
685 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
686 - @ref NEReduceMean
687 - @ref NEReorgLayer / @ref NEReorgLayerKernel
688 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
689 - @ref NEUpsampleLayer / @ref NEUpsampleLayerKernel
690 - @ref NEYOLOLayer / @ref NEYOLOLayerKernel
691 - New OpenCL kernels / functions:
692 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
693 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000694 - @ref CLComputeAllAnchorsKernel
695 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000696 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
697 - @ref CLReorgLayer / @ref CLReorgLayerKernel
698 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
699 - @ref CLPadLayer
700 - @ref CLReduceMean
701 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
702 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
703 - @ref CLSlice
704 - @ref CLSplit
705 - @ref CLStridedSlice / @ref CLStridedSliceKernel
706 - @ref CLUpsampleLayer / @ref CLUpsampleLayerKernel
707 - @ref CLYOLOLayer / @ref CLYOLOLayerKernel
708 - New CPP kernels / functions:
709 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
710 - Added the validate method in:
711 - @ref NEDepthConvertLayer
712 - @ref NEFloor / @ref CLFloor
713 - @ref NEGEMMMatrixAdditionKernel
714 - @ref NEReshapeLayer / @ref CLReshapeLayer
715 - @ref CLScale
716 - Added new examples:
717 - graph_shufflenet.cpp
718 - graph_yolov3.cpp
719 - Added documentation for add a new function or kernel.
720 - Improved doxygen documentation adding a list of the existing functions.
721 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100722 - CLWidthConcatenateLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000723 - @ref CLFlattenLayer
724 - @ref CLSoftmaxLayer
725 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
726 - Add SVE support
727 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
728 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
729 - Added NHWC data layout support to:
730 - @ref CLChannelShuffleLayer
731 - @ref CLDeconvolutionLayer
732 - @ref CLL2NormalizeLayer
733 - Added QASYMM8 support to the following kernels:
734 - @ref CLScaleKernel
735 - @ref NEDepthwiseConvolutionLayer3x3Kernel
736 - @ref CLPixelWiseMultiplicationKernel
737 - Added FP16 support to the following kernels:
738 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
739 - @ref NEDepthwiseConvolutionLayer3x3Kernel
740 - @ref CLNormalizePlanarYUVLayerKernel
741 - @ref CLWinogradConvolutionLayer (5x5 kernel)
742 - More tests added to both validation and benchmarking suites.
743
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100744v18.08 Public major release
745 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100746 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100747 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100748 - Removed support for QS8/QS16 data types.
749 - Added support for grouped convolution in @ref CLConvolutionLayer.
750 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100751 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100752 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
753 - @ref CLDepthwiseConvolutionLayer
754 - @ref CLDirectConvolutionLayer
755 - @ref CLConvolutionLayer
756 - @ref CLScale
757 - @ref CLIm2ColKernel
758 - New Neon kernels / functions:
759 - @ref NERNNLayer
760 - New OpenCL kernels / functions:
761 - @ref CLArithmeticDivision
762 - Introduced prepare() stage support in the graph API for GLES.
763 - Added support for memory reusage when trying to allocate smaller CLTensors.
764 - Enabled NHWC execution on graph examples.
765 - Added JPEG accessor for validation purposes.
766 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100767
768v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100769 - Various bug fixes.
770 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000771 - Major redesign in the interface for the neon kernels implemented in assembly.
772 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
773 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
774 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100775 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
776 - Improved doxygen documentation.
777 - Improved memory management for layer's transitions.
778 - Added support for NHWC data layout in tensors.
779 - Added NHWC data layout support to:
780 - @ref NEGEMMConvolutionLayer
781 - @ref NEDirectConvolutionLayer
782 - @ref NEPoolingLayer / @ref CLPoolingLayer
783 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
784 - @ref NEDepthwiseConvolutionLayer
785 - @ref NEScale
786 - @ref NEIm2Col
787 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
788 - New OpenCL kernels / functions:
789 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
790 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
791 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100792 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100793 - @ref CLRNNLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100794 - CLWidthConcatenateLayer / @ref CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100795 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
796 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
797 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100798 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
799 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
800 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
801 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
802 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
803 - Port mobilenet example to NHWC data layout.
804 - Enabled Winograd method in @ref CLConvolutionLayer.
805 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
806 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
807 - Added memory manager support in GLES functions.
808 - Major refactoring of the graph API.
809 - Added GLES backend in the graph API.
810 - Added support for the memory manager in the graph API.
811 - Enabled Winograd Convolution method in the graph API.
812 - Added support for grouped convolutions in the graph API.
813 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
814 - Added fast maths flag in @ref CLConvolutionLayer.
815 - Added new tests and benchmarks in validation and benchmark frameworks
816 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
817 - Added support to OpenCL 2.0 SVM
818 - Added support to import memory in OpenCL tensors.
819 - Added the prepare() method to perform any one off pre-processing before running the function.
820 - Added new examples:
821 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100822 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100823 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000824
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000825v18.03 Public maintenance release
826 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +0000827 - Fixed bug in @ref NEActivationLayer
828 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000829 - Updated recommended NDK version to r16b (And fixed warnings).
830 - Fixed bug in validation code.
831 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100832 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000833
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000834v18.02 Public major release
835 - Various NEON / OpenCL / GLES optimisations.
836 - Various bug fixes.
837 - Changed default number of threads on big LITTLE systems.
838 - Refactored examples and added:
839 - graph_mobilenet_qassym8
840 - graph_resnet
841 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +0000842 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
843 - 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 +0000844 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000845 - @ref CLActivationLayer
846 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000847 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000848 - @ref CLActivationLayer
849 - @ref CLDepthwiseConvolutionLayer
850 - @ref NEDepthwiseConvolutionLayer
851 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000852 - Added FP16 support to:
Manuel Bottini387259a2020-05-21 17:14:36 +0100853 - CLDepthwiseConvolutionLayer3x3
Anthony Barbier3762e742018-03-02 11:49:33 +0000854 - @ref CLDepthwiseConvolutionLayer
855 - Added broadcasting support to @ref NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
856 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
857 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000858 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100859 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +0000860 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000861 - Added name() method to all kernels.
862 - Added support for Winograd 5x5.
Anthony Barbier3762e742018-03-02 11:49:33 +0000863 - @ref NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100864 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
865 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
866 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +0100867 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000868 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000869 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +0000870
Anthony Barbier64c95a02018-01-22 18:48:55 +0000871v18.01 Public maintenance release
872 - Various bug fixes
873 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +0000874 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
875 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +0000876 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +0000877 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
878 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
879 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
880 - Added @ref GCScaleKernel / @ref GCScale
881 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +0000882 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000883 - @ref GCCol2ImKernel
884 - @ref GCGEMMInterleave4x4Kernel
885 - @ref GCGEMMTranspose1xWKernel
886 - @ref GCIm2ColKernel
887 - Refactored NEON Winograd (NEWinogradLayerKernel)
888 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000889 - Added QASYMM8 support to the following NEON kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000890 - @ref NEDepthwiseConvolutionLayer3x3Kernel
891 - @ref NEFillBorderKernel
892 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000893 - Added new examples:
894 - graph_cl_mobilenet_qasymm8.cpp
895 - graph_inception_v3.cpp
896 - gc_dc.cpp
897 - More tests added to both validation and benchmarking suites.
898
Gian Marcoff850932017-12-11 12:37:17 +0000899v17.12 Public major release
900 - Most machine learning functions on OpenCL support the new data type QASYMM8
901 - Introduced logging interface
902 - Introduced opencl timer
903 - Reworked GEMMLowp interface
904 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
905 - Added validation method for most Machine Learning kernels / functions
906 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
907 - Added sgemm example for OpenCL
908 - Added absolute difference example for GLES compute
909 - Added new tests and benchmarks in validation and benchmark frameworks
910 - Added new kernels / functions for GLES compute
911
912 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000913 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
914 - @ref GCActivationLayerKernel / @ref GCActivationLayer
915 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
916 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +0100917 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000918 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
919 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
920 - @ref GCFillBorderKernel / @ref GCFillBorder
921 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
922 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
923 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
924 - @ref GCIm2ColKernel
925 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
926 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
927 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
928 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
929 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +0000930
931 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +0000932 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
933 - arm_compute::NEHGEMMAArch64FP16Kernel
Michele Di Giorgiof22f6722020-07-03 16:29:24 +0100934 - @ref NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000935 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
936 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100937 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +0000938
939 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000940 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
941 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +0000942
943 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +0100944 - graph::BranchLayer
945 - graph::DepthConvertLayer
946 - graph::DepthwiseConvolutionLayer
947 - graph::DequantizationLayer
948 - graph::FlattenLayer
949 - graph::QuantizationLayer
950 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +0000951
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100952v17.10 Public maintenance release
953 - Bug fixes:
954 - Check the maximum local workgroup size supported by OpenCL devices
955 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +0000956 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100957 - Added a few new Graph nodes, support for branches and grouping.
958 - Automatically enable cl_printf in debug builds
959 - Fixed bare metal builds for armv7a
960 - Added AlexNet and cartoon effect examples
961 - 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)
962
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100963v17.09 Public major release
964 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +0000965 - 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 +0100966 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
967 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
968 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +0000969 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000970 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
971 - @ref NEFloorKernel / @ref NEFloor
972 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
973 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
974 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
975 - @ref NEReductionOperationKernel / @ref NEReductionOperation
976 - @ref NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100977
978 - New OpenCL kernels / functions:
Manuel Bottini387259a2020-05-21 17:14:36 +0100979 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000980 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
981 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
982 - @ref CLFlattenLayer
983 - @ref CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100984 - CLGEMMTranspose1xW
Anthony Barbier3762e742018-03-02 11:49:33 +0000985 - @ref CLGEMMMatrixVectorMultiplyKernel
986 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
987 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
988 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
989 - @ref CLReductionOperationKernel / @ref CLReductionOperation
990 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100991
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100992v17.06 Public major release
993 - Various bug fixes
994 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
995 - Added unit tests and benchmarks (AlexNet, LeNet)
996 - Added support for sub tensors.
997 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +0000998 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
999 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
1000 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001001 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001002 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +01001003 - @ref CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001004 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
1005 - @ref CLLocallyConnectedMatrixMultiplyKernel / @ref CLLocallyConnectedLayer
1006 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001007 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001008 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001009 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001010 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +01001011 - @ref NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001012 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
1013 - @ref NELocallyConnectedMatrixMultiplyKernel / @ref NELocallyConnectedLayer
1014 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001015
1016v17.05 Public bug fixes release
1017 - Various bug fixes
1018 - Remaining of the functions ported to use accurate padding.
1019 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
1020 - Added "free" method to allocator.
1021 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
1022
1023v17.04 Public bug fixes release
1024
1025 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +00001026 - @ref CLColorConvertKernel
1027 - @ref CLEdgeNonMaxSuppressionKernel
1028 - @ref CLEdgeTraceKernel
1029 - @ref CLGaussianPyramidHorKernel
1030 - @ref CLGaussianPyramidVertKernel
1031 - @ref CLGradientKernel
1032 - @ref NEChannelCombineKernel
1033 - @ref NEFillArrayKernel
1034 - @ref NEGaussianPyramidHorKernel
1035 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +01001036 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001037 - @ref NEHarrisScoreKernel
1038 - @ref NEHOGDetectorKernel
1039 - @ref NELogits1DMaxKernel
1040 - NELogits1DShiftExpSumKernel
1041 - NELogits1DNormKernel
1042 - @ref NENonMaximaSuppression3x3FP16Kernel
1043 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001044
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001045v17.03.1 First Major public release of the sources
1046 - Renamed the library to arm_compute
1047 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
1048 - New padding calculation interface introduced and ported most kernels / functions to use it.
1049 - New OpenCL kernels / functions:
Gian Marco Iodiceeb65f6d2020-04-15 11:42:15 +01001050 - CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001051 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001052 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
1053 - @ref NETransposeKernel / @ref NETranspose
1054 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
1055 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +01001056 - NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001057 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001058
1059v17.03 Sources preview
1060 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001061 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001062 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001063 - CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001064 - @ref CLTransposeKernel / @ref CLTranspose
1065 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
1066 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
1067 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001068 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001069 - @ref NEActivationLayerKernel / @ref NEActivationLayer
1070 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
1071 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001072
1073v17.02.1 Sources preview
1074 - New OpenCL kernels / functions:
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001075 - CLLogits1DMaxKernel, CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001076 - @ref CLPoolingLayerKernel / @ref CLPoolingLayer
1077 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
1078 - @ref CLRemapKernel / @ref CLRemap
1079 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
1080 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
1081 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001082 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +00001083 - @ref NEAccumulateWeightedFP16Kernel
1084 - @ref NEBox3x3FP16Kernel
1085 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001086
1087v17.02 Sources preview
1088 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001089 - @ref CLActivationLayerKernel / @ref CLActivationLayer
1090 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1091 - @ref CLDerivativeKernel / @ref CLChannelExtract
1092 - @ref CLFastCornersKernel / @ref CLFastCorners
1093 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001094 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001095 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1096 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001097 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1098 - Switched all the kernels / functions to use tensors instead of images.
1099 - Updated documentation to include instructions to build the library from sources.
1100
1101v16.12 Binary preview release
1102 - Original release
1103
1104@section S3_how_to_build How to build the library and the examples
1105
1106@subsection S3_1_build_options Build options
1107
1108scons 2.3 or above is required to build the library.
1109To see the build options available simply run ```scons -h```:
1110
Anthony Barbier79c61782017-06-23 11:48:24 +01001111 debug: Debug (yes|no)
1112 default: False
1113 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001114
Anthony Barbier79c61782017-06-23 11:48:24 +01001115 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1116 default: False
1117 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001118
Anthony Barbier79c61782017-06-23 11:48:24 +01001119 arch: Target Architecture (armv7a|arm64-v8a|arm64-v8.2-a|x86_32|x86_64)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001120 default: armv7a
1121 actual: armv7a
1122
Anthony Barbier79c61782017-06-23 11:48:24 +01001123 os: Target OS (linux|android|bare_metal)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001124 default: linux
1125 actual: linux
1126
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001127 build: Build type (native|cross_compile|embed_only)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001128 default: cross_compile
1129 actual: cross_compile
1130
Anthony Barbier79c61782017-06-23 11:48:24 +01001131 examples: Build example programs (yes|no)
1132 default: True
1133 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001134
Anthony Barbier79c61782017-06-23 11:48:24 +01001135 Werror: Enable/disable the -Werror compilation flag (yes|no)
1136 default: True
1137 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001138
Anthony Barbier79c61782017-06-23 11:48:24 +01001139 opencl: Enable OpenCL support (yes|no)
1140 default: True
1141 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001142
Anthony Barbier79c61782017-06-23 11:48:24 +01001143 neon: Enable Neon support (yes|no)
1144 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001145 actual: False
1146
Anthony Barbier20dbb822017-12-13 21:19:39 +00001147 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1148 default: False
1149 actual: False
1150
1151 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shader in library binary (yes|no)
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001152 default: True
1153 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001154
1155 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1156 default: False
1157 actual: False
1158
1159 openmp: Enable OpenMP backend (yes|no)
1160 default: False
1161 actual: False
1162
1163 cppthreads: Enable C++11 threads backend (yes|no)
1164 default: True
1165 actual: True
1166
1167 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1168 default: .
1169 actual: .
1170
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001171 extra_cxx_flags: Extra CXX flags to be appended to the build command
1172 default:
1173 actual:
1174
Anthony Barbier79c61782017-06-23 11:48:24 +01001175 pmu: Enable PMU counters (yes|no)
1176 default: False
1177 actual: False
1178
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001179 mali: Enable Mali hardware counters (yes|no)
1180 default: False
1181 actual: False
1182
Anthony Barbier79c61782017-06-23 11:48:24 +01001183 validation_tests: Build validation test programs (yes|no)
1184 default: False
1185 actual: False
1186
1187 benchmark_tests: Build benchmark test programs (yes|no)
1188 default: False
1189 actual: False
1190
1191@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001192 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1193 - 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)
1194 - 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).
1195
Anthony Barbier79c61782017-06-23 11:48:24 +01001196@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 +01001197
Anthony Barbier79c61782017-06-23 11:48:24 +01001198@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001199@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1200
Anthony Barbier79c61782017-06-23 11:48:24 +01001201@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 +01001202
Anthony Barbier79c61782017-06-23 11:48:24 +01001203@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 +01001204
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001205There 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.
1206
Anthony Barbier79c61782017-06-23 11:48:24 +01001207@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 +01001208
Anthony Barbier20dbb822017-12-13 21:19:39 +00001209@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 +01001210
Anthony Barbier20dbb822017-12-13 21:19:39 +00001211@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 +01001212
1213@b set_soname: Do you want to build the versioned version of the library ?
1214
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001215If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1216Example:
1217 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1218 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1219 libarm_compute_core.so.1.0.0
1220
1221@note This options is disabled by default as it requires SCons version 2.4 or above.
1222
Anthony Barbier79c61782017-06-23 11:48:24 +01001223@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1224
1225@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1226
1227@b examples: Build or not the examples
1228
1229@b validation_tests: Enable the build of the validation suite.
1230
Anthony Barbier79c61782017-06-23 11:48:24 +01001231@b benchmark_tests: Enable the build of the benchmark tests
1232
1233@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1234
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001235@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)
1236
Anthony Barbier79c61782017-06-23 11:48:24 +01001237@b openmp Build in the OpenMP scheduler for NEON.
1238
1239@note Only works when building with g++ not clang++
1240
1241@b cppthreads Build in the C++11 scheduler for NEON.
1242
Anthony Barbier3762e742018-03-02 11:49:33 +00001243@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001244
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001245@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001246
1247@subsubsection S3_2_1_library How to build the library ?
1248
1249For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1250
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001251 - gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
1252 - gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001253
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001254To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1255
1256 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1257
1258To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1259
1260 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1261
Anthony Barbier20dbb822017-12-13 21:19:39 +00001262To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1263
1264 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1265
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001266You can also compile the library natively on an ARM device by using <b>build=native</b>:
1267
1268 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1269 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1270
1271@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.
1272
1273For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1274
1275 apt-get install g++-arm-linux-gnueabihf
1276
1277Then run
1278
1279 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1280
1281or simply remove the build parameter as build=cross_compile is the default value:
1282
1283 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1284
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001285@subsubsection S3_2_2_examples How to manually build the examples ?
1286
1287The 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.
1288
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001289@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 +01001290
1291To cross compile a NEON example for Linux 32bit:
1292
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001293 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 +01001294
1295To cross compile a NEON example for Linux 64bit:
1296
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001297 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 +01001298
1299(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)
1300
1301To cross compile an OpenCL example for Linux 32bit:
1302
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001303 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 +01001304
1305To cross compile an OpenCL example for Linux 64bit:
1306
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001307 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 +01001308
Anthony Barbier14c86a92017-12-14 16:27:41 +00001309To cross compile a GLES example for Linux 32bit:
1310
1311 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
1312
1313To cross compile a GLES example for Linux 64bit:
1314
1315 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
1316
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001317(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)
1318
Anthony Barbier14c86a92017-12-14 16:27:41 +00001319To 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.
1320
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001321i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1322
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001323 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 +01001324
1325i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1326
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001327 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 +01001328
1329(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)
1330
Anthony Barbiere5007472017-10-27 15:01:44 +01001331@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1332
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001333To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1334
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001335 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 +01001336
1337To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1338
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001339 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 +01001340
1341(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1342
1343To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1344
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001345 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 +01001346
Anthony Barbier14c86a92017-12-14 16:27:41 +00001347To 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 +01001348
Anthony Barbier14c86a92017-12-14 16:27:41 +00001349 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
1350
1351To compile natively the examples with the Graph API, such as graph_lenet.cpp, you need to link the examples against arm_compute_graph.so too.
Anthony Barbier14c86a92017-12-14 16:27:41 +00001352
1353i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001354
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001355 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 +01001356
Anthony Barbier14c86a92017-12-14 16:27:41 +00001357i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001358
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001359 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 +01001360
1361(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 +01001362
Anthony Barbiere5007472017-10-27 15:01:44 +01001363@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1364
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001365@note These two commands assume libarm_compute.so is available in your library path, if not add the path to it using -L (e.g. -Llib/linux-arm64-v8a-neon-cl-asserts/)
Georgios Pinitas58216322020-02-26 11:13:13 +00001366@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 +01001367
1368To run the built executable simply run:
1369
1370 LD_LIBRARY_PATH=build ./neon_convolution
1371
1372or
1373
1374 LD_LIBRARY_PATH=build ./cl_convolution
1375
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001376@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 +00001377
1378For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001379
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001380 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001381
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001382Below is a list of the common parameters among the graph examples :
1383@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001384
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001385@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001386
1387For Android, the library was successfully built and tested using Google's standalone toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001388 - clang++ from NDK r18b for armv7a
1389 - clang++ from NDK r18b for arm64-v8a
1390 - clang++ from NDK r18b for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001391
1392Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1393
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001394- Download the NDK r18b from here: https://developer.android.com/ndk/downloads/index.html
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001395- Make sure you have Python 2.7 installed on your machine.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001396- Generate the 32 and/or 64 toolchains by running the following commands:
1397
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001398
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001399 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b --stl libc++ --api 21
1400 $NDK/build/tools/make_standalone_toolchain.py --arch arm --install-dir $MY_TOOLCHAINS/arm-linux-android-ndk-r18b --stl libc++ --api 21
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001401
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001402@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 +01001403
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001404@note Make sure to add the toolchains to your PATH:
1405
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001406 export PATH=$PATH:$MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b/bin:$MY_TOOLCHAINS/arm-linux-android-ndk-r18b/bin
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001407
1408@subsubsection S3_3_1_library How to build the library ?
1409
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001410To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1411
1412 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1413
1414To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1415
Anthony Barbier14c86a92017-12-14 16:27:41 +00001416 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 +01001417
Anthony Barbier20dbb822017-12-13 21:19:39 +00001418To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1419
Anthony Barbier14c86a92017-12-14 16:27:41 +00001420 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 +00001421
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001422@subsubsection S3_3_2_examples How to manually build the examples ?
1423
1424The 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.
1425
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001426@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 +01001427
1428Once you've got your Android standalone toolchain built and added to your path you can do the following:
1429
1430To cross compile a NEON example:
1431
1432 #32 bit:
Georgios Pinitas9873ea32017-12-05 15:28:55 +00001433 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 +01001434 #64 bit:
Anthony Barbier14c86a92017-12-14 16:27:41 +00001435 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 +01001436
1437To cross compile an OpenCL example:
1438
1439 #32 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001440 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 +01001441 #64 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001442 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 +00001443
1444To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001445
Anthony Barbier14c86a92017-12-14 16:27:41 +00001446 #32 bit:
1447 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
1448 #64 bit:
1449 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 +01001450
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001451To cross compile the examples with the Graph API, such as graph_lenet.cpp, you need to link the library arm_compute_graph also.
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001452
1453 #32 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001454 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 +01001455 #64 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001456 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 +01001457
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001458@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 +00001459@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 +01001460
1461Then you need to do is upload the executable and the shared library to the device using ADB:
1462
1463 adb push neon_convolution_arm /data/local/tmp/
1464 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001465 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001466 adb shell chmod 777 -R /data/local/tmp/
1467
1468And finally to run the example:
1469
1470 adb shell /data/local/tmp/neon_convolution_arm
1471 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001472 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001473
1474For 64bit:
1475
1476 adb push neon_convolution_aarch64 /data/local/tmp/
1477 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001478 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001479 adb shell chmod 777 -R /data/local/tmp/
1480
1481And finally to run the example:
1482
1483 adb shell /data/local/tmp/neon_convolution_aarch64
1484 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001485 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001486
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001487@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 +00001488
1489For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001490 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001491
1492In 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.
1493
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001494@subsection S3_4_bare_metal Building for bare metal
1495
Georgios Pinitas58216322020-02-26 11:13:13 +00001496For 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 +01001497 - arm-eabi for armv7a
1498 - aarch64-elf for arm64-v8a
1499
1500Download 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>.
1501
1502@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
1503
1504@subsubsection S3_4_1_library How to build the library ?
1505
1506To cross-compile the library with NEON support for baremetal arm64-v8a:
1507
1508 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
1509
1510@subsubsection S3_4_2_examples How to manually build the examples ?
1511
1512Examples 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>.
1513
1514@subsection S3_5_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001515
1516Using `scons` directly from the Windows command line is known to cause
1517problems. The reason seems to be that if `scons` is setup for cross-compilation
1518it gets confused about Windows style paths (using backslashes). Thus it is
1519recommended to follow one of the options outlined below.
1520
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001521@subsubsection S3_5_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001522
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001523The best and easiest option is to use
1524<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001525This feature is still marked as *beta* and thus might not be available.
1526However, if it is building the library is as simple as opening a *Bash on
1527Ubuntu on Windows* shell and following the general guidelines given above.
1528
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001529@subsubsection S3_5_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001530
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001531If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001532can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1533to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001534also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001535code of the library.) Linaro provides pre-built versions of
1536<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001537that can be used from the Cygwin terminal. When building for Android the
1538compiler is included in the Android standalone toolchain. After everything has
1539been set up in the Cygwin terminal the general guide on building the library
1540can be followed.
1541
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001542@subsection S3_6_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001543
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001544@subsubsection S3_6_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001545
1546Compute 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).
1547
1548Enabling 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.
1549
1550Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1551
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001552@subsubsection S3_6_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001553
1554Integer 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.
1555
1556OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1557
1558SVM 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 +01001559
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001560@subsection S3_7_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001561
1562The 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).
1563The 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 +01001564The 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 +01001565In 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.
1566
1567If 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:
1568
1569https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1570
1571Tuning 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.
1572
1573CLTuner 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.
1574
1575 #Example: 2 unique Matrix Multiply configurations
1576@code{.cpp}
1577 TensorShape a0 = TensorShape(32,32);
1578 TensorShape b0 = TensorShape(32,32);
1579 TensorShape c0 = TensorShape(32,32);
1580 TensorShape a1 = TensorShape(64,64);
1581 TensorShape b1 = TensorShape(64,64);
1582 TensorShape c1 = TensorShape(64,64);
1583
1584 Tensor a0_tensor;
1585 Tensor b0_tensor;
1586 Tensor c0_tensor;
1587 Tensor a1_tensor;
1588 Tensor b1_tensor;
1589 Tensor c1_tensor;
1590
1591 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1592 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1593 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1594 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1595 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1596 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1597
1598 CLGEMM gemm0;
1599 CLGEMM gemm1;
1600
1601 // Configuration 0
1602 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1603
1604 // Configuration 1
1605 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1606@endcode
1607
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001608@subsubsection S3_7_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001609
1610All 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
1611
1612 #Enable CL tuner
1613 ./graph_mobilenet --enable-tuner –-target=CL
1614 ./arm_compute_benchmark --enable-tuner
1615
1616 #Export/Import to/from a file
1617 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1618 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1619
1620If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1621
1622Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1623
1624 -# Disable the power management
1625 -# Keep the GPU frequency constant
1626 -# Run multiple times the network (i.e. 10).
1627
1628If 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.
1629
1630@code{.cpp}
1631CLTuner tuner;
1632
1633// Setup Scheduler
1634CLScheduler::get().default_init(&tuner);
1635@endcode
1636
1637After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1638- tuner.save_to_file("results.csv");
1639
1640This file can be also imported using the method "load_from_file("results.csv")".
1641- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001642*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001643} // namespace arm_compute