blob: 0ba1d3ef0be6d3a2a9807e9925b22d1ac66a210c [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
SiCong Li96209c72020-08-21 12:28:30 +0100240v20.11 Public major release
SiCong Li903f8cc2020-08-27 10:17:10 +0100241 - Added new data type S32 support for:
242 - @ref NEArithmeticSubtraction
243 - @ref NEArithmeticSubtractionKernel
SiCong Li96209c72020-08-21 12:28:30 +0100244 - Interface change
245 - Properly support softmax axis to have the same meaning as other major frameworks. That is, axis now defines the dimension
246 on which Softmax/Logsoftmax is performed. E.g. for input of shape 4x5x6 and axis=1, softmax will be applied to 4x6=24 vectors of size 5.
247 The supported value range of axis is [-rank, rank).
248 This change applies to the following functions:
249 - @ref NESoftmaxLayer
250 - @ref NELogSoftmaxLayer
251 - @ref CLSoftmaxLayer
252 - @ref CLLogSoftmaxLayer
253 - @ref GCSoftmaxLayer
Georgios Pinitas2d221392020-09-03 15:16:37 +0100254 - Deprecated OpenCL kernels / functions:
255 - CLLocallyConnectedLayer
256 - CLLocallyConnectedMatrixMultiplyKernel
257 - Deprecated NEON kernels / functions:
258 - NELocallyConnectedLayer
259 - NELocallyConnectedMatrixMultiplyKernel
SiCong Li96209c72020-08-21 12:28:30 +0100260
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100261v20.08 Public major release
262 - Various bug fixes.
263 - Various optimisations.
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100264 - Added new data type QASYMM8_SIGNED support for:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100265 - @ref CLArgMinMaxLayer
266 - @ref CLArgMinMaxLayerKernel
267 - Added new data type U8 support for:
268 - @ref NECropKernel
269 - @ref CLCropKernel
270 - Added aligh_corner support for nearest neighbor interpolation in:
271 - @ref NEScaleKernel
272 - @ref CLScaleKernel
273 - New OpenCL kernels / functions:
274 - @ref CLMaxUnpoolingLayerKernel
275 - New NEON kernels / functions:
276 - @ref NEMaxUnpoolingLayerKernel
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100277 - New graph example:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100278 - graph_yolov3_output_detector
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100279 - GEMMTuner improvements:
280 - Added fp16 support
281 - Output json files for easier integration
282 - Enabled tuning for export_to_cl_image_rhs option for RHS tensors
283 - More robust script for running benchmarks
Sheri Zhang3ef9b5f2020-07-09 16:32:58 +0100284 - Removed padding from:
Sheri Zhangdd4cfc02020-07-10 14:15:41 +0100285 - @ref NEPixelWiseMultiplicationKernel
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100286 - @ref NEHeightConcatenateLayerKernel
287 - @ref NEThresholdKernel
288 - @ref NEBatchConcatenateLayerKernel
289 - @ref NETransposeKernel
290 - @ref NEBatchNormalizationLayerKernel
291 - @ref NEArithmeticSubtractionKernel
292 - @ref NEBoundingBoxTransformKernel
293 - @ref NELogits1DMaxKernel
294 - @ref NELogits1DSoftmaxKernel
295 - @ref NEROIPoolingLayerKernel
296 - @ref NEROIAlignLayerKernel
297 - @ref NEYOLOLayerKernel
298 - @ref NEUpsampleLayerKernel
299 - @ref NEFloorKernel
300 - @ref NEWidthConcatenateLayerKernel
301 - @ref NEDepthConcatenateLayerKernel
302 - @ref NENormalizationLayerKernel
303 - @ref NEL2NormalizeLayerKernel
304 - @ref NEFillArrayKernel
305 - @ref NEDepthConvertLayerKernel
306 - @ref NERangeKernel
307 - @ref NEPriorBoxLayer
Sang-Hoon Parka45abfd2020-08-17 13:50:15 +0100308 - Removedd OpenCL kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100309 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
310 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
Sang-Hoon Parka45abfd2020-08-17 13:50:15 +0100311 - Removed NEON kernels / functions:
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100312 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
313 - NEGEMMMatrixAccumulateBiasesKernel
SiCong Lid004a7a2020-05-28 15:26:41 +0100314 - Deprecated functions / interfaces:
315 - Non-descriptor based interfaces for @ref NEThreshold, @ref CLThreshold
Sang-Hoon Park97c1a672020-08-18 11:44:13 +0100316 - Non-descriptor based interfaces for @ref NEScale, @ref CLScale and @ref GCScale
SiCong Lid004a7a2020-05-28 15:26:41 +0100317 - In @ref NESoftmaxLayer, @ref NELogSoftmaxLayer, @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer :
morgolock9c7fed82020-08-05 12:30:56 +0100318 The default "axis" value for @ref CLSoftmaxLayer, @ref CLLogSoftmaxLayer and @ref GCSoftmaxLayer is changed from 1 to 0.
319 Only axis 0 is supported.
320 The default "axis" value for @ref NESoftmaxLayer, @ref NELogSoftmaxLayer is changed from 1 to 0.
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100321 Only axis 0 is supported.
Sang-Hoon Parka0205b92020-07-07 09:36:09 +0100322 - The support for quantized data types has been removed from @ref CLLogSoftmaxLayer due to implementation complexity.
Gian Marco Iodice547b2e72020-08-12 10:25:29 +0100323 - Removed padding requirement for the input (e.g. LHS of GEMM) and output in @ref CLGEMMMatrixMultiplyNativeKernel, @ref CLGEMMMatrixMultiplyReshapedKernel, @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel and @ref CLIm2ColKernel (NHWC only)
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100324 - This change allows to use @ref CLGEMMConvolutionLayer without extra padding for the input and output.
325 - Only the weights/bias of @ref CLGEMMConvolutionLayer could require padding for the computation.
326 - Only on Arm Mali Midgard GPUs, @ref CLGEMMConvolutionLayer could require padding since @ref CLGEMMMatrixMultiplyKernel is called and currently requires padding.
Gian Marco Iodice547b2e72020-08-12 10:25:29 +0100327 - Added support for exporting the OpenCL buffer object to the OpenCL image object in @ref CLGEMMMatrixMultiplyReshapedKernel and @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel.
Sang-Hoon Parkadfaefb2020-08-18 09:13:05 +0100328 - This support allows to export the OpenCL buffer used for the reshaped RHS matrix to the OpenCL image object.
329 - The padding requirement for the OpenCL image object is considered into the @ref CLGEMMReshapeRHSMatrixKernel.
330 - The reshaped RHS matrix stores the weights when GEMM is used to accelerate @ref CLGEMMConvolutionLayer.
Georgios Pinitas25ef7212020-06-02 23:00:41 +0100331
Georgios Pinitasfd7780d2020-03-17 11:41:00 +0000332v20.05 Public major release
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000333 - Various bug fixes.
334 - Various optimisations.
Michele Di Giorgio36a551f2020-04-23 11:55:29 +0100335 - Updated recommended NDK version to r18b.
336 - Updated recommended gcc version to Linaro 6.3.1.
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000337 - Added Bfloat16 type support
338 - Added Bfloat16 support in:
339 - @ref NEWeightsReshapeKernel
340 - @ref NEConvolutionLayerReshapeWeights
341 - @ref NEIm2ColKernel
342 - @ref NEIm2Col
343 - @ref NEDepthConvertLayerKernel
344 - @ref NEDepthConvertLayer
345 - @ref NEGEMMConvolutionLayer
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000346 - @ref NEGEMMAssemblyDispatch
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000347 - Added new data type QASYMM8_SIGNED support for:
348 - @ref CLDirectConvolutionLayer
349 - @ref CLDeconvolutionLayer
350 - @ref CLDirectDeconvolutionLayer
351 - @ref CLGEMMDeconvolutionLayer
352 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
353 - @ref CLGEMMLowpQuantizeDownInt32ScaleKernel
354 - @ref CLGEMMLowpQuantizeDownInt32ScaleByFloatKernel
355 - @ref CLReductionOperation
356 - @ref CLReduceMean
Sheri Zhang359c48e2020-04-30 22:53:39 +0100357 - @ref NEScale
358 - @ref NEScaleKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000359 - @ref NEUpsampleLayer
360 - @ref NECast
361 - @ref NEReductionOperation
362 - @ref NEReduceMean
363 - @ref NEArgMinMaxLayer
364 - @ref NEDeconvolutionLayer
365 - @ref NEGEMMLowpQuantizeDownInt32ScaleKernel
366 - @ref CPPBoxWithNonMaximaSuppressionLimit
367 - @ref CPPDetectionPostProcessLayer
368 - @ref CPPPermuteKernel
369 - @ref CPPPermute
370 - @ref CPPTopKVKernel
371 - @ref CPPTopKV
Sheri Zhang359c48e2020-04-30 22:53:39 +0100372 - @ref CPPUpsample
373 - @ref CPPUpsampleKernel
Sheri Zhang31b49ca2020-04-24 11:15:10 +0100374 - New OpenCL kernels / functions:
375 - @ref CLQLSTMLayer
376 - @ref CLQLSTMLayerNormalizationKernel
377 - New NEON kernels / functions:
378 - @ref NEQLSTMLayer
379 - @ref NEQLSTMLayerNormalizationKernel
380 - Added HARD_SWISH support in:
381 - @ref CLActivationLayerKernel
382 - @ref NEActivationLayerKernel
Sheri Zhang0f2522b2020-03-25 16:38:19 +0000383 - Deprecated OpenCL kernels / functions:
384 - CLGEMMLowpQuantizeDownInt32ToUint8Scale
385 - CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFloat
386 - Deprecated NEON kernels / functions:
387 - NEGEMMLowpQuantizeDownInt32ToUint8Scale
388 - Removed CPP kernels / functions:
389 - CPPFlipWeightsKernel
Manuel Bottini387259a2020-05-21 17:14:36 +0100390 - Removed PoolingLayerInfo constructors without Data Layout.
391 - Removed CLDepthwiseConvolutionLayer3x3
392 - Removed NEDepthwiseConvolutionLayerOptimized
Manuel Bottini075253a2020-05-22 12:57:18 +0100393 - Added support for Winograd 3x3,4x4 on NEON FP16:
394 - @ref NEWinogradConvolutionLayer
395 - @ref NEWinogradLayerTransformInputKernel
396 - @ref NEWinogradLayerTransformOutputKernel
397 - @ref NEWinogradLayerTransformWeightsKernel
398 - Added CLCompileContext
399 - Added NEON GEMM kernel with 2D window support
Georgios Pinitasc7b183a2020-03-06 18:12:09 +0000400
Michele Di Giorgio740872e2020-03-04 15:29:49 +0000401v20.02.1 Maintenance release
402 - Added Android-NN build script.
403
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000404v20.02 Public major release
405 - Various bug fixes.
406 - Various optimisations.
407 - Added new data type QASYMM8_SIGNED support for:
408 - @ref CLDepthwiseConvolutionLayer
Manuel Bottini387259a2020-05-21 17:14:36 +0100409 - CLDepthwiseConvolutionLayer3x3
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000410 - @ref CLGEMMConvolutionLayer
411 - @ref CLGEMMLowpMatrixMultiplyCore
412 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
413 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
414 - @ref NEActivationLayer
415 - @ref NEComparisonOperationKernel
416 - @ref NEConvolutionLayer
417 - @ref NEDepthwiseConvolutionLayer
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100418 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000419 - @ref NEDirectConvolutionLayerOutputStageKernel
420 - @ref NEElementwiseComparison
421 - @ref NEElementwiseMax
422 - @ref NEElementwiseMin
423 - @ref NEElementwiseSquaredDiff
424 - @ref NEFullyConnectedLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +0100425 - NEGEMMMatrixVectorMultiplyKernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000426 - @ref NEPixelWiseMultiplication
427 - @ref NEPoolingLayer
428 - @ref NEPReluLayer
429 - Added support for QSYMM8_PER_CHANNEL in:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100430 - NEDepthwiseConvolutionLayer3x3Kernel
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000431 - Added support for split sizes in:
432 - @ref CLSplit
433 - @ref NESplit
434 - New OpenCL kernels / functions:
435 - @ref CLFill
436 - @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
437 - New NEON kernels / functions:
438 - @ref NEFill
439 - @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToInt8ScaleByFixedPoint
440 - Deprecated NEON functions / interfaces:
Manuel Bottini387259a2020-05-21 17:14:36 +0100441 - CLDepthwiseConvolutionLayer3x3
442 - NEDepthwiseConvolutionLayerOptimized
443 - PoolingLayerInfo constructors without Data Layout.
Giuseppe Rossinif04ddbc2020-02-17 17:22:49 +0000444 - Added support for quantization with multiplier greater than 1 on NEON and CL.
445 - Added support for quantized inputs of type QASYMM8_SIGNED and QASYMM8 to @ref CLQuantizationLayer.
446 - Added the ability to build bootcode for bare metal.
447 - Added support for generating synthetic QASYMM8 graphs.
448 - Added support for F16 datatype in VGG16.
449 - Removed pre-built binaries for GLES.
450
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000451v19.11.1 Public maintenance release
452 - Fix offset calculation in NEReductionOperationKernel.
453 - Fix data layout in NEScaleKernel for nhwc.
454 - Retain configuration step data layout to avoid side-effects.
455 - Perform sqrt in double domain for L2 pooling.
456 - Fix output shape calculation for Reduce Mean
457 - Restrict cases where optimized NEPadLayer runs.
458
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100459v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000460 - Various bug fixes.
461 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000462 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000463 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100464 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
465 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000466 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100467 - CLDepthwiseVectorToTensorKernel
468 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000469 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100470 - NEDepthwiseWeightsReshapeKernel
471 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000472 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100473 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100474 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000475 - New OpenCL kernels / functions:
476 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
477 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
478 OpenCL kernels / functions)
479 - @ref CLLogSoftmaxLayer
480 - New NEON kernels / functions:
481 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
482 - @ref NEComputeAllAnchorsKernel / @ref NEComputeAllAnchors
483 - @ref NEDetectionPostProcessLayer
484 - @ref NEGenerateProposalsLayer
485 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
486 - @ref NELogSoftmaxLayer
487 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
488 - Added QASYMM8 support for:
489 - @ref CLGenerateProposalsLayer
490 - @ref CLROIAlignLayer
491 - @ref CPPBoxWithNonMaximaSuppressionLimit
492 - Added QASYMM16 support for:
493 - @ref CLBoundingBoxTransform
494 - Added FP16 support for:
495 - @ref CLGEMMMatrixMultiplyReshapedKernel
496 - Added new data type QASYMM8_PER_CHANNEL support for:
497 - @ref CLDequantizationLayer
498 - @ref NEDequantizationLayer
499 - Added new data type QSYMM8_PER_CHANNEL support for:
500 - @ref CLConvolutionLayer
501 - @ref NEConvolutionLayer
502 - @ref CLDepthwiseConvolutionLayer
503 - @ref NEDepthwiseConvolutionLayer
504 - Added FP16 mixed-precision support for:
505 - @ref CLGEMMMatrixMultiplyReshapedKernel
506 - @ref CLPoolingLayerKernel
507 - Added FP32 and FP16 ELU activation for:
508 - @ref CLActivationLayer
509 - @ref NEActivationLayer
510 - Added asymmetric padding support for:
511 - @ref CLDirectDeconvolutionLayer
512 - @ref CLGEMMDeconvolutionLayer
513 - @ref NEDeconvolutionLayer
514 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
515 - Replaced the calls to @ref NECopyKernel and @ref NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
516 - Replaced the calls to @ref CLCopyKernel and @ref CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
517 - Improved performance for CL Inception V3 - FP16.
518 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
519 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
520 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
521 - Optimized @ref CLPadLayer.
522 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
523 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100524
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000525v19.08.1 Public maintenance release
526 - Fix offset calculation in NEReductionOperationKernel.
527 - Fix data layout in NEScaleKernel for nhwc.
528 - Retain configuration step data layout to avoid side-effects.
529 - Perform sqrt in double domain for L2 pooling.
530 - Fix output shape calculation for Reduce Mean
531 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
532
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100533v19.08 Public major release
534 - Various bug fixes.
535 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100536 - Deprecated NEON functions
537 - NEDepthConcatenateLayer
538 - NEWidthConcatenateLayer
539 - Deprecated OpenCL kernels / functions
540 - CLDepthConcatenateLayer
541 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
542 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
543 - CLWidthConcatenateLayer
544 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100545 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100546 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100547 - @ref NEElementwisePower
548 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100549 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100550 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100551 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100552 - @ref NESinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100553 - @ref NEBatchConcatenateLayerKernel
554 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
555 - @ref NEDepthwiseConvolutionLayerNativeKernel
556 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
557 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
558 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
559 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100560 - @ref CLAbsLayer
561 - @ref CLElementwisePower
562 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100563 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100564 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100565 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100566 - @ref CLSinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100567 - @ref CLBatchConcatenateLayerKernel
568 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
569 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
570 - @ref CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
571 - @ref CLGEMMMatrixMultiplyNativeKernel
572 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
573 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
574 - New examples:
575 - neon_opticalflow
576 - cl_cache
577 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100578 - Added support for FP16 in @ref NEDeconvolutionLayer
579 - Added support for FP16 in @ref CLDeconvolutionLayer
580 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100581 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
582 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
583 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
584 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
585 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
586 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini387259a2020-05-21 17:14:36 +0100587 - The CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
588 - The NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100589 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
590 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100591 - 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 +0100592
Michalis Spyroua9c44722019-04-05 17:18:36 +0100593v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100594 - Various bug fixes.
595 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100596 - New Neon kernels / functions:
597 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100598 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100599 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100600 - @ref NEDepthwiseConvolutionAssemblyDispatch
601 - @ref NEFFTDigitReverseKernel
602 - @ref NEFFTRadixStageKernel
603 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100604 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
605 - @ref NEHeightConcatenateLayerKernel
606 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100607 - @ref NEFFT1D
608 - @ref NEFFT2D
609 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100610 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100611 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100612 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100613 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100614 - @ref CLFFTDigitReverseKernel
615 - @ref CLFFTRadixStageKernel
616 - @ref CLFFTScaleKernel
617 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
618 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
619 - @ref CLHeightConcatenateLayerKernel
620 - @ref CLDirectDeconvolutionLayer
621 - @ref CLFFT1D
622 - @ref CLFFT2D
623 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100624 - @ref CLGEMMDeconvolutionLayer
625 - New OpenGLES kernels / functions:
626 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100627 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100628 - GCDepthConcatenateLayer
629 - NEWidthConcatenateLayer
630 - NEDepthConcatenateLayer
631 - CLWidthConcatenateLayer
632 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100633 - CLGEMMInterleave4x4
634 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100635 - Support different quantization info in CLConcatLayer.
636 - Add checks on different input/output quantization info were not supported.
637 - Tensors have different quantization information.
638 - Add FP16 support checks.
639 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
640 - New graph examples:
641 - graph_convolution
642 - graph_fully_connected
643 - graph_depthwise_convolution
644 - Deepspeech v0.4.1
645 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
646 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
647 - Add support for QASYMM8 NEDeconvolution.
648 - Add support for DequantizationLayer for NEON/CL.
649 - Add support for dilation in CLDepthwiseConvolution.
650 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
651 - Optimize CLDeconvolution.
652 - Add StackLayer to the graph API.
653 - Add support for "reflect" padding mode in NEPad.
654 - Winograd 7x7 NHWC on OpenCL.
655 - Rework CL ML layers to run exclusively on CL.
656 - Support different quantization info in PoolingLayer.
657 - Implement and test import memory interfaces.
658 - Added new tests and removed old ones.
659 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100660
giuros01a69a88b2019-01-31 16:29:19 +0000661v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000662 - Various bug fixes.
663 - Various optimisations.
664 - New Neon kernels / functions:
665 - @ref NETileKernel / @ref NETile
666 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
667 - @ref NEElementwiseOperationKernel
668 - @ref NEElementwiseMax
669 - @ref NEElementwiseMin
670 - @ref NEElementwiseSquaredDiff
671 - @ref NESelectKernel / @ref NESelect
672 - @ref NESplit
673 - @ref NESlice
674 - @ref NEUnstack
675 - @ref NEStridedSliceKernel / @ref NEStridedSlice
676 - @ref NEElementwiseUnaryKernel
677 - @ref NERsqrtLayer
678 - @ref NEExpLayer
679 - @ref NEReverseKernel / @ref NEReverse
680 - @ref NEArgMinMaxLayer
681 - @ref NEStackLayerKernel / @ref NEStackLayer
682 - @ref NERangeKernel / @ref NERange
683 - @ref NEPadLayer
684 - @ref NEMemsetKernel
685 - @ref NEGatherKernel / @ref NEGather
686 - @ref NEElementwiseComparison
687 - @ref NEElementwiseComparisonStatic
688 - @ref NEComparisonOperationKernel
689 - @ref NEElementwiseDivision
690 - New OpenCL kernels / functions:
691 - @ref CLSelectKernel / @ref CLSelect
692 - @ref CLTileKernel / @ref CLTile
693 - @ref CLComparisonKernel / @ref CLComparison
694 - @ref CLArgMinMaxLayer
695 - @ref CLElementwiseMax
696 - @ref CLElementwiseMin
697 - @ref CLElementwiseSquaredDiff
698 - @ref CLStackLayerKernel / @ref CLStackLayer
699 - @ref CLReverse / @ref CLReverseKernel
700 - @ref CLRsqrtLayer
701 - @ref CLExpLayer
702 - @ref CLElementWiseUnaryLayerKernel
703 - @ref CLGEMMReshapeLHSMatrixKernel
704 - @ref CLGEMMReshapeRHSMatrixKernel
705 - @ref CLGEMMMatrixMultiplyReshapedKernel
706 - @ref CLRangeKernel / @ref CLRange
707 - @ref CLUnstack
708 - @ref CLGatherKernel / @ref CLGather
709 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
710 - New CPP kernels / functions:
711 - @ref CPPDetectionOutputLayer
712 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000713 - Added new examples:
714 - graph_ssd_mobilenet.cpp
715 - graph_mobilenet_v2.cpp
716 - graph_resnet12.cpp
717 - graph_srcnn955.cpp
718 - graph_vgg_vdsr.cpp
719 - graph_inception_resnet_v1.cpp
720 - Add 4D tensors support to
721 - @ref NESoftmaxLayer
722 - Fused activation in @ref CLWinogradConvolutionLayer
723 - Extented @ref NEPermute to support more cases
724 - Added NEON/SVE GEMM Hybrid kernels
725 - Added u8 and s8 hybrid assembly kernels
726 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
727 - Improved @ref CLTuner
728 - Fused the bias addition within @ref CLGEMM
729 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
730 - Added NHWC data layout support to:
731 - @ref NEScale for F16
732 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
733 - @ref NEL2NormalizeLayer for FP32/FP16
734 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
735 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000736 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000737 - Added QASYMM8 support to the following kernels:
738 - @ref NEArithmeticAdditionKernel
739 - @ref NEScale
740 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000741 - Deprecated functions/interfaces
742 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
743
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000744v18.11 Public major release
745 - Various bug fixes.
746 - Various optimisations.
747 - New Neon kernels / functions:
748 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
749 - @ref NEReduceMean
750 - @ref NEReorgLayer / @ref NEReorgLayerKernel
751 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
752 - @ref NEUpsampleLayer / @ref NEUpsampleLayerKernel
753 - @ref NEYOLOLayer / @ref NEYOLOLayerKernel
754 - New OpenCL kernels / functions:
755 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
756 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000757 - @ref CLComputeAllAnchorsKernel
758 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000759 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
760 - @ref CLReorgLayer / @ref CLReorgLayerKernel
761 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
762 - @ref CLPadLayer
763 - @ref CLReduceMean
764 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
765 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
766 - @ref CLSlice
767 - @ref CLSplit
768 - @ref CLStridedSlice / @ref CLStridedSliceKernel
769 - @ref CLUpsampleLayer / @ref CLUpsampleLayerKernel
770 - @ref CLYOLOLayer / @ref CLYOLOLayerKernel
771 - New CPP kernels / functions:
772 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
773 - Added the validate method in:
774 - @ref NEDepthConvertLayer
775 - @ref NEFloor / @ref CLFloor
776 - @ref NEGEMMMatrixAdditionKernel
777 - @ref NEReshapeLayer / @ref CLReshapeLayer
778 - @ref CLScale
779 - Added new examples:
780 - graph_shufflenet.cpp
781 - graph_yolov3.cpp
782 - Added documentation for add a new function or kernel.
783 - Improved doxygen documentation adding a list of the existing functions.
784 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100785 - CLWidthConcatenateLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000786 - @ref CLFlattenLayer
787 - @ref CLSoftmaxLayer
788 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
789 - Add SVE support
790 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
791 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
792 - Added NHWC data layout support to:
793 - @ref CLChannelShuffleLayer
794 - @ref CLDeconvolutionLayer
795 - @ref CLL2NormalizeLayer
796 - Added QASYMM8 support to the following kernels:
797 - @ref CLScaleKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100798 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000799 - @ref CLPixelWiseMultiplicationKernel
800 - Added FP16 support to the following kernels:
801 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100802 - NEDepthwiseConvolutionLayer3x3Kernel
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000803 - @ref CLNormalizePlanarYUVLayerKernel
804 - @ref CLWinogradConvolutionLayer (5x5 kernel)
805 - More tests added to both validation and benchmarking suites.
806
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100807v18.08 Public major release
808 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100809 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100810 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100811 - Removed support for QS8/QS16 data types.
812 - Added support for grouped convolution in @ref CLConvolutionLayer.
813 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100814 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100815 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
816 - @ref CLDepthwiseConvolutionLayer
817 - @ref CLDirectConvolutionLayer
818 - @ref CLConvolutionLayer
819 - @ref CLScale
820 - @ref CLIm2ColKernel
821 - New Neon kernels / functions:
822 - @ref NERNNLayer
823 - New OpenCL kernels / functions:
824 - @ref CLArithmeticDivision
825 - Introduced prepare() stage support in the graph API for GLES.
826 - Added support for memory reusage when trying to allocate smaller CLTensors.
827 - Enabled NHWC execution on graph examples.
828 - Added JPEG accessor for validation purposes.
829 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100830
831v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100832 - Various bug fixes.
833 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000834 - Major redesign in the interface for the neon kernels implemented in assembly.
835 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
836 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
837 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100838 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
839 - Improved doxygen documentation.
840 - Improved memory management for layer's transitions.
841 - Added support for NHWC data layout in tensors.
842 - Added NHWC data layout support to:
843 - @ref NEGEMMConvolutionLayer
844 - @ref NEDirectConvolutionLayer
845 - @ref NEPoolingLayer / @ref CLPoolingLayer
846 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
847 - @ref NEDepthwiseConvolutionLayer
848 - @ref NEScale
849 - @ref NEIm2Col
850 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
851 - New OpenCL kernels / functions:
852 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
853 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
854 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100855 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100856 - @ref CLRNNLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100857 - CLWidthConcatenateLayer / @ref CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100858 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
859 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
860 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100861 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
862 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
863 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
864 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
865 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
866 - Port mobilenet example to NHWC data layout.
867 - Enabled Winograd method in @ref CLConvolutionLayer.
868 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
869 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
870 - Added memory manager support in GLES functions.
871 - Major refactoring of the graph API.
872 - Added GLES backend in the graph API.
873 - Added support for the memory manager in the graph API.
874 - Enabled Winograd Convolution method in the graph API.
875 - Added support for grouped convolutions in the graph API.
876 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
877 - Added fast maths flag in @ref CLConvolutionLayer.
878 - Added new tests and benchmarks in validation and benchmark frameworks
879 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
880 - Added support to OpenCL 2.0 SVM
881 - Added support to import memory in OpenCL tensors.
882 - Added the prepare() method to perform any one off pre-processing before running the function.
883 - Added new examples:
884 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100885 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100886 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000887
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000888v18.03 Public maintenance release
889 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +0000890 - Fixed bug in @ref NEActivationLayer
891 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000892 - Updated recommended NDK version to r16b (And fixed warnings).
893 - Fixed bug in validation code.
894 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100895 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000896
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000897v18.02 Public major release
898 - Various NEON / OpenCL / GLES optimisations.
899 - Various bug fixes.
900 - Changed default number of threads on big LITTLE systems.
901 - Refactored examples and added:
902 - graph_mobilenet_qassym8
903 - graph_resnet
904 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +0000905 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
906 - 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 +0000907 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000908 - @ref CLActivationLayer
909 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000910 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000911 - @ref CLActivationLayer
912 - @ref CLDepthwiseConvolutionLayer
913 - @ref NEDepthwiseConvolutionLayer
914 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000915 - Added FP16 support to:
Manuel Bottini387259a2020-05-21 17:14:36 +0100916 - CLDepthwiseConvolutionLayer3x3
Anthony Barbier3762e742018-03-02 11:49:33 +0000917 - @ref CLDepthwiseConvolutionLayer
918 - Added broadcasting support to @ref NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
919 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
920 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000921 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100922 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +0000923 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000924 - Added name() method to all kernels.
925 - Added support for Winograd 5x5.
Anthony Barbier3762e742018-03-02 11:49:33 +0000926 - @ref NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100927 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
928 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
929 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +0100930 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000931 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000932 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +0000933
Anthony Barbier64c95a02018-01-22 18:48:55 +0000934v18.01 Public maintenance release
935 - Various bug fixes
936 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +0000937 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
938 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +0000939 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +0000940 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
941 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
942 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
943 - Added @ref GCScaleKernel / @ref GCScale
944 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +0000945 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000946 - @ref GCCol2ImKernel
947 - @ref GCGEMMInterleave4x4Kernel
948 - @ref GCGEMMTranspose1xWKernel
949 - @ref GCIm2ColKernel
950 - Refactored NEON Winograd (NEWinogradLayerKernel)
951 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000952 - Added QASYMM8 support to the following NEON kernels:
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100953 - NEDepthwiseConvolutionLayer3x3Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000954 - @ref NEFillBorderKernel
955 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000956 - Added new examples:
957 - graph_cl_mobilenet_qasymm8.cpp
958 - graph_inception_v3.cpp
959 - gc_dc.cpp
960 - More tests added to both validation and benchmarking suites.
961
Gian Marcoff850932017-12-11 12:37:17 +0000962v17.12 Public major release
963 - Most machine learning functions on OpenCL support the new data type QASYMM8
964 - Introduced logging interface
965 - Introduced opencl timer
966 - Reworked GEMMLowp interface
967 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
968 - Added validation method for most Machine Learning kernels / functions
969 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
970 - Added sgemm example for OpenCL
971 - Added absolute difference example for GLES compute
972 - Added new tests and benchmarks in validation and benchmark frameworks
973 - Added new kernels / functions for GLES compute
974
975 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000976 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
977 - @ref GCActivationLayerKernel / @ref GCActivationLayer
978 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
979 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +0100980 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000981 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
982 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
983 - @ref GCFillBorderKernel / @ref GCFillBorder
984 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
985 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
986 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
987 - @ref GCIm2ColKernel
988 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
989 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
990 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
991 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
992 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +0000993
994 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +0000995 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
996 - arm_compute::NEHGEMMAArch64FP16Kernel
Georgios Pinitas7d0adc62020-09-04 15:25:24 +0100997 - NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000998 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
999 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Georgios Pinitas9fb11592018-04-26 20:34:58 +01001000 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +00001001
1002 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +00001003 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
1004 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
Gian Marcoff850932017-12-11 12:37:17 +00001005
1006 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001007 - graph::BranchLayer
1008 - graph::DepthConvertLayer
1009 - graph::DepthwiseConvolutionLayer
1010 - graph::DequantizationLayer
1011 - graph::FlattenLayer
1012 - graph::QuantizationLayer
1013 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +00001014
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001015v17.10 Public maintenance release
1016 - Bug fixes:
1017 - Check the maximum local workgroup size supported by OpenCL devices
1018 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +00001019 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +01001020 - Added a few new Graph nodes, support for branches and grouping.
1021 - Automatically enable cl_printf in debug builds
1022 - Fixed bare metal builds for armv7a
1023 - Added AlexNet and cartoon effect examples
1024 - 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)
1025
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001026v17.09 Public major release
1027 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +00001028 - 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 +01001029 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
1030 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
1031 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +00001032 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001033 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
1034 - @ref NEFloorKernel / @ref NEFloor
1035 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
1036 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
1037 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
1038 - @ref NEReductionOperationKernel / @ref NEReductionOperation
1039 - @ref NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001040
1041 - New OpenCL kernels / functions:
Manuel Bottini387259a2020-05-21 17:14:36 +01001042 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001043 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
1044 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
1045 - @ref CLFlattenLayer
1046 - @ref CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001047 - CLGEMMTranspose1xW
Anthony Barbier3762e742018-03-02 11:49:33 +00001048 - @ref CLGEMMMatrixVectorMultiplyKernel
1049 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
1050 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
1051 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
1052 - @ref CLReductionOperationKernel / @ref CLReductionOperation
1053 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001054
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001055v17.06 Public major release
1056 - Various bug fixes
1057 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
1058 - Added unit tests and benchmarks (AlexNet, LeNet)
1059 - Added support for sub tensors.
1060 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +00001061 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
1062 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
1063 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001064 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001065 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +01001066 - @ref CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001067 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
1068 - @ref CLLocallyConnectedMatrixMultiplyKernel / @ref CLLocallyConnectedLayer
1069 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001070 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +00001071 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001072 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001073 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +01001074 - @ref NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001075 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
1076 - @ref NELocallyConnectedMatrixMultiplyKernel / @ref NELocallyConnectedLayer
1077 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001078
1079v17.05 Public bug fixes release
1080 - Various bug fixes
1081 - Remaining of the functions ported to use accurate padding.
1082 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
1083 - Added "free" method to allocator.
1084 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
1085
1086v17.04 Public bug fixes release
1087
1088 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +00001089 - @ref CLColorConvertKernel
1090 - @ref CLEdgeNonMaxSuppressionKernel
1091 - @ref CLEdgeTraceKernel
1092 - @ref CLGaussianPyramidHorKernel
1093 - @ref CLGaussianPyramidVertKernel
1094 - @ref CLGradientKernel
1095 - @ref NEChannelCombineKernel
1096 - @ref NEFillArrayKernel
1097 - @ref NEGaussianPyramidHorKernel
1098 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +01001099 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +00001100 - @ref NEHarrisScoreKernel
1101 - @ref NEHOGDetectorKernel
1102 - @ref NELogits1DMaxKernel
1103 - NELogits1DShiftExpSumKernel
1104 - NELogits1DNormKernel
1105 - @ref NENonMaximaSuppression3x3FP16Kernel
1106 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001107
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001108v17.03.1 First Major public release of the sources
1109 - Renamed the library to arm_compute
1110 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
1111 - New padding calculation interface introduced and ported most kernels / functions to use it.
1112 - New OpenCL kernels / functions:
Gian Marco Iodiceeb65f6d2020-04-15 11:42:15 +01001113 - CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001114 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001115 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
1116 - @ref NETransposeKernel / @ref NETranspose
1117 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
1118 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
Michele Di Giorgiof22f6722020-07-03 16:29:24 +01001119 - NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001120 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001121
1122v17.03 Sources preview
1123 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001124 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +01001125 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001126 - CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001127 - @ref CLTransposeKernel / @ref CLTranspose
1128 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
1129 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
1130 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001131 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001132 - @ref NEActivationLayerKernel / @ref NEActivationLayer
1133 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
1134 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001135
1136v17.02.1 Sources preview
1137 - New OpenCL kernels / functions:
Michele Di Giorgiof6f78762020-07-06 11:27:21 +01001138 - CLLogits1DMaxKernel, CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
Anthony Barbier3762e742018-03-02 11:49:33 +00001139 - @ref CLPoolingLayerKernel / @ref CLPoolingLayer
1140 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
1141 - @ref CLRemapKernel / @ref CLRemap
1142 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
1143 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
1144 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001145 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +00001146 - @ref NEAccumulateWeightedFP16Kernel
1147 - @ref NEBox3x3FP16Kernel
1148 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001149
1150v17.02 Sources preview
1151 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001152 - @ref CLActivationLayerKernel / @ref CLActivationLayer
1153 - @ref CLChannelCombineKernel / @ref CLChannelCombine
1154 - @ref CLDerivativeKernel / @ref CLChannelExtract
1155 - @ref CLFastCornersKernel / @ref CLFastCorners
1156 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001157 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +00001158 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
1159 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001160 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
1161 - Switched all the kernels / functions to use tensors instead of images.
1162 - Updated documentation to include instructions to build the library from sources.
1163
1164v16.12 Binary preview release
1165 - Original release
1166
1167@section S3_how_to_build How to build the library and the examples
1168
1169@subsection S3_1_build_options Build options
1170
1171scons 2.3 or above is required to build the library.
1172To see the build options available simply run ```scons -h```:
1173
Anthony Barbier79c61782017-06-23 11:48:24 +01001174 debug: Debug (yes|no)
1175 default: False
1176 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001177
Anthony Barbier79c61782017-06-23 11:48:24 +01001178 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
1179 default: False
1180 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001181
Anthony Barbier79c61782017-06-23 11:48:24 +01001182 arch: Target Architecture (armv7a|arm64-v8a|arm64-v8.2-a|x86_32|x86_64)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001183 default: armv7a
1184 actual: armv7a
1185
Anthony Barbier79c61782017-06-23 11:48:24 +01001186 os: Target OS (linux|android|bare_metal)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001187 default: linux
1188 actual: linux
1189
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001190 build: Build type (native|cross_compile|embed_only)
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001191 default: cross_compile
1192 actual: cross_compile
1193
Anthony Barbier79c61782017-06-23 11:48:24 +01001194 examples: Build example programs (yes|no)
1195 default: True
1196 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001197
Anthony Barbier79c61782017-06-23 11:48:24 +01001198 Werror: Enable/disable the -Werror compilation flag (yes|no)
1199 default: True
1200 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001201
Anthony Barbier79c61782017-06-23 11:48:24 +01001202 opencl: Enable OpenCL support (yes|no)
1203 default: True
1204 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001205
Anthony Barbier79c61782017-06-23 11:48:24 +01001206 neon: Enable Neon support (yes|no)
1207 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001208 actual: False
1209
Anthony Barbier20dbb822017-12-13 21:19:39 +00001210 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1211 default: False
1212 actual: False
1213
1214 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shader in library binary (yes|no)
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001215 default: True
1216 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001217
1218 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1219 default: False
1220 actual: False
1221
1222 openmp: Enable OpenMP backend (yes|no)
1223 default: False
1224 actual: False
1225
1226 cppthreads: Enable C++11 threads backend (yes|no)
1227 default: True
1228 actual: True
1229
1230 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1231 default: .
1232 actual: .
1233
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001234 extra_cxx_flags: Extra CXX flags to be appended to the build command
1235 default:
1236 actual:
1237
Anthony Barbier79c61782017-06-23 11:48:24 +01001238 pmu: Enable PMU counters (yes|no)
1239 default: False
1240 actual: False
1241
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001242 mali: Enable Mali hardware counters (yes|no)
1243 default: False
1244 actual: False
1245
Anthony Barbier79c61782017-06-23 11:48:24 +01001246 validation_tests: Build validation test programs (yes|no)
1247 default: False
1248 actual: False
1249
1250 benchmark_tests: Build benchmark test programs (yes|no)
1251 default: False
1252 actual: False
1253
1254@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001255 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1256 - 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)
1257 - 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).
1258
Anthony Barbier79c61782017-06-23 11:48:24 +01001259@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 +01001260
Anthony Barbier79c61782017-06-23 11:48:24 +01001261@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001262@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1263
Anthony Barbier79c61782017-06-23 11:48:24 +01001264@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 +01001265
Anthony Barbier79c61782017-06-23 11:48:24 +01001266@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 +01001267
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001268There 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.
1269
Anthony Barbier79c61782017-06-23 11:48:24 +01001270@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 +01001271
Anthony Barbier20dbb822017-12-13 21:19:39 +00001272@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 +01001273
Anthony Barbier20dbb822017-12-13 21:19:39 +00001274@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 +01001275
1276@b set_soname: Do you want to build the versioned version of the library ?
1277
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001278If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1279Example:
1280 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1281 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1282 libarm_compute_core.so.1.0.0
1283
1284@note This options is disabled by default as it requires SCons version 2.4 or above.
1285
Anthony Barbier79c61782017-06-23 11:48:24 +01001286@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1287
1288@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1289
1290@b examples: Build or not the examples
1291
1292@b validation_tests: Enable the build of the validation suite.
1293
Anthony Barbier79c61782017-06-23 11:48:24 +01001294@b benchmark_tests: Enable the build of the benchmark tests
1295
1296@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1297
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001298@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)
1299
Anthony Barbier79c61782017-06-23 11:48:24 +01001300@b openmp Build in the OpenMP scheduler for NEON.
1301
1302@note Only works when building with g++ not clang++
1303
1304@b cppthreads Build in the C++11 scheduler for NEON.
1305
Anthony Barbier3762e742018-03-02 11:49:33 +00001306@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001307
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001308@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001309
1310@subsubsection S3_2_1_library How to build the library ?
1311
1312For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1313
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001314 - gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
1315 - gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001316
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001317To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1318
1319 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1320
1321To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1322
1323 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1324
Anthony Barbier20dbb822017-12-13 21:19:39 +00001325To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1326
1327 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1328
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001329You can also compile the library natively on an ARM device by using <b>build=native</b>:
1330
1331 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1332 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1333
1334@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.
1335
1336For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1337
1338 apt-get install g++-arm-linux-gnueabihf
1339
1340Then run
1341
1342 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1343
1344or simply remove the build parameter as build=cross_compile is the default value:
1345
1346 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1347
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001348@subsubsection S3_2_2_examples How to manually build the examples ?
1349
1350The 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.
1351
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001352@note The following command lines assume the arm_compute libraries 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 libraries 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 +01001353
1354To cross compile a NEON example for Linux 32bit:
1355
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001356 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 +01001357
1358To cross compile a NEON example for Linux 64bit:
1359
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001360 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 +01001361
1362(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)
1363
1364To cross compile an OpenCL example for Linux 32bit:
1365
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001366 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 +01001367
1368To cross compile an OpenCL example for Linux 64bit:
1369
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001370 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 +01001371
Anthony Barbier14c86a92017-12-14 16:27:41 +00001372To cross compile a GLES example for Linux 32bit:
1373
1374 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
1375
1376To cross compile a GLES example for Linux 64bit:
1377
1378 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
1379
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001380(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)
1381
Anthony Barbier14c86a92017-12-14 16:27:41 +00001382To 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.
1383
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001384i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1385
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001386 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 +01001387
1388i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1389
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001390 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 +01001391
1392(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)
1393
Anthony Barbiere5007472017-10-27 15:01:44 +01001394@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1395
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001396To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1397
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001398 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 +01001399
1400To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1401
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001402 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 +01001403
1404(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1405
1406To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1407
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001408 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 +01001409
Anthony Barbier14c86a92017-12-14 16:27:41 +00001410To 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 +01001411
Anthony Barbier14c86a92017-12-14 16:27:41 +00001412 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
1413
1414To 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 +00001415
1416i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001417
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001418 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 +01001419
Anthony Barbier14c86a92017-12-14 16:27:41 +00001420i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001421
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001422 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 +01001423
1424(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 +01001425
Anthony Barbiere5007472017-10-27 15:01:44 +01001426@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1427
Gian Marco Iodicef94c6742020-06-26 12:35:09 +01001428@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 +00001429@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 +01001430
1431To run the built executable simply run:
1432
1433 LD_LIBRARY_PATH=build ./neon_convolution
1434
1435or
1436
1437 LD_LIBRARY_PATH=build ./cl_convolution
1438
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001439@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 +00001440
1441For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001442
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001443 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001444
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001445Below is a list of the common parameters among the graph examples :
1446@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001447
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001448@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001449
1450For Android, the library was successfully built and tested using Google's standalone toolchains:
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001451 - clang++ from NDK r18b for armv7a
1452 - clang++ from NDK r18b for arm64-v8a
1453 - clang++ from NDK r18b for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001454
1455Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1456
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001457- Download the NDK r18b from here: https://developer.android.com/ndk/downloads/index.html to directory $NDK
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001458- Make sure you have Python 2.7 installed on your machine.
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001459- Generate the 32 and/or 64 toolchains by running the following commands to your toolchain dirctory $MY_TOOLCHAINS:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001460
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001461
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001462 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r18b --stl libc++ --api 21
1463 $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 +01001464
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001465@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 +01001466
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001467@note Make sure to add the toolchains to your PATH:
1468
Michele Di Giorgio36a551f2020-04-23 11:55:29 +01001469 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 +01001470
1471@subsubsection S3_3_1_library How to build the library ?
1472
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001473To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1474
1475 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1476
1477To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1478
Anthony Barbier14c86a92017-12-14 16:27:41 +00001479 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 +01001480
Anthony Barbier20dbb822017-12-13 21:19:39 +00001481To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1482
Anthony Barbier14c86a92017-12-14 16:27:41 +00001483 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 +00001484
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001485@subsubsection S3_3_2_examples How to manually build the examples ?
1486
1487The 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.
1488
Sheri Zhang7a7f4e02020-08-28 20:08:49 +01001489@note The following command lines assume the arm_compute libraries 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 libraries 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 +01001490
1491Once you've got your Android standalone toolchain built and added to your path you can do the following:
1492
1493To cross compile a NEON example:
1494
1495 #32 bit:
Georgios Pinitas9873ea32017-12-05 15:28:55 +00001496 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 +01001497 #64 bit:
Anthony Barbier14c86a92017-12-14 16:27:41 +00001498 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 +01001499
1500To cross compile an OpenCL example:
1501
1502 #32 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001503 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 +01001504 #64 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001505 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 +00001506
1507To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001508
Anthony Barbier14c86a92017-12-14 16:27:41 +00001509 #32 bit:
1510 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
1511 #64 bit:
1512 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 +01001513
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001514To 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 +01001515
1516 #32 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001517 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 +01001518 #64 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001519 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 +01001520
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001521@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 +00001522@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 +01001523
1524Then you need to do is upload the executable and the shared library to the device using ADB:
1525
1526 adb push neon_convolution_arm /data/local/tmp/
1527 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001528 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001529 adb shell chmod 777 -R /data/local/tmp/
1530
1531And finally to run the example:
1532
1533 adb shell /data/local/tmp/neon_convolution_arm
1534 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001535 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001536
1537For 64bit:
1538
1539 adb push neon_convolution_aarch64 /data/local/tmp/
1540 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001541 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001542 adb shell chmod 777 -R /data/local/tmp/
1543
1544And finally to run the example:
1545
1546 adb shell /data/local/tmp/neon_convolution_aarch64
1547 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001548 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001549
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001550@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 +00001551
1552For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001553 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001554
1555In 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.
1556
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001557@subsection S3_4_bare_metal Building for bare metal
1558
Georgios Pinitas58216322020-02-26 11:13:13 +00001559For 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 +01001560 - arm-eabi for armv7a
1561 - aarch64-elf for arm64-v8a
1562
1563Download 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>.
1564
1565@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
1566
1567@subsubsection S3_4_1_library How to build the library ?
1568
1569To cross-compile the library with NEON support for baremetal arm64-v8a:
1570
1571 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
1572
1573@subsubsection S3_4_2_examples How to manually build the examples ?
1574
1575Examples 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>.
1576
1577@subsection S3_5_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001578
1579Using `scons` directly from the Windows command line is known to cause
1580problems. The reason seems to be that if `scons` is setup for cross-compilation
1581it gets confused about Windows style paths (using backslashes). Thus it is
1582recommended to follow one of the options outlined below.
1583
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001584@subsubsection S3_5_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001585
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001586The best and easiest option is to use
1587<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001588This feature is still marked as *beta* and thus might not be available.
1589However, if it is building the library is as simple as opening a *Bash on
1590Ubuntu on Windows* shell and following the general guidelines given above.
1591
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001592@subsubsection S3_5_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001593
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001594If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001595can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1596to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001597also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001598code of the library.) Linaro provides pre-built versions of
1599<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001600that can be used from the Cygwin terminal. When building for Android the
1601compiler is included in the Android standalone toolchain. After everything has
1602been set up in the Cygwin terminal the general guide on building the library
1603can be followed.
1604
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001605@subsection S3_6_cl_requirements OpenCL DDK Requirements
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001606
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001607@subsubsection S3_6_1_cl_hard_requirements Hard Requirements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001608
1609Compute 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).
1610
1611Enabling 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.
1612
1613Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1614
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001615@subsubsection S3_6_2_cl_performance_requirements Performance improvements
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001616
1617Integer 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.
1618
1619OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1620
1621SVM 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 +01001622
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001623@subsection S3_7_cl_tuner OpenCL Tuner
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001624
1625The 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).
1626The 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 +01001627The 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 +01001628In 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.
1629
1630If 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:
1631
1632https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1633
1634Tuning 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.
1635
1636CLTuner 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.
1637
1638 #Example: 2 unique Matrix Multiply configurations
1639@code{.cpp}
1640 TensorShape a0 = TensorShape(32,32);
1641 TensorShape b0 = TensorShape(32,32);
1642 TensorShape c0 = TensorShape(32,32);
1643 TensorShape a1 = TensorShape(64,64);
1644 TensorShape b1 = TensorShape(64,64);
1645 TensorShape c1 = TensorShape(64,64);
1646
1647 Tensor a0_tensor;
1648 Tensor b0_tensor;
1649 Tensor c0_tensor;
1650 Tensor a1_tensor;
1651 Tensor b1_tensor;
1652 Tensor c1_tensor;
1653
1654 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1655 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1656 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1657 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1658 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1659 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1660
1661 CLGEMM gemm0;
1662 CLGEMM gemm1;
1663
1664 // Configuration 0
1665 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1666
1667 // Configuration 1
1668 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1669@endcode
1670
Georgios Pinitasfd7780d2020-03-17 11:41:00 +00001671@subsubsection S3_7_1_cl_tuner_how_to How to use it
Gian Marco Iodice201cea12018-07-30 17:21:41 +01001672
1673All 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
1674
1675 #Enable CL tuner
1676 ./graph_mobilenet --enable-tuner –-target=CL
1677 ./arm_compute_benchmark --enable-tuner
1678
1679 #Export/Import to/from a file
1680 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1681 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1682
1683If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1684
1685Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1686
1687 -# Disable the power management
1688 -# Keep the GPU frequency constant
1689 -# Run multiple times the network (i.e. 10).
1690
1691If 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.
1692
1693@code{.cpp}
1694CLTuner tuner;
1695
1696// Setup Scheduler
1697CLScheduler::get().default_init(&tuner);
1698@endcode
1699
1700After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1701- tuner.save_to_file("results.csv");
1702
1703This file can be also imported using the method "load_from_file("results.csv")".
1704- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001705*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001706} // namespace arm_compute