This patch updates README/doc texts about SPIN/ubuntu support.
Signed-off-by: Dongju Chae <dongju.chae@samsung.com>
| |-- 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)
+|-- debian/ Debian Packaging Files (i.e., Ubuntu 16.04/18.04)
`-- doc/ Documentation
```
- 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)
-## Related Repositories
+## Related Projects
- 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)
+## 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
+
## Reference Links
- Software Stack: http://suprem.sec.samsung.net/confluence/display/ODLC/NPU+OS+Stack
- CI Server: http://nnsuiteci.mooo.com/NPU_SystemService/ci/taos/
$ taos-mgr refresh
$ taos-mgr install npu-engine
```
-**Ubuntu 16.04 (x86_64)**
+**Ubuntu 16.04/18.04 (x86_64)**
``` bash
-$ cat /etc/apt/sources.list.d/ubuntu1604-spin.list
-deb [trusted=yes] http://[YOUR_SPIN_ACCOUNT]:[YOUR_SPIN_PW]@10.113.136.32/download_trbs/newlive/devel:/Tizen:/6.0:/AI:/UbuntuTools/Ubuntu_16.04/ /
+$ 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
+$
+$ cat /etc/apt/auth.conf.d/spin.conf
+machine 10.113.136.32
+login [YOUR_SPIN_ACCOUNT]
+password [YOUR_SPIN_PW]
+$
$ sudo apt-get update
$ sudo apt-get install npu-engine
```
+
Also, to test your installation of `npu-engine`, you may install `npu-engine-example` and `npu-engine-testdata`, too.
## FastModel (aarch64/armv7l/x86_64)
buildroot = ~/GBS-ROOT/
[repo.spin]
-url = http://[YOUR_SPIN_ACCOUNT]:[YOUR_SPIN_PW]@10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard/packages/
+url = http://10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard/packages/
+user = [YOUR_SPIN_ACCOUNT]
+passwd = [YOUR_SPIN_PW]
[repo.base]
url = http://download.tizen.org/snapshots/tizen/base/latest/repos/standard/packages/
$ ls ~/GBS-ROOT/local/repos/tizen/aarch64/RPMS/
```
-## Ubuntu 16.04 (x86_64)
+## Ubuntu 16.04/18.04 (x86_64)
-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.
+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.
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`.
Here is the example `~/.pbuilderrc`. Please make sure the SPIN repository (`10.113.136.32`) is properly configured.
+
```bash
MIRRORSITE=http://ftp.daumkakao.com/ubuntu/
DISTRIBUTION=xenial
To easily link the NPU Engine to your application, we recommend you also to use `gbs` build. Please make sure your `~/.gbs.conf` contains the SPIN repository like:
```bash
[repo.spin]
-http://[YOUR_SPIN_ACCOUNT]:[YOUR_SPIN_PW]@10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard/packages/
+url = http://10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard/packages/
+user = [YOUR_SPIN_ACCOUNT]
+passwd = [YOUR_SPIN_PW]
```
Here is the example `~/.gbs.conf`, which works perfectly.
```bash
buildroot = ~/GBS-ROOT/
[repo.spin]
-url = http://[YOUR_SPIN_ACCOUNT]:[YOUR_SPIN_PW]@10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard/packages/
+url = http://10.113.136.32/download_trbs/snapshots/devel/tizen-6.0-ai/latest/repos/Tizen_Unified_standard/packages/
+user = [YOUR_SPIN_ACCOUNT]
+passwd = [YOUR_SPIN_PW]
[repo.base]
url = http://download.tizen.org/snapshots/tizen/base/latest/repos/standard/packages/
For the detailed example for packaging, please refer to [here](https://github.sec.samsung.net/dongju-chae/npu-engine-app).
-## Ubuntu 16.04 (x86_64)
+## Ubuntu 16.04/18.04 (x86_64)
When you install `npu-engine*` packages using `apt` command, all files are installed under `/opt/trinity/`
```bash
-$ cat /etc/apt/sources.list.d/ubuntu1604-spin.list
-deb [trusted=yes] http://[YOUR_SPIN_ACCOUNT]:[YOUR_SPIN_PW]@10.113.136.32/download_trbs/newlive/devel:/Tizen:/6.0:/AI:/UbuntuTools/Ubuntu_16.04/ /
+$ 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
+$
+$ cat /etc/apt/auth.conf.d/spin.conf
+machine 10.113.136.32
+login [YOUR_SPIN_ACCOUNT]
+password [YOUR_SPIN_PW]
+$
$ sudo apt-get update
$ sudo apt-get install npu-engine npu-engine-devel
$
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.
-Let's assume you are testing the application in Ubuntu 16.04.
+Let's assume you are testing the application in Ubuntu 16.04/18.04.
```bash
$ sudo apt-get install npu-engine-example npu-engine-testdata
$ cd /opt/trinity