[README] Add the quick-start guide using docker
authorDongju Chae <dongju.chae@samsung.com>
Tue, 17 Nov 2020 08:48:45 +0000 (17:48 +0900)
committer우상정/On-Device Lab(SR)/Staff Engineer/삼성전자 <sangjung.woo@samsung.com>
Wed, 18 Nov 2020 10:58:19 +0000 (19:58 +0900)
This patch adds the Quick-start guide using docker for npu-engine
users.

Signed-off-by: Dongju Chae <dongju.chae@samsung.com>
README.md

index 662b756..4791df7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,12 +34,35 @@ NPU_SystemService/    Root directory
 - Usage examples using the NPU Engine library: press [here](/doc/usage_examples.md)
 - NPU Engine-enabled bootable images for an FPGA board: press [here](https://github.sec.samsung.net/AIP/meta-trinity/blob/master/README.md)
 
+## Quick-start Guide using Docker
+- Docker images (xenial, bionic) images from [Artifactory](https://art.sec.samsung.net/artifactory/webapp/#/home)
+- Trinity NPU simulation by [libmrpsim](https://github.sec.samsung.net/AIP/SIM_TrinityVision2/tree/master/mRPsim)
+```
+$ sudo apt install docker.io
+$ sudo docker pull art.sec.samsung.net/aip_docker/n2s2_docker/xenial
+$ sudo docker run -i -t art.sec.samsung.net/aip_docker/n2s2_docker/xenial /bin/bash
+
+root# ls /opt/trinity/share/npu-engine/testdata/npubinfmt_v3/MOBILENET_V1
+input_fmap_0.bin  model.tvn  output_fmap_0.bin
+
+root# apptest_tvn_triv2 /opt/trinity/share/npu-engine/testdata/npubinfmt_v3/MOBILENET_V1
+>>> Initializaing SPM with zero. It can be time-consuming...
+>>> Initializaing SPM with zero. It can be time-consuming...
+[Core Name: NPCore0], [File Name: /opt/trinity/share/mRPsim/decoder-triv2-emul.bin], [Ver: 1]
+        Section(.SRP.FLIH) Base (22000000) Size(36)
+...
+[APPTEST] apptest_tvn_triv2: PASSED
+
+root# exit
+```
+
 ## 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 (NPU models and reference input/output)
 - [AIP/NPU_SystemService_Emulator](https://github.sec.samsung.net/AIP/NPU_SystemService_Emulator): Cpp-based emulator to precheck NPU inferences in Ubuntu env.
 - [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
 
 ## SPIN Repository (to download official packages)
 - How to create your SPIN account: press [here](https://code.sec.samsung.net/confluence/display/NEWCOMM/SPIN+Request+Process)