aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/introduction.dox
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user_guide/introduction.dox')
-rw-r--r--docs/user_guide/introduction.dox44
1 files changed, 28 insertions, 16 deletions
diff --git a/docs/user_guide/introduction.dox b/docs/user_guide/introduction.dox
index 6b10b9c2a2..15c95f7103 100644
--- a/docs/user_guide/introduction.dox
+++ b/docs/user_guide/introduction.dox
@@ -1,5 +1,5 @@
///
-/// Copyright (c) 2017-2021 Arm Limited.
+/// Copyright (c) 2017-2024 Arm Limited.
///
/// SPDX-License-Identifier: MIT
///
@@ -34,11 +34,15 @@ namespace arm_compute
The Compute Library is a collection of low-level machine learning functions optimized for both Arm CPUs and GPUs using SIMD technologies.
Several builds of the library are available using various configurations:
- - OS: Linux, Android, macOS or bare metal.
- - Architecture: armv7a (32bit) or arm64-v8a (64bit).
+ - OS: Linux®, Android™, macOS or bare metal.
+ - Architecture: armv7a (32bit) or armv8a (64bit).
- Technology: Arm® Neon™ / OpenCL / Arm® Neon™ and OpenCL.
- 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.
+@warning Depecation Notice from 24.01: NCHW data format specific optimizations will gradually be removed from the code base in
+ future releases. The implication of this is that the user is expected to translate NCHW models into NHWC in
+ order to benefit from the optimizations.
+
@b Minimum toolchains requirements are shown below:
<table>
@@ -47,11 +51,11 @@ Several builds of the library are available using various configurations:
<th>Architecture
<th>Minimum Toolchain
<tr>
- <td rowspan="4">Linux
+ <td rowspan="4">Linux®
<td>armv7a
<td>gcc-linaro-6.3.1-2017.05-x86_64_arm-linux-gnueabihf
<tr>
- <td>arm64-v8a
+ <td>armv8a
<td rowspan="2">gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu
<tr>
<td>armv8.2-a
@@ -59,13 +63,18 @@ Several builds of the library are available using various configurations:
<td>armv8.2-a-sve
<td>gcc-arm-10.2-2020.11-x86_64-aarch64-none-linux-gnu
<tr>
- <td rowspan="3">Android
- <td>armv7a
- <td rowspan="3">NDK r18b
+ <td rowspan="3">Android™
+ <td>armv8a
+ <td rowspan="2">NDK r20b
<tr>
- <td>arm64-v8a
+ <td>armv8.2-a
<tr>
+ <td>armv8.2-a-sve
+ <td>NDK r23b
+<tr>
+ <td rowspan="1">macOS
<td>armv8.2-a
+ <td>Monterey (OS version): clang 13 (native)
</table>
@section S0_1_contact Contact / Support
@@ -74,19 +83,22 @@ Please create an issue on <a href="https://github.com/ARM-software/ComputeLibrar
In 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:
- $ strings android-armv7a-cl-asserts/libarm_compute.so | grep arm_compute_version
- 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
+ $ strings android-armv8a-cl-asserts/libarm_compute.so | grep arm_compute_version
+ 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
@section S0_2_prebuilt_binaries Pre-built binaries
For each release we provide some pre-built binaries of the library [here](https://github.com/ARM-software/ComputeLibrary/releases).
These binaries have been built using the following toolchains:
- - Linux armv7a: gcc-linaro-7.2.1-2017.11-x86_64_arm-linux-gnueabihf
- - Linux arm64-v8a: gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu
- - Linux armv8.2a-sve: gcc-arm-10.2-2020.11-x86_64-aarch64-none-linux-gnu
- - Android armv7a: clang++ / libc++ NDK r18b
- - Android am64-v8a: clang++ / libc++ NDK r20b
+ - Linux® armv7a: gcc-linaro-7.2.1-2017.11-x86_64_arm-linux-gnueabihf
+ - Linux® armv8a: gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu
+ - Linux® armv8.2-a: gcc-linaro-7.2.1-2017.11-x86_64_aarch64-linux-gnu
+ - Linux® armv8.2-a (multi-ISA binary): gcc-arm-10.2-2020.11-x86_64-aarch64-none-linux-gnu
+ - Linux® armv8.2-a-sve: gcc-arm-10.2-2020.11-x86_64-aarch64-none-linux-gnu
+ - Android™ armv8a: clang++ / libc++ NDK r20b
+ - Android™ armv8.2-a: clang++ / libc++ NDK r20b
+ - Android™ armv8.2-a-sve: clang++ / libc++ NDK r23b
@warning Make sure to use a compatible toolchain to build your application or you will get some std::bad_alloc errors at runtime.