[Doc] Fix updated information
authorDongju Chae <dongju.chae@samsung.com>
Wed, 26 Feb 2020 08:10:44 +0000 (17:10 +0900)
committer채동주/On-Device Lab(SR)/Staff Engineer/삼성전자 <dongju.chae@samsung.com>
Mon, 2 Mar 2020 09:55:40 +0000 (18:55 +0900)
This commit fixes updated information

Signed-off-by: Dongju Chae <dongju.chae@samsung.com>
README.md
doc/how_to_build.md
doc/how_to_use.md
doc/usage_examples.md

index 9d3dc6f..fb30c9f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-## NPU SystemService
+## NPU SystemService (compatible with both TRIV1 and TRIV2)
 
 [![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/)
 
index 4f733c3..b19e741 100644 (file)
@@ -59,7 +59,7 @@ $ gbs build -A [aarch64/armv7l/x86_64] --include-all --clean
 
 Lastly, we can find the `.rpm` files in the GBS root directory.
 ```bash
-$ ls `~/GBS-ROOT/local/repos/tizen/aarch64/RPMS/`
+$ ls ~/GBS-ROOT/local/repos/tizen/aarch64/RPMS/
 ```
 
 ## Ubuntu 16.04 (x86_64)
index 3341195..7fda1cb 100644 (file)
@@ -65,6 +65,7 @@ npu-engine
 $ ls /opt/trinity/etc
 npu-engine.ini
 ```
+Note that all logs are printed to the log file specified in `npu-engine.ini` (default: `/tmp/npu-engine.log`).
 
 Then, you can build your application with NPU-Engine library in any convenient way. For example,
 ```bash
index 184b343..045036f 100644 (file)
@@ -15,7 +15,7 @@ The `npu-engine-example` package contains useful unittests and apptests
 
 **Ubuntu**: `/opt/trinity/bin`
 
-## `npu-engine-testdata` package
+## `npu-engine-testdata` package (from [NPU_SystemService_Testdata](https://github.sec.samsung.net/AIP/NPU_SystemService_Testdata))
 The `npu-engine-testdata` package contains testdata used in some example test programs.
 
 **FastModel**: `/usr/share/npu-engine/testdata`
@@ -24,15 +24,15 @@ The `npu-engine-testdata` package contains testdata used in some example test pr
 
 ## Example: apptest_example_visa
 This application ([example_visa.c](/tests/apptests/example_visa.c)) executes NPU models (with single or multi layers) and compares outputs with their golden data.
-Note that the testdata used here follows the NPU binary format ([npubinfmt.h](/include/common/npubinfmt.h)) agreed with several parts.
+Note that the testdata used here follows the NPU binary format ([npubinfmt.h](/include/common/npubinfmt.h)). We currently support two versions of metadata (i.e., npubinfmt_v1 and v2), and older versions could be deprecated soon.
 
 Let's assume you are testing the application in Ubuntu 16.04.
 ```bash
 $ sudo apt-get install npu-engine-example npu-engine-testdata
 $ cd /opt/trinity
-$ ./bin/apptests/apptest_example_visa share/npu-engine/testdata/single
+$ ./bin/apptests/apptest_example_visa share/npu-engine/testdata/npubinfmt_v1
 ...
-$ ./bin/apptests/apptest_example_visa share/npu-engine/testdata/multi
+$ ./bin/apptests/apptest_example_visa share/npu-engine/testdata/npubinfmt_v2
 ...
 ```
 All tests should be passed if the library is successfully installed.