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 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
   5 [![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)
   6 [![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/)
   7 [![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)
   8 [![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)
   9 [![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)
  10 [![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)
  11 [![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)
  12
  13 ## Directory Structure
  14 ```
  15 NPU_SystemService/    Root directory
  16 |-- src/
  17 |   |-- core/         Source files for NPU Engine Core
  18 |   `-- host/         Source files for User APIs
  19 |-- include/
  20 |   |-- common/       Definitions for Common Data
  21 |   `-- host/         Definitions for User APIs
  22 |-- tests/
  23 |   |-- unittests     Source files for Unit Tests
  24 |   |-- apptests      Source files for App Tests
  25 |   `-- utils         Source files for Test Utils
  26 |-- plugins/
  27 |   |-- npumgr        Reference plugin codes for VD NPU Manager
  28 |   `-- nnstreamer    Reference plugin codes for NNStreamer
  29 |-- packaging/        Tizen Packaging Files (i.e., FastModel or FPGA)
  30 |-- debian/           Debian Packaging Files (i.e., Ubuntu 18.04, 20.04)
  31 `-- docs/             Documentation using hotdoc
  32 ```
  33
  34 ## Additional Notes
  35 - Please refer to Wiki's Releated Projects and Reference Links [here](https://github.sec.samsung.net/AIP/NPU_SystemService/wiki/Releated-Projects-and-Reference-Links).
  36 - The FastModel simulator requires Ubuntu 18.04 as your Host OS.