1/// 2/// Copyright (c) 2017-2023 Arm Limited. 3/// 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/// 24namespace arm_compute 25{ 26/** 27@mainpage Introduction 28@copydoc introduction 29 30@page introduction Introduction 31 32@tableofcontents 33 34The Compute Library is a collection of low-level machine learning functions optimized for both Arm CPUs and GPUs using SIMD technologies. 35 36Several builds of the library are available using various configurations: 37 - OS: Linux, Android, macOS or bare metal. 38 - Architecture: armv7a (32bit) or armv8a (64bit). 39 - Technology: Arm® Neon™ / OpenCL / Arm® Neon™ and OpenCL. 40 - 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. 41 42@warning From 22.08 release, armv7a with Android build will no longer be tested or maintained. 43 44@b Minimum toolchains requirements are shown below: 45 46<table> 47<tr> 48 <th>Operating System 49 <th>Architecture 50 <th>Minimum Toolchain 51<tr> 52 <td rowspan="4">Linux 53 <td>armv7a 54 <td>gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf 55 <tr> 56 <td>armv8a 57 <td rowspan="2">gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu 58 <tr> 59 <td>armv8.2-a 60 <tr> 61 <td>armv8.2-a-sve 62 <td>gcc-arm-10.2-2020.11-x86_64-aarch64-none-linux-gnu 63<tr> 64 <td rowspan="2">Android 65 <td>armv8a 66 <td rowspan="2">NDK r20b 67 <tr> 68 <td>armv8.2-a 69<tr> 70 <td rowspan="1">macOS 71 <td>armv8.2-a 72 <td>Monterey (OS version): clang 13 (native) 73</table> 74 75@section S0_1_contact Contact / Support 76 77Please create an issue on <a href="https://github.com/ARM-software/ComputeLibrary/issues">Github</a>. 78 79In 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: 80 81 $ strings android-armv8a-cl-asserts/libarm_compute.so | grep arm_compute_version 82 arm_compute_version=v16.12 Build options: {'embed_kernels': '1', 'opencl': '1', 'arch': 'armv8a', 'neon': '0', 'asserts': '1', 'debug': '0', 'os': 'android', 'Werror': '1'} Git hash=f51a545d4ea12a9059fe4e598a092f1fd06dc858 83 84@section S0_2_prebuilt_binaries Pre-built binaries 85 86For each release we provide some pre-built binaries of the library [here](https://github.com/ARM-software/ComputeLibrary/releases). 87 88These binaries have been built using the following toolchains: 89 - Linux armv7a: gcc-linaro-7.2.1-2017.11-x86_64_arm-linux-gnueabihf 90 - Linux armv8a: gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu 91 - Linux armv8.2-a: gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu 92 - Linux armv8.2-a (multi-ISA binary): gcc-arm-10.2-2020.11-x86_64-aarch64-none-linux-gnu 93 - Linux armv8.2-a-sve: gcc-arm-10.2-2020.11-x86_64-aarch64-none-linux-gnu 94 - Android armv8a: clang++ / libc++ NDK r20b 95 - Android armv8.2-a: clang++ / libc++ NDK r20b 96 97@warning Make sure to use a compatible toolchain to build your application or you will get some std::bad_alloc errors at runtime. 98 99@section S0_3_file_organisation File organisation 100 101This archive contains: 102 - The arm_compute header and source files 103 - The latest Khronos OpenCL 1.2 C headers from the <a href="https://www.khronos.org/registry/cl/">Khronos OpenCL registry</a> 104 - 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) 105 - The latest Khronos EGL 1.5 C headers from the <a href="https://www.khronos.org/registry/gles/">Khronos EGL registry</a> 106 - The sources for a stub version of libOpenCL.so, libGLESv1_CM.so, libGLESv2.so and libEGL.so to help you build your application. 107 - An examples folder containing a few examples to compile and link against the library. 108 - A utils folder containing headers with some boiler plate code used by the examples. 109 - This documentation. 110 111 For detailed information about file organization, please refer to Files -> File List section of this documentation. 112 113*/ 114} // namespace arm_compute 115