update SW Development Document for completion DR (#2571)
authorРоман Михайлович Русяев/AI Tools Lab /SRR/Staff Engineer/삼성전자 <r.rusyaev@samsung.com>
Mon, 10 Dec 2018 11:41:27 +0000 (14:41 +0300)
committerGitHub Enterprise <noreply-CODE@samsung.com>
Mon, 10 Dec 2018 11:41:27 +0000 (14:41 +0300)
* update SW Development Document for completion DR

* add report of ProtexIP
* add report of SVACE
* add code metrics result
* correct System Test document for completion DR
* add mention about coding style document

Signed-off-by: Roman Rusyaev <r.rusyaev@samsung.com>
contrib/nnc/doc/project/18_NN_Compiler_and_Optimizer_SDD.rst
contrib/nnc/doc/project/18_NN_Compiler_and_Optimizer_STD.rst

index fa3419f..b2a3c56 100644 (file)
@@ -26,6 +26,8 @@ SW Development Document
 +-------+-------------+-----------------------------+--------------------------+---------------------+
 | 2.0   | 2018.09.24  | DR2                         | Vostokov Sergey          | Sung-Jae Lee        |
 +-------+-------------+-----------------------------+--------------------------+---------------------+
+| 3.0   | 2018.12.7   | Completion DR               | Rusyaev Roman            | Sung-Jae Lee        |
++-------+-------------+-----------------------------+--------------------------+---------------------+
 
 |
 
@@ -198,10 +200,10 @@ Development Schedule
 | Prepare design    | HLD, DLD                   | 05.2018    | 08.2018    |  05.2018     | 08.2018    | S\. Vostokov       |
 | document          |                            |            |            |              |            |                    |
 +-------------------+----------------------------+------------+------------+--------------+------------+--------------------+
-| Prepare test      | STD, UTR                   | 04.2018    | 10.2018    |              |            | S\. Vostokov       |
+| Prepare test      | STD, UTR                   | 04.2018    | 10.2018    |  09.2018     | 12.2018    | R\. Rusyaev        |
 | result            |                            |            |            |              |            |                    |
 +-------------------+----------------------------+------------+------------+--------------+------------+--------------------+
-| Prepare project   | SDD,                       | 05.2018    | 12.2018    |              |            | S\. Vostokov       |
+| Prepare project   | SDD,                       | 05.2018    | 12.2018    |  12.2018     | 12.2018    | R\. Rusyaev        |
 | completion        | Project completion report  |            |            |              |            |                    |
 | documents         |                            |            |            |              |            |                    |
 +-------------------+----------------------------+------------+------------+--------------+------------+--------------------+
@@ -211,10 +213,10 @@ Development Schedule
 | Implement code    | Code emitter               | 05.2018    | 09.2018    | 05.2018      | 09.2018    | S\. Vostokov       |
 | emitter for CPU   |                            |            |            |              |            |                    |
 +-------------------+----------------------------+------------+------------+--------------+------------+--------------------+
-| Implement TF Lite | TensorFlow Lite NN model   | 05.2018    | 11.2018    |              |            | S\. Vostokov       |
+| Implement TF Lite | TensorFlow Lite NN model   | 05.2018    | 11.2018    | 05.2018      | 07.2018    | S\. Vostokov       |
 | Importer          | Importer                   |            |            |              |            |                    |
 +-------------------+----------------------------+------------+------------+--------------+------------+--------------------+
-| Implement code    | Code emitter               | 02.2018    | 11.2018    |              |            | S\. Vostokov       |
+| Implement code    | Code emitter               | 02.2018    | 11.2018    | 08.2018      | 12.2018    | R\. Rusyaev        |
 | emitter for GPU   |                            |            |            |              |            |                    |
 +-------------------+----------------------------+------------+------------+--------------+------------+--------------------+
 
@@ -239,95 +241,95 @@ SW Metrics
      - GTest
      - 22.02.2018 - 31.12.2018
      - 100%
-     -
-     - S\. Vostokov
+     - 100%
+     - R\. Rusyaev
 
    * - Quality
      - Defects density
      - Manual (GTest/Scripts)
      - 22.02.2018 - 31.12.2018
      - <= 1 defect/KLOC
-     -
-     - S\. Vostokov
+     - 0.0013
+     - R\. Rusyaev
 
    * - Quality
      - Defects removal rate
-     - SonerQube
+     - Manual (GTest/Scripts)
      - 22.02.2018 - 31.12.2018
      - 100%
-     -
-     - S\. Vostokov
+     - 86%
+     - R\. Rusyaev
 
    * - Quality
      - Critical defects
      - SVACE
      - 22.02.2018 - 31.12.2018
      - 0
-     -
-     - S\. Vostokov
+     - 2
+     - R\. Rusyaev
 
    * - Quality
      - Major defects
      - SVACE
      - 22.02.2018 - 31.12.2018
      - 0
-     -
-     - S\. Vostokov
+     - 4
+     - R\. Rusyaev
 
    * - Quality
      - Code review issue removal
      - Samsung Research github
      - 22.02.2018 - 31.12.2018
      - 100%
-     -
-     - S\. Vostokov
+     - 94%
+     - R\. Rusyaev
 
    * - Quality
      - Comments Rate
      - ``cloc`` tool
      - 22.02.2018 - 31.12.2018
      - Exceed 20%
-     -
-     - S\. Vostokov
+     - 12%
+     - R\. Rusyaev
 
    * - Quality
      - Cyclomatic Complexity
-     - SonarQube
+     - Manual (Scripts)
      - 22.02.2018 - 31.12.2018
      - < 50
-     -
-     - S\. Vostokov
+     - 24
+     - R\. Rusyaev
 
    * - Quality
      - Unused Items (Unused Files, Unused Functions, Unused Global Variables)
      - gcc/g++
      - 22.02.2018 - 31.12.2018
      - 0
-     -
-     - S\. Vostokov
+     - 1
+     - R\. Rusyaev
 
    * - Process
      - Project On-time Completion Rate
      - PLM
      - 22.02.2018 - 31.12.2018
      - 100%
-     -
-     - S\. Vostokov
+     - 100%
+     - R\. Rusyaev
 
    * - Process
      - Milestone On-time Completion Rate
      - PLM
      - 22.02.2018 - 31.12.2018
      - 100%
-     -
-     - S\. Vostokov
+     - 100%
+     - R\. Rusyaev
 
    * - Process
      - Process compliance
      - Audit
      - 22.02.2018 - 31.12.2018
      - 100%
-     -
+     - 100%
      - A\. Kondrashov
 
 
@@ -452,7 +454,7 @@ SW Verification
      - ProtexIP
      - Execution
      - Vostokov Sergey
-     -
+     - `Appendix 1. ProtexIP Report`_
      -
 
    * - 2
@@ -461,7 +463,7 @@ SW Verification
      - Svace
      - Test
      - Vostokov Sergey
-     -
+     - The defects are not fixed yet
      -
 
    * - 3
@@ -470,7 +472,7 @@ SW Verification
      - Github
      - Test
      - Vostokov Sergey
-     -
+     - all critical defects were fixed
      -
 
 Static Analysis
@@ -490,19 +492,19 @@ Static Analysis
      - SA Verification I (SVACE)
      - 28.09.2018
      - 20 defects
-     - To be fixed at project completion
+     -
 
    * - 2
      - SA Verification II (SVACE)
      - 30.11.2018
-     -
+     - 30 defects
      -
 
    * - 2
      - SA Verification III (SVACE)
      - 31.12.2018
-     -
-     -
+     - 6 defects
+     - see `Appendix 2. Svace Report`_
 
 Coding Standard
 ---------------
@@ -520,8 +522,8 @@ Coding Standard
    * - 1
      - Coding standard enforcement with ``clang-format`` tool.
      - Regular
-     -
-     -
+     - ``clang-format`` has not been used yet to verify coding style
+     - our coding style document `coding style document <https://github.sec.samsung.net/STAR/nncc/blob/master/contrib/nnc/doc/codestyle.rst>`_
 
 
 Convergence (integration testing)
@@ -552,13 +554,13 @@ Dynamic Analysis
    * - 2
      - DA Verification II
      - 30.11.2018
-     -
+     - memory leaks are absent
      -
 
    * - 2
      - DA Verification III
      - 31.12.2018
-     -
+     - memory leaks are absent
      -
 
 Architecture Analysis
@@ -590,7 +592,7 @@ Code Review
    * - 1
      - Code review
      - Regular
-     -
+     - 416
      - All code is reviewed manually using ``github`` tool before committing
 
 Risk Management
@@ -612,37 +614,319 @@ Risk Management
      - Project scope is changed due extra HQ request
      - Discuss the new requirements via email and messenger, update SRS
      - 02.2018 - 12.2018
-     -
-     - S\. Vostokov
+     - no risks
+     - R\. Rusyaev
 
    * - 2
      - Unavoidable technical difficulties during requirements implementation
      - Submit requirements changes and get confirmation from HQ
      - 02.2018 - 12.2018
-     -
-     - S\. Vostokov
+     - no risks
+     - R\. Rusyaev
 
    * - 3
      - Not enough HR
      - Hire team members as soon as possible, request assistance from other teams
      - 02.2018 - 12.2018
-     -
-     - S\. Vostokov
+     - no risks
+     - R\. Rusyaev
 
    * - 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
+     - no risks
+     - R\. Rusyaev
 
    * - 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
+     - no risks
+     - R\. Rusyaev
+
+Appendix 1. ProtexIP Report
+===========================
+
+Summary
+-------
+
+.. list-table::
+
+   * - **Name**
+     - nncc_latest_MV_13188_STAR+nncc
+
+   * - **Project Creator**
+     - move.swc.tizen SWC
+
+   * - **License**
+     - Apache License Version 2.0 [Reviewed and Approved]
+
+   * - **Description**
      -
-     - S\. Vostokov
+
+   * - **Number of Files**
+     - 1,320
+
+   * - **Files Pending Identification**
+     - 0 (0%)
+
+   * - **Files with Violations**
+     - 0 (0%)
+
+   * - **Server**
+     - 165.213.149.122
+
+
+Analysis Summary
+----------------
+
+.. list-table::
+
+   * - **Last Updated:**
+     - 6.12.2018, 8:40
+
+   * - **Scan Started:**
+     - 6.12.2018, 8:33
+
+   * - **Scan Finished:**
+     - 6.12.2018, 8:40
+
+   * - **Files Analyzed:**
+     - 1,320 Files
+
+   * - **Bytes Analyzed:**
+     - 4.998 MB (5,240,297 B)
+
+   * - **Files Skipped:**
+     - 13 Files
+
+   * - **Bytes Skipped:**
+     - 468,187 B
+
+   * - **Analysis Release Description:**
+     - Product version 7.5.0 KB update 16, custom codeprints modified March 21, 2018 03:06 PM
+
+   * - **Analyzed From Host:**
+     - solveweb2
+
+   * - **Analyzed By:**
+     - move.swc.tizen SWC (move.swc.tizen@samsung.com)
+
+   * - **Analyzed With OS:**
+     - Linux
+
+   * - **Analyzed With Locale:**
+     - ko-KR
+
+   * - **Analyzed With Options:**
+     -
+
+   * - File Matches
+     - Yes
+
+   * - Snippet Matches
+     - Yes
+
+   * - Snippet Match Sensitivity
+     - 8 - Default
+
+   * - Java Import Statements
+     - Yes
+
+   * - Java Package Statements
+     - Yes
+
+   * - Binary Dependencies
+     - Yes
+
+   * - String Searches
+     - Yes
+
+   * - Allow wild cards (*) in string search queries
+     - No
+
+   * - Allow regular expression search queries
+     - No
+
+   * - Decompress Compressed Files
+     - No
+
+   * - Discard Rejected Code Matches
+     - No
+
+   * - Keep Only To Discoveries To Codeprinted Components
+     - No
+
+   * - Keep Only Discoveries To Components With Best Matching Source Path
+     - No
+
+   * - Keep Only Discoveries To Components Released On Or After
+     - No
+
+   * - Keep Only Discoveries To Top Component Matches
+     - No
+
+   * - Keep Only Discoveries To Maven Artifacts
+     - No
+
+   * - Expand Archive Files
+     - No
+
+   * - Enable Multi-User File Comparison
+     - Yes
+
+   * - Store non-precision matches
+     - Yes
+
+   * - Enable Rapid Identification
+     - No
+
+
+Bill of Materials
+-----------------
+
+.. list-table::
+   :header-rows: 1
+
+   * - Approval Status
+     - License Conflict
+     - Component
+     - Version
+     - Home Page
+     - Component Comment
+
+   * - N/A
+     - N/A
+     - nncc_latest_MV_13188_STAR+nncc
+     - Unspecified
+     -
+     -
+
+.. list-table::
+   :header-rows: 1
+
+   * - License
+     - External IDs
+     - Usage
+     - Ship Status
+     - Manual Code Match
+     - Rapid ID Code Match
+     - Depends
+     - Search
+     - Used By
+
+   * - Apache License Version 2.0 [Reviewed and Approved]
+     -
+     - Original Code
+     - Ship
+     - 1,320
+     - 0
+     - 0
+     - 0
+     -
+
+Licenses in Effect
+------------------
+
+.. list-table::
+   :header-rows: 1
+
+   * - License Name
+     - Ship Status
+     - Custom Fields
+
+   * - Apache License Version 2.0 [Reviewed and Approved]
+     - Ship
+     -
+
+License Conflicts
+-----------------
+
+There are no license conflicts in this project.
+
+
+Appendix 2. Svace Report
+========================
+
+===== ======================== ========
+WGID  Checker                  Severity
+===== ======================== ========
+39491 INVARIANT_RESULT.OP_ZERO Major
+39492 INVARIANT_RESULT.OP_ZERO Major
+39493 UNINIT.CTOR.MANY         Critical
+39494 NO_EFFECT                Major
+39495 NO_EFFECT                Major
+39496 UNINIT.CTOR              Critical
+===== ======================== ========
+
+================= ==========================================================================
+Count In Snapshot File Path
+================= ==========================================================================
+1                 /usr/include/c++/7/
+1                 /usr/include/c++/7/
+1                 /home/timur/Development/metrics/nncc-build/build/contrib/enco/test/tflite/
+1                 /usr/include/c++/7/
+1                 /usr/include/c++/7/
+1                 /home/timur/Development/metrics/nncc-build/build/contrib/enco/test/tflite/
+================= ==========================================================================
+
+============================================================= =================== ======= =========
+Function                                                      File                Comment Audit
+============================================================= =================== ======= =========
+reference std::array<Network::Output, 0>::at(size_type)       array                       Undecided
+const_reference std::array<Network::Output, 0>::at(size_type) array                       Undecided
+_ZN7NetworkC2Ev                                               empty.cpp                   Undecided
+reference std::array<Network::Output, 0>::at(size_type)       array                       Undecided
+const_reference std::array<Network::Output, 0>::at(size_type) array                       Undecided
+_ZN7NetworkC2Ev                                               Regression_0002.cpp         Undecided
+============================================================= =================== ======= =========
+
+========= ========== ==================== ========================= ==================
+Action    Owner      First Detected Date  Detected Date In Snapshot Last Reviewed Date
+========= ========== ==================== ========================= ==================
+Undecided Unassigned 2018/12/07  13:35:18 2018/12/07  13:35:21
+Undecided Unassigned 2018/12/07  13:35:18 2018/12/07  13:35:21
+Undecided Unassigned 2018/12/07  13:35:18 2018/12/07  13:35:21
+Undecided Unassigned 2018/12/07  13:35:18 2018/12/07  13:35:21
+Undecided Unassigned 2018/12/07  13:35:18 2018/12/07  13:35:21
+Undecided Unassigned 2018/12/07  13:35:18 2018/12/07  13:35:21
+========= ========== ==================== ========================= ==================
+
+============== ========= ===========================================================
+Classification Component WGID URL
+============== ========= ===========================================================
+Undecided      REST      http://svace.rnd.samsung.ru/page/review#PRJID=20&WGID=39491
+Undecided      REST      http://svace.rnd.samsung.ru/page/review#PRJID=20&WGID=39492
+Undecided      REST      http://svace.rnd.samsung.ru/page/review#PRJID=20&WGID=39493
+Undecided      REST      http://svace.rnd.samsung.ru/page/review#PRJID=20&WGID=39494
+Undecided      REST      http://svace.rnd.samsung.ru/page/review#PRJID=20&WGID=39495
+Undecided      REST      http://svace.rnd.samsung.ru/page/review#PRJID=20&WGID=39496
+============== ========= ===========================================================
+
+============ =============== =========== ======= ======
+Status       Detected Status File Status Project Module
+============ =============== =========== ======= ======
+Unclassified New             FILE OLD    18 NNCC nncc
+Unclassified New             FILE OLD    18 NNCC nncc
+Unclassified New             FILE NEW    18 NNCC nncc
+Unclassified New             FILE OLD    18 NNCC nncc
+Unclassified New             FILE OLD    18 NNCC nncc
+Unclassified New             FILE NEW    18 NNCC nncc
+============ =============== =========== ======= ======
+
+================ ===================== =========== ===========
+Custom Pick list Custom Search User ID Custom Text Snapshot ID
+================ ===================== =========== ===========
+Undecided        Unassigned                        696
+Undecided        Unassigned                        696
+Undecided        Unassigned                        696
+Undecided        Unassigned                        696
+Undecided        Unassigned                        696
+Undecided        Unassigned                        696
+================ ===================== =========== ===========
+
 
 
 **References**
index 7c7cb64..312d7ae 100644 (file)
@@ -1681,14 +1681,16 @@ Test Result
 
 Defect rates
 ````````````
-To be filled at the project completion
+No defects are found
+
 
 Main problem contents
 ---------------------
-To be filled at the project completion
+
+No problems were found
 
 
 Total Result
 ============
 
-To be filled at the project completion
+128 of 173 tests are passed