From 75fd4db82a4cb1bf024c5db595bacbec68dfd8f4 Mon Sep 17 00:00:00 2001 From: DonghakPark Date: Fri, 5 Aug 2022 13:23:52 +0900 Subject: [PATCH] [trivial] Reorganize README.md files This is Proposal PR with issue #1974 - Remove Exmaple contents in nntrainer/README.md - Add Example contents in nntrainer/Application/README.md - Close #1974 Signed-off-by: DonghakPark --- Applications/README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 56 ++++---------------------------------------------- 2 files changed, 57 insertions(+), 52 deletions(-) diff --git a/Applications/README.md b/Applications/README.md index 94128a9..8d58b97 100644 --- a/Applications/README.md +++ b/Applications/README.md @@ -3,3 +3,56 @@ title: Applications ... # Applications + +#### [Custom Shortcut Application](https://github.com/nnstreamer/nntrainer/tree/main/Applications/Tizen_native/CustomShortcut) + +A demo application which enable user defined custom shortcut on galaxy watch. + +#### [MNIST Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/MNIST) + +An example to train mnist dataset. It consists two convolution 2d layer, 2 pooling 2d layer, flatten layer and fully connected layer. + +#### [Reinforcement Learning Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/ReinforcementLearning/DeepQ) + +A reinforcement learning example with cartpole game. It is using DeepQ algorithm. + +#### [Transfer Learning Examples](https://github.com/nnstreamer/nntrainer/tree/main/Applications/TransferLearning) + +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. + +#### [ResNet Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/Resnet) + +An example to train resnet18 network. + +#### [VGG Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/VGG) + +An example to train vgg16 network. + +#### [ProductRating Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/ProductRatings) + +This application contains a simple embedding-based model that predicts ratings given a user and a product. + +#### [SimpleShot Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/SimpleShot) + +An example to demonstrate few-shot learning : SimpleShot + +#### [Custom Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/Custom) + +An example to demonstrate how to create custom layers, optimizers or other supported objects. + + + + + + +#### [KNN Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/KNN) + +A transfer learning example with for image classification using the Cifar 10 dataset. TFlite is used for feature extractor and compared with KNN. + +#### [Logistic Regression Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/LogisticRegression) + +A logistic regression example using NNTrainer. + +#### [Alexnet Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/AlexNet) + +An example to train Alexnet(Fused) network with CIFAR100 Dataset diff --git a/README.md b/README.md index 0f9c370..b5f69f3 100644 --- a/README.md +++ b/README.md @@ -166,58 +166,6 @@ NNTrainer provides Currently, we provide [C APIs](https://github.com/nnstreamer/nntrainer/blob/master/api/capi/include/nntrainer.h) for Tizen. [C++ APIs](https://github.com/nnstreamer/nntrainer/blob/master/api/ccapi/include) are also provided for other platform. Java & C# APIs will be provided soon. -### Examples for NNTrainer - -#### [Custom Shortcut Application](https://github.com/nnstreamer/nntrainer/tree/main/Applications/Tizen_native/CustomShortcut) - - -A demo application which enable user defined custom shortcut on galaxy watch. - -#### [MNIST Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/MNIST) - -An example to train mnist dataset. It consists two convolution 2d layer, 2 pooling 2d layer, flatten layer and fully connected layer. - -#### [Reinforcement Learning Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/ReinforcementLearning/DeepQ) - -A reinforcement learning example with cartpole game. It is using DeepQ algorithm. - -#### [Transfer Learning Examples](https://github.com/nnstreamer/nntrainer/tree/main/Applications/TransferLearning) - -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. - -#### [ResNet Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/Resnet) - -An example to train resnet18 network. - -#### [VGG Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/VGG) - -An example to train vgg16 network. - -#### [ProductRating Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/ProductRatings) - -This application contains a simple embedding-based model that predicts ratings given a user and a product. - -#### [SimpleShot Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/SimpleShot) - -An example to demonstrate few-shot learning : SimpleShot - -#### [Custom Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/Custom) - -An example to demonstrate how to create custom layers, optimizers or other supported objects. - - - - - - -#### [KNN Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/KNN) - -A transfer learning example with for image classification using the Cifar 10 dataset. TFlite is used for feature extractor and compared with KNN. - -#### [Logistic Regression Example](https://github.com/nnstreamer/nntrainer/tree/main/Applications/LogisticRegression) - -A logistic regression example using NNTrainer. - ## [Getting Started](https://github.com/nnstreamer/nntrainer/blob/main/docs/getting-started.md) Instructions for installing NNTrainer. @@ -226,6 +174,10 @@ Instructions for installing NNTrainer. Instructions for preparing NNTrainer for execution +### [Examples for NNTrainer](https://github.com/nnstreamer/nntrainer/tree/main/Applications) + +NNTrainer example for a variety of networks + ## Open Source License The nntrainer is an open source project released under the terms of the Apache License version 2.0. -- 2.7.4