README.md

   1 # NNtrainer
   2
   3 [![Code Coverage](http://nnsuite.mooo.com/nntrainer/ci/badge/codecoverage.svg)](http://nnsuite.mooo.com/nntrainer/ci/gcov_html/index.html)
   4 ![GitHub repo size](https://img.shields.io/github/repo-size/nnstreamer/nntrainer)
   5 ![GitHub issues](https://img.shields.io/github/issues/nnstreamer/nntrainer)
   6 ![GitHub pull requests](https://img.shields.io/github/issues-pr/nnstreamer/nntrainer)
   7
   8 NNtrainer is a Software Framework for training Neural Network models on devices.
   9
  10 ## Overview
  11
  12 NNtrainer is an Open Source Project. The aim of the NNtrainer is to develop a Software Framework to train neural network models on embedded devices which have relatively limited resources. Rather than training whole layers of a network, NNtrainer trains only one or a few layers of the layers added after a feature extractor.
  13
  14 Even though NNTrainer can be used to train sub-models, it requires implementation of additional functionalities to train models obtained from other machine learning and deep learning libraries. In the current version, various machine learning algorithms such as k-Nearest Neighbor (k-NN), Neural Networks, Logistic Regression and Reinforcement Learning algorithms are implemented. We also provide examples for various tasks such as transfer learning of models. In some of these examples, deep learning models such as Mobilenet V2 trained with Tensorflow-lite, are used as feature extractors. All of these were tested on Galaxy S8 with Android and PC (Ubuntu 16.04).
  15
  16 ## Maintainer
  17 * [Jijoong Moon](https://github.com/jijoongmoon)
  18 * [MyungJoo Ham](https://github.com/myungjoo)
  19 * [Geunsik Lim](https://github.com/leemgs)
  20
  21 ## Reviewers
  22 * [Sangjung Woo](https://github.com/again4you)
  23 * [Wook Song](https://github.com/wooksong)
  24 * [Jaeyun Jung](https://github.com/jaeyun-jung)
  25 * [Hyoungjoo Ahn](https://github.com/helloahn)
  26 * [Parichay Kapoor](https://github.com/kparichay)
  27 * [Dongju Chae](https://github.com/dongju-chae)
  28 * [Gichan Jang](https://github.com/gichan-jang)
  29 * [Yongjoo Ahn](https://github.com/anyj0527)
  30 * [Jihoon Lee](https://github.com/zhoonit)
  31 * [Hyeonseok Lee](https://github.com/lhs8928)
  32 * [Mete Ozay](https://github.com/meteozay)
  33
  34 ## Components
  35
  36 ### Supported Layers
  37
  38 This component defines layers which consist of a neural network model. Layers have their own properties to be set.
  39
  40  | Keyword | Layer Name | Description |
  41  |:-------:|:---:|:---|
  42  |  conv2d | Convolution 2D |Convolution 2-Dimentional Layer |
  43  |  pooling2d | Pooling 2D |Pooling 2-Dimentional Layer. Support average / max / global average / global max pooing |
  44  | flatten | Flatten | Flatten Layer |
  45  | fully_connected | Fully Connected | Fully Connected Layer |
  46  | input | Input | Input Layer.  This is not always requied. |
  47  | batch_normalization | Batch Normalization Layer | Batch Normalization Layer. |
  48  | loss layer | loss layer | hidden from users |
  49  | activation | activaiton layer | set by layer property |
  50
  51 ### Supported Optimizers
  52
  53 NNTrainer Provides
  54
  55  | Keyword | Optimizer Name | Description |
  56  |:-------:|:---:|:---:|
  57  | sgd | Stochastic Gradient Decent | - |
  58  | adam | Adaptive Moment Estimation | - |
  59
  60 ### Supported Loss Functions
  61
  62 NNTrainer provides
  63
  64  | Keyword | Loss Name | Description |
  65  |:-------:|:---:|:---:|
  66  | mse | Mean squared Error | - |
  67  | cross | Cross Entropy - sigmoid | if activation last layer is sigmoid |
  68  | cross | Cross Entropy - softmax | if activation last layer is softmax |
  69
  70 ### Supported Activation Functions
  71
  72 NNTrainer provides
  73
  74  | Keyword | Loss Name | Description |
  75  |:-------:|:---:|:---|
  76  | tanh | tanh function | set as layer property |
  77  | sigmoid | sigmoid function | set as layer property |
  78  | relu | relu function | set as layer propery |
  79  | softmax | softmax function | set as layer propery |
  80  | weight_initializer | Weight Initialization | Xavier(Normal/Uniform), LeCun(Normal/Uniform),  HE(Normal/Unifor) |
  81  | weight_regularizer | weight decay ( L2Norm only ) | needs set weight_regularizer_param & type |
  82  | learnig_rate_decay | learning rate decay | need to set step |
  83
  84 ### Tensor
  85
  86 Tensor is responsible for calculation of a layer. It executes several operations such as addition, division, multiplication, dot production, data averaging and so on. In order to accelerate  calculation speed, CBLAS (C-Basic Linear Algebra: CPU) and CUBLAS (CUDA: Basic Linear Algebra) for PC (Especially NVIDIA GPU) are implemented for some of the operations. Later, these calculations will be optimized.
  87 Currently, we supports lazy calculation mode to reduce complexity for copying tensors during calculations.
  88
  89  | Keyword | Description |
  90  |:-------:|:---:|
  91  | 4D Tensor | B, C, H, W|
  92  | Add/sub/mul/div | - |
  93  | sum, average, argmax | - |
  94  | Dot, Transpose | - |
  95  | normalization, standardization | - |
  96  | save, read | - |
  97
  98 ### Others
  99
 100 NNTrainer provides
 101
 102  | Keyword | Loss Name | Description |
 103  |:-------:|:---:|:---|
 104  | weight_initializer | Weight Initialization | Xavier(Normal/Uniform), LeCun(Normal/Uniform),  HE(Normal/Unifor) |
 105  | weight_regularizer | weight decay ( L2Norm only ) | needs set weight_regularizer_constant & type |
 106  | learnig_rate_decay | learning rate decay | need to set step |
 107
 108 ### APIs
 109 Currently, we provide [C APIs](https://github.com/nnstreamer/nntrainer/blob/master/api/capi/include/nntrainer.h) for Tizen. C++ API will be also provided soon.
 110
 111
 112 ### Examples for NNTrainer
 113
 114 #### [Custom Shortcut Application](https://github.com/nnstreamer/nntrainer/tree/main/Applications/Tizen_native/CustomShortcut)
 115
 116
 117 A demo application which enable user defined custom shortcut on galaxy watch.
 118
 119 #### [MNIST Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/MNIST)
 120
 121 An example to train mnist dataset. It consists two convolution 2d layer, 2 pooling 2d layer, flatten layer and fully connected layer.
 122
 123 #### [Reinforcement Learning Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/ReinforcementLearning/DeepQ)
 124
 125 A reinforcement learning example with cartpole game. It is using DeepQ algorithm.
 126
 127 #### [Transfer Learning Examples](https://github.com/nnstreamer/nntrainer/tree/main/Applications/TransferLearning)
 128
 129 Transfer learning examples with for image classification using the Cifar 10 dataset and for OCR. TFlite is used for feature extractor and modify last layer (fully connected layer) of network.
 130
 131 #### ~Tizen CAPI Example~
 132
 133 An example to demonstrate c api for Tizen. It is same transfer learing but written with tizen c api.~
 134 Deleted instead moved to a [test](https://github.com/nnstreamer/nntrainer/blob/master/test/tizen_capi/unittest_tizen_capi.cpp)
 135
 136 #### [KNN Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/KNN)
 137
 138 A transfer learning example with for image classification using the Cifar 10 dataset. TFlite is used for feature extractor and compared with KNN.
 139
 140 #### [Logistic Regression Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/LogisticRegression)
 141
 142 A logistic regression example using NNTrainer.
 143
 144 ## [Getting Started](https://github.com/nnstreamer/nntrainer/blob/main/docs/getting-started.md)
 145
 146 Instructions for installing NNTrainer.
 147
 148 ### [Running Examples](https://github.com/nnstreamer/nntrainer/blob/main/docs/how-to-run-examples.md)
 149
 150 Instructions for preparing NNTrainer for execution
 151
 152 ## Open Source License
 153
 154 The nntrainer is an open source project released under the terms of the Apache License version 2.0.
 155
 156 ## Contributing
 157
 158 Contributions are welcome! Please see our [Contributing](https://github.com/nnstreamer/nntrainer/blob/main/docs/contributing.md) Guide for more details.
 159
 160 [![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/images/0)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/links/0)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/images/1)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/links/1)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/images/2)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/links/2)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/images/3)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/links/3)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/images/4)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/links/4)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/images/5)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/links/5)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/images/6)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/links/6)[![](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/images/7)](https://sourcerer.io/fame/dongju-chae/nnstreamer/nntrainer/links/7)