diff options
| author | Chunseok Lee <chunseok.lee@samsung.com> | 2020-12-14 14:43:04 +0900 |
|---|---|---|
| committer | Chunseok Lee <chunseok.lee@samsung.com> | 2020-12-14 14:43:04 +0900 |
| commit | 12d88feea8573f8490629cf62fc342b152e57d65 (patch) | |
| tree | 3c734cc4d629834d2d523f4575ef84cd64684e57 /README.md | |
| parent | d6b371e095d737922187a518b8faba1ef6f3a2b1 (diff) | |
| download | nnfw-12d88feea8573f8490629cf62fc342b152e57d65.tar.gz nnfw-12d88feea8573f8490629cf62fc342b152e57d65.tar.bz2 nnfw-12d88feea8573f8490629cf62fc342b152e57d65.zip | |
Imported Upstream version 1.11.0upstream/1.11.0
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 92 |
1 files changed, 31 insertions, 61 deletions
@@ -1,91 +1,61 @@ -# nnfw +[](https://github.com/Samsung/ONE/releases) +[](https://nnfw.readthedocs.io/en/latest/?badge=latest) + +[](https://gitter.im/Samsung/ONE) -A high-performance, on-device neural network inference framework +# **ONE** (On-device Neural Engine) -## Goal - -This project _nnfw_ aims at providing a high-performance, on-device neural network (NN) inference -framework that performs inference of a given NN model on processors, such as CPU, GPU, or NPU, in -the target platform, such as the Linux kernel based OS including Tizen. +<img src='docs/images/logo_original_samsungblue_cropped.png' alt='ONE Logo' width='400' /> -## Project Documents +A high-performance, on-device neural network inference framework. -- [Roadmap](docs/nnfw/roadmap.md) -- [SW Requirement Specification](docs/nnfw/project/2019_requirement_specification.md) -- [SW High Level Design](docs/nnfw/project/2018_high_level_design.md) +## Goal -## Getting started +This project **ONE** aims at providing a high-performance, on-device neural network (NN) inference +framework that performs inference of a given NN model on processors, such as CPU, GPU, DSP or NPU. -- For the contribution, please refer to our [contribution guide](docs/nnfw/HowToContribute.md). -- You can also find how-to documents [HERE](docs/nnfw/howto.md). +We develop a runtime that runs on a Linux kernel-based OS platform such as Ubuntu, Tizen, or +Android, and a compiler toolchain to support NN models created using various NN training frameworks such +as Tensorflow or PyTorch in a unified form at runtime. -## Maintainers +## Overview -- Sung-Jae Lee <<sj925.lee@samsung.com>> -- Chunseok Lee <<chunseok.lee@samsung.com>> +- [Background](docs/overview/background.md) +- [Roadmap](docs/overview/roadmap.md) +- [Overall Architecture](docs/overview/overall-architecture.md) -## Committers +## Getting started -- Hyeongseok Oh <<hseok82.oh@samsung.com>> -- Hanjoung Lee <<hanjoung.lee@samsung.com>> -- Sharan Allur <<sharan.allur@samsung.com>> +- For the contribution, please refer to our [contribution guide](docs/howto/how-to-contribute.md). +- You can also find various how-to documents [here](docs/howto). -## Feature Request (NEW) +## Feature Request -You can suggest development of nnfw's features that are not yet available. +You can suggest development of **ONE**'s features that are not yet available. -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. +The functions requested so far can be checked in the [popular feature request](https://github.com/Samsung/ONE/issues?q=label%3AFEATURE_REQUEST+) list. - If the feature you want is on the list, :+1: to the body of the issue. The feature with the most :+1: is placed at the top of the list. When adding new features, we will prioritize them with this reference. Of course, it is good to add an additional comment which describes your request in detail. -- For features not listed, [create a new issue](https://github.sec.samsung.net/STAR/nnfw/issues/new). +- For features not listed, [create a new issue](https://github.com/Samsung/ONE/issues/new). Sooner or later, the maintainer will tag the `FEATURE_REQUEST` label and appear on the list. We expect one of the most frequent feature requests would be the operator kernel implementation. It is good to make a request, but it is better if you contribute by yourself. See the following guide, -[How to Implement Operator Kernel](docs/nnfw/HowToImplementOperatorKernel.md), for help. +[How to add a new operation](docs/howto/how-to-add-a-new-operation.md), for help. We are looking forward to your participation. Thank you in advance! -# nncc -Re-targetable neural network (NN) model compilation framework - -## Goals -nncc, which stands for neural network compiler collection, aims to provide a general framework for -compiling a given NN model to an artifact that runs on various target devices such as CPU, GPU, or -NPU. - -## Maintainers - -- Sung-Jae Lee <<sj925.lee@samsung.com>> -- Jonghyun Park <<jh1302.park@samsung.com>> - -## Committers - -- Saehie Park <<saehie.park@samsung.com>> -- Hyeongseok Oh <<hseok82.oh@samsung.com>> -- Efimov Alexander <<a.efimov@samsung.com>> - ----- - -## Notice +## How to Contact -### 22/07/2019 +- Please post questions, issues, or suggestions into [Issues](https://github.com/Samsung/ONE/issues). This is the best way to communicate with the developer. +- You can also have an open discussion with community members through [gitter.im](https://gitter.im/Samsung/ONE) channel. -Congratulations! On July 22nd, 2019, _nnfw_ repo and -[_nncc_](https://github.sec.samsung.net/STAR/nncc) repo are finally integrated into single one. Now -all activities related to the development of _nnas(Neural Network Acceleration Solution)_ will -proceed in this integrated _nnfw_ repo. The old _nncc_ repo will only be maintained for follow up on -remaining issues and for preserving development history. The following notice will remain in place -until the update of documents in integrated repo is complete. +## Hall of Fame -### 02/05/2019 +[](https://sourcerer.io/fame/lemmaa/Samsung/ONE/links/0)[](https://sourcerer.io/fame/lemmaa/Samsung/ONE/links/1)[](https://sourcerer.io/fame/lemmaa/Samsung/ONE/links/2)[](https://sourcerer.io/fame/lemmaa/Samsung/ONE/links/3)[](https://sourcerer.io/fame/lemmaa/Samsung/ONE/links/4)[](https://sourcerer.io/fame/lemmaa/Samsung/ONE/links/5)[](https://sourcerer.io/fame/lemmaa/Samsung/ONE/links/6)[](https://sourcerer.io/fame/lemmaa/Samsung/ONE/links/7) -~~We are currently working on [_nncc_](https://github.sec.samsung.net/STAR/nncc) as a sibling project. -In our plan, the two projects will soon be integrated into one, and focusing on their roles as -front-end(_nncc_) and back-end(_nnfw_), respectively. It will accompany the physical combination of -the github repo.~~ You can find the latest roadmap of the integrated project -[here](https://github.sec.samsung.net/orgs/STAR/projects/1). |