Skip to content

Latest commit

 

History

History
175 lines (122 loc) · 4.44 KB

getting-started.md

File metadata and controls

175 lines (122 loc) · 4.44 KB
Raw

title: Getting Started ...

Getting Started

Prerequisites

The following dependencies are needed to compile/build/run.

  • gcc/g++ >= 7 ( std=c++17 is used )
  • meson >= 0.50
  • libopenblas-dev and base
  • tensorflow-lite >= 2.3.0
  • libiniparser
  • libjsoncpp >=0.6.0 ( if you want to use open AI )
  • libcurl3 >=7.47 ( if you want to use open AI )
  • libgtest >=1.10 ( for testing )

Install via PPA repository (Debian/Ubuntu)

The NNTrainer releases are available with launchpad PPA repository. In order to install it, use:

sudo apt-add-repository ppa:nnstreamer
sudo apt update
sudo apt install nntrainer

Clean build with pdebuild (Ubuntu 18.04)

Use the NNStreamer PPA to resolve additional build-dependencies (Tensorflow/Tensorflow-Lite).

Install build tools:

sudo apt install pbuilder debootstrap devscripts

The following example configuration is for Ubuntu 18.04:

$ cat ~/.pbuilderrc
DISTRIBUTION=bionic
COMPONENTS="main restricted universe multiverse"
OTHERMIRROR="deb http://archive.ubuntu.com/ubuntu ${DISTRIBUTION} main restricted universe multiverse |\
  deb http://archive.ubuntu.com/ubuntu ${DISTRIBUTION}-security main restricted universe multiverse |\
  deb http://archive.ubuntu.com/ubuntu ${DISTRIBUTION}-updates main restricted universe multiverse |\
  deb [trusted=yes] http://ppa.launchpad.net/nnstreamer/ppa/ubuntu ${DISTRIBUTION} main"
$ sudo ln -s  ~/.pbuilderrc /root/.pbuilderrc
$ sudo pbuilder create

Run pdebuild to build and get the package.

$ pdebuild
...
$ ls -al /var/cache/pbuilder/result/*.deb

Refer to PbuilderHowto for more about pdebuild.

Linux Self-Hosted Build

Build with Debian/Ubuntu tools

Clone the needed repositories

git clone https://github.com/nnstreamer/nntrainer

Alternatively, you may simply download binary packages from PPA:

sudo apt-add-repository ppa:nnstreamer
sudo apt install tensorflow2-lite-dev

Build .deb package

cd nntrainer && sudo mk-build-deps --install debian/control && sudo dpkg -i *.deb

Creating the .deb packages

export DEB_BUILD_OPTIONS="parallel=$(($(cat /proc/cpuinfo |grep processor|wc -l) + 1))"
cd nntrainer && time debuild -us -uc

If there is a missing package, debuild will tell you which package is missing. If you haven't configured debuild properly, yet, you will need to add -uc -us options to debuild.

Install the generated *.deb files

The files will be there at the parent dir. Eg. at nnbuilder/.. directory.

In order to install them (should run as root):

sudo apt install ./tensorflow-lite-dev_*.deb
sudo apt install ./nntrainer_0.1.0*_amd64.deb

If you need nntrainer development package:

sudo apt install ./nntrainer-dev_0.1.0*_amd64.deb

Build with meson

Add nnstreamer ppa for some of the dependencies.

sudo add-apt-repository ppa:nnstreamer/ppa
sudo apt-get update

Install the required packages.

sudo apt install meson ninja-build
sudo apt install gcc g++ pkg-config libopenblas-dev libiniparser-dev libjsoncpp-dev libcurl3-dev tensorflow2-lite-dev nnstreamer-dev libglib2.0-dev libgstreamer1.0-dev libgtest-dev ml-api-common-dev flatbuffers-compiler ml-inference-api-dev

Build at the git repo root directory, this will install nntrainer and related files.

meson build
ninja -C build install
  • Installs libraries to {prefix}/{libdir}
  • Installs common header files to {prefix}/{includedir}

Build on Tizen

Get GBS from https://source.tizen.org/documentation/reference/git-build-system/usage/gbs-build

First install the required packages.

sudo apt install gbs

Generates .rpm packages:

gbs build

gbs build will execute unit testing as well unlike meson build.

Troubleshooting

Error 1:

In file included from /usr/include/tensorflow/lite/core/api/op_resolver.h:20,
                 from /usr/include/tensorflow/lite/model.h:39,
                 from /usr/include/tensorflow/lite/kernels/register.h:19,
                 from ../Applications/KNN/jni/main_sample.cpp:21:
/usr/include/tensorflow/lite/schema/schema_generated.h:21:10: fatal error: flatbuffers/flatbuffers.h: No such file or directory
   21 | #include "flatbuffers/flatbuffers.h"
      |          ^~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.

Solution: Please install libflatbuffers-dev using the following:

sudo apt install libflatbuffers-dev