From 703f37198b25f111db18d5fcf11617839445c6dd Mon Sep 17 00:00:00 2001 From: =?utf8?q?=EC=9C=A4=ED=98=84=EC=8B=9D/On-Device=20Lab=28SR=29/Princip?= =?utf8?q?al=20Engineer/=EC=82=BC=EC=84=B1=EC=A0=84=EC=9E=90?= Date: Fri, 22 Nov 2019 12:09:22 +0900 Subject: [PATCH] [nncc] Skeleton of README.md for nncc in nnas SDK 1.0 (#9034) * [nncc] Skeleton of README.md for SDK 1.0 This is a skeleton README document for SDK 1.0. Note that main readers are developers who want to compile Tensorflow models. Please, write any part you want to write after making an issue. Signed-off-by: Hyun Sik Yoon * adding contents about nnpackage * explaining nnas sdk * NNCC to nncc * numbering on section * moving license into 1. nnas SDK 1.0 * added semantic versioning. Changed version 1.0 to 1.0.0 --- docs/nncc/README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/nncc/README.md diff --git a/docs/nncc/README.md b/docs/nncc/README.md new file mode 100644 index 0000000..203b4aa --- /dev/null +++ b/docs/nncc/README.md @@ -0,0 +1,56 @@ +# 1. nnas SDK + +_describe simply that current version is 1.0.0, and nnas SDK has nncc and nnfw._ + + _we use symantic versioning. Provide link to https://semver.org/_ + +_simply mention that we go with apache license_ + +# 2. nncc + +_please write a short description_ +_for example, what is this compiler_ +_design philosophy and advantages of this compiler_ + +## 2.1. Architecture + +_For example, simple architecture or compiling flow, showing we're cool_ + +## 2.2. Getting Started + +This section will explain how to install and compile a Tensorflow model file. + +### 2.2.1. Supported Environment + +_x86, ubuntu 16.04... versions of Tensorflow that produce models.. frozen file..., ... etc..._ + +### 2.2.2. How to Install + +_please write how to install_ + +### 2.2.3. How to Compile and Package + +_what is 'nnpackage'?_ +_environment variables_ +_compiling inception v3 pb file and packaging into an nnpackage_ +_explaining files in an nnpackage_ +_an example with custom op_ + +## 2.3. List of Supported Operations + +_separate md file_ +_showing a list of [ tensorflow op , circle op, limitation ]_ + +## 2.4. Benchmark + +_inception v3 (we have shorter ops)_ +_instance normalization (link to runtime performance)_ +_showing we have bright future_ + +## 2.5. Support + +_report a bug into our github_ + +## 2.6. Revision History + +_separate md file where SDK 1.0.0 and future version history are maintained_ -- 2.7.4