diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 167 |
1 files changed, 145 insertions, 22 deletions
@@ -1,49 +1,172 @@ + +> **⚠ Deprecation Notice** +> 24.01 announcement: 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. + +<br> <div align="center"> - <img src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png"><br><br> + <img src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png"/><br><br> </div> -Release repository: https://github.com/arm-software/ComputeLibrary +# Compute Library  + + +The Compute Library is a collection of low-level machine learning functions optimized for Arm® Cortex®-A, Arm® Neoverse® and Arm® Mali™ GPUs architectures.<br> + +The library provides superior performance to other open source alternatives and immediate support for new Arm® technologies e.g. SVE2. + +Key Features: + +- Open source software available under a permissive MIT license +- Over 100 machine learning functions for CPU and GPU +- Multiple convolution algorithms (GeMM, Winograd, FFT, Direct and indirect-GeMM) +- Support for multiple data types: FP32, FP16, INT8, UINT8, BFLOAT16 +- Micro-architecture optimization for key ML primitives +- Highly configurable build options enabling lightweight binaries +- Advanced optimization techniques such as kernel fusion, Fast math enablement and texture utilization +- Device and workload specific tuning using OpenCL tuner and GeMM optimized heuristics + +<br> + +| Repository | Link | +| ----------- | ---------------------------------------------------------------- | +| Release | https://github.com/arm-software/ComputeLibrary | +| Development | https://review.mlplatform.org/#/admin/projects/ml/ComputeLibrary | + +<br> + +## Documentation +[](https://arm-software.github.io/ComputeLibrary/latest) + +> Note: The documentation includes the reference API, changelogs, build guide, contribution guide, errata, etc. + +<br> -Development repository: https://review.mlplatform.org/#/admin/projects/ml/ComputeLibrary +## Pre-built binaries +All the binaries can be downloaded from [here](https://github.com/ARM-software/ComputeLibrary/releases) or from the tables below. -Please report issues here: https://github.com/ARM-software/ComputeLibrary/issues +<br> -**Make sure you are using the latest version of the library before opening an issue. Thanks** +| Platform | Operating System | Release archive (Download) | +| -------------- | ---------------- | -------------------------- | +| Raspberry Pi 4 | Linux® 32bit | [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-armv7a-neon.tar.gz) | +| Raspberry Pi 4 | Linux® 64bit | [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8a-neon.tar.gz) | +| Odroid N2 | Linux® 64bit | [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8a-neon.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8a-cl.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8a-neon-cl.tar.gz) | +| HiKey960 | Linux® 64bit | [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8a-neon.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8a-cl.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8a-neon-cl.tar.gz) | -News: +<br> +| Architecture | Operating System | Release archive (Download) | +| ------------ | ---------------- | -------------------------- | +| armv7 | Linux® | [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-armv7a-neon.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-armv7a-cl.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-armv7a-neon-cl.tar.gz) | +| arm64-v8a | Android™ | [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-android-arm64-v8a-neon.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-android-arm64-v8a-cl.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-android-arm64-v8a-neon-cl.tar.gz) | +| arm64-v8a | Linux® | [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8a-neon.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8a-cl.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8a-neon-cl.tar.gz) | +| arm64-v8.2-a | Android™ | [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-android-arm64-v8.2-a-neon.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-android-arm64-v8.2-a-cl.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-android-arm64-v8.2-a-neon-cl.tar.gz) | +| arm64-v8.2-a | Linux® | [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8.2-a-neon.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8.2-a-cl.tar.gz) [](https://github.com/ARM-software/ComputeLibrary/releases/download/v24.04/arm_compute-v24.04-bin-linux-arm64-v8.2-a-neon-cl.tar.gz) | + +<br> + +Please refer to the following link for more pre-built binaries: [](https://github.com/ARM-software/ComputeLibrary/releases/tag/v24.04) + +Pre-build binaries are generated with the following security / good coding practices related flags: +> -Wall, -Wextra, -Wformat=2, -Winit-self, -Wstrict-overflow=2, -Wswitch-default, -Woverloaded-virtual, -Wformat-security, -Wctor-dtor-privacy, -Wsign-promo, -Weffc++, -pedantic, -fstack-protector-strong + +## Supported Architectures/Technologies + +- Arm® CPUs: + - Arm® Cortex®-A processor family using Arm® Neon™ technology + - Arm® Neoverse® processor family + - Arm® Cortex®-R processor family with Armv8-R AArch64 architecture using Arm® Neon™ technology + - Arm® Cortex®-X1 processor using Arm® Neon™ technology + +- Arm® Mali™ GPUs: + - Arm® Mali™-G processor family + - Arm® Mali™-T processor family + +- x86 + +<br> + +## Supported Systems + +- Android™ +- Bare Metal +- Linux® +- OpenBSD® +- macOS® +- Tizen™ + +<br> + +## Resources +- [Tutorial: Running AlexNet on Raspberry Pi with Compute Library](https://community.arm.com/processors/b/blog/posts/running-alexnet-on-raspberry-pi-with-compute-library) - [Gian Marco's talk on Performance Analysis for Optimizing Embedded Deep Learning Inference Software](https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2019-embedded-vision-summit) - [Gian Marco's talk on optimizing CNNs with Winograd algorithms at the EVS](https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2018-embedded-vision-summit-iodice) - [Gian Marco's talk on using SGEMM and FFTs to Accelerate Deep Learning](https://www.embedded-vision.com/platinum-members/arm/embedded-vision-training/videos/pages/may-2016-embedded-vision-summit-iodice) -Related projects: +<br> -- [Arm NN SDK](https://github.com/arm-software/armnn) +## Experimental builds -Tutorials: +**⚠ Important** Bazel and CMake builds are experimental CPU only builds, please see the [documentation](https://arm-software.github.io/ComputeLibrary/latest/how_to_build.xhtml) for more details. -- [Tutorial: Cartoonifying Images on Raspberry Pi with the Compute Library](https://community.arm.com/graphics/b/blog/posts/cartoonifying-images-on-raspberry-pi-with-the-compute-library) -- [Tutorial: Running AlexNet on Raspberry Pi with Compute Library](https://community.arm.com/processors/b/blog/posts/running-alexnet-on-raspberry-pi-with-compute-library) +<br> + +## How to contribute -Documentation (API, changelogs, build guide, contribution guide, errata, etc.) available at https://github.com/ARM-software/ComputeLibrary/wiki/Documentation. +Contributions to the Compute Library are more than welcome. If you are interested on contributing, please have a look at our [how to contribute guidelines](https://arm-software.github.io/ComputeLibrary/latest/contribution_guidelines.xhtml). -Binaries available at https://github.com/ARM-software/ComputeLibrary/releases. +### Developer Certificate of Origin (DCO) +Before the Compute Library accepts your contribution, you need to certify its origin and give us your permission. To manage this process we use the Developer Certificate of Origin (DCO) V1.1 (https://developercertificate.org/) -License & Contributions: The software is provided under MIT license. Contributions to this project are accepted under the same license. +To indicate that you agree to the the terms of the DCO, you "sign off" your contribution by adding a line with your name and e-mail address to every git commit message: + +```Signed-off-by: John Doe <john.doe@example.org>``` + +You must use your real name, no pseudonyms or anonymous contributions are accepted. ### Public mailing list For technical discussion, the ComputeLibrary project has a public mailing list: acl-dev@lists.linaro.org The list is open to anyone inside or outside of Arm to self subscribe. In order to subscribe, please visit the following website: -https://lists.linaro.org/mailman/listinfo/acl-dev +https://lists.linaro.org/mailman3/lists/acl-dev.lists.linaro.org/ -### Developer Certificate of Origin (DCO) -Before the ComputeLibrary project accepts your contribution, you need to certify its origin and give us your permission. To manage this process we use the Developer Certificate of Origin (DCO) V1.1 (https://developercertificate.org/) +<br> -To indicate that you agree to the the terms of the DCO, you "sign off" your contribution by adding a line with your name and e-mail address to every git commit message: +## License and Contributions -```Signed-off-by: John Doe <john.doe@example.org>``` +The software is provided under MIT license. Contributions to this project are accepted under the same license. -You must use your real name, no pseudonyms or anonymous contributions are accepted. +### Other Projects +This project contains code from other projects as listed below. The original license text is included in those source files. + +* The OpenCL header library is licensed under Apache License, Version 2.0, which is a permissive license compatible with MIT license. + +* The half library is licensed under MIT license. + +* The libnpy library is licensed under MIT license. + +* The stb image library is either licensed under MIT license or is in Public Domain. It is used by this project under the terms of MIT license. + +<br> + +## Trademarks and Copyrights + +Android is a trademark of Google LLC. + +Arm, Cortex, Mali and Neon are registered trademarks or trademarks of Arm Limited (or its subsidiaries) in the US and/or elsewhere. + +Bazel is a trademark of Google LLC., registered in the U.S. and other +countries. + +CMake is a trademark of Kitware, Inc., registered in the U.S. and other +countries. + +Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries. + +Mac and macOS are trademarks of Apple Inc., registered in the U.S. and other +countries. + +Tizen is a registered trademark of The Linux Foundation. -### Security Issues -If you believe you have discovered a security issue please contact MLG-Security@arm.com +Windows® is a trademark of the Microsoft group of companies. |