README.md

   1 ## NPU SystemService (compatible with both TRIV1 and TRIV2)
   2
   3 [![Version](https://github.sec.samsung.net/nnsuite/n2s2/blob/master/AIP_NPU_SystemService/badges/version.svg)](/CHANGES)
   4 [![Code Coverage](https://github.sec.samsung.net/nnsuite/n2s2/blob/master/AIP_NPU_SystemService/badges/codecoverage.svg)](http://nnsuiteci.mooo.com/NPU_SystemService/ci/gcov_html/index.html)
   5 [![Unit Test](https://github.sec.samsung.net/nnsuite/n2s2/blob/master/AIP_NPU_SystemService/badges/unittest.svg)](http://nnsuiteci.mooo.com/NPU_SystemService/ci/unittest_result/)
   6 [![SAM Score](https://github.sec.samsung.net/nnsuite/n2s2/blob/master/AIP_NPU_SystemService/badges/samscore.svg)](https://code.sec.samsung.net/architecturemanager/app/sam/NPU_SystemService/npu-engine/latest/overview)
   7 [![Issues](https://github.sec.samsung.net/nnsuite/n2s2/blob/master/AIP_NPU_SystemService/badges/issues.svg)](https://github.sec.samsung.net/AIP/NPU_SystemService/issues)
   8 [![Pull Requests](https://github.sec.samsung.net/nnsuite/n2s2/blob/master/AIP_NPU_SystemService/badges/pulls.svg)](https://github.sec.samsung.net/AIP/NPU_SystemService/pulls)
   9
  10 ## Directory Structure
  11 ```
  12 NPU_SystemService/    Root directory
  13 |-- src/
  14 |   |-- core/         Source files for NPU Engine
  15 |   |-- host/         Source files for Host Lib (not used currently)
  16 |-- include/
  17 |   |-- common/       Definitions for Common Data
  18 |   |-- host/         Definitions for User APIs
  19 |-- tests/
  20 |   |-- unittests     Source files for Unit Tests
  21 |   |-- apptests      Source files for App Tests
  22 |   `-- utils         Source files for Test Utils
  23 |-- packaging/        Tizen Packaging Files (i.e., FastModel Simulator)
  24 |-- debian/           Debian Packaging Files (i.e., Ubuntu 16.04)
  25 `-- doc/              Documentation
  26 ```
  27
  28 ## Getting Started
  29 - How to setup your own FastModel enviornment (in Ubuntu 16.04 running on your host PC): press [here](https://github.sec.samsung.net/AIP/NPU_bootstrap/blob/master/README.md)
  30 - How to build the NPU Engine library (FastModel or Ubuntu): press [here](/doc/how_to_build.md)
  31 - How to use the NPU Engine library in user apps: press [here](/doc/how_to_use.md)
  32 - Usage examples using the NPU Engine library: press [here](/doc/usage_examples.md)
  33
  34 ## Related Projects
  35 - [AIP/NPU_bootstrap](https://github.sec.samsung.net/AIP/NPU_bootstrap): Bootstrap packages for FastModel simulator
  36 - [AIP/NPU_Linux-kernel](https://github.sec.samsung.net/AIP/NPU_Linux-kernel): Linux kernel image and drivers (on FastModel simulator)
  37 - [AIP/NPU_SystemService_Testdata](https://github.sec.samsung.net/AIP/NPU_SystemService_Testdata): Testdata for verification (NPU models and reference input/output)
  38 - [AIP/NPU_SystemService_Emulator](https://github.sec.samsung.net/AIP/NPU_SystemService_Emulator): Cpp-based emulator to precheck NPU inferences in Ubuntu env.
  39
  40 ## SPIN Repository (to download official packages)
  41 - How to create your SPIN account: press [here](https://code.sec.samsung.net/confluence/display/NEWCOMM/SPIN+Request+Process)
  42 - Tizen: http://10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard
  43 - Ubuntu (16.04): http://10.113.136.32/download_trbs/newlive/devel:/Tizen:/6.0:/AI:/UbuntuTools/Ubuntu_16.04
  44
  45 ## Additional Notes
  46 - We don't officially support Ubuntu 18.04 as the FastModel Simulator does not fully support it.
  47 - While TRIV1 is compatible with one of two binary formats (npubinfmt v1 and v2), TRIV2 requires npubinfmt v3 only.
  48 - To use the NPU Engine library, it's mandatory to access the SPIN repository (`10.113.136.32`). Please read the related document carefully.
  49
  50 ## Reference Links
  51 - Software Stack: http://suprem.sec.samsung.net/confluence/display/ODLC/NPU+OS+Stack
  52 - CI Server: http://nnsuiteci.mooo.com/NPU_SystemService/ci/taos/
  53 - Code Coverage: http://nnsuiteci.mooo.com/NPU_SystemService/ci/gcov_html/
  54 - Doxygen manual: http://nnsuiteci.mooo.com/NPU_SystemService/latex/book.pdf