Revise some documents (e.g., removing ubuntu 18.04, additional notes)

This patch revises some documents (e.g., removing ubuntu 18.04,
additional notes)

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

diff --git a/README.md b/README.md
index 068e464..9722d68 100644 (file)
--- a/README.md
+++ b/README.md
@@ -21,12 +21,12 @@ NPU_SystemService/    Root directory
 |   |-- 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/18.04)
+|-- debian/           Debian Packaging Files (i.e., Ubuntu 16.04)
 `-- doc/              Documentation
 ```
 
 ## 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 setup your own FastModel enviornment (in Ubuntu 16.04 running on your host PC): 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)
@@ -40,7 +40,12 @@ NPU_SystemService/    Root directory
 ## 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)
 - Tizen: http://10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard
-- Ubuntu (16.04/18.04): http://10.113.136.32/download_trbs/newlive/devel:/Tizen:/6.0:/AI:/UbuntuTools
+- Ubuntu (16.04): http://10.113.136.32/download_trbs/newlive/devel:/Tizen:/6.0:/AI:/UbuntuTools/Ubuntu_16.04
+
+## Additional Notes
+- We don't officially support Ubuntu 18.04 as the FastModel Simulator does not fully support it.
+- While TRIV1 is compatible with one of two binary formats (npubinfmt v1 and v2), TRIV2 requires npubinfmt v3 only.
+- To use the NPU Engine library, it's mandatory to access the SPIN repository (`10.113.136.32`). Please read the related document carefully.
 
 ## Reference Links
 - Software Stack: http://suprem.sec.samsung.net/confluence/display/ODLC/NPU+OS+Stack

diff --git a/doc/how_to_build.md b/doc/how_to_build.md
index cb6d020..3ff1f48 100644 (file)
--- a/doc/how_to_build.md
+++ b/doc/how_to_build.md
@@ -14,7 +14,7 @@ Also, before accessing the packages, you need to get the access permission for S
 $ taos-mgr refresh
 $ taos-mgr install npu-engine
 ```
-**Ubuntu 16.04/18.04 (x86_64)**
+**Ubuntu 16.04 (x86_64)**
 ``` bash
 $ sudo echo "deb [trusted=yes] http://10.113.136.32/download_trbs/newlive/devel:/Tizen:/6.0:/AI:/UbuntuTools/Ubuntu_16.04 /" | sudo tee /etc/apt/sources.list.d/spin.list
 $
@@ -70,9 +70,9 @@ Lastly, we can find the `.rpm` files in the GBS root directory.
 $ ls ~/GBS-ROOT/local/repos/tizen/aarch64/RPMS/
 ```
 
-## Ubuntu 16.04/18.04 (x86_64)
+## Ubuntu 16.04 (x86_64)
 
-We assume you are using Ubuntu 16.04/18.04 (x86_64) as a host OS. If not, you may use virtualized system such as VirtualBox or Docker service.
+We assume you are using Ubuntu 16.04 (x86_64) as a host OS. If not, you may use virtualized system such as VirtualBox or Docker service.
 
 To build NPU Engine manually, you may use `pbuilder`, the gbs-like build system in a debian-based Linux.
 Thus, you first need to configure pbuilder, `pbuilderrc`.

diff --git a/doc/how_to_use.md b/doc/how_to_use.md
index db15780..5aa7811 100644 (file)
--- a/doc/how_to_use.md
+++ b/doc/how_to_use.md
@@ -53,7 +53,7 @@ For example, `BuildRequires: npu-engine-devel` is required in `packaging/[app-na
 
 For the detailed example for packaging, please refer to [here](https://github.sec.samsung.net/dongju-chae/npu-engine-app).
 
-## Ubuntu 16.04/18.04 (x86_64)
+## Ubuntu 16.04 (x86_64)
 
 When you install `npu-engine*` packages using `apt` command, all files are installed under `/opt/trinity/`
 ```bash

diff --git a/doc/usage_examples.md b/doc/usage_examples.md
index 3926285..df1d3ef 100644 (file)
--- a/doc/usage_examples.md
+++ b/doc/usage_examples.md
@@ -22,11 +22,12 @@ The `npu-engine-testdata` package contains testdata used in some example test pr
 
 **Ubuntu**: `/opt/trinity/share/npu-engine/testdata`
 
-## 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)). We currently support two versions of metadata (i.e., npubinfmt_v1 and v2), and older versions could be deprecated soon.
+## Example: apptest_example_visa_triv2
+This application ([example_visa_triv2.c](/tests/apptests/example_visa_triv2.c)) executes TRIV2 models and compares outputs with their golden data.
+Note that the testdata used here follows the NPU binary format ([npubinfmt.h](/include/common/npubinfmt.h)).
+We currently support three versions of metadata (i.e., npubinfmt_v1, v2, and v3), and TRIV2 works with npubinfmt v3 only.
 
-Let's assume you are testing the application in Ubuntu 16.04/18.04.
+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
@@ -34,5 +35,7 @@ $ ./bin/apptests/apptest_example_visa share/npu-engine/testdata/npubinfmt_v1
 ...
 $ ./bin/apptests/apptest_example_visa share/npu-engine/testdata/npubinfmt_v2
 ...
+$ ./bin/apptests/apptest_example_visa_triv2 share/npu-engine/testdata/npubinfmt_v3
+...
 ```
 All tests should be passed if the library is successfully installed.