Add template of High-Level Design document (#261)
authorSergey Vostokov/AI Tools Lab/Staff Engineer/삼성전자 <s.vostokov@samsung.com>
Fri, 25 May 2018 09:25:19 +0000 (12:25 +0300)
committerGitHub Enterprise <noreply-CODE@samsung.com>
Fri, 25 May 2018 09:25:19 +0000 (12:25 +0300)
Template of High-Level Design Document v1.0

doc/project/high_level_design.md [new file with mode: 0644]

diff --git a/doc/project/high_level_design.md b/doc/project/high_level_design.md
new file mode 100644 (file)
index 0000000..221d604
--- /dev/null
@@ -0,0 +1,82 @@
+# SW High Level Design
+
+**Revision history**
+
+| Ver. | Date       | Contents        | Author          | Approver     |
+| ---- | ---------- | --------------- | --------------- | ------------ |
+| 0.1  | 2018.05.25 | Initial version | Vostokov Sergey | Sung-Jae Lee |
+
+**Terminology and Abbreviation**
+
+|              |                                                               |
+| ------------ | ------------------------------------------------------------- |
+| OS           | Operating System                                              |
+| OS API       | Application interface of OS                                   |
+| HW           | Hardware                                                      |
+| SW           | Software                                                      |
+| NN           | Neural Network                                                |
+| NN model     | Neural network model (Instance of NN built with ML framework) |
+| NN compiler  | The compiler for neural network                               |
+| ML framework | The machine learning framework                                |
+| TF/TF Lite   | Tensorflow/Tensorflow Lite ML framework                       |
+| IR           | Intermediate representation                                   |
+| CI/CI system | Continuous integration system                                 |
+| UI           | The user interface                                            |
+| GUI          | The graphical user interface                                  |
+| CLI          | The command-line interface                                    |
+
+## Overview
+
+### Scope
+
+The main goal of the project is to develop a compiler for neural
+networks to produce executable artefact for specified SW and HW
+platform.
+
+The development scope includes the following components:
+
+  - Develop importer module to parse, verify and represent NN model for
+    further optimization and compilation
+  - Develop code emitters to produce executable binary for CPU and GPU
+
+2018 year goals:
+
+  - Support TensorFlow Lite NN model format
+  - Support Caffe NN model format
+  - Support Caffe2 NN model format (Optional)
+  - Support compilation of MobileNet NN
+  - Support compilation of Inception v3 NN
+  - Support ARM CPU
+  - Support ARM GPU (Mali)
+  - Support Tizen OS
+  - Support SmartMachine OS(Optional)
+
+| Product             | Target Model Name              | Comment          |
+| ------------------- | ------------------------------ | ---------------- |
+| Tizen phone         | Tizen TM2                      | Reference device |
+| Tizen device        | Odroid XU4                     | Reference board  |
+| SmartMachine target | Microvision mv8890, exynos8890 | Reference device |
+
+1-1. Target Model
+
+### Design Consideration
+
+### Constraints
+
+## SW System Architecture Design
+
+### Overall Architecture
+
+### Composition of Architecture
+
+| Layer or Subsystem Name | Description |
+| ----------------------- | ----------- |
+|  |
+|  |
+|  |
+
+### Interface
+
+## SW System Operation Design
+
+## Appendix 1. Tracebility Matrix