projects / platform / adaptation / npu / trix-engine.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
[VD/Kernel] Support multi-tensors of kernel requests
[platform/adaptation/npu/trix-engine.git] / README.md
diff --git a/README.md b/README.md
index 355ab74..6b3b8f9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,20 @@
-## NPU SystemService (compatible with both TRIV1 and TRIV2)
+## NPU SystemService (NPU Engine)
 
-[![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)
+[![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
-|   |-- host/         Source files for Host Lib (not used currently)
+|   |-- core/         Source files for NPU Engine Core
+|   |-- host/         Source files for User APIs
 |-- include/
 |   |-- common/       Definitions for Common Data
 |   |-- host/         Definitions for User APIs
@@ -15,23 +22,39 @@ NPU_SystemService/    Root directory
 |   |-- unittests     Source files for Unit Tests
 |   |-- apptests      Source files for App Tests
 |   `-- utils         Source files for Test Utils
-|-- packaging/        Tizen Packaging Files (i.e., FastModel Simulator)
-|-- debian/           Debian Packaging Files (i.e., Ubuntu 16.04)
-`-- doc/              Documentation
+|-- 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
-- How to setup your own FastModel enviornment: press [here](https://github.sec.samsung.net/AIP/NPU_bootstrap/blob/master/README.md)
-- How to build the NPU Engine library (FastModel or Ubuntu): press [here](/doc/how_to_build.md)
-- How to use the NPU Engine library in user apps: press [here](/doc/how_to_use.md)
-- Usage examples using the NPU Engine library: press [here](/doc/usage_examples.md)
+- [AIP/NPU_DDK_DOCS](https://github.sec.samsung.net/pages/AIP/NPU_DDK_DOCS): Official documents generated by hotdoc
 
-## Related Repositories
-- NPU SystemService's testdata: press [here](https://github.sec.samsung.net/AIP/NPU_SystemService_Testdata)
-- NPU SystemService's NPU emulator: press [here](https://github.sec.samsung.net/AIP/NPU_SystemService_Emulator)
+## 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
+- 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: http://suprem.sec.samsung.net/confluence/display/ODLC/NPU+OS+Stack
+- 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
Domain: Machine Learning / ML Framework;