[Document] update documents

update broken links and nnstreamer changes

Signed-off-by: Jaeyun Jung <jy1210.jung@samsung.com>

diff --git a/Documentation/coding-convention.md b/Documentation/coding-convention.md
index 3d22c5c..01be875 100644 (file)
--- a/Documentation/coding-convention.md
+++ b/Documentation/coding-convention.md
@@ -11,6 +11,6 @@ If there is a change due to code style issues, make two separate commits: (Pleas
 - commit with style change only (i.e., commit gst-indent-formatted original code - not your code change)
 - commit with your code change only (i.e., contents only).
 
-```bash
-$ ./common/gst-indent <file-name>
+```
+$ ./tools/development/gst-indent <file-name>
 ```

diff --git a/Documentation/component-description.md b/Documentation/component-description.md
index a1754a5..c83bd49 100644 (file)
--- a/Documentation/component-description.md
+++ b/Documentation/component-description.md
@@ -4,7 +4,7 @@
 - other/tensors
 - other/tensorsave (Planned)
 
-findtype specifics: refer to the wiki (other/tensorsave)
+findtype specifics: refer to the wiki ([other/tensorsave](https://github.com/nnsuite/nnstreamer/wiki/Design-External-Save-Format-for-other-tensor-and-other-tensors-Stream-for-TypeFind))
 
 Note that in any frame in a stream of other/tensor and other/tensors, there should be only ONE instance of other/tensor or other/tensors.
 
@@ -16,7 +16,7 @@ Note that "stable" does not mean that it is complete. It means that it has enoug
 
 In this page, we focus on the status of each elements. For requirements and designs of each element, please refer to the README.md of the element.
 
-- [tensor\_converter](../gst/tensor_converter/)
+- [tensor\_converter](../gst/nnstreamer/tensor_converter)
   - Video (stable)
     - video/x-raw. Colorspaces of RGB, BGRx, Gray8 are supported.
     - Caution: if width is not divisible by 4, RGB/Gray8 video incurs memcpy.
@@ -26,7 +26,7 @@ In this page, we focus on the status of each elements. For requirements and desi
     - text/x-raw. Partially implemented. Needs fixes and test cases.
   - Binary (experimenal)
     - application/octet-stream. Stream pipeline developer MUST specify the corresponding type and dimensions via properties (input-dim, input-type)
-- [tensor\_filter](../gst/tensor_filter/)
+- [tensor\_filter](../gst/nnstreamer/tensor_filter)
   - Main (stable)
     - Supported features
       - Fixed input/ouput dimensions (fixed by subplugin)
@@ -38,50 +38,51 @@ In this page, we focus on the status of each elements. For requirements and desi
     - TODO: Recurrent models. The first target unit-test is LSTM.
   - Tensorflow-Lite (stable)
   - Custom (stable)
-  - Tensorflow (WIP. Not working properly as of 2018/10/13)
+  - Tensorflow (experimental)
   - Other NNFW TBD (caffe2, caffe, ...)
-- [tensor\_sink](../gst/tensor_sink/) (stable)
-- [tensor\_transform](../gst/tensor_transform/) (stable, but with a lot of WIP items)
+- [tensor\_sink](../gst/nnstreamer/tensor_sink) (stable)
+- [tensor\_transform](../gst/nnstreamer/tensor_transform) (stable, but with NYI WIP items)
   - Supported features
-    - Type Cast (typecast) (stable)
-    - Dimension Change (dimchg) (experimental)
-    - Arithmetic (arithmetic) (experimental. stable with limited sub features)
-    - Transpose (transpose) (experimental. stable with limited sub features)
-    - Standardization/Normalization (stand) (experimental. stable with limited sub features)
+    - Type Cast (typecast) (stable, orc supported with the property ```acceleration```)
+    - Dimension Change (dimchg) (stable with limited sub features)
+    - Arithmetic (arithmetic) (stable, orc supported with the property ```acceleration```)
+    - Transpose (transpose) (stable with limited sub features)
+    - Standardization/Normalization (stand) (stable with limited sub features)
     - More features coming soon!
-- [tensor\_merge](../gst/tensor_merge/) (stable, but with NYI WIP items)
-- [tensor\_split](../gst/tensor_split/) (stable, but with NYI WIP items)
-- [tensor\_decoder](../gst/tensor_decoder/) (stable, but with NYI WIP items)
+- [tensor\_merge](../gst/nnstreamer/tensor_merge) (stable, but with NYI WIP items)
+- [tensor\_split](../gst/nnstreamer/tensor_split) (stable, but with NYI WIP items)
+- [tensor\_decoder](../gst/nnstreamer/tensor_decoder) (stable, but with NYI WIP items)
   - Supported features
     - Direct video conversion (video/x-raw) (stable)
     - Image classification labeling (text/x-raw) (stable)
-    - Bounding Boxes (video/x-raw) (WIP)
+    - Bounding Boxes (video/x-raw) (stable)
     - More items are planned.
-- [tensor\_mux](../gst/tensor_mux/) (stable)
-- [tensor\_demux](../gst/tensor_demux/) (stable)
-- [tensor\_source](../gst/tensor_source/) (planned)
-- [tensor\_save](../gst/tensor_save/) (planned)
-- [tensor\_load](../gst/tensor_load/) (planned)
-- [tensor\_aggregator](../gst/tensor_aggregator) (stable)
-- [tensor\_ros\_sink](../gst/tensor_ros_sink/) (planned)
-- [tensor\_ros\_src](../gst/tensor_ros_src/) (planned)
+- [tensor\_mux](../gst/nnstreamer/tensor_mux) (stable)
+- [tensor\_demux](../gst/nnstreamer/tensor_demux) (stable)
+- [tensor\_source](../gst/nnstreamer/tensor_source) (planned)
+- [tensor\_save](../gst/nnstreamer/tensor_saveload) (planned)
+- [tensor\_load](../gst/nnstreamer/tensor_saveload) (planned)
+- [tensor\_aggregator](../gst/nnstreamer/tensor_aggregator) (stable)
+- [tensor\_ros\_sink](https://github.com/nnsuite/nnstreamer-ros) (planned)
+- [tensor\_ros\_src](https://github.com/nnsuite/nnstreamer-ros) (planned)
 
 
 Note that test elements in /tests/ are not elements for applications. They exist as scaffoldings to test the above elements especially in the case where related elements are not yet implemented.
 
 # Other Components
 - CI ([@private server](http://nnsuite.mooo.com/) (stable): Up and running
-- CI (@AWS) (experimental): WIP (sewon-oh, leemgs)
+- CI (@AWS) (experimental): WIP (leemgs)
 - CD (@launchpad / @OBS) (planned)
-- [Test cases](tests/): Mandatory unit test cases required to pass for each PR.
-  - Planned to use [SSAT](https://github.com/myungjoo/SSAT) later.
+- [Test cases](../tests/): Mandatory unit test cases required to pass for each PR.
+  - Used [SSAT](https://github.com/nnsuite/SSAT).
   - Each element and feature is required to register its testcases here.
-- [Example applications](nnstreamer_example/): Example gstreamer applications using nnstreamer and example sub-plugins for nnstreamer. The binaries from this directory is not supposed to be packaged with the main binary package.
+- Examples: Example gstreamer applications using nnstreamer and example sub-plugins for nnstreamer. The binaries from this directory is not supposed to be packaged with the main binary package.
+  - [Example gstreamer applications](https://github.com/nnsuite/nnstreamer-example)
+  - [Example sub-plugins](../nnstreamer_example)
 - Packaing for Distros / SW-Platform Compatibility.
-  - [Tizen](packaging/) (stable): RPM packaging for Tizen 5.0+. It is expected to be compatible with other RPM-based distros; however, it is not tested or guaranteed.
-  - [Ubuntu](debian/) (stable): DEB packaging for Ubuntu 16.04. It is highly expected to be compatible with later versions as well; but, not tested yet. Debian is not tested, either.
+  - [Tizen](../packaging) (stable): RPM packaging for Tizen 5.0+. It is expected to be compatible with other RPM-based distros; however, it is not tested or guaranteed.
+  - [Ubuntu](../debian) (stable): DEB packaging for Ubuntu 16.04. It is highly expected to be compatible with later versions as well; but, not tested yet. Debian is not tested, either.
   - Yocto (experimental)
   - Android (planned with high priority)
   - iOS (planned with low priority)
-- [Common library](common/)
-- [Common headers](include/)
+- [Common headers](../gst/nnstreamer)

diff --git a/Documentation/how-to-use-testcases.md b/Documentation/how-to-use-testcases.md
index b26b79e..cc3d9df 100644 (file)
--- a/Documentation/how-to-use-testcases.md
+++ b/Documentation/how-to-use-testcases.md
@@ -4,16 +4,16 @@
 
 - Unit Test 
 
-For common library unit test
-```bash
+For gtest based test cases (common library and nnstreamer plugins)
+```
 $ cd build
-$ ./unittest_common
+$ ninja test
 ```
 
-For all gst-launch-based test cases (mostly golden testing)
-```bash
+For all gst-launch-based test cases ([SSAT](https://github.com/nnsuite/SSAT), mostly golden testing)
+```
 $ cd tests
-$ ./testAll.sh
+$ ssat
 ```
 
 ## How to write Test Cases