[Doc] NNTrainer Tool Utilization Guide
authorDonghyeon Jeong <dhyeon.jeong@samsung.com>
Fri, 26 Jul 2024 07:53:32 +0000 (16:53 +0900)
committerJijoong Moon <jijoong.moon@samsung.com>
Thu, 1 Aug 2024 01:52:20 +0000 (10:52 +0900)
This PR adds a guide for executing unit tests on the Android device.

**Self-evaluation:**
1. Build test: [X]Passed [ ]Failed [ ]Skipped
2. Run test:   [X]Passed [ ]Failed [ ]Skipped

Signed-off-by: Donghyeon Jeong <dhyeon.jeong@samsung.com>
tools/README.md [new file with mode: 0644]

diff --git a/tools/README.md b/tools/README.md
new file mode 100644 (file)
index 0000000..da4937a
--- /dev/null
@@ -0,0 +1,34 @@
+# Tools
+
+This section explains how to utilize the NNTrainer tools.
+
+## Running Unit Tests on Android Devices
+
+Here we will guide you through running unit tests on an Android device.
+
+#### Preparing for Android Testing
+
+Prerequisite: Install and configure the NDK
+
+```
+$ ./tools/android_test.sh
+```
+
+#### Generating Layer Golden Data
+
+```
+$ meson build [flags...]
+$ cd build
+$ adb push res/ /data/local/tmp/nntr_android_test
+```
+
+Please note that golden data is necessary to execute layer-related tests.
+
+#### Executing Unit Tests on the Android Device
+
+```
+$ adb shell
+$ cd /data/local/tmp/nntr_android_test/
+$ export LD_LIBRARY_PATH=.
+$ ./unittest_nntrainer_tensor
+```