README.md

   1 ## NPU SystemService (compatible with both TRIV1 and TRIV2)
   2
   3 [![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) [![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/)
   4
   5 ## Directory Structure
   6 ```
   7 NPU_SystemService/    Root directory
   8 |-- src/
   9 |   |-- core/         Source files for NPU Engine
  10 |   |-- host/         Source files for Host Lib (not used currently)
  11 |-- include/
  12 |   |-- common/       Definitions for Common Data
  13 |   |-- host/         Definitions for User APIs
  14 |-- tests/
  15 |   |-- unittests     Source files for Unit Tests
  16 |   |-- apptests      Source files for App Tests
  17 |   |-- utils         Source files for Test Utils
  18 |   `-- models        NPU Model binaries from second/third-party repos
  19 |-- tools/            Useful tools or scripts
  20 |-- packaging/        Tizen Packaging Files (i.e., FastModel Simulator)
  21 |-- debian/           Debian Packaging Files (i.e., Ubuntu 16.04)
  22 `-- doc/              Documentation
  23 ```
  24
  25 ## Getting Started
  26 - How to setup your own FastModel enviornment: press [here](https://github.sec.samsung.net/AIP/NPU_bootstrap/blob/master/README.md)
  27 - How to build the NPU Engine library (FastModel or Ubuntu): press [here](/doc/how_to_build.md)
  28 - How to use the NPU Engine library in user apps: press [here](/doc/how_to_use.md)
  29 - Usage examples using the NPU Engine library: press [here](/doc/usage_examples.md)
  30
  31 ## Related Repositories
  32 - NPU SystemService's testdata: press [here](https://github.sec.samsung.net/AIP/NPU_SystemService_Testdata)
  33 - NPU SystemService's NPU emulator: press [here](https://github.sec.samsung.net/AIP/NPU_SystemService_Emulator)
  34
  35 ## Reference Links
  36 - Software Stack: http://suprem.sec.samsung.net/confluence/display/ODLC/NPU+OS+Stack
  37 - CI Server: http://nnsuiteci.mooo.com/NPU_SystemService/ci/taos/
  38 - Code Coverage: http://nnsuiteci.mooo.com/NPU_SystemService/ci/gcov_html/
  39 - Doxygen manual: http://nnsuiteci.mooo.com/NPU_SystemService/latex/book.pdf