From: Роман Михайлович Русяев/AI Tools Lab /SRR/Staff Engineer/삼성전자 <r.rusyaev@samsung.com>
Date: Tue, 25 Sep 2018 14:03:54 +0000 (+0300)
Subject: Update SDD doc (#1643)
X-Git-Tag: nncc_backup~1704
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e0950f5535ea0d26faa739f713851be8d7d7f4c5;p=platform%2Fcore%2Fml%2Fnnfw.git

Update SDD doc (#1643)

include all rst files into the document

Signed-off-by: Roman Rusyaev <r.rusyaev@samsung.com>
---

diff --git a/contrib/nnc/doc/project/18_NN_Compiler_and_Optimizer_SDD.rst b/contrib/nnc/doc/project/18_NN_Compiler_and_Optimizer_SDD.rst
index 03cfa74..f831425 100644
--- a/contrib/nnc/doc/project/18_NN_Compiler_and_Optimizer_SDD.rst
+++ b/contrib/nnc/doc/project/18_NN_Compiler_and_Optimizer_SDD.rst
@@ -25,7 +25,45 @@ SW Development Document
 | 1.1   | 2018.04.17  | Add SW Quality Verification | Vostokov Sergey          | Sung-Jae Lee        |
 +-------+-------------+-----------------------------+--------------------------+---------------------+
 
-.. include:: project_terms_and_abbreviation.rst
+|
+
+**Terminology and Abbreviation**
+
+.. list-table::
+   :widths: 10 30
+   :header-rows: 0
+
+   * - 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
+   * - CG
+     - Computational Graph
+
 
 Project Overview
 ================
@@ -34,13 +72,101 @@ Purpose and Scope
 -----------------
 
 
-.. include:: project_purpose_and_scope.rst
-.. include:: project_target_model.rst
+The main goal of the project is to develop a compiler for neural networks to produce executable artifact 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)
+|
+
+.. list-table:: Table 1-1. Target Model
+   :widths: 23 50 20
+   :header-rows: 1
+
+   * - Product
+     - Target Model Name
+     - Comment
+
+   * - Tizen phone
+     - Tizen TM2
+     - Reference device
+
+   * - Tizen device
+     - Odroid XU4
+     - Reference board
+
+   * - SmartMachine target
+     - Microvision mv8890, exynos8890
+     - Reference device
 
 Assumptions, Dependencies and Constraints
 -----------------------------------------
 
-.. include:: project_sw_hw_constraints.rst
+|
+
+.. list-table:: Table 1-2. Assumptions, Dependencies and the Constraints
+   :widths: 23 40 23
+   :header-rows: 1
+
+   * - Item
+     - Assumptions, Dependencies and the Constraints
+     - Reference
+
+   * - Tizen SW Platform
+     - The following items should be provided:
+         - Tizen API
+         - Tizen kernel
+         - Tizen FW
+         - Tizen SDK
+         - Tizen naming convention
+         |
+     -
+         - `www.tizen.org <www.tizen.org>`_
+         - `wiki.tizen.org <wiki.tizen.org>`_
+         - `developer.tizen.org <developer.tizen.org>`_
+
+   * - SmartMachine OS Platform
+     - The following items should be provided:
+         - SmartMachine API
+         - SmartMachine kernel
+         - SmartMachine FW
+         - SmartMachine SDK
+         - SmartMachine naming convention
+         |
+     -
+         - `Platform confluence <http://suprem.sec.samsung.net/confluence/pages/viewpage.action?pageId=81833987>`_
+         - `Github <https://github.sec.samsung.net/RS7-SmartMachine>`_
+         - `Functional Safety confluence <http://suprem.sec.samsung.net/confluence/display/ASEC/Adaptive+AUTOSAR>`_
+
+
+   * - Host OS
+     - Linux-based OS (Ubuntu, Archlinux, etc)
+     -
+         - `Ubuntu site <https://www.ubuntu.com/>`_
+         - `Archlinux site <https://www.archlinux.org/>`_
+
+   * - Tizen target HW
+     - The reference device should be provided: Tizen TM2
+     -
+
+   * - SmartMachine target HW
+     - The reference device should be provided
+     -
+
 
 Development Plan And Result
 ===========================