Update README.md of reference runtime
authorHyung-Kyu Choi <hk0110.choi@samsung.com>
Tue, 20 Mar 2018 13:37:26 +0000 (22:37 +0900)
committer최형규/동작제어Lab(SR)/Senior Engineer/삼성전자 <hk0110.choi@samsung.com>
Thu, 22 Mar 2018 05:00:04 +0000 (14:00 +0900)
- Add design philosophies of reference runtime

Signed-off-by: Hyung-Kyu Choi <hk0110.choi@samsung.com>
src/runtime/ref/README.md

index fa448f2..dff5e43 100644 (file)
@@ -1,3 +1,16 @@
 # Reference implementation of NN runtime
 
 This directory will host a reference implementation of NN runtime.
+
+## Design philosophies for this reference implemenation
+
+We will follow below philosophies until we have a working stack of NN runtime.
+
+- Basically we are going to import necessary code from `experiments/android_nn`
+- And we will remove unnecessary code and modify of `experiments/android_nn`.
+- Keep same structure and name of directory/file with `experiments/android_nn` when importing `experiments/android_nn`
+- Keep same name of type, variable, function, namespace and etc. of C++ source code with `experiments/android_nn`
+- Introduce a new file if we have to introduce and define our own type, variable, function, namespace and etc. of C++ source code.
+  - Don't share existing file of `experiments/android_nn` for our own implementation.
+
+Simply keep as much as possible of `experiments/android_nn` when importing and introduce new files for our own implementaion.