From: Sergey Vostokov/AI Tools Lab/Staff Engineer/삼성전자 Date: Fri, 25 May 2018 08:38:33 +0000 (+0300) Subject: SW Development Document v1.0 (#79) X-Git-Tag: nncc_backup~2663 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=1d861d2150ab655a8d482ce3ff90a107da04794d;p=platform%2Fcore%2Fml%2Fnnfw.git SW Development Document v1.0 (#79) * Add initial version of SW Development Document This commit adds the initial version for SW Development Document. Signed-off-by: Sergey Vostokov * Add "support of Caffe/Caffe2" to title of SDD This commit adds "support of Caffe/Caffe2" to the title of the document SW Development Document Signed-off-by: Sergey Vostokov * Update format of SDD to fix errors This commit fixes format errors of SDD * Update revision table for SDD This commits add revision number after SE Team review Signed-off-by: Sergey Vostokov * Fix typos in SDD This commit fixes typos (NN Model -> NN model, etc) in SDD Signed-off-by: Sergey Vostokov * Change clang to gcc/g++, and DaRT to SVACE in SDD This commit changes tools to get SW Metrics in SDD Signed-off-by: Sergey Vostokov * Update Project plan in SDD This commit updates project plan and baseline in SDD Signed-off-by: Sergey Vostokov * Remove Reference section for SDD This commit removes Reference section and commpetitors enumeration from SDD. This information would be put in other document. Signed-off-by: Sergey Vostokov * Remove duplication of Reference and Competitors section There were duplications of Reference and Competitors section at the end of document. This commit removes them. Signed-off-by: Sergey Vostokov --- diff --git a/doc/project/development_document.md b/doc/project/development_document.md new file mode 100644 index 0000000..49320fe --- /dev/null +++ b/doc/project/development_document.md @@ -0,0 +1,201 @@ +# SW Development Document + +**Revision history** + +| Ver. | Date | Contents | Author | Approver | +| ---- | ---------- | -------------------------- | --------------- | ------------ | +| 0.1 | 2018.04.12 | Initial version | Vostokov Sergey | Sung-Jae Lee | +| 0.2 | 2018.04.16 | SE member in-charge review | Ilya Lopatin | | +| 1.0 | 2018.04.17 | Final Execution DR 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 | + +## Project Overview + +### Purpose and 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 | + +Table 1-1. Target Model + +### Assumptions, Dependencies and Constraints + + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ItemAssumptions, Dependencies and the ConstraintsReference
Tizen SW Platform
+
The following items should be provided:
+
    +
  • Tizen API
    • +
  • Tizen kernel
    • +
  • Tizen FW
    • +
  • Tizen SDK
    • +
  • Tizen naming convention
    • +
+
+
- www.tizen.org
- wiki.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
- Github
- Functional Safety confluence
Host OSLinux-based OS (Ubuntu, Archlinux, etc)- Ubuntu site
- Archlinux site
Tizen target HWThe reference device should be provided: Tizen TM2
SmartMachine target HWThe reference device should be provided
+Table 1-2. Assumptions, Dependecies and the Constraints + +## Development Plan And Result + +### Development Schedule + +| Task | Deliverable | Plan start | Plan end | Result start | Result end | Responsibility | +| ------------------------------------ | --------------------------------- | ---------- | -------- | ------------ | ---------- | -------------- | +| Prepare SW requirements | SRS | 04.2018 | 04.2018 | | | S. Vostokov | +| Prepare initial SW Test Document | STD | 04.2018 | 04.2018 | | | S. Vostokov | +| Prepare Initial Project Plan | SDD | 04.2018 | 04.2018 | | | S. Vostokov | +| Prepare SW Test Document | STD | 04.2018 | 06.2018 | | | S. Vostokov | +| Prepare design document | HLD, DLD | 05.2018 | 08.2018 | | | S. Vostokov | +| Prepare test result | STD, UTR | 04.2018 | 10.2018 | | | S. Vostokov | +| Prepare project completion documents | SDD, Project completion report | 05.2018 | 12.2018 | | | S. Vostokov | +| Implement Caffe Importer | Caffe NN model Importer | 05.2018 | 09.2018 | | | S. Vostokov | +| Implement code emitter for CPU | Code emitter | 05.2018 | 09.2018 | | | S. Vostokov | +| Implement TF Lite Importer | TensorFlow Lite NN model Importer | 05.2018 | 11.2018 | | | S. Vostokov | +| Implement code emitter for GPU | Code emitter | 02.2018 | 11.2018 | | | S. Vostokov | + +### SW Metrics + +| Category | Metric | Collection Method | Collection Period | Planned | Actual | Responsibility | +| -------- | ---------------------------------------------------------------------- | ------------------------ | ----------------------- | ----------------- | ------ | -------------- | +| Quality | Test pass rate | GTest | 22.02.2018 - 31.12.2018 | 100% | | S. Vostokov | +| Quality | Defects density | Defect management system | 22.02.2018 - 31.12.2018 | \<= 1 defect/KLOC | | S. Vostokov | +| Quality | Defects removal rate | Defect management system | 22.02.2018 - 31.12.2018 | 100% | | S. Vostokov | +| Quality | Critical defects | Static analysis | 22.02.2018 - 31.12.2018 | 0 | | S. Vostokov | +| Quality | Major defects | Static analysis | 22.02.2018 - 31.12.2018 | 0 | | S. Vostokov | +| Quality | Code review issue removal | Samsung Research github | 22.02.2018 - 31.12.2018 | 100% | | S. Vostokov | +| Quality | Comments Rate | `cloc` tool | 22.02.2018 - 31.12.2018 | Exceed 20% | | S. Vostokov | +| Quality | Cyclomatic Complexity | SVACE | 22.02.2018 - 31.12.2018 | \< 50 | | S. Vostokov | +| Quality | Unused Items (Unused Files, Unused Functions, Unused Global Variables) | gcc/g++ | 22.02.2018 - 31.12.2018 | 0 | | S. Vostokov | +| Process | Project On-time Completion Rate | PLM | 22.02.2018 - 31.12.2018 | 100% | | S. Vostokov | +| Process | Milestone On-time Completion Rate | PLM | 22.02.2018 - 31.12.2018 | 100% | | S. Vostokov | +| Process | Process compliance | Audit | 22.02.2018 - 31.12.2018 | 100% | | S. Vostokov | + +### SW Configurations Management + +#### Document + +| No | Configuration Item | Location | Submitter | +| -- | ---------------------------- | -------- | ----------- | +| 1 | SW Requirement Specification | PLM | S. Vostokov | +| 2 | SW Development Document | PLM | S. Vostokov | +| 3 | SW High Level Document | PLM | S. Vostokov | +| 4 | SW Detailed Level Document | PLM | S. Vostokov | +| 5 | SW System Test Document | PLM | S. Vostokov | +| 6 | SW Unit Test Report | PLM | S. Vostokov | + +#### SW Source Code + +SW Repository: + + + git clone https://github.sec.samsung.net/STAR/nncc.git + +#### Baseline + +| Phase | Baseline Name | SW Configuration Item | +| ------------------ | ------------------ | ------------------------------------------------------------------------------------------- | +| 04.2018 Plan | Execution DR | SW Requirement Specification, SW Development Document, System Test Document initial version | +| 06.2018 Execution | DR1 | System Test Document | +| 08.2018 Execution | Design document | SW High Level Document, SW Detailed Design Document | +| 09.2018 Execution | DR2 | | +| 10.2018 Execution | Test report | SW System Test Document (result), SW Unit Test Report | +| 12.2018 Completion | Project Completion | Project Completion Report | + +## Risk Management + +| Priority | Risk Description | Risk Reduction Solution | Schedule | Result | Responsibility | +| -------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------- | ------ | -------------- | +| 1 | Project scope is changed due extra HQ request | Discuss the new requirements via email and messenger, update SRS | 02.2018 - 12.2018 | | S. Vostokov | +| 2 | Unavoidable technical difficulties during requirements implementation | Submit requirements changes and get confirmation from HQ | 02.2018 - 12.2018 | | S. Vostokov | +| 3 | Not enough HR | Hire team members as soon as possible, request assistance from other teams | 02.2018 - 12.2018 | | S. Vostokov | +| 4 | Use of GPL code | Minimize usage of GPL code, wrap GPL modules with well-defined interfaces so they can be easily replaced. | 02.2018 - 12.2018 | | S. Vostokov | +| 5 | Requirements would change due external or internal circumstances, e.g. new technology or product launch | Discuss project changes and make corrections | 02.2018 - 12.2018 | | S. Vostokov | +