From 5884fe79dcd87fa36a982b93735bae4be2b65594 Mon Sep 17 00:00:00 2001 From: James Conroy Date: Thu, 18 Aug 2022 08:30:28 +0100 Subject: IVGCVSW-6779 Add build-tool Docs and update docs * Added Arm NN Build Tool README.md and license. * Added Dockerfile diagram image and license. * Updated existing guides: added note to the cross compile guide to use build-tool, removed content from the Delegate BuildGuideNative.md. * Added Arm NN logo image to homepage README.md and added license. Signed-off-by: James Conroy Change-Id: I9306ad24165cf3b0203c2a1852ec3afd718e9eab --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ac3c332e54..5f7a38d9b8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -# Arm NN +
+
+ Arm NN Logo +
* [Quick Start Guides](#quick-start-guides) * [Pre-Built Binaries](#pre-built-binaries) @@ -13,6 +16,8 @@ ## Announcement: As part of Arm's commitment to the use of inclusive language we will be moving away from 'master' branch to 'main' soon. ## From 15 August 2022 our 'master' branch will be frozen and we will be using 'main' branch instead. +# Arm NN + **_Arm NN_** is the **most performant** machine learning (ML) inference engine for Android and Linux, accelerating ML on **Arm Cortex-A CPUs and Arm Mali GPUs**. This ML inference engine is an open source SDK which bridges the gap between existing neural network frameworks and power-efficient Arm IP. @@ -49,6 +54,12 @@ We also provide Debian packages for Arm NN, which are a quick way to start using [here](InstallationViaAptRepository.md) which provides instructions on how to install the Arm NN Core and the TF Lite Parser for Ubuntu 20.04. +To build Arm NN from scratch, we provide the **[Arm NN Build Tool](build-tool/README.md)**. This tool consists of +**parameterized bash scripts** accompanied by a **Dockerfile** for building Arm NN and its dependencies, including +**[Arm Compute Library (ACL)](https://github.com/ARM-software/ComputeLibrary/)**. This tool replaces/supersedes the +majority of the existing Arm NN build guides as a user-friendly way to build Arm NN. The main benefit of building +Arm NN from scratch is the ability to **exactly choose which components to build, targeted for your ML project**.
+ ## Pre-Built Binaries @@ -95,7 +106,7 @@ For FAQs and troubleshooting advice, see the [FAQ](docs/FAQ.md) or take a look a ## Get Involved -The best way to get involved is by using our software. If you need help or encounter and issue, please raise it as a +The best way to get involved is by using our software. If you need help or encounter an issue, please raise it as a [GitHub Issue](https://github.com/ARM-software/armnn/issues). Feel free to have a look at any of our open issues too. We also welcome feedback on our documentation. -- cgit v1.2.1