blob: e85d2b2efb32d12f8b171bf0427c00b3c5240fc8 [file] [log] [blame]
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00001///
SiCong Li6d8b94a2019-11-21 18:22:38 +00002/// Copyright (c) 2017-2019 ARM Limited.
Vidhya Sudhan Loganathand646ae12018-11-19 15:18:20 +00003///
4/// SPDX-License-Identifier: MIT
5///
6/// Permission is hereby granted, free of charge, to any person obtaining a copy
7/// of this software and associated documentation files (the "Software"), to
8/// deal in the Software without restriction, including without limitation the
9/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10/// sell copies of the Software, and to permit persons to whom the Software is
11/// furnished to do so, subject to the following conditions:
12///
13/// The above copyright notice and this permission notice shall be included in all
14/// copies or substantial portions of the Software.
15///
16/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22/// SOFTWARE.
23///
Anthony Barbier3762e742018-03-02 11:49:33 +000024namespace arm_compute
25{
Anthony Barbier6ff3b192017-09-04 18:44:23 +010026/** @mainpage Introduction
27
28@tableofcontents
29
30The Computer Vision and Machine Learning library is a set of functions optimised for both ARM CPUs and GPUs using SIMD technologies.
31
32Several builds of the library are available using various configurations:
33 - OS: Linux, Android or bare metal.
34 - Architecture: armv7a (32bit) or arm64-v8a (64bit)
Anthony Barbier20dbb822017-12-13 21:19:39 +000035 - Technology: NEON / OpenCL / GLES_COMPUTE / NEON and OpenCL and GLES_COMPUTE
Anthony Barbier6ff3b192017-09-04 18:44:23 +010036 - Debug / Asserts / Release: Use a build with asserts enabled to debug your application and enable extra validation. Once you are sure your application works as expected you can switch to a release build of the library for maximum performance.
37
38@section S0_1_contact Contact / Support
39
40Please email developer@arm.com
41
42In order to facilitate the work of the support team please provide the build information of the library you are using. To get the version of the library you are using simply run:
43
44 $ strings android-armv7a-cl-asserts/libarm_compute.so | grep arm_compute_version
45 arm_compute_version=v16.12 Build options: {'embed_kernels': '1', 'opencl': '1', 'arch': 'armv7a', 'neon': '0', 'asserts': '1', 'debug': '0', 'os': 'android', 'Werror': '1'} Git hash=f51a545d4ea12a9059fe4e598a092f1fd06dc858
46
Anthony Barbier14c86a92017-12-14 16:27:41 +000047@section S0_2_prebuilt_binaries Pre-built binaries
48
49For each release we provide some pre-built binaries of the library [here](https://github.com/ARM-software/ComputeLibrary/releases)
50
51These binaries have been built using the following toolchains:
Isabella Gottardibe2de402018-11-21 15:23:49 +000052 - Linux armv7a: gcc-linaro-4.9-2016.02-x86_64_arm-linux-gnueabihf
Anthony Barbier14c86a92017-12-14 16:27:41 +000053 - Linux arm64-v8a: gcc-linaro-4.9-2016.02-x86_64_aarch64-linux-gnu
SiCong Li1f7f9882019-11-28 14:59:35 +000054 - Android armv7a: clang++ / libc++ NDK r17c
55 - Android am64-v8a: clang++ / libc++ NDK r17c
Anthony Barbier14c86a92017-12-14 16:27:41 +000056
57@warning Make sure to use a compatible toolchain to build your application or you will get some std::bad_alloc errors at runtime.
58
Anthony Barbier6ff3b192017-09-04 18:44:23 +010059@section S1_file_organisation File organisation
60
61This archive contains:
62 - The arm_compute header and source files
63 - The latest Khronos OpenCL 1.2 C headers from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a>
64 - The latest Khronos cl2.hpp from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a> (API version 2.1 when this document was written)
Anthony Barbier20dbb822017-12-13 21:19:39 +000065 - The latest Khronos OpenGL ES 3.1 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos OpenGL ES registry</a>
66 - The latest Khronos EGL 1.5 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos EGL registry</a>
67 - The sources for a stub version of libOpenCL.so, libGLESv1_CM.so, libGLESv2.so and libEGL.so to help you build your application.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010068 - An examples folder containing a few examples to compile and link against the library.
69 - A @ref utils folder containing headers with some boiler plate code used by the examples.
70 - This documentation.
71
72You should have the following file organisation:
73
74 .
75 ├── arm_compute --> All the arm_compute headers
Georgios Pinitasf112ede2019-03-01 19:11:20 +000076 │ ├── graph.h --> Includes all the Graph headers at once.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010077 │   ├── core
78 │   │   ├── CL
Georgios Pinitas5ca23952020-01-20 19:03:06 +000079 │ │ │ ├── CLCoreRuntimeContext.h --> Manages all core OpenCL objects needed for kernel execution (cl_context, cl_kernel, cl_command_queue, etc).
Anthony Barbier6a5627a2017-09-26 14:42:02 +010080 │   │   │   ├── CLKernelLibrary.h --> Manages all the OpenCL kernels compilation and caching, provides accessors for the OpenCL Context.
Anthony Barbier6ff3b192017-09-04 18:44:23 +010081 │   │   │   ├── CLKernels.h --> Includes all the OpenCL kernels at once
Georgios Pinitas5ca23952020-01-20 19:03:06 +000082 │   │   │   ├── CL specialisation of all the generic objects interfaces (ICLTensor, ICLArray, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +010083 │   │   │   ├── kernels --> Folder containing all the OpenCL kernels
84 │   │   │   │   └── CL*Kernel.h
85 │   │   │   └── OpenCL.h --> Wrapper to configure the Khronos OpenCL C++ header
86 │   │ ├── CPP
Anthony Barbier6a5627a2017-09-26 14:42:02 +010087 │   │   │   ├── CPPKernels.h --> Includes all the CPP kernels at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +010088 │   │ │   └── kernels --> Folder containing all the CPP kernels
Anthony Barbier6a5627a2017-09-26 14:42:02 +010089 │   │   │      └── CPP*Kernel.h
Anthony Barbier20dbb822017-12-13 21:19:39 +000090 │   │   ├── GLES_COMPUTE
Georgios Pinitas5ca23952020-01-20 19:03:06 +000091 │ │ │ ├── GCCoreRuntimeContext.h --> Manages all core GLES objects needed for kernel execution.
Anthony Barbier20dbb822017-12-13 21:19:39 +000092 │   │   │   ├── GCKernelLibrary.h --> Manages all the GLES kernels compilation and caching, provides accessors for the GLES Context.
93 │   │   │   ├── GCKernels.h --> Includes all the GLES kernels at once
Georgios Pinitas5ca23952020-01-20 19:03:06 +000094 │   │   │   ├── GLES specialisation of all the generic objects interfaces (IGCTensor etc.)
Anthony Barbier20dbb822017-12-13 21:19:39 +000095 │   │   │   ├── kernels --> Folder containing all the GLES kernels
96 │   │   │   │   └── GC*Kernel.h
97 │   │   │   └── OpenGLES.h --> Wrapper to configure the Khronos EGL and OpenGL ES C header
Anthony Barbier6ff3b192017-09-04 18:44:23 +010098 │   │   ├── NEON
99 │   │   │   ├── kernels --> Folder containing all the NEON kernels
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100100 │   │   │   │ ├── assembly --> headers for assembly optimised NEON kernels.
101 │   │   │   │ ├── convolution --> headers for convolution assembly optimised NEON kernels.
102 │   │   │   │   │   ├── common --> headers for code which is common to several convolution implementations.
103 │   │   │   │   │   ├── depthwise --> headers for Depthwise convolultion assembly implementation
104 │   │   │   │   │   └── winograd --> headers for Winograd convolution assembly implementation
105 │   │   │   │ ├── detail --> Common code for several intrinsics implementations.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100106 │   │   │   │   └── NE*Kernel.h
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000107 │   │   │   ├── wrapper --> NEON wrapper used to simplify code
108 │   │   │   │ ├── intrinsics --> NEON instrincs' wrappers
109 │   │   │   │ ├── scalar --> Scalar operations
110 │   │   │   │ ├── traits.h --> Traits defined on NEON vectors
111 │   │   │   │   └── wrapper.h --> Includes all wrapper headers at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100112 │   │   │   └── NEKernels.h --> Includes all the NEON kernels at once
113 │   │   ├── All common basic types (Types.h, Window, Coordinates, Iterator, etc.)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000114 │   │   ├── All generic objects interfaces (ITensor, IArray, etc.)
115 │   │   └── Objects metadata classes (TensorInfo, MultiImageInfo)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100116 │   ├── graph
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100117 │   │   ├── algorithms
118 │   │   │   └── Generic algorithms used by the graph backend (e.g Order of traversal)
119 │   │   ├── backends --> The backend specific code
120 │   │   │   ├── CL --> OpenCL specific operations
121 │   │   │   ├── GLES --> OpenGLES Compute Shaders specific operations
122 │   │   │   └── NEON --> NEON specific operations
123 │   │   ├── detail
124 │   │   │   └── Collection of internal utilities.
125 │   │   ├── frontend
126 │   │   │   └── Code related to the stream frontend interface.
127 │   │   ├── mutators
128 │   │   │   └── Used to modify / optimise the Graph intermediate representation(Operator fusion, in place operations, etc.)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100129 │   │   ├── nodes
130 │   │   │   └── The various nodes supported by the graph API
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100131 │   │   ├── printers
132 │   │   │   └── Debug printers
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100133 │   │   └── Graph objects ( INode, ITensorAccessor, Graph, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100134 │   └── runtime
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000135 │   ├── common
136 │ │ └── Common utility code used by all backends
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100137 │   ├── CL
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000138 │   │   ├── CL objects & allocators (CLArray, CLTensor, etc.)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100139 │   │   ├── functions --> Folder containing all the OpenCL functions
140 │   │   │   └── CL*.h
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100141 │   │   ├── CLScheduler.h --> Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100142 │   │   ├── CLFunctions.h --> Includes all the OpenCL functions at once
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000143 │   │   ├── ICLTuner.h --> Interface used to tune the local work-group size of OpenCL kernels
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100144 │   │   └── tuners
145 │   │      └── Local workgroup size tuners for specific architectures / GPUs
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100146 │   ├── CPP
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100147 │      │   ├── CPPKernels.h --> Includes all the CPP functions at once.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100148 │   │   ├── CPPScheduler.h --> Basic pool of threads to execute CPP/NEON code on several cores in parallel
149 │   │   └── functions --> Folder containing all the CPP functions
150 │   │      └── CPP*.h
Anthony Barbier20dbb822017-12-13 21:19:39 +0000151 │   ├── GLES_COMPUTE
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000152 │   │   ├── GLES objects & allocators (GCArray, GCTensor, etc.)
Anthony Barbier20dbb822017-12-13 21:19:39 +0000153 │   │   ├── functions --> Folder containing all the GLES functions
154 │   │   │   └── GC*.h
155 │   │   ├── GCScheduler.h --> Interface to enqueue GLES kernels and get/set the GLES CommandQueue.
156 │   │   └── GCFunctions.h --> Includes all the GLES functions at once
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100157 │   ├── NEON
158 │   │ ├── functions --> Folder containing all the NEON functions
159 │   │ │   └── NE*.h
160 │   │ └── NEFunctions.h --> Includes all the NEON functions at once
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100161 │   ├── OMP
162 │   │   └── OMPScheduler.h --> OpenMP scheduler (Alternative to the CPPScheduler)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000163 │ ├── Memory & weights manager files (LifetimeManager, PoolManager, etc.)
164 │   └── Basic implementations of the generic object interfaces (Array, Tensor, etc.)
165 ├── data --> Contains test images and reference data dumps used by validation tests
166 ├── docs --> Contains Doxyfile and Doxygen sources used to generate the HTML pages in the documentation folder.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100167 ├── documentation
168 │   ├── index.xhtml
169 │   └── ...
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000170 ├── documentation.xhtml --> documentation/index.xhtml
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100171 ├── examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000172 │   ├── cl_*.cpp --> OpenCL examples
Anthony Barbier14c86a92017-12-14 16:27:41 +0000173 │   ├── gc_*.cpp --> GLES compute shaders examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000174 │   ├── graph_*.cpp --> Graph examples
175 │   ├── neoncl_*.cpp --> NEON / OpenCL interoperability examples
176 │   └── neon_*.cpp --> NEON examples
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100177 ├── include
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100178 │   ├── CL
179 │   │ └── Khronos OpenCL C headers and C++ wrapper
180 │   ├── half --> FP16 library available from http://half.sourceforge.net
Anthony Barbier14c86a92017-12-14 16:27:41 +0000181 │   ├── libnpy --> Library to load / write npy buffers, available from https://github.com/llohse/libnpy
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000182 │  ├── linux --> Headers only needed for Linux builds
183 │   │ └── Khronos EGL and OpenGLES headers
184 │ └── stb
185 │ └── stb_image.h --> Single header library to load image files, available from https://github.com/nothings/stb
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100186 ├── scripts
187 │   ├── caffe_data_extractor.py --> Basic script to export weights from Caffe to npy files
188 │   └── tensorflow_data_extractor.py --> Basic script to export weights from Tensor Flow to npy files
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100189 ├── src
190 │   ├── core
191 │ │ └── ... (Same structure as headers)
Anthony Barbier20dbb822017-12-13 21:19:39 +0000192 │   │ ├── CL
193 │   │ │ └── cl_kernels --> All the OpenCL kernels
194 │   │ └── GLES_COMPUTE
195 │   │ └── cs_shaders --> All the OpenGL ES Compute Shaders
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100196 │   ├── graph
197 │ │ └── ... (Same structure as headers)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100198 │ └── runtime
199 │ └── ... (Same structure as headers)
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100200 ├── support
201 │ └── Various headers to work around toolchains / platform issues.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100202 ├── tests
203 │   ├── All test related files shared between validation and benchmark
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100204 │   ├── benchmark --> Sources for benchmarking
205 │ │ ├── Benchmark specific files
206 │   │ ├── fixtures
207 │ │ │ └── Backend agnostic fixtures to initialise and run the functions to test.
208 │ │ ├── CL --> OpenCL benchmarking tests
209 │ │ ├── GLES_COMPUTE --> GLES benchmarking tests
210 │ │ └── NEON --> NEON benchmarking tests
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000211 │ ├── benchmark_examples --> Sources needed to wrap examples to run through our benchmarking framework.
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100212 │   ├── CL --> OpenCL accessors
Anthony Barbier20dbb822017-12-13 21:19:39 +0000213 │   ├── GLES_COMPUTE --> GLES accessors
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100214 │   ├── NEON --> NEON accessors
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100215 │   ├── datasets
216 │ │ └── Datasets for all the validation / benchmark tests, layer configurations for various networks, etc.
217 │   ├── framework
218 │ │ └── Boiler plate code for both validation and benchmark test suites (Command line parsers, instruments, output loggers, etc.)
Georgios Pinitas5ca23952020-01-20 19:03:06 +0000219 │   ├── instruments --> User defined instruments that can be registered to the framework.
220 │ ├── validate_examples --> Sources needed to wrap examples to run through our validation framework.
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100221 │   └── validation --> Sources for validation
222 │ ├── Validation specific files
223 │   ├── fixtures
224 │ │ └── Backend agnostic fixtures to initialise and run the functions to test.
225 │   ├── reference
226 │ │ └── Reference implementation used to validate the results of the various backends.
227 │ ├── CL --> OpenCL validation tests
228 │ ├── GLES_COMPUTE --> GLES validation tests
229 │ ├── CPP --> C++ reference implementations
230 │ └── NEON --> NEON validation tests
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100231 └── utils --> Boiler plate code used by examples
Anthony Barbier20dbb822017-12-13 21:19:39 +0000232 └── Various utilities to print types, load / store assets, etc.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100233
234@section S2_versions_changelog Release versions and changelog
235
236@subsection S2_1_versions Release versions
237
238All releases are numbered vYY.MM Where YY are the last two digits of the year, and MM the month number.
239If there is more than one release in a month then an extra sequential number is appended at the end:
240
241 v17.03 (First release of March 2017)
242 v17.03.1 (Second release of March 2017)
243 v17.04 (First release of April 2017)
244
245@note We're aiming at releasing one major public release with new features per quarter. All releases in between will only contain bug fixes.
246
247@subsection S2_2_changelog Changelog
248
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000249v19.11.1 Public maintenance release
250 - Fix offset calculation in NEReductionOperationKernel.
251 - Fix data layout in NEScaleKernel for nhwc.
252 - Retain configuration step data layout to avoid side-effects.
253 - Perform sqrt in double domain for L2 pooling.
254 - Fix output shape calculation for Reduce Mean
255 - Restrict cases where optimized NEPadLayer runs.
256
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100257v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000258 - Various bug fixes.
259 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000260 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000261 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100262 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
263 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000264 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100265 - CLDepthwiseVectorToTensorKernel
266 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000267 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100268 - NEDepthwiseWeightsReshapeKernel
269 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000270 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100271 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100272 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000273 - New OpenCL kernels / functions:
274 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
275 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
276 OpenCL kernels / functions)
277 - @ref CLLogSoftmaxLayer
278 - New NEON kernels / functions:
279 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
280 - @ref NEComputeAllAnchorsKernel / @ref NEComputeAllAnchors
281 - @ref NEDetectionPostProcessLayer
282 - @ref NEGenerateProposalsLayer
283 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
284 - @ref NELogSoftmaxLayer
285 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
286 - Added QASYMM8 support for:
287 - @ref CLGenerateProposalsLayer
288 - @ref CLROIAlignLayer
289 - @ref CPPBoxWithNonMaximaSuppressionLimit
290 - Added QASYMM16 support for:
291 - @ref CLBoundingBoxTransform
292 - Added FP16 support for:
293 - @ref CLGEMMMatrixMultiplyReshapedKernel
294 - Added new data type QASYMM8_PER_CHANNEL support for:
295 - @ref CLDequantizationLayer
296 - @ref NEDequantizationLayer
297 - Added new data type QSYMM8_PER_CHANNEL support for:
298 - @ref CLConvolutionLayer
299 - @ref NEConvolutionLayer
300 - @ref CLDepthwiseConvolutionLayer
301 - @ref NEDepthwiseConvolutionLayer
302 - Added FP16 mixed-precision support for:
303 - @ref CLGEMMMatrixMultiplyReshapedKernel
304 - @ref CLPoolingLayerKernel
305 - Added FP32 and FP16 ELU activation for:
306 - @ref CLActivationLayer
307 - @ref NEActivationLayer
308 - Added asymmetric padding support for:
309 - @ref CLDirectDeconvolutionLayer
310 - @ref CLGEMMDeconvolutionLayer
311 - @ref NEDeconvolutionLayer
312 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
313 - Replaced the calls to @ref NECopyKernel and @ref NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
314 - Replaced the calls to @ref CLCopyKernel and @ref CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
315 - Improved performance for CL Inception V3 - FP16.
316 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
317 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
318 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
319 - Optimized @ref CLPadLayer.
320 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
321 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100322
Michele Di Giorgiod374ff22020-01-21 10:03:20 +0000323v19.08.1 Public maintenance release
324 - Fix offset calculation in NEReductionOperationKernel.
325 - Fix data layout in NEScaleKernel for nhwc.
326 - Retain configuration step data layout to avoid side-effects.
327 - Perform sqrt in double domain for L2 pooling.
328 - Fix output shape calculation for Reduce Mean
329 - Fix broadcast CLPixelwiseMultiplication with 5D tensors
330
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100331v19.08 Public major release
332 - Various bug fixes.
333 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100334 - Deprecated NEON functions
335 - NEDepthConcatenateLayer
336 - NEWidthConcatenateLayer
337 - Deprecated OpenCL kernels / functions
338 - CLDepthConcatenateLayer
339 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
340 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
341 - CLWidthConcatenateLayer
342 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100343 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100344 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100345 - @ref NEElementwisePower
346 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100347 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100348 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100349 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100350 - @ref NESinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100351 - @ref NEBatchConcatenateLayerKernel
352 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
353 - @ref NEDepthwiseConvolutionLayerNativeKernel
354 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
355 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
356 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
357 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100358 - @ref CLAbsLayer
359 - @ref CLElementwisePower
360 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100361 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100362 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100363 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100364 - @ref CLSinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100365 - @ref CLBatchConcatenateLayerKernel
366 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
367 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
368 - @ref CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
369 - @ref CLGEMMMatrixMultiplyNativeKernel
370 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
371 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
372 - New examples:
373 - neon_opticalflow
374 - cl_cache
375 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100376 - Added support for FP16 in @ref NEDeconvolutionLayer
377 - Added support for FP16 in @ref CLDeconvolutionLayer
378 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100379 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
380 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
381 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
382 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
383 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
384 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini05069f02019-09-26 17:18:26 +0100385 - The @ref CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
386 - The @ref NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100387 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
388 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100389 - 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 +0100390
Michalis Spyroua9c44722019-04-05 17:18:36 +0100391v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100392 - Various bug fixes.
393 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100394 - New Neon kernels / functions:
395 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100396 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100397 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100398 - @ref NEDepthwiseConvolutionAssemblyDispatch
399 - @ref NEFFTDigitReverseKernel
400 - @ref NEFFTRadixStageKernel
401 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100402 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
403 - @ref NEHeightConcatenateLayerKernel
404 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100405 - @ref NEFFT1D
406 - @ref NEFFT2D
407 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100408 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100409 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100410 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100411 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100412 - @ref CLFFTDigitReverseKernel
413 - @ref CLFFTRadixStageKernel
414 - @ref CLFFTScaleKernel
415 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
416 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
417 - @ref CLHeightConcatenateLayerKernel
418 - @ref CLDirectDeconvolutionLayer
419 - @ref CLFFT1D
420 - @ref CLFFT2D
421 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100422 - @ref CLGEMMDeconvolutionLayer
423 - New OpenGLES kernels / functions:
424 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100425 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100426 - GCDepthConcatenateLayer
427 - NEWidthConcatenateLayer
428 - NEDepthConcatenateLayer
429 - CLWidthConcatenateLayer
430 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100431 - CLGEMMInterleave4x4
432 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100433 - Support different quantization info in CLConcatLayer.
434 - Add checks on different input/output quantization info were not supported.
435 - Tensors have different quantization information.
436 - Add FP16 support checks.
437 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
438 - New graph examples:
439 - graph_convolution
440 - graph_fully_connected
441 - graph_depthwise_convolution
442 - Deepspeech v0.4.1
443 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
444 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
445 - Add support for QASYMM8 NEDeconvolution.
446 - Add support for DequantizationLayer for NEON/CL.
447 - Add support for dilation in CLDepthwiseConvolution.
448 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
449 - Optimize CLDeconvolution.
450 - Add StackLayer to the graph API.
451 - Add support for "reflect" padding mode in NEPad.
452 - Winograd 7x7 NHWC on OpenCL.
453 - Rework CL ML layers to run exclusively on CL.
454 - Support different quantization info in PoolingLayer.
455 - Implement and test import memory interfaces.
456 - Added new tests and removed old ones.
457 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100458
giuros01a69a88b2019-01-31 16:29:19 +0000459v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000460 - Various bug fixes.
461 - Various optimisations.
462 - New Neon kernels / functions:
463 - @ref NETileKernel / @ref NETile
464 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
465 - @ref NEElementwiseOperationKernel
466 - @ref NEElementwiseMax
467 - @ref NEElementwiseMin
468 - @ref NEElementwiseSquaredDiff
469 - @ref NESelectKernel / @ref NESelect
470 - @ref NESplit
471 - @ref NESlice
472 - @ref NEUnstack
473 - @ref NEStridedSliceKernel / @ref NEStridedSlice
474 - @ref NEElementwiseUnaryKernel
475 - @ref NERsqrtLayer
476 - @ref NEExpLayer
477 - @ref NEReverseKernel / @ref NEReverse
478 - @ref NEArgMinMaxLayer
479 - @ref NEStackLayerKernel / @ref NEStackLayer
480 - @ref NERangeKernel / @ref NERange
481 - @ref NEPadLayer
482 - @ref NEMemsetKernel
483 - @ref NEGatherKernel / @ref NEGather
484 - @ref NEElementwiseComparison
485 - @ref NEElementwiseComparisonStatic
486 - @ref NEComparisonOperationKernel
487 - @ref NEElementwiseDivision
488 - New OpenCL kernels / functions:
489 - @ref CLSelectKernel / @ref CLSelect
490 - @ref CLTileKernel / @ref CLTile
491 - @ref CLComparisonKernel / @ref CLComparison
492 - @ref CLArgMinMaxLayer
493 - @ref CLElementwiseMax
494 - @ref CLElementwiseMin
495 - @ref CLElementwiseSquaredDiff
496 - @ref CLStackLayerKernel / @ref CLStackLayer
497 - @ref CLReverse / @ref CLReverseKernel
498 - @ref CLRsqrtLayer
499 - @ref CLExpLayer
500 - @ref CLElementWiseUnaryLayerKernel
501 - @ref CLGEMMReshapeLHSMatrixKernel
502 - @ref CLGEMMReshapeRHSMatrixKernel
503 - @ref CLGEMMMatrixMultiplyReshapedKernel
504 - @ref CLRangeKernel / @ref CLRange
505 - @ref CLUnstack
506 - @ref CLGatherKernel / @ref CLGather
507 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
508 - New CPP kernels / functions:
509 - @ref CPPDetectionOutputLayer
510 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000511 - Added new examples:
512 - graph_ssd_mobilenet.cpp
513 - graph_mobilenet_v2.cpp
514 - graph_resnet12.cpp
515 - graph_srcnn955.cpp
516 - graph_vgg_vdsr.cpp
517 - graph_inception_resnet_v1.cpp
518 - Add 4D tensors support to
519 - @ref NESoftmaxLayer
520 - Fused activation in @ref CLWinogradConvolutionLayer
521 - Extented @ref NEPermute to support more cases
522 - Added NEON/SVE GEMM Hybrid kernels
523 - Added u8 and s8 hybrid assembly kernels
524 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
525 - Improved @ref CLTuner
526 - Fused the bias addition within @ref CLGEMM
527 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
528 - Added NHWC data layout support to:
529 - @ref NEScale for F16
530 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
531 - @ref NEL2NormalizeLayer for FP32/FP16
532 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
533 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000534 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000535 - Added QASYMM8 support to the following kernels:
536 - @ref NEArithmeticAdditionKernel
537 - @ref NEScale
538 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000539 - Deprecated functions/interfaces
540 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
541
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000542v18.11 Public major release
543 - Various bug fixes.
544 - Various optimisations.
545 - New Neon kernels / functions:
546 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
547 - @ref NEReduceMean
548 - @ref NEReorgLayer / @ref NEReorgLayerKernel
549 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
550 - @ref NEUpsampleLayer / @ref NEUpsampleLayerKernel
551 - @ref NEYOLOLayer / @ref NEYOLOLayerKernel
552 - New OpenCL kernels / functions:
553 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
554 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000555 - @ref CLComputeAllAnchorsKernel
556 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000557 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
558 - @ref CLReorgLayer / @ref CLReorgLayerKernel
559 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
560 - @ref CLPadLayer
561 - @ref CLReduceMean
562 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
563 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
564 - @ref CLSlice
565 - @ref CLSplit
566 - @ref CLStridedSlice / @ref CLStridedSliceKernel
567 - @ref CLUpsampleLayer / @ref CLUpsampleLayerKernel
568 - @ref CLYOLOLayer / @ref CLYOLOLayerKernel
569 - New CPP kernels / functions:
570 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
571 - Added the validate method in:
572 - @ref NEDepthConvertLayer
573 - @ref NEFloor / @ref CLFloor
574 - @ref NEGEMMMatrixAdditionKernel
575 - @ref NEReshapeLayer / @ref CLReshapeLayer
576 - @ref CLScale
577 - Added new examples:
578 - graph_shufflenet.cpp
579 - graph_yolov3.cpp
580 - Added documentation for add a new function or kernel.
581 - Improved doxygen documentation adding a list of the existing functions.
582 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100583 - CLWidthConcatenateLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000584 - @ref CLFlattenLayer
585 - @ref CLSoftmaxLayer
586 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
587 - Add SVE support
588 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
589 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
590 - Added NHWC data layout support to:
591 - @ref CLChannelShuffleLayer
592 - @ref CLDeconvolutionLayer
593 - @ref CLL2NormalizeLayer
594 - Added QASYMM8 support to the following kernels:
595 - @ref CLScaleKernel
596 - @ref NEDepthwiseConvolutionLayer3x3Kernel
597 - @ref CLPixelWiseMultiplicationKernel
598 - Added FP16 support to the following kernels:
599 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
600 - @ref NEDepthwiseConvolutionLayer3x3Kernel
601 - @ref CLNormalizePlanarYUVLayerKernel
602 - @ref CLWinogradConvolutionLayer (5x5 kernel)
603 - More tests added to both validation and benchmarking suites.
604
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100605v18.08 Public major release
606 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100607 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100608 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100609 - Removed support for QS8/QS16 data types.
610 - Added support for grouped convolution in @ref CLConvolutionLayer.
611 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100612 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100613 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
614 - @ref CLDepthwiseConvolutionLayer
615 - @ref CLDirectConvolutionLayer
616 - @ref CLConvolutionLayer
617 - @ref CLScale
618 - @ref CLIm2ColKernel
619 - New Neon kernels / functions:
620 - @ref NERNNLayer
621 - New OpenCL kernels / functions:
622 - @ref CLArithmeticDivision
623 - Introduced prepare() stage support in the graph API for GLES.
624 - Added support for memory reusage when trying to allocate smaller CLTensors.
625 - Enabled NHWC execution on graph examples.
626 - Added JPEG accessor for validation purposes.
627 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100628
629v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100630 - Various bug fixes.
631 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000632 - Major redesign in the interface for the neon kernels implemented in assembly.
633 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
634 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
635 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100636 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
637 - Improved doxygen documentation.
638 - Improved memory management for layer's transitions.
639 - Added support for NHWC data layout in tensors.
640 - Added NHWC data layout support to:
641 - @ref NEGEMMConvolutionLayer
642 - @ref NEDirectConvolutionLayer
643 - @ref NEPoolingLayer / @ref CLPoolingLayer
644 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
645 - @ref NEDepthwiseConvolutionLayer
646 - @ref NEScale
647 - @ref NEIm2Col
648 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
649 - New OpenCL kernels / functions:
650 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
651 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
652 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100653 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100654 - @ref CLRNNLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100655 - CLWidthConcatenateLayer / @ref CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100656 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
657 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
658 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100659 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
660 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
661 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
662 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
663 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
664 - Port mobilenet example to NHWC data layout.
665 - Enabled Winograd method in @ref CLConvolutionLayer.
666 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
667 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
668 - Added memory manager support in GLES functions.
669 - Major refactoring of the graph API.
670 - Added GLES backend in the graph API.
671 - Added support for the memory manager in the graph API.
672 - Enabled Winograd Convolution method in the graph API.
673 - Added support for grouped convolutions in the graph API.
674 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
675 - Added fast maths flag in @ref CLConvolutionLayer.
676 - Added new tests and benchmarks in validation and benchmark frameworks
677 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
678 - Added support to OpenCL 2.0 SVM
679 - Added support to import memory in OpenCL tensors.
680 - Added the prepare() method to perform any one off pre-processing before running the function.
681 - Added new examples:
682 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100683 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100684 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000685
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000686v18.03 Public maintenance release
687 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +0000688 - Fixed bug in @ref NEActivationLayer
689 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000690 - Updated recommended NDK version to r16b (And fixed warnings).
691 - Fixed bug in validation code.
692 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100693 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000694
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000695v18.02 Public major release
696 - Various NEON / OpenCL / GLES optimisations.
697 - Various bug fixes.
698 - Changed default number of threads on big LITTLE systems.
699 - Refactored examples and added:
700 - graph_mobilenet_qassym8
701 - graph_resnet
702 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +0000703 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
704 - 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 +0000705 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000706 - @ref CLActivationLayer
707 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000708 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000709 - @ref CLActivationLayer
710 - @ref CLDepthwiseConvolutionLayer
711 - @ref NEDepthwiseConvolutionLayer
712 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000713 - Added FP16 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000714 - @ref CLDepthwiseConvolutionLayer3x3
715 - @ref CLDepthwiseConvolutionLayer
716 - Added broadcasting support to @ref NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
717 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
718 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000719 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100720 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +0000721 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000722 - Added name() method to all kernels.
723 - Added support for Winograd 5x5.
Anthony Barbier3762e742018-03-02 11:49:33 +0000724 - @ref NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100725 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
726 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
727 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +0100728 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000729 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000730 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +0000731
Anthony Barbier64c95a02018-01-22 18:48:55 +0000732v18.01 Public maintenance release
733 - Various bug fixes
734 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +0000735 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
736 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +0000737 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +0000738 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
739 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
740 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
741 - Added @ref GCScaleKernel / @ref GCScale
742 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +0000743 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000744 - @ref GCCol2ImKernel
745 - @ref GCGEMMInterleave4x4Kernel
746 - @ref GCGEMMTranspose1xWKernel
747 - @ref GCIm2ColKernel
748 - Refactored NEON Winograd (NEWinogradLayerKernel)
749 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000750 - Added QASYMM8 support to the following NEON kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000751 - @ref NEDepthwiseConvolutionLayer3x3Kernel
752 - @ref NEFillBorderKernel
753 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000754 - Added new examples:
755 - graph_cl_mobilenet_qasymm8.cpp
756 - graph_inception_v3.cpp
757 - gc_dc.cpp
758 - More tests added to both validation and benchmarking suites.
759
Gian Marcoff850932017-12-11 12:37:17 +0000760v17.12 Public major release
761 - Most machine learning functions on OpenCL support the new data type QASYMM8
762 - Introduced logging interface
763 - Introduced opencl timer
764 - Reworked GEMMLowp interface
765 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
766 - Added validation method for most Machine Learning kernels / functions
767 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
768 - Added sgemm example for OpenCL
769 - Added absolute difference example for GLES compute
770 - Added new tests and benchmarks in validation and benchmark frameworks
771 - Added new kernels / functions for GLES compute
772
773 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000774 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
775 - @ref GCActivationLayerKernel / @ref GCActivationLayer
776 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
777 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +0100778 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000779 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
780 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
781 - @ref GCFillBorderKernel / @ref GCFillBorder
782 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
783 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
784 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
785 - @ref GCIm2ColKernel
786 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
787 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
788 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
789 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
790 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +0000791
792 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +0000793 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
794 - arm_compute::NEHGEMMAArch64FP16Kernel
Giorgio Arenad93e2632019-10-15 11:09:33 +0100795 - @ref NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / @ref NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000796 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
797 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
798 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8Scale
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100799 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +0000800
801 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000802 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
803 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
804 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8Scale
Gian Marcoff850932017-12-11 12:37:17 +0000805
806 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +0100807 - graph::BranchLayer
808 - graph::DepthConvertLayer
809 - graph::DepthwiseConvolutionLayer
810 - graph::DequantizationLayer
811 - graph::FlattenLayer
812 - graph::QuantizationLayer
813 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +0000814
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100815v17.10 Public maintenance release
816 - Bug fixes:
817 - Check the maximum local workgroup size supported by OpenCL devices
818 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +0000819 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100820 - Added a few new Graph nodes, support for branches and grouping.
821 - Automatically enable cl_printf in debug builds
822 - Fixed bare metal builds for armv7a
823 - Added AlexNet and cartoon effect examples
824 - 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)
825
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100826v17.09 Public major release
827 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +0000828 - 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 +0100829 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
830 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
831 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +0000832 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000833 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
834 - @ref NEFloorKernel / @ref NEFloor
835 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
836 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
837 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
838 - @ref NEReductionOperationKernel / @ref NEReductionOperation
839 - @ref NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100840
841 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100842 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / @ref CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000843 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
844 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
845 - @ref CLFlattenLayer
846 - @ref CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100847 - CLGEMMTranspose1xW
Anthony Barbier3762e742018-03-02 11:49:33 +0000848 - @ref CLGEMMMatrixVectorMultiplyKernel
849 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
850 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
851 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
852 - @ref CLReductionOperationKernel / @ref CLReductionOperation
853 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100854
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100855v17.06 Public major release
856 - Various bug fixes
857 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
858 - Added unit tests and benchmarks (AlexNet, LeNet)
859 - Added support for sub tensors.
860 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +0000861 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
862 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
863 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100864 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000865 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100866 - @ref CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000867 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
868 - @ref CLLocallyConnectedMatrixMultiplyKernel / @ref CLLocallyConnectedLayer
869 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100870 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000871 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100872 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000873 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100874 - @ref NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000875 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
876 - @ref NELocallyConnectedMatrixMultiplyKernel / @ref NELocallyConnectedLayer
877 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100878
879v17.05 Public bug fixes release
880 - Various bug fixes
881 - Remaining of the functions ported to use accurate padding.
882 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
883 - Added "free" method to allocator.
884 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
885
886v17.04 Public bug fixes release
887
888 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +0000889 - @ref CLColorConvertKernel
890 - @ref CLEdgeNonMaxSuppressionKernel
891 - @ref CLEdgeTraceKernel
892 - @ref CLGaussianPyramidHorKernel
893 - @ref CLGaussianPyramidVertKernel
894 - @ref CLGradientKernel
895 - @ref NEChannelCombineKernel
896 - @ref NEFillArrayKernel
897 - @ref NEGaussianPyramidHorKernel
898 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +0100899 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000900 - @ref NEHarrisScoreKernel
901 - @ref NEHOGDetectorKernel
902 - @ref NELogits1DMaxKernel
903 - NELogits1DShiftExpSumKernel
904 - NELogits1DNormKernel
905 - @ref NENonMaximaSuppression3x3FP16Kernel
906 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100907
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100908v17.03.1 First Major public release of the sources
909 - Renamed the library to arm_compute
910 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
911 - New padding calculation interface introduced and ported most kernels / functions to use it.
912 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000913 - @ref CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100914 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000915 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
916 - @ref NETransposeKernel / @ref NETranspose
917 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
918 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
919 - @ref NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
920 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100921
922v17.03 Sources preview
923 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000924 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +0100925 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Anthony Barbier3762e742018-03-02 11:49:33 +0000926 - @ref CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
927 - @ref CLTransposeKernel / @ref CLTranspose
928 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
929 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
930 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100931 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000932 - @ref NEActivationLayerKernel / @ref NEActivationLayer
933 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
934 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100935
936v17.02.1 Sources preview
937 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000938 - @ref CLLogits1DMaxKernel, @ref CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
939 - @ref CLPoolingLayerKernel / @ref CLPoolingLayer
940 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
941 - @ref CLRemapKernel / @ref CLRemap
942 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
943 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
944 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100945 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +0000946 - @ref NEAccumulateWeightedFP16Kernel
947 - @ref NEBox3x3FP16Kernel
948 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100949
950v17.02 Sources preview
951 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000952 - @ref CLActivationLayerKernel / @ref CLActivationLayer
953 - @ref CLChannelCombineKernel / @ref CLChannelCombine
954 - @ref CLDerivativeKernel / @ref CLChannelExtract
955 - @ref CLFastCornersKernel / @ref CLFastCorners
956 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100957 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000958 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
959 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100960 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
961 - Switched all the kernels / functions to use tensors instead of images.
962 - Updated documentation to include instructions to build the library from sources.
963
964v16.12 Binary preview release
965 - Original release
966
967@section S3_how_to_build How to build the library and the examples
968
969@subsection S3_1_build_options Build options
970
971scons 2.3 or above is required to build the library.
972To see the build options available simply run ```scons -h```:
973
Anthony Barbier79c61782017-06-23 11:48:24 +0100974 debug: Debug (yes|no)
975 default: False
976 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100977
Anthony Barbier79c61782017-06-23 11:48:24 +0100978 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
979 default: False
980 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100981
Anthony Barbier79c61782017-06-23 11:48:24 +0100982 arch: Target Architecture (armv7a|arm64-v8a|arm64-v8.2-a|x86_32|x86_64)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100983 default: armv7a
984 actual: armv7a
985
Anthony Barbier79c61782017-06-23 11:48:24 +0100986 os: Target OS (linux|android|bare_metal)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100987 default: linux
988 actual: linux
989
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000990 build: Build type (native|cross_compile|embed_only)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100991 default: cross_compile
992 actual: cross_compile
993
Anthony Barbier79c61782017-06-23 11:48:24 +0100994 examples: Build example programs (yes|no)
995 default: True
996 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100997
Anthony Barbier79c61782017-06-23 11:48:24 +0100998 Werror: Enable/disable the -Werror compilation flag (yes|no)
999 default: True
1000 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001001
Anthony Barbier79c61782017-06-23 11:48:24 +01001002 opencl: Enable OpenCL support (yes|no)
1003 default: True
1004 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001005
Anthony Barbier79c61782017-06-23 11:48:24 +01001006 neon: Enable Neon support (yes|no)
1007 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001008 actual: False
1009
Anthony Barbier20dbb822017-12-13 21:19:39 +00001010 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
1011 default: False
1012 actual: False
1013
1014 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shader in library binary (yes|no)
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001015 default: True
1016 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001017
1018 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1019 default: False
1020 actual: False
1021
1022 openmp: Enable OpenMP backend (yes|no)
1023 default: False
1024 actual: False
1025
1026 cppthreads: Enable C++11 threads backend (yes|no)
1027 default: True
1028 actual: True
1029
1030 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1031 default: .
1032 actual: .
1033
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001034 extra_cxx_flags: Extra CXX flags to be appended to the build command
1035 default:
1036 actual:
1037
Anthony Barbier79c61782017-06-23 11:48:24 +01001038 pmu: Enable PMU counters (yes|no)
1039 default: False
1040 actual: False
1041
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001042 mali: Enable Mali hardware counters (yes|no)
1043 default: False
1044 actual: False
1045
Anthony Barbier79c61782017-06-23 11:48:24 +01001046 validation_tests: Build validation test programs (yes|no)
1047 default: False
1048 actual: False
1049
1050 benchmark_tests: Build benchmark test programs (yes|no)
1051 default: False
1052 actual: False
1053
1054@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001055 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1056 - 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)
1057 - 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).
1058
Anthony Barbier79c61782017-06-23 11:48:24 +01001059@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 +01001060
Anthony Barbier79c61782017-06-23 11:48:24 +01001061@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001062@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1063
Anthony Barbier79c61782017-06-23 11:48:24 +01001064@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 +01001065
Anthony Barbier79c61782017-06-23 11:48:24 +01001066@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 +01001067
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001068There 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.
1069
Anthony Barbier79c61782017-06-23 11:48:24 +01001070@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 +01001071
Anthony Barbier20dbb822017-12-13 21:19:39 +00001072@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 +01001073
Anthony Barbier20dbb822017-12-13 21:19:39 +00001074@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 +01001075
1076@b set_soname: Do you want to build the versioned version of the library ?
1077
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001078If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1079Example:
1080 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1081 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1082 libarm_compute_core.so.1.0.0
1083
1084@note This options is disabled by default as it requires SCons version 2.4 or above.
1085
Anthony Barbier79c61782017-06-23 11:48:24 +01001086@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1087
1088@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1089
1090@b examples: Build or not the examples
1091
1092@b validation_tests: Enable the build of the validation suite.
1093
Anthony Barbier79c61782017-06-23 11:48:24 +01001094@b benchmark_tests: Enable the build of the benchmark tests
1095
1096@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1097
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001098@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)
1099
Anthony Barbier79c61782017-06-23 11:48:24 +01001100@b openmp Build in the OpenMP scheduler for NEON.
1101
1102@note Only works when building with g++ not clang++
1103
1104@b cppthreads Build in the C++11 scheduler for NEON.
1105
Anthony Barbier3762e742018-03-02 11:49:33 +00001106@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001107
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001108@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001109
1110@subsubsection S3_2_1_library How to build the library ?
1111
1112For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1113
Michele Di Giorgio6513ccb2018-08-28 14:38:35 +01001114 - gcc-linaro-4.9-2016.02-x86_64_arm-linux-gnueabihf
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001115 - gcc-linaro-4.9-2016.02-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001116
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001117To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1118
1119 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1120
1121To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1122
1123 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1124
Anthony Barbier20dbb822017-12-13 21:19:39 +00001125To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1126
1127 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1128
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001129You can also compile the library natively on an ARM device by using <b>build=native</b>:
1130
1131 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1132 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1133
1134@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.
1135
1136For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1137
1138 apt-get install g++-arm-linux-gnueabihf
1139
1140Then run
1141
1142 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1143
1144or simply remove the build parameter as build=cross_compile is the default value:
1145
1146 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1147
1148@attention To cross compile with opencl=1 you need to make sure to have a version of libOpenCL matching your target architecture.
1149
1150@subsubsection S3_2_2_examples How to manually build the examples ?
1151
1152The 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.
1153
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001154@note The following command lines assume the arm_compute binaries are present in the current directory or in the system library path. If this is not the case you can specify the location of the pre-built library with the compiler option -L. When building the OpenCL example the commands below assume that the CL headers are located in the include folder where the command is executed.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001155
1156To cross compile a NEON example for Linux 32bit:
1157
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001158 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 +01001159
1160To cross compile a NEON example for Linux 64bit:
1161
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001162 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 +01001163
1164(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)
1165
1166To cross compile an OpenCL example for Linux 32bit:
1167
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001168 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 +01001169
1170To cross compile an OpenCL example for Linux 64bit:
1171
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001172 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 +01001173
Anthony Barbier14c86a92017-12-14 16:27:41 +00001174To cross compile a GLES example for Linux 32bit:
1175
1176 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
1177
1178To cross compile a GLES example for Linux 64bit:
1179
1180 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
1181
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001182(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)
1183
Anthony Barbier14c86a92017-12-14 16:27:41 +00001184To 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.
1185
1186@note The compute library must currently be built with both neon and opencl enabled - neon=1 and opencl=1
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001187
1188i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1189
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001190 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 +01001191
1192i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1193
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001194 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 +01001195
1196(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)
1197
Anthony Barbiere5007472017-10-27 15:01:44 +01001198@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1199
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001200To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1201
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001202 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 +01001203
1204To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1205
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001206 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 +01001207
1208(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1209
1210To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1211
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001212 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 +01001213
Anthony Barbier14c86a92017-12-14 16:27:41 +00001214To 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 +01001215
Anthony Barbier14c86a92017-12-14 16:27:41 +00001216 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
1217
1218To 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.
1219@note The compute library must currently be built with both neon and opencl enabled - neon=1 and opencl=1
1220
1221i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001222
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001223 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 +01001224
Anthony Barbier14c86a92017-12-14 16:27:41 +00001225i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001226
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001227 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 +01001228
1229(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 +01001230
Anthony Barbiere5007472017-10-27 15:01:44 +01001231@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1232
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001233@note These two commands assume libarm_compute.so is available in your library path, if not add the path to it using -L
Georgios Pinitas80b867d2019-12-04 18:20:52 +00001234@note You might need to export the path to OpenCL library as well in your LD_LIBRARY_PATH if Compute Library was build with OpenCL enabled.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001235
1236To run the built executable simply run:
1237
1238 LD_LIBRARY_PATH=build ./neon_convolution
1239
1240or
1241
1242 LD_LIBRARY_PATH=build ./cl_convolution
1243
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001244@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 +00001245
1246For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001247
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001248 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001249
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001250Below is a list of the common parameters among the graph examples :
1251@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001252
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001253@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001254
1255For Android, the library was successfully built and tested using Google's standalone toolchains:
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001256 - clang++ from NDK r17c for armv7a
1257 - clang++ from NDK r17c for arm64-v8a
Anthony Barbier3a6163e2018-08-10 17:36:36 +01001258 - clang++ from NDK r18-beta1 for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001259
1260Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1261
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001262- Download the NDK r17c from here: https://developer.android.com/ndk/downloads/index.html
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001263- Make sure you have Python 2.7 installed on your machine.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001264- Generate the 32 and/or 64 toolchains by running the following commands:
1265
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001266
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001267 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r17c --stl libc++ --api 21
1268 $NDK/build/tools/make_standalone_toolchain.py --arch arm --install-dir $MY_TOOLCHAINS/arm-linux-android-ndk-r17c --stl libc++ --api 21
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001269
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001270@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 +01001271
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001272@note Make sure to add the toolchains to your PATH:
1273
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001274 export PATH=$PATH:$MY_TOOLCHAINS/aarch64-linux-android-ndk-r17c/bin:$MY_TOOLCHAINS/arm-linux-android-ndk-r17c/bin
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001275
1276@subsubsection S3_3_1_library How to build the library ?
1277
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001278To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1279
1280 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1281
1282To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1283
Anthony Barbier14c86a92017-12-14 16:27:41 +00001284 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 +01001285
Anthony Barbier20dbb822017-12-13 21:19:39 +00001286To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1287
Anthony Barbier14c86a92017-12-14 16:27:41 +00001288 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 +00001289
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001290@subsubsection S3_3_2_examples How to manually build the examples ?
1291
1292The 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.
1293
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001294@note The following command lines assume the arm_compute binaries are present in the current directory or in the system library path. If this is not the case you can specify the location of the pre-built library with the compiler option -L. When building the OpenCL example the commands below assume that the CL headers are located in the include folder where the command is executed.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001295
1296Once you've got your Android standalone toolchain built and added to your path you can do the following:
1297
1298To cross compile a NEON example:
1299
1300 #32 bit:
Georgios Pinitas9873ea32017-12-05 15:28:55 +00001301 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 +01001302 #64 bit:
Anthony Barbier14c86a92017-12-14 16:27:41 +00001303 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 +01001304
1305To cross compile an OpenCL example:
1306
1307 #32 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001308 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 +01001309 #64 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001310 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 +00001311
1312To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001313
Anthony Barbier14c86a92017-12-14 16:27:41 +00001314 #32 bit:
1315 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
1316 #64 bit:
1317 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 +01001318
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001319To cross compile the examples with the Graph API, such as graph_lenet.cpp, you need to link the library arm_compute_graph also.
1320(notice the compute library has to be built with both neon and opencl enabled - neon=1 and opencl=1)
1321
1322 #32 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001323 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 +01001324 #64 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001325 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 +01001326
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001327@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 +00001328@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 +01001329
1330Then you need to do is upload the executable and the shared library to the device using ADB:
1331
1332 adb push neon_convolution_arm /data/local/tmp/
1333 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001334 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001335 adb shell chmod 777 -R /data/local/tmp/
1336
1337And finally to run the example:
1338
1339 adb shell /data/local/tmp/neon_convolution_arm
1340 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001341 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001342
1343For 64bit:
1344
1345 adb push neon_convolution_aarch64 /data/local/tmp/
1346 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001347 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001348 adb shell chmod 777 -R /data/local/tmp/
1349
1350And finally to run the example:
1351
1352 adb shell /data/local/tmp/neon_convolution_aarch64
1353 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001354 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001355
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001356@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 +00001357
1358For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001359 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001360
1361In 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.
1362
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001363@subsection S3_4_bare_metal Building for bare metal
1364
1365For bare metal, the library was successfully built using linaros's latest (gcc-linaro-6.3.1-2017.05) bare metal toolchains:
1366 - arm-eabi for armv7a
1367 - aarch64-elf for arm64-v8a
1368
1369Download 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>.
1370
1371@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
1372
1373@subsubsection S3_4_1_library How to build the library ?
1374
1375To cross-compile the library with NEON support for baremetal arm64-v8a:
1376
1377 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
1378
1379@subsubsection S3_4_2_examples How to manually build the examples ?
1380
1381Examples 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>.
1382
1383@subsection S3_5_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001384
1385Using `scons` directly from the Windows command line is known to cause
1386problems. The reason seems to be that if `scons` is setup for cross-compilation
1387it gets confused about Windows style paths (using backslashes). Thus it is
1388recommended to follow one of the options outlined below.
1389
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001390@subsubsection S3_5_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001391
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001392The best and easiest option is to use
1393<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001394This feature is still marked as *beta* and thus might not be available.
1395However, if it is building the library is as simple as opening a *Bash on
1396Ubuntu on Windows* shell and following the general guidelines given above.
1397
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001398@subsubsection S3_5_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001399
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001400If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001401can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1402to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001403also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001404code of the library.) Linaro provides pre-built versions of
1405<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001406that can be used from the Cygwin terminal. When building for Android the
1407compiler is included in the Android standalone toolchain. After everything has
1408been set up in the Cygwin terminal the general guide on building the library
1409can be followed.
1410
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001411@subsection S3_6_cl_stub_library The OpenCL stub library
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001412
1413In the opencl-1.2-stubs folder you will find the sources to build a stub OpenCL library which then can be used to link your application or arm_compute against.
1414
1415If you preferred you could retrieve the OpenCL library from your device and link against this one but often this library will have dependencies on a range of system libraries forcing you to link your application against those too even though it is not using them.
1416
1417@warning This OpenCL library provided is a stub and *not* a real implementation. You can use it to resolve OpenCL's symbols in arm_compute while building the example but you must make sure the real libOpenCL.so is in your PATH when running the example or it will not work.
1418
1419To cross-compile the stub OpenCL library simply run:
1420
1421 <target-prefix>-gcc -o libOpenCL.so -Iinclude opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1422
1423For example:
1424
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001425 #Linux 32bit
1426 arm-linux-gnueabihf-gcc -o libOpenCL.so -Iinclude opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1427 #Linux 64bit
1428 aarch64-linux-gnu-gcc -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC
1429 #Android 32bit
1430 arm-linux-androideabi-clang -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1431 #Android 64bit
Anthony Barbier14c86a92017-12-14 16:27:41 +00001432 aarch64-linux-android-clang -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1433
1434@subsection S3_7_gles_stub_library The Linux OpenGLES and EGL stub libraries
1435
1436In the opengles-3.1-stubs folder you will find the sources to build stub EGL and OpenGLES libraries which then can be used to link your Linux application of arm_compute against.
1437
1438@note The stub libraries are only needed on Linux. For Android, the NDK toolchains already provide the meta-EGL and meta-GLES libraries.
1439
1440To cross-compile the stub OpenGLES and EGL libraries simply run:
1441
1442 <target-prefix>-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1443 <target-prefix>-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
1444
1445 #Linux 32bit
1446 arm-linux-gnueabihf-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1447 arm-linux-gnueabihf-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
1448
1449 #Linux 64bit
1450 aarch64-linux-gnu-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1451 aarch64-linux-gnu-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001452
1453@subsection S3_8_cl_requirements OpenCL DDK Requirements
1454
1455@subsubsection S3_8_1_cl_hard_requirements Hard Requirements
1456
1457Compute 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).
1458
1459Enabling 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.
1460
1461Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1462
1463@subsubsection S3_8_2_cl_performance_requirements Performance improvements
1464
1465Integer 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.
1466
1467OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1468
1469SVM 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 +01001470
1471@subsection S3_9_cl_tuner OpenCL Tuner
1472
1473The 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).
1474The 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 +01001475The 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 +01001476In 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.
1477
1478If 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:
1479
1480https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1481
1482Tuning 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.
1483
1484CLTuner 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.
1485
1486 #Example: 2 unique Matrix Multiply configurations
1487@code{.cpp}
1488 TensorShape a0 = TensorShape(32,32);
1489 TensorShape b0 = TensorShape(32,32);
1490 TensorShape c0 = TensorShape(32,32);
1491 TensorShape a1 = TensorShape(64,64);
1492 TensorShape b1 = TensorShape(64,64);
1493 TensorShape c1 = TensorShape(64,64);
1494
1495 Tensor a0_tensor;
1496 Tensor b0_tensor;
1497 Tensor c0_tensor;
1498 Tensor a1_tensor;
1499 Tensor b1_tensor;
1500 Tensor c1_tensor;
1501
1502 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1503 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1504 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1505 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1506 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1507 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1508
1509 CLGEMM gemm0;
1510 CLGEMM gemm1;
1511
1512 // Configuration 0
1513 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1514
1515 // Configuration 1
1516 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1517@endcode
1518
1519@subsubsection S3_9_1_cl_tuner_how_to How to use it
1520
1521All 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
1522
1523 #Enable CL tuner
1524 ./graph_mobilenet --enable-tuner –-target=CL
1525 ./arm_compute_benchmark --enable-tuner
1526
1527 #Export/Import to/from a file
1528 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1529 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1530
1531If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1532
1533Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1534
1535 -# Disable the power management
1536 -# Keep the GPU frequency constant
1537 -# Run multiple times the network (i.e. 10).
1538
1539If 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.
1540
1541@code{.cpp}
1542CLTuner tuner;
1543
1544// Setup Scheduler
1545CLScheduler::get().default_init(&tuner);
1546@endcode
1547
1548After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1549- tuner.save_to_file("results.csv");
1550
1551This file can be also imported using the method "load_from_file("results.csv")".
1552- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001553*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001554} // namespace arm_compute