README.md

   1 # nnfw
   2
   3 A high-performance, on-device neural network inference framework
   4
   5 ## Goal
   6
   7 This project _nnfw_ aims at providing a high-performance, on-device neural network (NN) inference
   8 framework that performs inference of a given NN model on processors, such as CPU, GPU, or NPU, in
   9 the target platform, such as the Linux kernel based OS including Tizen.
  10
  11 ## Project Documents
  12
  13 - [Roadmap](docs/nnfw/roadmap.md)
  14 - [SW Requirement Specification](docs/nnfw/project/2019_requirement_specification.md)
  15 - [SW High Level Design](docs/nnfw/project/2018_high_level_design.md)
  16
  17 ## Getting started
  18
  19 - For the contribution, please refer to our [contribution guide](docs/HowToContribute.md).
  20 - You can also find how-to documents [HERE](docs/nnfw/howto.md).
  21
  22 ## Maintainers
  23
  24 - Sung-Jae Lee <<sj925.lee@samsung.com>>
  25 - Chunseok Lee <<chunseok.lee@samsung.com>>
  26
  27 ## Committers
  28
  29 - Hyeongseok Oh <<hseok82.oh@samsung.com>>
  30 - Hanjoung Lee <<hanjoung.lee@samsung.com>>
  31 - Sharan Allur <<sharan.allur@samsung.com>>
  32
  33 ## Feature Request (NEW)
  34
  35 You can suggest development of nnfw's features that are not yet available.
  36
  37 The functions requested so far can be checked in the [popular feature request](https://github.sec.samsung.net/STAR/nnfw/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3AFEATURE_REQUEST+sort%3Areactions-%2B1-desc) list.
  38
  39 - If the feature you want is on the list, :+1: to the body of the issue. The feature with the most
  40 :+1: is placed at the top of the list. When adding new features, we will prioritize them with this reference.
  41 Of course, it is good to add an additional comment which describes your request in detail.
  42
  43 - For features not listed, [create a new issue](https://github.sec.samsung.net/STAR/nnfw/issues/new).
  44 Sooner or later, the maintainer will tag the `FEATURE_REQUEST` label and appear on the list.
  45
  46 We expect one of the most frequent feature requests would be the operator kernel implementation.
  47 It is good to make a request, but it is better if you contribute by yourself. See the following guide,
  48 [How to Implement Operator Kernel](docs/nnfw/HowToImplementOperatorKernel.md), for help.
  49
  50 We are looking forward to your participation.
  51 Thank you in advance!
  52
  53 # nncc
  54 Re-targetable neural network (NN) model compilation framework
  55
  56 ## Goals
  57 nncc, which stands for neural network compiler collection, aims to provide a general framework for
  58 compiling a given NN model to an artifact that runs on various target devices such as CPU, GPU, or
  59 NPU.
  60
  61 ## Maintainers
  62
  63 - Sung-Jae Lee <<sj925.lee@samsung.com>>
  64 - Jonghyun Park <<jh1302.park@samsung.com>>
  65
  66 ## Committers
  67
  68 - Saehie Park <<saehie.park@samsung.com>>
  69 - Hyeongseok Oh <<hseok82.oh@samsung.com>>
  70 - Efimov Alexander <<a.efimov@samsung.com>>
  71
  72 ----
  73
  74 ## Notice
  75
  76 ### 22/07/2019
  77
  78 Congratulations! On July 22nd, 2019, _nnfw_ repo and
  79 [_nncc_](https://github.sec.samsung.net/STAR/nncc) repo are finally integrated into single one. Now
  80 all activities related to the development of _nnas(Neural Network Acceleration Solution)_ will
  81 proceed in this integrated _nnfw_ repo. The old _nncc_ repo will only be maintained for follow up on
  82 remaining issues and for preserving development history. The following notice will remain in place
  83 until the update of documents in integrated repo is complete.
  84
  85 ### 02/05/2019
  86
  87 ~~We are currently working on [_nncc_](https://github.sec.samsung.net/STAR/nncc) as a sibling project.
  88 In our plan, the two projects will soon be integrated into one, and focusing on their roles as
  89 front-end(_nncc_) and back-end(_nnfw_), respectively. It will accompany the physical combination of
  90 the github repo.~~ You can find the latest roadmap of the integrated project
  91 [here](https://github.sec.samsung.net/orgs/STAR/projects/1).