aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKristofer Jonsson <kristofer.jonsson@arm.com>2020-05-12 14:50:26 +0200
committerKristofer Jonsson <kristofer.jonsson@arm.com>2020-05-14 11:05:05 +0200
commita65116a416f8628ee2648b25fdcabed8c0d1543d (patch)
treefb2947e86d5f1dfd910f0471e71efda5df42876b
parent7029d246df72b4f219e88a64d2daf5b08edd886d (diff)
downloadethos-u-a65116a416f8628ee2648b25fdcabed8c0d1543d.tar.gz
Update README.md
Add information about the repositories. Change-Id: Iea95a4b2b37b2f351b9031e28b0906dc403adee5
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 34ef455..58452e5 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,23 @@ users download required repositories and place them in a tree structure.
```
$ ./fetch_externals.py
```
+
+The script will build following tree structure.
+
+```
+Directory Repository
+. https://review.mlplatform.org/admin/repos/ml/ethos-u/ethos-u
++-- core_software https://review.mlplatform.org/admin/repos/ml/ethos-u/ethos-u-core-driver
+| +-- core_driver https://review.mlplatform.org/admin/repos/ml/ethos-u/ethos-u-core-software
+| +-- cmsis GitHub
+| +-- tensorflow GitHub
++-- vela https://review.mlplatform.org/admin/repos/ml/ethos-u/ethos-u-vela
+```
+
+| Directory | Description |
+--- | ---
+| . | This is the root directory for all Ethos-u software. |
+| core_software | The software executing on Arm Cortex-M is referred to as _Core Software_. This folder provides a small build system that illustrates how to build the key components for the Ethos-u core software. |
+| cmsis | CMSIS provides optimized kernels and generic interfaces to the Arm Cortex-M CPUs. |
+| tensorflow | The TensorFlowLite micro framework is used to run inferences. |
+| vela | The Vela optimizer takes a TFLu file as input and replaces operators that are supported by the Ethos-u NPU with custom operators designed to run on the NPU. Operators not supported by the NPU are executed in software. |