README.md

   1 ## NPU SystemService (NPU Engine)
   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 [![artifacts-ubuntu](https://github.sec.samsung.net/AIP/NPU_SystemService/workflows/artifacts-ubuntu/badge.svg)](https://github.sec.samsung.net/AIP/NPU_SystemService/actions?query=workflow%3Aartifacts-ubuntu)
  10 [![artifacts-tizen](https://github.sec.samsung.net/AIP/NPU_SystemService/workflows/artifacts-tizen/badge.svg)](https://github.sec.samsung.net/AIP/NPU_SystemService/actions?query=workflow%3Aartifacts-tizen)
  11
  12 ## Directory Structure
  13 ```
  14 NPU_SystemService/    Root directory
  15 |-- src/
  16 |   |-- core/         Source files for NPU Engine Core
  17 |   |-- host/         Source files for User APIs
  18 |-- include/
  19 |   |-- common/       Definitions for Common Data
  20 |   |-- host/         Definitions for User APIs
  21 |-- tests/
  22 |   |-- unittests     Source files for Unit Tests
  23 |   |-- apptests      Source files for App Tests
  24 |   `-- utils         Source files for Test Utils
  25 |-- plugins/
  26 |   |-- npumgr        Reference plugin codes for NPU Manager
  27 |   `-- nnstreamer    Reference plugin codes for NNStreamer
  28 |-- packaging/        Tizen Packaging Files (i.e., FastModel or FPGA)
  29 |-- debian/           Debian Packaging Files (i.e., Ubuntu 18.04, 20.04)
  30 `-- docs/             Documentation using hotdoc
  31 ```
  32
  33 ## Getting Started
  34 - [AIP/NPU_DDK_DOCS](https://github.sec.samsung.net/pages/AIP/NPU_DDK_DOCS): Official documents generated by hotdoc
  35
  36 ## Related Projects
  37 - [AIP/NPU_Linux-kernel](https://github.sec.samsung.net/AIP/NPU_Linux-kernel): Linux kernel image and drivers (on FastModel simulator)
  38 - [AIP/NPU_bootstrap](https://github.sec.samsung.net/AIP/NPU_bootstrap): Bootstrap packages for FastModel simulator
  39 - [AIP/NPU_SystemService_Testdata](https://github.sec.samsung.net/AIP/NPU_SystemService_Testdata): Testdata for verification (.tvn models compiled by [AIP/NPU_Compiler](https://github.sec.samsung.net/AIP/NPU_Compiler))
  40 - [AIP/meta-trinity](https://github.sec.samsung.net/AIP/meta-trinity): Bitbake recipes for an FPGA board (ZCU102-ZYNQMP)
  41 - [AIP/n2s2_docker](https://github.sec.samsung.net/AIP/n2s2_docker): Docker images for npu-engine users
  42
  43 ## Official Repository (to download npu-engine packages)
  44 - Artifactory
  45   - Ubuntu 18.04: https://art.sec.samsung.net/artifactory/aip_debian/dists/bionic-nightly
  46   - Ubuntu 20.04: https://art.sec.samsung.net/artifactory/aip_debian/dists/focal-nightly
  47 - SPIN OBS
  48   - How to create your SPIN account: press [here](https://code.sec.samsung.net/confluence/display/NEWCOMM/SPIN+Request+Process)
  49   - Tizen: http://10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard
  50   - Ubuntu 18.04: http://10.113.136.32/download_trbs/newlive/devel:/Tizen:/6.0:/AI:/UbuntuTools
  51
  52 ## Additional Notes
  53 - The FastModel simulator requires Ubuntu 18.04 as your Host OS.
  54 - TRIV2 Models (.tvn) should be compatible with npubinfmt v3. Please refer to [npubinfmt.h](/include/common/npubinfmt.h)
  55
  56 ## Reference Links
  57 - Software Stack: https://code.sec.samsung.net/confluence/display/ODLC/2020+Overall+Software+Stack
  58 - CI Server: http://nnsuiteci.mooo.com/NPU_SystemService/ci/taos/
  59 - Code Coverage: http://nnsuiteci.mooo.com/NPU_SystemService/ci/gcov_html/
  60 - Doxygen manual: http://nnsuiteci.mooo.com/NPU_SystemService/latex/book.pdf