commit | 66b4a6a8ca1ee55e5b7f05bae2543cf99fe22d6d | [log] [tgz] |
---|---|---|
author | Gunes Bayir <gunes.bayir@arm.com> | Sat Jul 01 22:55:42 2023 +0100 |
committer | Gunes Bayir <gunes.bayir@arm.com> | Tue Aug 08 14:23:35 2023 +0000 |
tree | a11e009e6fc742df0fd4551fd7c545325210a07d | |
parent | f77b969d3375f412ff236586d2b6eb2297c6b96d [diff] |
Setup pre-commit and include code formatting scripts This patch - includes our code formatting scripts used in our precommit pipeline - sets up pre-commit framework to help contributors validate their patches This has several benefits: - our repository becomes more inclusive to external contributions - we can use several hooks available online efficiently, w/o implementing our own - it speeds up our development flow and, it is completely optional. The pre-commit configuration includes running the following: - our code formatting scripts - CMake and Bazel build file generation scripts - hooks that check trailing whitespace, end of files, committed large files etc. The number of checks can easily be extended using pre-commit framework. Change-Id: I06bf1259715579d321f89820726a8301504c36d9 Signed-off-by: Gunes Bayir <gunes.bayir@arm.com> Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/10064 Reviewed-by: Jakub Sujak <jakub.sujak@arm.com> Tested-by: Arm Jenkins <bsgcomp@arm.com> Comments-Addressed: Arm Jenkins <bsgcomp@arm.com> Benchmark: Arm Jenkins <bsgcomp@arm.com>
⚠ Important From release 22.05: 'master' branch has been replaced with 'main' following our inclusive language update, more information here.
⚠ Important From release 22.08: armv7a with Android build will no longer be tested or maintained.
⚠ Important From release 23.02: The 23.02 release introduces a change to the default tensor extend padding behavior. To remain compatible with previous behavior, users will need to set the new flag
ITensorInfo::lock_paddings()
on tensors for which paddings should not be extended, such as the input and output of the model that need to be mapped to a camera frame or frame buffer.
The Compute Library is a collection of low-level machine learning functions optimized for Arm® Cortex®-A, Arm® Neoverse® and Arm® Mali™ GPUs architectures.
The library provides superior performance to other open source alternatives and immediate support for new Arm® technologies e.g. SVE2.
Key Features:
Repository | Link |
---|---|
Release | https://github.com/arm-software/ComputeLibrary |
Development | https://review.mlplatform.org/#/admin/projects/ml/ComputeLibrary |
Note: The documentation includes the reference API, changelogs, build guide, contribution guide, errata, etc.
All the binaries can be downloaded from here or from the tables below.
Platform | Operating System | Release archive (Download) |
---|---|---|
Raspberry Pi 4 | Linux 32bit | |
Raspberry Pi 4 | Linux 64bit | |
Odroid N2 | Linux 64bit | |
HiKey960 | Linux 64bit |
Architecture | Operating System | Release archive (Download) |
---|---|---|
armv7 | Linux | |
arm64-v8a | Android | |
arm64-v8a | Linux | |
arm64-v8.2-a | Android | |
arm64-v8.2-a | Linux |
Please refer to the following link for more pre-built binaries:
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
Arm® CPUs:
Arm® Mali™ GPUs:
x86
⚠ Important Bazel and CMake builds are experimental CPU only builds, please see the documentation for more details.
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.
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/)
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.
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/mailman3/lists/acl-dev.lists.linaro.org/
The software is provided under MIT license. Contributions to this project are accepted under the same license.
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.
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.
Windows® is a trademark of the Microsoft group of companies.