summaryrefslogtreecommitdiff
path: root/docs/nncc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nncc/README.md')
-rw-r--r--docs/nncc/README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/nncc/README.md b/docs/nncc/README.md
new file mode 100644
index 000000000..203b4aa45
--- /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_