From: 남궁석/On-Device Lab(SR)/Engineer/삼성전자 <sk.namkoong@samsung.com>
Date: Mon, 17 Jun 2019 22:32:53 +0000 (+0900)
Subject: [angkor] Introduce README.md (#3331)
X-Git-Tag: nncc_backup~379
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b569dd1e3b2e4db5878bbff1ab5a62990010ebb6;p=platform%2Fcore%2Fml%2Fnnfw.git

[angkor] Introduce README.md (#3331)

* [angkor] Introduce README.md

This commit will add README file for `angkor`

Signed-off-by: Seok NamKoong <sk.namkoong@samsung.com>

* remove line

* Add words

* Fix headlines
---

diff --git a/contrib/angkor/README.md b/contrib/angkor/README.md
new file mode 100644
index 0000000..c842fc1
--- /dev/null
+++ b/contrib/angkor/README.md
@@ -0,0 +1,51 @@
+# angkor
+
+## Purpose
+
+_angkor_ is a `nncc` core library
+
+## How to use
+
+_angkor_ implements abstract data type(ADT) for feature, kernel, tensor.
+There are layout, shape information and enumerator and so on.
+
+To use some of these things, just insert `include`!
+```cpp
+#include <nncc/core/ADT/feature/WHAT_YOU_WANT>
+#include <nncc/core/ADT/kernel/WHAT_YOU_WANT>
+#include <nncc/core/ADT/tensor/WHAT_YOU_WANT>
+```
+
+## Example
+
+- `contrib/coco/core/CMakeLists.txt`
+
+```cmake
+target_link_libraries(coco_core PUBLIC angkor)
+```
+
+- `contrib/coco/core/src/IR/Arg.cpp`
+
+```cpp
+#include "coco/IR/Arg.h"
+
+#include <nncc/core/ADT/tensor/LexicalLayout.h>
+#include <nncc/core/ADT/tensor/IndexEnumerator.h>
+
+namespace
+{
+const nncc::core::ADT::tensor::LexicalLayout l;
+}
+
+namespace coco
+{
+
+Arg::Arg(const nncc::core::ADT::tensor::Shape &shape) : _shape{shape}, _bag{nullptr}
+{
+  _map.resize(nncc::core::ADT::tensor::num_elements(shape));
+}
+
+// ....
+
+}
+```