summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChunseok Lee <chunseok.lee@samsung.com>2018-05-04 17:57:16 +0900
committerChunseok Lee <chunseok.lee@samsung.com>2018-05-04 17:57:16 +0900
commit07659ccd9fe7b1cf1547cc6cad78bcf489f0a361 (patch)
treecf3a123812b7f1ad8b50d7d0ace891e0c03c6110 /README.md
parentda6f7a3e8360a49fd073a6e0031a4da134d9d984 (diff)
downloadnnfw-07659ccd9fe7b1cf1547cc6cad78bcf489f0a361.tar.gz
nnfw-07659ccd9fe7b1cf1547cc6cad78bcf489f0a361.tar.bz2
nnfw-07659ccd9fe7b1cf1547cc6cad78bcf489f0a361.zip
Imported Upstream version 0.1upstream/0.1submit/tizen/20180504.091146
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..3d2a1f451
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# nnfw
+
+A high-performance, on-device neural network inference framework
+
+## Goal
+This project _nnfw_ aims at providing a high-performance, on-device neural network (NN) inference
+framework that performs inference of a given NN model on processors, such as CPU, GPU, or NPU, in
+the target platform, such as Tizen and Smart Machine Platform (SMP).
+
+## About this _experimental_ release
+_Experimental_ means the Tizen M1 release of _nnfw_ has very limited capability, which could only
+run InceptionV3, and would have very limited support from the developers. And, the backward
+compatibility in the future release, e.g., one planned in October, might not be guaranteed.
+
+## How-to documents
+- [How to add unittest using gtest](docs/howto/HowToAddUnittest.md)