## NPU SystemService (NPU Engine)

[![Version](https://github.sec.samsung.net/nnsuite/n2s2/blob/master/AIP_NPU_SystemService/badges/version.svg)](/CHANGES)
[![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/)
[![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)
[![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)
[![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)
[![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)
[![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)

## Directory Structure
```
NPU_SystemService/    Root directory
|-- src/
|   |-- core/         Source files for NPU Engine Core
|   |-- host/         Source files for User APIs
|-- include/
|   |-- common/       Definitions for Common Data
|   |-- host/         Definitions for User APIs
|-- tests/
|   |-- unittests     Source files for Unit Tests
|   |-- apptests      Source files for App Tests
|   `-- utils         Source files for Test Utils
|-- plugins/
|   |-- npumgr        Reference plugin codes for NPU Manager
|   `-- nnstreamer    Reference plugin codes for NNStreamer
|-- packaging/        Tizen Packaging Files (i.e., FastModel or FPGA)
|-- debian/           Debian Packaging Files (i.e., Ubuntu 18.04, 20.04)
`-- docs/             Documentation using hotdoc
```

## Getting Started
- [AIP/NPU_DDK_DOCS](https://github.sec.samsung.net/pages/AIP/NPU_DDK_DOCS): Official documents generated by hotdoc

## Related Projects
- [AIP/NPU_Linux-kernel](https://github.sec.samsung.net/AIP/NPU_Linux-kernel): Linux kernel image and drivers (on FastModel simulator)
- [AIP/NPU_bootstrap](https://github.sec.samsung.net/AIP/NPU_bootstrap): Bootstrap packages for FastModel simulator
- [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))
- [AIP/meta-trinity](https://github.sec.samsung.net/AIP/meta-trinity): Bitbake recipes for an FPGA board (ZCU102-ZYNQMP)
- [AIP/n2s2_docker](https://github.sec.samsung.net/AIP/n2s2_docker): Docker images for npu-engine users

## Official Repository (to download npu-engine packages)
- Artifactory
  - Ubuntu 18.04: https://art.sec.samsung.net/artifactory/aip_debian/dists/bionic-nightly
  - Ubuntu 20.04: https://art.sec.samsung.net/artifactory/aip_debian/dists/focal-nightly
- SPIN OBS
  - How to create your SPIN account: press [here](https://code.sec.samsung.net/confluence/display/NEWCOMM/SPIN+Request+Process)
  - Tizen: http://10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard
  - Ubuntu 18.04: http://10.113.136.32/download_trbs/newlive/devel:/Tizen:/6.0:/AI:/UbuntuTools

## Additional Notes
- Please refer to [here](https://github.sec.samsung.net/AIP/NPU_SystemService/blob/tizen/tests/apptests/tvn_triv2_example.cc) to get a reference user program using the npu-engine library
- The FastModel simulator requires Ubuntu 18.04 as your Host OS.
- TRIV2 Models (.tvn) should be compatible with npubinfmt v3. Please refer to [npubinfmt.h](/include/common/npubinfmt.h)

## Reference Links
- Software Stack: https://code.sec.samsung.net/confluence/display/ODLC/2020+Overall+Software+Stack
- CI Server: http://nnsuiteci.mooo.com/NPU_SystemService/ci/taos/
- Code Coverage: http://nnsuiteci.mooo.com/NPU_SystemService/ci/gcov_html/
- Doxygen manual: http://nnsuiteci.mooo.com/NPU_SystemService/latex/book.pdf