summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
author서상민/동작제어Lab(SR)/Senior Engineer/삼성전자 <sangmin7.seo@samsung.com>2018-05-02 17:19:46 +0900
committerGitHub Enterprise <noreply-CODE@samsung.com>2018-05-02 17:19:46 +0900
commit3d7b67cb37d0a4b353b7aa9b5364c57fbfa8dfd9 (patch)
tree7885b2c050b1c28e5b8663d91a11e64192353f27 /docs
parent7e202c2e040a52c44500ac6e474520fe9809637a (diff)
downloadnnfw-3d7b67cb37d0a4b353b7aa9b5364c57fbfa8dfd9.tar.gz
nnfw-3d7b67cb37d0a4b353b7aa9b5364c57fbfa8dfd9.tar.bz2
nnfw-3d7b67cb37d0a4b353b7aa9b5364c57fbfa8dfd9.zip
List up how-to documents in a separate document (#1003)
For #926 This commit puts together how-to documents in docs/howto and lists them up in docs/howto.md. Signed-off-by: Sangmin Seo <sangmin7.seo@samsung.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/howto.md25
-rw-r--r--docs/howto/BuildTFfromSource.md (renamed from docs/BuildTFfromSource.md)0
-rw-r--r--docs/howto/CrossBuildForAarch64.md (renamed from docs/CrossBuildForAarch64.md)0
-rw-r--r--docs/howto/CrossBuildForArm.md (renamed from docs/CrossBuildForArm.md)0
-rw-r--r--docs/howto/HowToAddUnittest.md (renamed from docs/HowToAddUnittest.md)0
-rw-r--r--docs/howto/HowToUseDockerImage.md (renamed from docs/HowToUseDockerImage.md)0
-rw-r--r--docs/howto/device/xu3-dip.png (renamed from docs/device/xu3-dip.png)bin262925 -> 262925 bytes
-rw-r--r--docs/howto/device/xu3_ubuntu.md (renamed from docs/device/xu3_ubuntu.md)0
-rw-r--r--docs/howto/device/xu4_tizen.md (renamed from docs/device/xu4_tizen.md)0
-rw-r--r--docs/howto/device/xu4_ubuntu.md (renamed from docs/device/xu4_ubuntu.md)0
10 files changed, 25 insertions, 0 deletions
diff --git a/docs/howto.md b/docs/howto.md
new file mode 100644
index 000000000..fb4d79207
--- /dev/null
+++ b/docs/howto.md
@@ -0,0 +1,25 @@
+## How to use (simple) NNAPI Binding
+
+This repo provides a T/F Lite Model loader(named ``tflite_run``), and simple NNAPI binding.
+
+Let's type the following commands, and see what happens!
+```
+$ make install
+$ USE_NNAPI=1 LD_LIBRARY_PATH="$(pwd)/Product/obj/tools/nnapi_bindings/bindings/logging" Product/out/bin/tflite_run [T/F Lite Flatbuffer Model Path]
+```
+
+## How to get pre-built T/F Lite models?
+Google provides several pre-built T/F Lite models. Please check [this article](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/contrib/lite/g3doc/models.md)
+
+
+## Build How-to
+- [Cross building for ARM](howto/CrossBuildForArm.md)
+- [Cross building for AARCH64](howto/CrossBuildForAarch64.md)
+- [Build using prebuilt docker image](howto/HowToUseDockerImage.md)
+
+
+## Other how-to documents
+- [Building TensorFlow and TOCO from source](howto/BuildTFfromSource.md)
+- [How to setup XU3 with Ubuntu 16.04](howto/device/xu3_ubuntu.md)
+- [How to setup XU4 with Ubuntu 16.04](howto/device/xu4_ubuntu.md)
+- [How to add unittest using gtest](howto/HowToAddUnittest.md)
diff --git a/docs/BuildTFfromSource.md b/docs/howto/BuildTFfromSource.md
index 3880d5ab9..3880d5ab9 100644
--- a/docs/BuildTFfromSource.md
+++ b/docs/howto/BuildTFfromSource.md
diff --git a/docs/CrossBuildForAarch64.md b/docs/howto/CrossBuildForAarch64.md
index bd1880ff0..bd1880ff0 100644
--- a/docs/CrossBuildForAarch64.md
+++ b/docs/howto/CrossBuildForAarch64.md
diff --git a/docs/CrossBuildForArm.md b/docs/howto/CrossBuildForArm.md
index cc3a37c0b..cc3a37c0b 100644
--- a/docs/CrossBuildForArm.md
+++ b/docs/howto/CrossBuildForArm.md
diff --git a/docs/HowToAddUnittest.md b/docs/howto/HowToAddUnittest.md
index 6612f153d..6612f153d 100644
--- a/docs/HowToAddUnittest.md
+++ b/docs/howto/HowToAddUnittest.md
diff --git a/docs/HowToUseDockerImage.md b/docs/howto/HowToUseDockerImage.md
index a5a91bfed..a5a91bfed 100644
--- a/docs/HowToUseDockerImage.md
+++ b/docs/howto/HowToUseDockerImage.md
diff --git a/docs/device/xu3-dip.png b/docs/howto/device/xu3-dip.png
index 59c0be3f2..59c0be3f2 100644
--- a/docs/device/xu3-dip.png
+++ b/docs/howto/device/xu3-dip.png
Binary files differ
diff --git a/docs/device/xu3_ubuntu.md b/docs/howto/device/xu3_ubuntu.md
index 38dbc69b0..38dbc69b0 100644
--- a/docs/device/xu3_ubuntu.md
+++ b/docs/howto/device/xu3_ubuntu.md
diff --git a/docs/device/xu4_tizen.md b/docs/howto/device/xu4_tizen.md
index d79bc1532..d79bc1532 100644
--- a/docs/device/xu4_tizen.md
+++ b/docs/howto/device/xu4_tizen.md
diff --git a/docs/device/xu4_ubuntu.md b/docs/howto/device/xu4_ubuntu.md
index e202e2a5a..e202e2a5a 100644
--- a/docs/device/xu4_ubuntu.md
+++ b/docs/howto/device/xu4_ubuntu.md