blob: b3772274cd7774c1f4149d2d47d7260be1899bb4 [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 Giorgioa046e162019-10-08 09:36:26 +0100249v19.11 Public major release
SiCong Lica1f98c2019-11-28 11:06:11 +0000250 - Various bug fixes.
251 - Various optimisations.
SiCong Li1f7f9882019-11-28 14:59:35 +0000252 - Updated recommended NDK version to r17c.
SiCong Lica1f98c2019-11-28 11:06:11 +0000253 - Deprecated OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100254 - CLDepthwiseConvolutionLayerReshapeWeightsGenericKernel
255 - CLDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000256 - CLDepthwiseSeparableConvolutionLayer
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100257 - CLDepthwiseVectorToTensorKernel
258 - CLDirectConvolutionLayerOutputStageKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000259 - Deprecated NEON kernels / functions:
Giorgio Arenad93e2632019-10-15 11:09:33 +0100260 - NEDepthwiseWeightsReshapeKernel
261 - NEDepthwiseIm2ColKernel
SiCong Lica1f98c2019-11-28 11:06:11 +0000262 - NEDepthwiseSeparableConvolutionLayer
Giorgio Arenad93e2632019-10-15 11:09:33 +0100263 - NEDepthwiseVectorToTensorKernel
Manuel Bottini05069f02019-09-26 17:18:26 +0100264 - NEDepthwiseConvolutionLayer3x3
SiCong Lica1f98c2019-11-28 11:06:11 +0000265 - New OpenCL kernels / functions:
266 - @ref CLInstanceNormalizationLayerKernel / @ref CLInstanceNormalizationLayer
267 - @ref CLDepthwiseConvolutionLayerNativeKernel to replace the old generic depthwise convolution (see Deprecated
268 OpenCL kernels / functions)
269 - @ref CLLogSoftmaxLayer
270 - New NEON kernels / functions:
271 - @ref NEBoundingBoxTransformKernel / @ref NEBoundingBoxTransform
272 - @ref NEComputeAllAnchorsKernel / @ref NEComputeAllAnchors
273 - @ref NEDetectionPostProcessLayer
274 - @ref NEGenerateProposalsLayer
275 - @ref NEInstanceNormalizationLayerKernel / @ref NEInstanceNormalizationLayer
276 - @ref NELogSoftmaxLayer
277 - @ref NEROIAlignLayerKernel / @ref NEROIAlignLayer
278 - Added QASYMM8 support for:
279 - @ref CLGenerateProposalsLayer
280 - @ref CLROIAlignLayer
281 - @ref CPPBoxWithNonMaximaSuppressionLimit
282 - Added QASYMM16 support for:
283 - @ref CLBoundingBoxTransform
284 - Added FP16 support for:
285 - @ref CLGEMMMatrixMultiplyReshapedKernel
286 - Added new data type QASYMM8_PER_CHANNEL support for:
287 - @ref CLDequantizationLayer
288 - @ref NEDequantizationLayer
289 - Added new data type QSYMM8_PER_CHANNEL support for:
290 - @ref CLConvolutionLayer
291 - @ref NEConvolutionLayer
292 - @ref CLDepthwiseConvolutionLayer
293 - @ref NEDepthwiseConvolutionLayer
294 - Added FP16 mixed-precision support for:
295 - @ref CLGEMMMatrixMultiplyReshapedKernel
296 - @ref CLPoolingLayerKernel
297 - Added FP32 and FP16 ELU activation for:
298 - @ref CLActivationLayer
299 - @ref NEActivationLayer
300 - Added asymmetric padding support for:
301 - @ref CLDirectDeconvolutionLayer
302 - @ref CLGEMMDeconvolutionLayer
303 - @ref NEDeconvolutionLayer
304 - Added SYMMETRIC and REFLECT modes for @ref CLPadLayerKernel / @ref CLPadLayer.
305 - Replaced the calls to @ref NECopyKernel and @ref NEMemsetKernel with @ref NEPadLayer in @ref NEGenerateProposalsLayer.
306 - Replaced the calls to @ref CLCopyKernel and @ref CLMemsetKernel with @ref CLPadLayer in @ref CLGenerateProposalsLayer.
307 - Improved performance for CL Inception V3 - FP16.
308 - Improved accuracy for CL Inception V3 - FP16 by enabling FP32 accumulator (mixed-precision).
309 - Improved NEON performance by enabling fusing batch normalization with convolution and depth-wise convolution layer.
310 - Improved NEON performance for MobileNet-SSD by improving the output detection performance.
311 - Optimized @ref CLPadLayer.
312 - Optimized CL generic depthwise convolution layer by introducing @ref CLDepthwiseConvolutionLayerNativeKernel.
313 - Reduced memory consumption by implementing weights sharing.
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100314
Georgios Pinitas3d13af82019-06-04 13:04:16 +0100315v19.08 Public major release
316 - Various bug fixes.
317 - Various optimisations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100318 - Deprecated NEON functions
319 - NEDepthConcatenateLayer
320 - NEWidthConcatenateLayer
321 - Deprecated OpenCL kernels / functions
322 - CLDepthConcatenateLayer
323 - CLGEMMInterleave4x4Kernel / CLGEMMInterleave4x4
324 - CLGEMMTranspose1xWKernel / CLGEMMTranspose1xW
325 - CLWidthConcatenateLayer
326 - New NEON kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100327 - @ref NEAbsLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100328 - @ref NECast
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100329 - @ref NEElementwisePower
330 - @ref NELogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100331 - @ref NELSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100332 - @ref NENegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100333 - @ref NEPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100334 - @ref NESinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100335 - @ref NEBatchConcatenateLayerKernel
336 - @ref NEDepthToSpaceLayerKernel / @ref NEDepthToSpaceLayer
337 - @ref NEDepthwiseConvolutionLayerNativeKernel
338 - @ref NEGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
339 - @ref NEMeanStdDevNormalizationKernel / @ref NEMeanStdDevNormalizationLayer
340 - @ref NESpaceToDepthLayerKernel / @ref NESpaceToDepthLayer
341 - New OpenCL kernels / functions:
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100342 - @ref CLAbsLayer
343 - @ref CLElementwisePower
344 - @ref CLLogLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100345 - @ref CLLSTMLayerQuantized
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100346 - @ref CLNegLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100347 - @ref CLPReluLayer
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100348 - @ref CLSinLayer
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100349 - @ref CLBatchConcatenateLayerKernel
350 - @ref CLDepthToSpaceLayerKernel / @ref CLDepthToSpaceLayer
351 - @ref CLGEMMLowpMatrixMultiplyNativeKernel
352 - @ref CLGEMMLowpQuantizeDownInt32ToInt16ScaleByFixedPointKernel
353 - @ref CLGEMMMatrixMultiplyNativeKernel
354 - @ref CLMeanStdDevNormalizationKernel / @ref CLMeanStdDevNormalizationLayer
355 - @ref CLSpaceToDepthLayerKernel / @ref CLSpaceToDepthLayer
356 - New examples:
357 - neon_opticalflow
358 - cl_cache
359 - neon_permute
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100360 - Added support for FP16 in @ref NEDeconvolutionLayer
361 - Added support for FP16 in @ref CLDeconvolutionLayer
362 - Added support for REDUCE_MIN and REDUCE_MAX in @ref ReductionOperation
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100363 - Enable the fusion of batch normalization with convolution and depthwise convolution layer for FP32 in the graph API (OpenCL only)
364 - Added support for fusing activation function and broadcast addition with the matrix multiplication for FP32 (OpenCL only)
365 - Re-factored the depthwise convolution layer kernel on NEON for generic cases
366 - Added an optimized depthwise convolution layer kernel for 5x5 filters (NEON only)
367 - Added support to enable OpenCL kernel cache. Added example showing how to load the prebuilt OpenCL kernels from a binary cache file
368 - Altered @ref QuantizationInfo interface to support per-channel quantization.
Manuel Bottini05069f02019-09-26 17:18:26 +0100369 - The @ref CLDepthwiseConvolutionLayer3x3 will be included by @ref CLDepthwiseConvolutionLayer to accommodate for future optimizations.
370 - The @ref NEDepthwiseConvolutionLayerOptimized will be included by @ref NEDepthwiseConvolutionLayer to accommodate for future optimizations.
Gian Marco Iodicecc2f54b2019-08-22 10:10:52 +0100371 - Removed inner_border_right and inner_border_top parameters from @ref CLDeconvolutionLayer interface
372 - Removed inner_border_right and inner_border_top parameters from @ref NEDeconvolutionLayer interface
Gian Marco Iodicec5f48ad2019-09-02 09:52:12 +0100373 - 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 +0100374
Michalis Spyroua9c44722019-04-05 17:18:36 +0100375v19.05 Public major release
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100376 - Various bug fixes.
377 - Various optimisations.
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100378 - New Neon kernels / functions:
379 - @ref NEBatchToSpaceLayerKernel / @ref NEBatchToSpaceLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100380 - @ref NEComplexPixelWiseMultiplicationKernel / @ref NEComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100381 - @ref NECropKernel / @ref NECropResize
Michalis Spyrouca82e622019-05-10 16:43:20 +0100382 - @ref NEDepthwiseConvolutionAssemblyDispatch
383 - @ref NEFFTDigitReverseKernel
384 - @ref NEFFTRadixStageKernel
385 - @ref NEFFTScaleKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100386 - @ref NEGEMMLowpOffsetContributionOutputStageKernel
387 - @ref NEHeightConcatenateLayerKernel
388 - @ref NESpaceToBatchLayerKernel / @ref NESpaceToBatchLayer
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100389 - @ref NEFFT1D
390 - @ref NEFFT2D
391 - @ref NEFFTConvolutionLayer
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100392 - New OpenCL kernels / functions:
Michalis Spyrouca82e622019-05-10 16:43:20 +0100393 - @ref CLComplexPixelWiseMultiplicationKernel / @ref CLComplexPixelWiseMultiplication
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100394 - @ref CLCropKernel / @ref CLCropResize
Michalis Spyroud7dd15c2019-05-30 14:53:58 +0100395 - @ref CLDeconvolutionReshapeOutputKernel
Georgios Pinitasf790fdb2019-04-24 12:41:25 +0100396 - @ref CLFFTDigitReverseKernel
397 - @ref CLFFTRadixStageKernel
398 - @ref CLFFTScaleKernel
399 - @ref CLGEMMLowpMatrixMultiplyReshapedOnlyRHSKernel
400 - @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
401 - @ref CLHeightConcatenateLayerKernel
402 - @ref CLDirectDeconvolutionLayer
403 - @ref CLFFT1D
404 - @ref CLFFT2D
405 - @ref CLFFTConvolutionLayer
Michalis Spyrouca82e622019-05-10 16:43:20 +0100406 - @ref CLGEMMDeconvolutionLayer
407 - New OpenGLES kernels / functions:
408 - @ref GCConcatenateLayer
Michalis Spyroua9c44722019-04-05 17:18:36 +0100409 - Deprecated functions/interfaces
Georgios Pinitas09f24972019-05-17 18:14:40 +0100410 - GCDepthConcatenateLayer
411 - NEWidthConcatenateLayer
412 - NEDepthConcatenateLayer
413 - CLWidthConcatenateLayer
414 - CLDepthConcatenateLayer
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100415 - CLGEMMInterleave4x4
416 - CLGEMMTranspose1xW
Michalis Spyrouc6608ac2019-05-16 17:40:23 +0100417 - Support different quantization info in CLConcatLayer.
418 - Add checks on different input/output quantization info were not supported.
419 - Tensors have different quantization information.
420 - Add FP16 support checks.
421 - Fix output quantization CLDeptwiseConv3x3 when activation is fused.
422 - New graph examples:
423 - graph_convolution
424 - graph_fully_connected
425 - graph_depthwise_convolution
426 - Deepspeech v0.4.1
427 - Add support for QASYMM8 in NEArithmeticSubtractionKernel.
428 - Add support for QASYMM8 in NEPixelWiseMultiplicationKernel.
429 - Add support for QASYMM8 NEDeconvolution.
430 - Add support for DequantizationLayer for NEON/CL.
431 - Add support for dilation in CLDepthwiseConvolution.
432 - Fuse offset contribution with the output stage when we use NEGEMMLowpMatrixMultiplyCore.
433 - Optimize CLDeconvolution.
434 - Add StackLayer to the graph API.
435 - Add support for "reflect" padding mode in NEPad.
436 - Winograd 7x7 NHWC on OpenCL.
437 - Rework CL ML layers to run exclusively on CL.
438 - Support different quantization info in PoolingLayer.
439 - Implement and test import memory interfaces.
440 - Added new tests and removed old ones.
441 - Various clang-tidy fixes.
Michalis Spyroua9c44722019-04-05 17:18:36 +0100442
giuros01a69a88b2019-01-31 16:29:19 +0000443v19.02 Public major release
Isabella Gottardi62538972019-02-12 19:52:44 +0000444 - Various bug fixes.
445 - Various optimisations.
446 - New Neon kernels / functions:
447 - @ref NETileKernel / @ref NETile
448 - @ref NEFuseBatchNormalizationKernel / @ref NEFuseBatchNormalization
449 - @ref NEElementwiseOperationKernel
450 - @ref NEElementwiseMax
451 - @ref NEElementwiseMin
452 - @ref NEElementwiseSquaredDiff
453 - @ref NESelectKernel / @ref NESelect
454 - @ref NESplit
455 - @ref NESlice
456 - @ref NEUnstack
457 - @ref NEStridedSliceKernel / @ref NEStridedSlice
458 - @ref NEElementwiseUnaryKernel
459 - @ref NERsqrtLayer
460 - @ref NEExpLayer
461 - @ref NEReverseKernel / @ref NEReverse
462 - @ref NEArgMinMaxLayer
463 - @ref NEStackLayerKernel / @ref NEStackLayer
464 - @ref NERangeKernel / @ref NERange
465 - @ref NEPadLayer
466 - @ref NEMemsetKernel
467 - @ref NEGatherKernel / @ref NEGather
468 - @ref NEElementwiseComparison
469 - @ref NEElementwiseComparisonStatic
470 - @ref NEComparisonOperationKernel
471 - @ref NEElementwiseDivision
472 - New OpenCL kernels / functions:
473 - @ref CLSelectKernel / @ref CLSelect
474 - @ref CLTileKernel / @ref CLTile
475 - @ref CLComparisonKernel / @ref CLComparison
476 - @ref CLArgMinMaxLayer
477 - @ref CLElementwiseMax
478 - @ref CLElementwiseMin
479 - @ref CLElementwiseSquaredDiff
480 - @ref CLStackLayerKernel / @ref CLStackLayer
481 - @ref CLReverse / @ref CLReverseKernel
482 - @ref CLRsqrtLayer
483 - @ref CLExpLayer
484 - @ref CLElementWiseUnaryLayerKernel
485 - @ref CLGEMMReshapeLHSMatrixKernel
486 - @ref CLGEMMReshapeRHSMatrixKernel
487 - @ref CLGEMMMatrixMultiplyReshapedKernel
488 - @ref CLRangeKernel / @ref CLRange
489 - @ref CLUnstack
490 - @ref CLGatherKernel / @ref CLGather
491 - @ref CLGEMMLowpMatrixMultiplyReshapedKernel
492 - New CPP kernels / functions:
493 - @ref CPPDetectionOutputLayer
494 - @ref CPPTopKV / @ref CPPTopKVKernel
Isabella Gottardi62538972019-02-12 19:52:44 +0000495 - Added new examples:
496 - graph_ssd_mobilenet.cpp
497 - graph_mobilenet_v2.cpp
498 - graph_resnet12.cpp
499 - graph_srcnn955.cpp
500 - graph_vgg_vdsr.cpp
501 - graph_inception_resnet_v1.cpp
502 - Add 4D tensors support to
503 - @ref NESoftmaxLayer
504 - Fused activation in @ref CLWinogradConvolutionLayer
505 - Extented @ref NEPermute to support more cases
506 - Added NEON/SVE GEMM Hybrid kernels
507 - Added u8 and s8 hybrid assembly kernels
508 - Introduced GEMM strategy name in NEGEMMAssemblyWrapper
509 - Improved @ref CLTuner
510 - Fused the bias addition within @ref CLGEMM
511 - Added support for QASYMM8 LOGISTIC activation in @ref NEActivationLayer
512 - Added NHWC data layout support to:
513 - @ref NEScale for F16
514 - @ref CLNormalizationLayer IN_MAP_2D for FP32/FP16
515 - @ref NEL2NormalizeLayer for FP32/FP16
516 - @ref NENormalizationLayer IN_MAP_2D for FP32/FP16
517 - @ref CLROIAlignLayer
Manuel Bottini5209be52019-02-13 16:34:56 +0000518 - @ref CLGenerateProposalsLayer
Isabella Gottardi62538972019-02-12 19:52:44 +0000519 - Added QASYMM8 support to the following kernels:
520 - @ref NEArithmeticAdditionKernel
521 - @ref NEScale
522 - Added new tests and improved validation and benchmarking suites.
giuros01a69a88b2019-01-31 16:29:19 +0000523 - Deprecated functions/interfaces
524 - Usage of inner_border_right and inner_border_top has been deprecated in @ref CLDeconvolutionLayer and @ref NEDeconvolutionLayer
525
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000526v18.11 Public major release
527 - Various bug fixes.
528 - Various optimisations.
529 - New Neon kernels / functions:
530 - @ref NEChannelShuffleLayer / @ref NEChannelShuffleLayerKernel
531 - @ref NEReduceMean
532 - @ref NEReorgLayer / @ref NEReorgLayerKernel
533 - @ref NEPriorBoxLayer / @ref NEPriorBoxLayerKernel
534 - @ref NEUpsampleLayer / @ref NEUpsampleLayerKernel
535 - @ref NEYOLOLayer / @ref NEYOLOLayerKernel
536 - New OpenCL kernels / functions:
537 - @ref CLBatchToSpaceLayer / @ref CLBatchToSpaceLayerKernel
538 - @ref CLBoundingBoxTransform / @ref CLBoundingBoxTransformKernel
Manuel Bottini5209be52019-02-13 16:34:56 +0000539 - @ref CLComputeAllAnchorsKernel
540 - @ref CLGenerateProposalsLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000541 - @ref CLNormalizePlanarYUVLayer / @ref CLNormalizePlanarYUVLayerKernel
542 - @ref CLReorgLayer / @ref CLReorgLayerKernel
543 - @ref CLSpaceToBatchLayer / @ref CLSpaceToBatchLayerKernel
544 - @ref CLPadLayer
545 - @ref CLReduceMean
546 - @ref CLPriorBoxLayer / @ref CLPriorBoxLayerKernel
547 - @ref CLROIAlignLayer / @ref CLROIAlignLayerKernel
548 - @ref CLSlice
549 - @ref CLSplit
550 - @ref CLStridedSlice / @ref CLStridedSliceKernel
551 - @ref CLUpsampleLayer / @ref CLUpsampleLayerKernel
552 - @ref CLYOLOLayer / @ref CLYOLOLayerKernel
553 - New CPP kernels / functions:
554 - @ref CPPBoxWithNonMaximaSuppressionLimit / @ref CPPBoxWithNonMaximaSuppressionLimitKernel
555 - Added the validate method in:
556 - @ref NEDepthConvertLayer
557 - @ref NEFloor / @ref CLFloor
558 - @ref NEGEMMMatrixAdditionKernel
559 - @ref NEReshapeLayer / @ref CLReshapeLayer
560 - @ref CLScale
561 - Added new examples:
562 - graph_shufflenet.cpp
563 - graph_yolov3.cpp
564 - Added documentation for add a new function or kernel.
565 - Improved doxygen documentation adding a list of the existing functions.
566 - Add 4D tensors support to
Georgios Pinitas09f24972019-05-17 18:14:40 +0100567 - CLWidthConcatenateLayer
Isabella Gottardi8773d7c2018-11-20 09:56:46 +0000568 - @ref CLFlattenLayer
569 - @ref CLSoftmaxLayer
570 - Add dot product support for @ref CLDepthwiseConvolutionLayer3x3NHWCKernel non-unit stride
571 - Add SVE support
572 - Fused batch normalization into convolution layer weights in @ref CLFuseBatchNormalization
573 - Fuses activation in @ref CLDepthwiseConvolutionLayer3x3NCHWKernel, @ref CLDepthwiseConvolutionLayer3x3NHWCKernel and @ref NEGEMMConvolutionLayer
574 - Added NHWC data layout support to:
575 - @ref CLChannelShuffleLayer
576 - @ref CLDeconvolutionLayer
577 - @ref CLL2NormalizeLayer
578 - Added QASYMM8 support to the following kernels:
579 - @ref CLScaleKernel
580 - @ref NEDepthwiseConvolutionLayer3x3Kernel
581 - @ref CLPixelWiseMultiplicationKernel
582 - Added FP16 support to the following kernels:
583 - @ref CLDepthwiseConvolutionLayer3x3NHWCKernel
584 - @ref NEDepthwiseConvolutionLayer3x3Kernel
585 - @ref CLNormalizePlanarYUVLayerKernel
586 - @ref CLWinogradConvolutionLayer (5x5 kernel)
587 - More tests added to both validation and benchmarking suites.
588
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100589v18.08 Public major release
590 - Various bug fixes.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100591 - Various optimisations.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100592 - Updated recommended NDK version to r17b.
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100593 - Removed support for QS8/QS16 data types.
594 - Added support for grouped convolution in @ref CLConvolutionLayer.
595 - Added NHWC data layout support to:
Georgios Pinitas09f24972019-05-17 18:14:40 +0100596 - NEDepthConcatenateLayer / CLDepthConcatenateLayer
Michele Di Giorgio02baf012018-08-20 18:10:38 +0100597 - @ref NEWinogradConvolutionLayer / @ref CLWinogradConvolutionLayer
598 - @ref CLDepthwiseConvolutionLayer
599 - @ref CLDirectConvolutionLayer
600 - @ref CLConvolutionLayer
601 - @ref CLScale
602 - @ref CLIm2ColKernel
603 - New Neon kernels / functions:
604 - @ref NERNNLayer
605 - New OpenCL kernels / functions:
606 - @ref CLArithmeticDivision
607 - Introduced prepare() stage support in the graph API for GLES.
608 - Added support for memory reusage when trying to allocate smaller CLTensors.
609 - Enabled NHWC execution on graph examples.
610 - Added JPEG accessor for validation purposes.
611 - Added validate methods to some kernels / functions.
Anthony Barbierd51ea0a2018-08-07 17:48:03 +0100612
613v18.05 Public major release
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100614 - Various bug fixes.
615 - Various optimisations.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000616 - Major redesign in the interface for the neon kernels implemented in assembly.
617 - Removed arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore / arm_compute::NEHGEMMAArch64FP16Kernel
618 - Added NEGEMMAssemblyWrapper and AssemblyKernelGlue which are used to execute assembly kernels in neon functions.
619 - Minor changes to the CPUInfo type to make it compatible with the new assembly gemm interface.
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100620 - Moved neon assembly kernels to the folder src/core/NEON/kernels/arm_gemm.
621 - Improved doxygen documentation.
622 - Improved memory management for layer's transitions.
623 - Added support for NHWC data layout in tensors.
624 - Added NHWC data layout support to:
625 - @ref NEGEMMConvolutionLayer
626 - @ref NEDirectConvolutionLayer
627 - @ref NEPoolingLayer / @ref CLPoolingLayer
628 - @ref NEBatchNormalizationLayer / @ref CLBatchNormalizationLayer
629 - @ref NEDepthwiseConvolutionLayer
630 - @ref NEScale
631 - @ref NEIm2Col
632 - Added support for dilated convolutions in @ref NEConvolutionLayer and @ref CLConvolutionLayer.
633 - New OpenCL kernels / functions:
634 - @ref CLChannelShuffleLayer / @ref CLChannelShuffleLayerKernel
635 - @ref CLConvertFullyConnectedWeightsKernel / @ref CLConvertFullyConnectedWeights
636 - @ref CLCopy / @ref CLCopyKernel
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100637 - @ref CLLSTMLayer
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100638 - @ref CLRNNLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100639 - CLWidthConcatenateLayer / @ref CLWidthConcatenateLayerKernel
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100640 - @ref CLWinogradFilterTransformKernel / @ref CLWinogradInputTransformKernel / @ref CLWinogradConvolutionLayer
641 - @ref CLWinogradInputTransformKernel / @ref CLWinogradInputTransform
642 - New Neon kernels / functions:
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100643 - @ref NEConvertFullyConnectedWeightsKernel / @ref NEConvertFullyConnectedWeights.
644 - Created the validate method in @ref CLDepthwiseConvolutionLayer.
645 - Beta and gamma are no longer mandatory arguments in @ref NEBatchNormalizationLayer and @ref CLBatchNormalizationLayer.
646 - Added depth multiplier support in @ref NEDepthwiseConvolutionLayer and @ref CLDepthwiseConvolutionLayer.
647 - Added broadcast multiply support in @ref NEPixelWiseMultiplication / @ref NEPixelWiseMultiplicationKernel.
648 - Port mobilenet example to NHWC data layout.
649 - Enabled Winograd method in @ref CLConvolutionLayer.
650 - Renamed NEWinogradLayer to @ref NEWinogradConvolutionLayer.
651 - Updated @ref NEWinogradConvolutionLayer to use highly optimised assembly kernels in src/core/NEON/kernels/arm_gemm.
652 - Added memory manager support in GLES functions.
653 - Major refactoring of the graph API.
654 - Added GLES backend in the graph API.
655 - Added support for the memory manager in the graph API.
656 - Enabled Winograd Convolution method in the graph API.
657 - Added support for grouped convolutions in the graph API.
658 - Replaced NEDeconvolutionLayerUpsampleKernel with @ref NEScaleKernel in @ref NEDeconvolutionLayer.
659 - Added fast maths flag in @ref CLConvolutionLayer.
660 - Added new tests and benchmarks in validation and benchmark frameworks
661 - Merge Activation layer with Convolution Layer (NEON. CL, GLES)
662 - Added support to OpenCL 2.0 SVM
663 - Added support to import memory in OpenCL tensors.
664 - Added the prepare() method to perform any one off pre-processing before running the function.
665 - Added new examples:
666 - graph_inception_v4.cpp
Anthony Barbier38e7f1f2018-05-21 13:37:47 +0100667 - graph_resnext50.cpp
Pablo Tellob5cc95b2018-05-15 11:49:33 +0100668 - Added memory measurement instrument for CL.
Pablo Telloeb82fd22018-02-23 13:43:50 +0000669
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000670v18.03 Public maintenance release
671 - Various bug fixes.
Anthony Barbier3762e742018-03-02 11:49:33 +0000672 - Fixed bug in @ref NEActivationLayer
673 - Fix in @ref CLTuner when using batches.
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000674 - Updated recommended NDK version to r16b (And fixed warnings).
675 - Fixed bug in validation code.
676 - Added Inception v4 graph example.
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100677 - Renamed NEWinogradLayer.cpp to @ref NEWinogradConvolutionLayer
Anthony Barbier577fbdf2018-03-01 15:17:54 +0000678
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000679v18.02 Public major release
680 - Various NEON / OpenCL / GLES optimisations.
681 - Various bug fixes.
682 - Changed default number of threads on big LITTLE systems.
683 - Refactored examples and added:
684 - graph_mobilenet_qassym8
685 - graph_resnet
686 - graph_squeezenet_v1_1
Anthony Barbier3762e742018-03-02 11:49:33 +0000687 - Renamed @ref CLConvolutionLayer into @ref CLGEMMConvolutionLayer and created a new @ref CLConvolutionLayer to select the fastest convolution method.
688 - 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 +0000689 - Added in place support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000690 - @ref CLActivationLayer
691 - @ref CLBatchNormalizationLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000692 - Added QASYMM8 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000693 - @ref CLActivationLayer
694 - @ref CLDepthwiseConvolutionLayer
695 - @ref NEDepthwiseConvolutionLayer
696 - @ref NESoftmaxLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000697 - Added FP16 support to:
Anthony Barbier3762e742018-03-02 11:49:33 +0000698 - @ref CLDepthwiseConvolutionLayer3x3
699 - @ref CLDepthwiseConvolutionLayer
700 - Added broadcasting support to @ref NEArithmeticAddition / @ref CLArithmeticAddition / @ref CLPixelWiseMultiplication
701 - Added fused batched normalization and activation to @ref CLBatchNormalizationLayer and @ref NEBatchNormalizationLayer
702 - Added support for non-square pooling to @ref NEPoolingLayer and @ref CLPoolingLayer
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000703 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100704 - CLDirectConvolutionLayerOutputStageKernel
Pablo Tellof6c572c2018-02-14 12:47:30 +0000705 - New NEON kernels / functions
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000706 - Added name() method to all kernels.
707 - Added support for Winograd 5x5.
Anthony Barbier3762e742018-03-02 11:49:33 +0000708 - @ref NEPermuteKernel / @ref NEPermute
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100709 - @ref NEWinogradLayerTransformInputKernel / NEWinogradLayer
710 - @ref NEWinogradLayerTransformOutputKernel / NEWinogradLayer
711 - @ref NEWinogradLayerTransformWeightsKernel / NEWinogradLayer
Anthony Barbiere1553372018-07-16 18:53:52 +0100712 - Renamed NEWinogradLayerKernel into NEWinogradLayerBatchedGEMMKernel
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000713 - New GLES kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000714 - @ref GCTensorShiftKernel / @ref GCTensorShift
Pablo Tellof6c572c2018-02-14 12:47:30 +0000715
Anthony Barbier64c95a02018-01-22 18:48:55 +0000716v18.01 Public maintenance release
717 - Various bug fixes
718 - Added some of the missing validate() methods
Anthony Barbier3762e742018-03-02 11:49:33 +0000719 - Added @ref CLDeconvolutionLayerUpsampleKernel / @ref CLDeconvolutionLayer @ref CLDeconvolutionLayerUpsample
720 - Added @ref CLPermuteKernel / @ref CLPermute
Anthony Barbier64c95a02018-01-22 18:48:55 +0000721 - Added method to clean the programs cache in the CL Kernel library.
Anthony Barbier3762e742018-03-02 11:49:33 +0000722 - Added @ref GCArithmeticAdditionKernel / @ref GCArithmeticAddition
723 - Added @ref GCDepthwiseConvolutionLayer3x3Kernel / @ref GCDepthwiseConvolutionLayer3x3
724 - Added @ref GCNormalizePlanarYUVLayerKernel / @ref GCNormalizePlanarYUVLayer
725 - Added @ref GCScaleKernel / @ref GCScale
726 - Added @ref GCWeightsReshapeKernel / @ref GCConvolutionLayer
Anthony Barbier64c95a02018-01-22 18:48:55 +0000727 - Added FP16 support to the following GLES compute kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000728 - @ref GCCol2ImKernel
729 - @ref GCGEMMInterleave4x4Kernel
730 - @ref GCGEMMTranspose1xWKernel
731 - @ref GCIm2ColKernel
732 - Refactored NEON Winograd (NEWinogradLayerKernel)
733 - Added @ref NEDirectConvolutionLayerOutputStageKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000734 - Added QASYMM8 support to the following NEON kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000735 - @ref NEDepthwiseConvolutionLayer3x3Kernel
736 - @ref NEFillBorderKernel
737 - @ref NEPoolingLayerKernel
Anthony Barbier64c95a02018-01-22 18:48:55 +0000738 - Added new examples:
739 - graph_cl_mobilenet_qasymm8.cpp
740 - graph_inception_v3.cpp
741 - gc_dc.cpp
742 - More tests added to both validation and benchmarking suites.
743
Gian Marcoff850932017-12-11 12:37:17 +0000744v17.12 Public major release
745 - Most machine learning functions on OpenCL support the new data type QASYMM8
746 - Introduced logging interface
747 - Introduced opencl timer
748 - Reworked GEMMLowp interface
749 - Added new NEON assembly kernels for GEMMLowp, SGEMM and HGEMM
750 - Added validation method for most Machine Learning kernels / functions
751 - Added new graph examples such as googlenet, mobilenet, squeezenet, vgg16 and vgg19
752 - Added sgemm example for OpenCL
753 - Added absolute difference example for GLES compute
754 - Added new tests and benchmarks in validation and benchmark frameworks
755 - Added new kernels / functions for GLES compute
756
757 - New OpenGL ES kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000758 - @ref GCAbsoluteDifferenceKernel / @ref GCAbsoluteDifference
759 - @ref GCActivationLayerKernel / @ref GCActivationLayer
760 - @ref GCBatchNormalizationLayerKernel / @ref GCBatchNormalizationLayer
761 - @ref GCCol2ImKernel
Georgios Pinitas09f24972019-05-17 18:14:40 +0100762 - @ref GCDepthConcatenateLayerKernel / GCDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000763 - @ref GCDirectConvolutionLayerKernel / @ref GCDirectConvolutionLayer
764 - @ref GCDropoutLayerKernel / @ref GCDropoutLayer
765 - @ref GCFillBorderKernel / @ref GCFillBorder
766 - @ref GCGEMMInterleave4x4Kernel / @ref GCGEMMInterleave4x4
767 - @ref GCGEMMMatrixAccumulateBiasesKernel / @ref GCGEMMMatrixAdditionKernel / @ref GCGEMMMatrixMultiplyKernel / @ref GCGEMM
768 - @ref GCGEMMTranspose1xWKernel / @ref GCGEMMTranspose1xW
769 - @ref GCIm2ColKernel
770 - @ref GCNormalizationLayerKernel / @ref GCNormalizationLayer
771 - @ref GCPixelWiseMultiplicationKernel / @ref GCPixelWiseMultiplication
772 - @ref GCPoolingLayerKernel / @ref GCPoolingLayer
773 - @ref GCLogits1DMaxKernel / @ref GCLogits1DShiftExpSumKernel / @ref GCLogits1DNormKernel / @ref GCSoftmaxLayer
774 - @ref GCTransposeKernel / @ref GCTranspose
Gian Marcoff850932017-12-11 12:37:17 +0000775
776 - New NEON kernels / functions
Pablo Telloeb82fd22018-02-23 13:43:50 +0000777 - arm_compute::NEGEMMLowpAArch64A53Kernel / arm_compute::NEGEMMLowpAArch64Kernel / arm_compute::NEGEMMLowpAArch64V8P4Kernel / arm_compute::NEGEMMInterleavedBlockedKernel / arm_compute::NEGEMMLowpAssemblyMatrixMultiplyCore
778 - arm_compute::NEHGEMMAArch64FP16Kernel
Giorgio Arenad93e2632019-10-15 11:09:33 +0100779 - @ref NEDepthwiseConvolutionLayer3x3Kernel / NEDepthwiseIm2ColKernel / @ref NEGEMMMatrixVectorMultiplyKernel / NEDepthwiseVectorToTensorKernel / @ref NEDepthwiseConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000780 - @ref NEGEMMLowpOffsetContributionKernel / @ref NEGEMMLowpMatrixAReductionKernel / @ref NEGEMMLowpMatrixBReductionKernel / @ref NEGEMMLowpMatrixMultiplyCore
781 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
782 - @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel / @ref NEGEMMLowpQuantizeDownInt32ToUint8Scale
Georgios Pinitas9fb11592018-04-26 20:34:58 +0100783 - NEWinogradLayer / NEWinogradLayerKernel
Gian Marcoff850932017-12-11 12:37:17 +0000784
785 - New OpenCL kernels / functions
Anthony Barbier3762e742018-03-02 11:49:33 +0000786 - @ref CLGEMMLowpOffsetContributionKernel / @ref CLGEMMLowpMatrixAReductionKernel / @ref CLGEMMLowpMatrixBReductionKernel / @ref CLGEMMLowpMatrixMultiplyCore
787 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPointKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleByFixedPoint
788 - @ref CLGEMMLowpQuantizeDownInt32ToUint8ScaleKernel / @ref CLGEMMLowpQuantizeDownInt32ToUint8Scale
Gian Marcoff850932017-12-11 12:37:17 +0000789
790 - New graph nodes for NEON and OpenCL
Georgios Pinitasd9eb2752018-04-03 13:44:29 +0100791 - graph::BranchLayer
792 - graph::DepthConvertLayer
793 - graph::DepthwiseConvolutionLayer
794 - graph::DequantizationLayer
795 - graph::FlattenLayer
796 - graph::QuantizationLayer
797 - graph::ReshapeLayer
Gian Marcoff850932017-12-11 12:37:17 +0000798
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100799v17.10 Public maintenance release
800 - Bug fixes:
801 - Check the maximum local workgroup size supported by OpenCL devices
802 - Minor documentation updates (Fixed instructions to build the examples)
Anthony Barbier3762e742018-03-02 11:49:33 +0000803 - Introduced a graph::GraphContext
Anthony Barbier3c5b4ff2017-10-12 13:20:52 +0100804 - Added a few new Graph nodes, support for branches and grouping.
805 - Automatically enable cl_printf in debug builds
806 - Fixed bare metal builds for armv7a
807 - Added AlexNet and cartoon effect examples
808 - 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)
809
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100810v17.09 Public major release
811 - Experimental Graph support: initial implementation of a simple stream API to easily chain machine learning layers.
Anthony Barbier3762e742018-03-02 11:49:33 +0000812 - 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 +0100813 - New validation and benchmark frameworks (Boost and Google frameworks replaced by homemade framework).
814 - Most machine learning functions support both fixed point 8 and 16 bit (QS8, QS16) for both NEON and OpenCL.
815 - New NEON kernels / functions:
Pablo Telloeb82fd22018-02-23 13:43:50 +0000816 - arm_compute::NEGEMMAssemblyBaseKernel arm_compute::NEGEMMAArch64Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000817 - @ref NEDequantizationLayerKernel / @ref NEDequantizationLayer
818 - @ref NEFloorKernel / @ref NEFloor
819 - @ref NEL2NormalizeLayerKernel / @ref NEL2NormalizeLayer
820 - @ref NEQuantizationLayerKernel @ref NEMinMaxLayerKernel / @ref NEQuantizationLayer
821 - @ref NEROIPoolingLayerKernel / @ref NEROIPoolingLayer
822 - @ref NEReductionOperationKernel / @ref NEReductionOperation
823 - @ref NEReshapeLayerKernel / @ref NEReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100824
825 - New OpenCL kernels / functions:
Michele Di Giorgioa046e162019-10-08 09:36:26 +0100826 - @ref CLDepthwiseConvolutionLayer3x3NCHWKernel @ref CLDepthwiseConvolutionLayer3x3NHWCKernel CLDepthwiseIm2ColKernel CLDepthwiseVectorToTensorKernel CLDepthwiseWeightsReshapeKernel / @ref CLDepthwiseConvolutionLayer3x3 @ref CLDepthwiseConvolutionLayer CLDepthwiseSeparableConvolutionLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000827 - @ref CLDequantizationLayerKernel / @ref CLDequantizationLayer
828 - @ref CLDirectConvolutionLayerKernel / @ref CLDirectConvolutionLayer
829 - @ref CLFlattenLayer
830 - @ref CLFloorKernel / @ref CLFloor
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +0100831 - CLGEMMTranspose1xW
Anthony Barbier3762e742018-03-02 11:49:33 +0000832 - @ref CLGEMMMatrixVectorMultiplyKernel
833 - @ref CLL2NormalizeLayerKernel / @ref CLL2NormalizeLayer
834 - @ref CLQuantizationLayerKernel @ref CLMinMaxLayerKernel / @ref CLQuantizationLayer
835 - @ref CLROIPoolingLayerKernel / @ref CLROIPoolingLayer
836 - @ref CLReductionOperationKernel / @ref CLReductionOperation
837 - @ref CLReshapeLayerKernel / @ref CLReshapeLayer
Anthony Barbier6a5627a2017-09-26 14:42:02 +0100838
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100839v17.06 Public major release
840 - Various bug fixes
841 - Added support for fixed point 8 bit (QS8) to the various NEON machine learning kernels.
842 - Added unit tests and benchmarks (AlexNet, LeNet)
843 - Added support for sub tensors.
844 - Added infrastructure to provide GPU specific optimisation for some OpenCL kernels.
Anthony Barbier3762e742018-03-02 11:49:33 +0000845 - Added @ref OMPScheduler (OpenMP) scheduler for NEON
846 - Added @ref SingleThreadScheduler scheduler for NEON (For bare metal)
847 - User can specify his own scheduler by implementing the @ref IScheduler interface.
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100848 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000849 - @ref CLBatchNormalizationLayerKernel / @ref CLBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100850 - @ref CLDepthConcatenateLayerKernel / CLDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000851 - @ref CLHOGOrientationBinningKernel @ref CLHOGBlockNormalizationKernel, @ref CLHOGDetectorKernel / @ref CLHOGDescriptor @ref CLHOGDetector @ref CLHOGGradient @ref CLHOGMultiDetection
852 - @ref CLLocallyConnectedMatrixMultiplyKernel / @ref CLLocallyConnectedLayer
853 - @ref CLWeightsReshapeKernel / @ref CLConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100854 - New C++ kernels:
Anthony Barbier3762e742018-03-02 11:49:33 +0000855 - @ref CPPDetectionWindowNonMaximaSuppressionKernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100856 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000857 - @ref NEBatchNormalizationLayerKernel / @ref NEBatchNormalizationLayer
Georgios Pinitas09f24972019-05-17 18:14:40 +0100858 - @ref NEDepthConcatenateLayerKernel / NEDepthConcatenateLayer
Anthony Barbier3762e742018-03-02 11:49:33 +0000859 - @ref NEDirectConvolutionLayerKernel / @ref NEDirectConvolutionLayer
860 - @ref NELocallyConnectedMatrixMultiplyKernel / @ref NELocallyConnectedLayer
861 - @ref NEWeightsReshapeKernel / @ref NEConvolutionLayerReshapeWeights
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100862
863v17.05 Public bug fixes release
864 - Various bug fixes
865 - Remaining of the functions ported to use accurate padding.
866 - Library does not link against OpenCL anymore (It uses dlopen / dlsym at runtime instead to determine whether or not OpenCL is available).
867 - Added "free" method to allocator.
868 - Minimum version of g++ required for armv7 Linux changed from 4.8 to 4.9
869
870v17.04 Public bug fixes release
871
872 The following functions have been ported to use the new accurate padding:
Anthony Barbier3762e742018-03-02 11:49:33 +0000873 - @ref CLColorConvertKernel
874 - @ref CLEdgeNonMaxSuppressionKernel
875 - @ref CLEdgeTraceKernel
876 - @ref CLGaussianPyramidHorKernel
877 - @ref CLGaussianPyramidVertKernel
878 - @ref CLGradientKernel
879 - @ref NEChannelCombineKernel
880 - @ref NEFillArrayKernel
881 - @ref NEGaussianPyramidHorKernel
882 - @ref NEGaussianPyramidVertKernel
Georgios Pinitas09d34512018-08-30 16:02:11 +0100883 - NEHarrisScoreFP16Kernel
Anthony Barbier3762e742018-03-02 11:49:33 +0000884 - @ref NEHarrisScoreKernel
885 - @ref NEHOGDetectorKernel
886 - @ref NELogits1DMaxKernel
887 - NELogits1DShiftExpSumKernel
888 - NELogits1DNormKernel
889 - @ref NENonMaximaSuppression3x3FP16Kernel
890 - @ref NENonMaximaSuppression3x3Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100891
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100892v17.03.1 First Major public release of the sources
893 - Renamed the library to arm_compute
894 - New CPP target introduced for C++ kernels shared between NEON and CL functions.
895 - New padding calculation interface introduced and ported most kernels / functions to use it.
896 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000897 - @ref CLGEMMLowpMatrixMultiplyKernel / CLGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100898 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000899 - @ref NENormalizationLayerKernel / @ref NENormalizationLayer
900 - @ref NETransposeKernel / @ref NETranspose
901 - @ref NELogits1DMaxKernel, NELogits1DShiftExpSumKernel, NELogits1DNormKernel / @ref NESoftmaxLayer
902 - @ref NEIm2ColKernel, @ref NECol2ImKernel, NEConvolutionLayerWeightsReshapeKernel / @ref NEConvolutionLayer
903 - @ref NEGEMMMatrixAccumulateBiasesKernel / @ref NEFullyConnectedLayer
904 - @ref NEGEMMLowpMatrixMultiplyKernel / NEGEMMLowp
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100905
906v17.03 Sources preview
907 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000908 - @ref CLGradientKernel, @ref CLEdgeNonMaxSuppressionKernel, @ref CLEdgeTraceKernel / @ref CLCannyEdge
Gian Marco Iodice57a89612019-08-22 14:10:27 +0100909 - GEMM refactoring + FP16 support: CLGEMMInterleave4x4Kernel, CLGEMMTranspose1xWKernel, @ref CLGEMMMatrixMultiplyKernel, CLGEMMMatrixAdditionKernel / @ref CLGEMM
Anthony Barbier3762e742018-03-02 11:49:33 +0000910 - @ref CLGEMMMatrixAccumulateBiasesKernel / @ref CLFullyConnectedLayer
911 - @ref CLTransposeKernel / @ref CLTranspose
912 - @ref CLLKTrackerInitKernel, @ref CLLKTrackerStage0Kernel, @ref CLLKTrackerStage1Kernel, @ref CLLKTrackerFinalizeKernel / @ref CLOpticalFlow
913 - @ref CLNormalizationLayerKernel / @ref CLNormalizationLayer
914 - @ref CLLaplacianPyramid, @ref CLLaplacianReconstruct
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100915 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000916 - @ref NEActivationLayerKernel / @ref NEActivationLayer
917 - GEMM refactoring + FP16 support (Requires armv8.2 CPU): @ref NEGEMMInterleave4x4Kernel, @ref NEGEMMTranspose1xWKernel, @ref NEGEMMMatrixMultiplyKernel, @ref NEGEMMMatrixAdditionKernel / @ref NEGEMM
918 - @ref NEPoolingLayerKernel / @ref NEPoolingLayer
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100919
920v17.02.1 Sources preview
921 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000922 - @ref CLLogits1DMaxKernel, @ref CLLogits1DShiftExpSumKernel, @ref CLLogits1DNormKernel / @ref CLSoftmaxLayer
923 - @ref CLPoolingLayerKernel / @ref CLPoolingLayer
924 - @ref CLIm2ColKernel, @ref CLCol2ImKernel, CLConvolutionLayerWeightsReshapeKernel / @ref CLConvolutionLayer
925 - @ref CLRemapKernel / @ref CLRemap
926 - @ref CLGaussianPyramidHorKernel, @ref CLGaussianPyramidVertKernel / @ref CLGaussianPyramid, @ref CLGaussianPyramidHalf, @ref CLGaussianPyramidOrb
927 - @ref CLMinMaxKernel, @ref CLMinMaxLocationKernel / @ref CLMinMaxLocation
928 - @ref CLNonLinearFilterKernel / @ref CLNonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100929 - New NEON FP16 kernels (Requires armv8.2 CPU)
Anthony Barbier3762e742018-03-02 11:49:33 +0000930 - @ref NEAccumulateWeightedFP16Kernel
931 - @ref NEBox3x3FP16Kernel
932 - @ref NENonMaximaSuppression3x3FP16Kernel
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100933
934v17.02 Sources preview
935 - New OpenCL kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000936 - @ref CLActivationLayerKernel / @ref CLActivationLayer
937 - @ref CLChannelCombineKernel / @ref CLChannelCombine
938 - @ref CLDerivativeKernel / @ref CLChannelExtract
939 - @ref CLFastCornersKernel / @ref CLFastCorners
940 - @ref CLMeanStdDevKernel / @ref CLMeanStdDev
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100941 - New NEON kernels / functions:
Anthony Barbier3762e742018-03-02 11:49:33 +0000942 - HOG / SVM: @ref NEHOGOrientationBinningKernel, @ref NEHOGBlockNormalizationKernel, @ref NEHOGDetectorKernel, NEHOGNonMaximaSuppressionKernel / @ref NEHOGDescriptor, @ref NEHOGDetector, @ref NEHOGGradient, @ref NEHOGMultiDetection
943 - @ref NENonLinearFilterKernel / @ref NENonLinearFilter
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100944 - Introduced a CLScheduler to manage the default context and command queue used by the runtime library and create synchronisation events.
945 - Switched all the kernels / functions to use tensors instead of images.
946 - Updated documentation to include instructions to build the library from sources.
947
948v16.12 Binary preview release
949 - Original release
950
951@section S3_how_to_build How to build the library and the examples
952
953@subsection S3_1_build_options Build options
954
955scons 2.3 or above is required to build the library.
956To see the build options available simply run ```scons -h```:
957
Anthony Barbier79c61782017-06-23 11:48:24 +0100958 debug: Debug (yes|no)
959 default: False
960 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100961
Anthony Barbier79c61782017-06-23 11:48:24 +0100962 asserts: Enable asserts (this flag is forced to 1 for debug=1) (yes|no)
963 default: False
964 actual: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100965
Anthony Barbier79c61782017-06-23 11:48:24 +0100966 arch: Target Architecture (armv7a|arm64-v8a|arm64-v8.2-a|x86_32|x86_64)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100967 default: armv7a
968 actual: armv7a
969
Anthony Barbier79c61782017-06-23 11:48:24 +0100970 os: Target OS (linux|android|bare_metal)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100971 default: linux
972 actual: linux
973
Anthony Barbier2d0ce772018-02-21 15:35:36 +0000974 build: Build type (native|cross_compile|embed_only)
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100975 default: cross_compile
976 actual: cross_compile
977
Anthony Barbier79c61782017-06-23 11:48:24 +0100978 examples: Build example programs (yes|no)
979 default: True
980 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100981
Anthony Barbier79c61782017-06-23 11:48:24 +0100982 Werror: Enable/disable the -Werror compilation flag (yes|no)
983 default: True
984 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100985
Anthony Barbier79c61782017-06-23 11:48:24 +0100986 opencl: Enable OpenCL support (yes|no)
987 default: True
988 actual: True
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100989
Anthony Barbier79c61782017-06-23 11:48:24 +0100990 neon: Enable Neon support (yes|no)
991 default: False
Anthony Barbier6ff3b192017-09-04 18:44:23 +0100992 actual: False
993
Anthony Barbier20dbb822017-12-13 21:19:39 +0000994 gles_compute: Enable OpenGL ES Compute Shader support (yes|no)
995 default: False
996 actual: False
997
998 embed_kernels: Embed OpenCL kernels and OpenGL ES compute shader in library binary (yes|no)
Anthony Barbiercc0a80b2017-12-15 11:37:29 +0000999 default: True
1000 actual: True
Anthony Barbier79c61782017-06-23 11:48:24 +01001001
1002 set_soname: Set the library's soname and shlibversion (requires SCons 2.4 or above) (yes|no)
1003 default: False
1004 actual: False
1005
1006 openmp: Enable OpenMP backend (yes|no)
1007 default: False
1008 actual: False
1009
1010 cppthreads: Enable C++11 threads backend (yes|no)
1011 default: True
1012 actual: True
1013
1014 build_dir: Specify sub-folder for the build ( /path/to/build_dir )
1015 default: .
1016 actual: .
1017
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001018 extra_cxx_flags: Extra CXX flags to be appended to the build command
1019 default:
1020 actual:
1021
Anthony Barbier79c61782017-06-23 11:48:24 +01001022 pmu: Enable PMU counters (yes|no)
1023 default: False
1024 actual: False
1025
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001026 mali: Enable Mali hardware counters (yes|no)
1027 default: False
1028 actual: False
1029
Anthony Barbier79c61782017-06-23 11:48:24 +01001030 validation_tests: Build validation test programs (yes|no)
1031 default: False
1032 actual: False
1033
1034 benchmark_tests: Build benchmark test programs (yes|no)
1035 default: False
1036 actual: False
1037
1038@b debug / @b asserts:
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001039 - With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
1040 - 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)
1041 - 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).
1042
Anthony Barbier79c61782017-06-23 11:48:24 +01001043@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 +01001044
Anthony Barbier79c61782017-06-23 11:48:24 +01001045@b os: Choose the operating system you are targeting: Linux, Android or bare metal.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001046@note bare metal can only be used for NEON (not OpenCL), only static libraries get built and NEON's multi-threading support is disabled.
1047
Anthony Barbier79c61782017-06-23 11:48:24 +01001048@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 +01001049
Anthony Barbier79c61782017-06-23 11:48:24 +01001050@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 +01001051
Anthony Barbier2d0ce772018-02-21 15:35:36 +00001052There 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.
1053
Anthony Barbier79c61782017-06-23 11:48:24 +01001054@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 +01001055
Anthony Barbier20dbb822017-12-13 21:19:39 +00001056@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 +01001057
Anthony Barbier20dbb822017-12-13 21:19:39 +00001058@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 +01001059
1060@b set_soname: Do you want to build the versioned version of the library ?
1061
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001062If enabled the library will contain a SONAME and SHLIBVERSION and some symlinks will automatically be created between the objects.
1063Example:
1064 libarm_compute_core.so -> libarm_compute_core.so.1.0.0
1065 libarm_compute_core.so.1 -> libarm_compute_core.so.1.0.0
1066 libarm_compute_core.so.1.0.0
1067
1068@note This options is disabled by default as it requires SCons version 2.4 or above.
1069
Anthony Barbier79c61782017-06-23 11:48:24 +01001070@b extra_cxx_flags: Custom CXX flags which will be appended to the end of the build command.
1071
1072@b build_dir: Build the library in a subfolder of the "build" folder. (Allows to build several configurations in parallel).
1073
1074@b examples: Build or not the examples
1075
1076@b validation_tests: Enable the build of the validation suite.
1077
Anthony Barbier79c61782017-06-23 11:48:24 +01001078@b benchmark_tests: Enable the build of the benchmark tests
1079
1080@b pmu: Enable the PMU cycle counter to measure execution time in benchmark tests. (Your device needs to support it)
1081
Anthony Barbier6a5627a2017-09-26 14:42:02 +01001082@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)
1083
Anthony Barbier79c61782017-06-23 11:48:24 +01001084@b openmp Build in the OpenMP scheduler for NEON.
1085
1086@note Only works when building with g++ not clang++
1087
1088@b cppthreads Build in the C++11 scheduler for NEON.
1089
Anthony Barbier3762e742018-03-02 11:49:33 +00001090@sa Scheduler::set
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001091
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001092@subsection S3_2_linux Building for Linux
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001093
1094@subsubsection S3_2_1_library How to build the library ?
1095
1096For Linux, the library was successfully built and tested using the following Linaro GCC toolchain:
1097
Michele Di Giorgio6513ccb2018-08-28 14:38:35 +01001098 - gcc-linaro-4.9-2016.02-x86_64_arm-linux-gnueabihf
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001099 - gcc-linaro-4.9-2016.02-x86_64_aarch64-linux-gnu
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001100
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001101To cross-compile the library in debug mode, with NEON only support, for Linux 32bit:
1102
1103 scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=linux arch=armv7a
1104
1105To cross-compile the library in asserts mode, with OpenCL only support, for Linux 64bit:
1106
1107 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=1 embed_kernels=1 os=linux arch=arm64-v8a
1108
Anthony Barbier20dbb822017-12-13 21:19:39 +00001109To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Linux 64bit:
1110
1111 scons Werror=1 -j8 debug=0 asserts=1 neon=0 opencl=0 gles_compute=1 embed_kernels=1 os=linux arch=arm64-v8a
1112
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001113You can also compile the library natively on an ARM device by using <b>build=native</b>:
1114
1115 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=arm64-v8a build=native
1116 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=native
1117
1118@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.
1119
1120For example on a 64bit Debian based system you would have to install <b>g++-arm-linux-gnueabihf</b>
1121
1122 apt-get install g++-arm-linux-gnueabihf
1123
1124Then run
1125
1126 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a build=cross_compile
1127
1128or simply remove the build parameter as build=cross_compile is the default value:
1129
1130 scons Werror=1 -j8 debug=0 neon=1 opencl=0 os=linux arch=armv7a
1131
1132@attention To cross compile with opencl=1 you need to make sure to have a version of libOpenCL matching your target architecture.
1133
1134@subsubsection S3_2_2_examples How to manually build the examples ?
1135
1136The 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.
1137
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001138@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 +01001139
1140To cross compile a NEON example for Linux 32bit:
1141
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001142 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 +01001143
1144To cross compile a NEON example for Linux 64bit:
1145
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001146 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 +01001147
1148(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)
1149
1150To cross compile an OpenCL example for Linux 32bit:
1151
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001152 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 +01001153
1154To cross compile an OpenCL example for Linux 64bit:
1155
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001156 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 +01001157
Anthony Barbier14c86a92017-12-14 16:27:41 +00001158To cross compile a GLES example for Linux 32bit:
1159
1160 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
1161
1162To cross compile a GLES example for Linux 64bit:
1163
1164 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
1165
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001166(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)
1167
Anthony Barbier14c86a92017-12-14 16:27:41 +00001168To 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.
1169
1170@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 +01001171
1172i.e. to cross compile the "graph_lenet" example for Linux 32bit:
1173
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001174 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 +01001175
1176i.e. to cross compile the "graph_lenet" example for Linux 64bit:
1177
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001178 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 +01001179
1180(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)
1181
Anthony Barbiere5007472017-10-27 15:01:44 +01001182@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1183
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001184To compile natively (i.e directly on an ARM device) for NEON for Linux 32bit:
1185
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001186 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 +01001187
1188To compile natively (i.e directly on an ARM device) for NEON for Linux 64bit:
1189
Anthony Barbierb2881fc2017-09-29 17:12:12 +01001190 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 +01001191
1192(notice the only difference with the 32 bit command is that we don't need the -mfpu option)
1193
1194To compile natively (i.e directly on an ARM device) for OpenCL for Linux 32bit or Linux 64bit:
1195
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001196 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 +01001197
Anthony Barbier14c86a92017-12-14 16:27:41 +00001198To 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 +01001199
Anthony Barbier14c86a92017-12-14 16:27:41 +00001200 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
1201
1202To 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.
1203@note The compute library must currently be built with both neon and opencl enabled - neon=1 and opencl=1
1204
1205i.e. to natively compile the "graph_lenet" example for Linux 32bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001206
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001207 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 +01001208
Anthony Barbier14c86a92017-12-14 16:27:41 +00001209i.e. to natively compile the "graph_lenet" example for Linux 64bit:
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001210
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001211 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 +01001212
1213(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 +01001214
Anthony Barbiere5007472017-10-27 15:01:44 +01001215@note If compiling using static libraries, this order must be followed when linking: arm_compute_graph_static, arm_compute, arm_compute_core
1216
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001217@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 +00001218@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 +01001219
1220To run the built executable simply run:
1221
1222 LD_LIBRARY_PATH=build ./neon_convolution
1223
1224or
1225
1226 LD_LIBRARY_PATH=build ./cl_convolution
1227
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001228@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 +00001229
1230For example:
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001231
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001232 LD_LIBRARY_PATH=. ./graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001233
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001234Below is a list of the common parameters among the graph examples :
1235@snippet utils/CommonGraphOptions.h Common graph examples parameters
Anthony Barbier3762e742018-03-02 11:49:33 +00001236
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001237@subsection S3_3_android Building for Android
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001238
1239For Android, the library was successfully built and tested using Google's standalone toolchains:
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001240 - clang++ from NDK r17c for armv7a
1241 - clang++ from NDK r17c for arm64-v8a
Anthony Barbier3a6163e2018-08-10 17:36:36 +01001242 - clang++ from NDK r18-beta1 for arm64-v8.2-a with FP16 support
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001243
1244Here is a guide to <a href="https://developer.android.com/ndk/guides/standalone_toolchain.html">create your Android standalone toolchains from the NDK</a>
1245
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001246- Download the NDK r17c from here: https://developer.android.com/ndk/downloads/index.html
Georgios Pinitasf112ede2019-03-01 19:11:20 +00001247- Make sure you have Python 2.7 installed on your machine.
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001248- Generate the 32 and/or 64 toolchains by running the following commands:
1249
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001250
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001251 $NDK/build/tools/make_standalone_toolchain.py --arch arm64 --install-dir $MY_TOOLCHAINS/aarch64-linux-android-ndk-r17c --stl libc++ --api 21
1252 $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 +01001253
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001254@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 +01001255
Anthony Barbier38e7f1f2018-05-21 13:37:47 +01001256@note Make sure to add the toolchains to your PATH:
1257
Georgios Pinitas25a6b672019-12-04 17:51:22 +00001258 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 +01001259
1260@subsubsection S3_3_1_library How to build the library ?
1261
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001262To cross-compile the library in debug mode, with NEON only support, for Android 32bit:
1263
1264 CXX=clang++ CC=clang scons Werror=1 -j8 debug=1 neon=1 opencl=0 os=android arch=armv7a
1265
1266To cross-compile the library in asserts mode, with OpenCL only support, for Android 64bit:
1267
Anthony Barbier14c86a92017-12-14 16:27:41 +00001268 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 +01001269
Anthony Barbier20dbb822017-12-13 21:19:39 +00001270To cross-compile the library in asserts mode, with GLES_COMPUTE only support, for Android 64bit:
1271
Anthony Barbier14c86a92017-12-14 16:27:41 +00001272 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 +00001273
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001274@subsubsection S3_3_2_examples How to manually build the examples ?
1275
1276The 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.
1277
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001278@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 +01001279
1280Once you've got your Android standalone toolchain built and added to your path you can do the following:
1281
1282To cross compile a NEON example:
1283
1284 #32 bit:
Georgios Pinitas9873ea32017-12-05 15:28:55 +00001285 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 +01001286 #64 bit:
Anthony Barbier14c86a92017-12-14 16:27:41 +00001287 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 +01001288
1289To cross compile an OpenCL example:
1290
1291 #32 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001292 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 +01001293 #64 bit:
Georgios Pinitasd9eb2752018-04-03 13:44:29 +01001294 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 +00001295
1296To cross compile a GLES example:
Anthony Barbiercc0a80b2017-12-15 11:37:29 +00001297
Anthony Barbier14c86a92017-12-14 16:27:41 +00001298 #32 bit:
1299 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
1300 #64 bit:
1301 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 +01001302
Gian Marco Iodicedaec1aa2017-09-29 12:03:18 +01001303To cross compile the examples with the Graph API, such as graph_lenet.cpp, you need to link the library arm_compute_graph also.
1304(notice the compute library has to be built with both neon and opencl enabled - neon=1 and opencl=1)
1305
1306 #32 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001307 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 +01001308 #64 bit:
Georgios Pinitas12be7ab2018-07-03 12:06:23 +01001309 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 +01001310
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001311@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 +00001312@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 +01001313
1314Then you need to do is upload the executable and the shared library to the device using ADB:
1315
1316 adb push neon_convolution_arm /data/local/tmp/
1317 adb push cl_convolution_arm /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001318 adb push gc_absdiff_arm /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001319 adb shell chmod 777 -R /data/local/tmp/
1320
1321And finally to run the example:
1322
1323 adb shell /data/local/tmp/neon_convolution_arm
1324 adb shell /data/local/tmp/cl_convolution_arm
Anthony Barbier14c86a92017-12-14 16:27:41 +00001325 adb shell /data/local/tmp/gc_absdiff_arm
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001326
1327For 64bit:
1328
1329 adb push neon_convolution_aarch64 /data/local/tmp/
1330 adb push cl_convolution_aarch64 /data/local/tmp/
Anthony Barbier14c86a92017-12-14 16:27:41 +00001331 adb push gc_absdiff_aarch64 /data/local/tmp/
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001332 adb shell chmod 777 -R /data/local/tmp/
1333
1334And finally to run the example:
1335
1336 adb shell /data/local/tmp/neon_convolution_aarch64
1337 adb shell /data/local/tmp/cl_convolution_aarch64
Anthony Barbier14c86a92017-12-14 16:27:41 +00001338 adb shell /data/local/tmp/gc_absdiff_aarch64
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001339
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001340@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 +00001341
1342For example:
Georgios Pinitas9f28b392018-07-18 20:01:53 +01001343 adb shell /data/local/tmp/graph_lenet --help
Anthony Barbier3762e742018-03-02 11:49:33 +00001344
1345In 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.
1346
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001347@subsection S3_4_bare_metal Building for bare metal
1348
1349For bare metal, the library was successfully built using linaros's latest (gcc-linaro-6.3.1-2017.05) bare metal toolchains:
1350 - arm-eabi for armv7a
1351 - aarch64-elf for arm64-v8a
1352
1353Download 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>.
1354
1355@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
1356
1357@subsubsection S3_4_1_library How to build the library ?
1358
1359To cross-compile the library with NEON support for baremetal arm64-v8a:
1360
1361 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
1362
1363@subsubsection S3_4_2_examples How to manually build the examples ?
1364
1365Examples 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>.
1366
1367@subsection S3_5_windows_host Building on a Windows host system
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001368
1369Using `scons` directly from the Windows command line is known to cause
1370problems. The reason seems to be that if `scons` is setup for cross-compilation
1371it gets confused about Windows style paths (using backslashes). Thus it is
1372recommended to follow one of the options outlined below.
1373
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001374@subsubsection S3_5_1_ubuntu_on_windows Bash on Ubuntu on Windows
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001375
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001376The best and easiest option is to use
1377<a href="https://msdn.microsoft.com/en-gb/commandline/wsl/about">Ubuntu on Windows</a>.
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001378This feature is still marked as *beta* and thus might not be available.
1379However, if it is building the library is as simple as opening a *Bash on
1380Ubuntu on Windows* shell and following the general guidelines given above.
1381
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001382@subsubsection S3_5_2_cygwin Cygwin
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001383
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001384If the Windows subsystem for Linux is not available <a href="https://www.cygwin.com/">Cygwin</a>
Pablo Tello78a5d222019-08-06 10:09:18 +01001385can be used to install and run `scons`, the minimum Cygwin version must be 3.0.7 or later. In addition
1386to the default packages installed by Cygwin `scons` has to be selected in the installer. (`git` might
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001387also be useful but is not strictly required if you already have got the source
Gian Marco Iodice5fc07aa2019-05-15 17:08:02 +01001388code of the library.) Linaro provides pre-built versions of
1389<a href="http://releases.linaro.org/components/toolchain/binaries/">GCC cross-compilers</a>
Moritz Pflanzer07674de2017-07-21 09:39:36 +01001390that can be used from the Cygwin terminal. When building for Android the
1391compiler is included in the Android standalone toolchain. After everything has
1392been set up in the Cygwin terminal the general guide on building the library
1393can be followed.
1394
Michalis Spyrou6e52ba32017-10-04 15:40:38 +01001395@subsection S3_6_cl_stub_library The OpenCL stub library
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001396
1397In 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.
1398
1399If 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.
1400
1401@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.
1402
1403To cross-compile the stub OpenCL library simply run:
1404
1405 <target-prefix>-gcc -o libOpenCL.so -Iinclude opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1406
1407For example:
1408
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001409 #Linux 32bit
1410 arm-linux-gnueabihf-gcc -o libOpenCL.so -Iinclude opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1411 #Linux 64bit
1412 aarch64-linux-gnu-gcc -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC
1413 #Android 32bit
1414 arm-linux-androideabi-clang -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1415 #Android 64bit
Anthony Barbier14c86a92017-12-14 16:27:41 +00001416 aarch64-linux-android-clang -o libOpenCL.so -Iinclude -shared opencl-1.2-stubs/opencl_stubs.c -fPIC -shared
1417
1418@subsection S3_7_gles_stub_library The Linux OpenGLES and EGL stub libraries
1419
1420In 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.
1421
1422@note The stub libraries are only needed on Linux. For Android, the NDK toolchains already provide the meta-EGL and meta-GLES libraries.
1423
1424To cross-compile the stub OpenGLES and EGL libraries simply run:
1425
1426 <target-prefix>-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1427 <target-prefix>-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
1428
1429 #Linux 32bit
1430 arm-linux-gnueabihf-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1431 arm-linux-gnueabihf-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
1432
1433 #Linux 64bit
1434 aarch64-linux-gnu-gcc -o libEGL.so -Iinclude/linux opengles-3.1-stubs/EGL.c -fPIC -shared
1435 aarch64-linux-gnu-gcc -o libGLESv2.so -Iinclude/linux opengles-3.1-stubs/GLESv2.c -fPIC -shared
Georgios Pinitasd9cb0572018-07-16 12:23:09 +01001436
1437@subsection S3_8_cl_requirements OpenCL DDK Requirements
1438
1439@subsubsection S3_8_1_cl_hard_requirements Hard Requirements
1440
1441Compute 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).
1442
1443Enabling 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.
1444
1445Use of @ref CLMeanStdDev function requires 64-bit atomics support, thus \a cl_khr_int64_base_atomics should be supported in order to use.
1446
1447@subsubsection S3_8_2_cl_performance_requirements Performance improvements
1448
1449Integer 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.
1450
1451OpenCL kernel level debugging can be simplified with the use of printf, this requires the \a cl_arm_printf extension to be supported.
1452
1453SVM 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 +01001454
1455@subsection S3_9_cl_tuner OpenCL Tuner
1456
1457The 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).
1458The 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 +01001459The 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 +01001460In 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.
1461
1462If 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:
1463
1464https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice
1465
1466Tuning 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.
1467
1468CLTuner 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.
1469
1470 #Example: 2 unique Matrix Multiply configurations
1471@code{.cpp}
1472 TensorShape a0 = TensorShape(32,32);
1473 TensorShape b0 = TensorShape(32,32);
1474 TensorShape c0 = TensorShape(32,32);
1475 TensorShape a1 = TensorShape(64,64);
1476 TensorShape b1 = TensorShape(64,64);
1477 TensorShape c1 = TensorShape(64,64);
1478
1479 Tensor a0_tensor;
1480 Tensor b0_tensor;
1481 Tensor c0_tensor;
1482 Tensor a1_tensor;
1483 Tensor b1_tensor;
1484 Tensor c1_tensor;
1485
1486 a0_tensor.allocator()->init(TensorInfo(a0, 1, DataType::F32));
1487 b0_tensor.allocator()->init(TensorInfo(b0, 1, DataType::F32));
1488 c0_tensor.allocator()->init(TensorInfo(c0, 1, DataType::F32));
1489 a1_tensor.allocator()->init(TensorInfo(a1, 1, DataType::F32));
1490 b1_tensor.allocator()->init(TensorInfo(b1, 1, DataType::F32));
1491 c1_tensor.allocator()->init(TensorInfo(c1 1, DataType::F32));
1492
1493 CLGEMM gemm0;
1494 CLGEMM gemm1;
1495
1496 // Configuration 0
1497 gemm0.configure(&a0, &b0, nullptr, &c0, 1.0f, 0.0f);
1498
1499 // Configuration 1
1500 gemm1.configure(&a1, &b1, nullptr, &c1, 1.0f, 0.0f);
1501@endcode
1502
1503@subsubsection S3_9_1_cl_tuner_how_to How to use it
1504
1505All 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
1506
1507 #Enable CL tuner
1508 ./graph_mobilenet --enable-tuner –-target=CL
1509 ./arm_compute_benchmark --enable-tuner
1510
1511 #Export/Import to/from a file
1512 ./graph_mobilenet --enable-tuner --target=CL --tuner-file=acl_tuner.csv
1513 ./arm_compute_benchmark --enable-tuner --tuner-file=acl_tuner.csv
1514
1515If you are importing the CLTuner'results from a file, the new tuned LWS values will be appended to it.
1516
1517Either you are benchmarking the graph examples or the test cases in the arm_compute_benchmark remember to:
1518
1519 -# Disable the power management
1520 -# Keep the GPU frequency constant
1521 -# Run multiple times the network (i.e. 10).
1522
1523If 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.
1524
1525@code{.cpp}
1526CLTuner tuner;
1527
1528// Setup Scheduler
1529CLScheduler::get().default_init(&tuner);
1530@endcode
1531
1532After the first run, the CLTuner's results can be exported to a file using the method "save_to_file()".
1533- tuner.save_to_file("results.csv");
1534
1535This file can be also imported using the method "load_from_file("results.csv")".
1536- tuner.load_from_file("results.csv");
Anthony Barbier6ff3b192017-09-04 18:44:23 +01001537*/
Anthony Barbierd51ea0a2018-08-07 17:48:03 +01001538} // namespace arm_compute