From: Андрей Шедько/AI Tools Lab /SRR/Engineer/삼성전자 <a.shedko@samsung.com>
Date: Mon, 13 May 2019 16:23:55 +0000 (+0300)
Subject: [MIR] Added Readme (#3271)
X-Git-Tag: nncc_backup~607
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5eb9ef2338711f3efc50d2d0edbcf498eb2307f5;p=platform%2Fcore%2Fml%2Fnnfw.git

[MIR] Added Readme (#3271)

Added a readme for Model IR

Signed-off-by: Andrei Shedko <a.shedko@samsung.com>
---

diff --git a/contrib/mir/Readme.md b/contrib/mir/Readme.md
new file mode 100644
index 0000000..a7a3c10
--- /dev/null
+++ b/contrib/mir/Readme.md
@@ -0,0 +1,36 @@
+## Model IR (MIR)
+
+### Purpose
+This library exposes **NNC**'s model IR to the outer tools (currently `Mirunner`).
+
+### Design philosophy
+
+**MIR** was designed to support a multiple-frontend NN compiler/optimizer.
+
+### Function
+
+The high level overview of **MIR** is:
+* operations are a composition of their `inputs`, `outputs` and 
+special attributes specific to different operation types.
+* operations can have multiple inputs and multiple outputs,
+ each output can be an input to more than one operation 
+ (can be used in more than one operation).
+* the kernel tensors are represented by `ConstantOp` and
+ are linked to operations via `Input` objects.
+
+Mir has a protobuf serializer/deserializer for shapes and tensors (see `mir.proto` schema).
+
+For list of currently supported operations, see `mir/ops/operations.lst.h`.
+ 
+### How to use
+Can be included as a `CMake` target.
+
+### TODO
+
+* Expand serialization
+* Add More to readme 
+ 
+### Dependencies
+
+Mir depends on `adtitas` library, which provides the `small_vector` data type.
+    
\ No newline at end of file