[Documentation] List up supported features for binary releases

For binary release list up supported features. Fixes nnstreamer#1448 Signed-off-by: MyungJoo Ham <[email protected]>
panfir · Mar 2, 2021 · 4d13f20 · 4d13f20
1 parent 730a722
commit 4d13f20
Show file tree

Hide file tree

Showing 3 changed files with 97 additions and 1 deletion.
diff --git a/Documentation/features-per-distro.md b/Documentation/features-per-distro.md
@@ -0,0 +1,94 @@
+## Feature lists of each official release
+
+This document lists features enabled in official releases of each OS or Linux distro.
+
+Note that users may adjust features freely with build options if they decide to build nnstreamer; any Linux developers should be able to do it with ease.
+
+This document reflects the status of 2021-02-24 ebafe31 (1.7.1 devel)
+
+
+## Tizen
+
+- Main GStreamer Elements
+    - All main tensor-\* elements are enabled including IIO support.
+    - ROS extensions are **not** released. With ROS packages, you may build and deploy.
+- Extra Elements and Subplugins
+    - Enabled
+        - tensorflow-lite (1.13)
+        - tensorflow2-lite (2.3) w/ gpu delegation
+        - nnfw runtime (a.k.a. ONERT)
+        - python filter
+        - mvncsdk2
+        - openvino
+        - edgeTPU
+        - flatbuf (converter/decoder)
+        - protobuf (converter/decoder)
+        - Tizen sensor source
+        - all trivial filter/converter/decoder subplugins.
+    - Disabled
+        - tensorflow (we do not use Bazel in Tizen)
+        - tensorflow2
+        - armnn (ready, but no one requested)
+        - verisilicon/vivante (ready, a few vivante libraries are not ported to Tizen public distro)
+        - pytorch (ready)
+        - caffe2 (ready)
+        - snap (not supported in Tizen)
+        - snpe (not supported in Tizen)
+
+
+## Android
+
+Android releases will have multiple binaries with different configurations; e.g., "nnstreamer-full", "nnstreamer-lite", "nnstreamer-basic", and so on.
+
+This list shows a release corresponding to "full".
+
+- GStreamer Elements
+    - All main tensor-\* elements except for IIO
+    - ROS extensions are **not** released.
+- Extra Elements and Subplugins
+    - Enabled
+        - tensorflow-lite (1.13)
+        - tensorflow2-lite (2.3) w/ gpu delegation
+        - nnfw runtime (a.k.a. ONERT)
+        - (depending on options) snap / snpe (you cannot install both simultaneously)
+        - all trivial filter/converter/decoder subplugins.
+    - Disabled
+        - tensorflow
+        - tensorflow2
+        - armnn
+        - verisilicon/vivante
+        - pytorch
+        - caffe2
+        - python filter
+        - mvncsdk2
+        - openvino
+        - edgeTPU
+        - and others.
+
+## Ubuntu
+
+We limit the number of extra subplugins in Ubuntu PPA. However, users can easily build more subplugins easily with meson build options or they may build their own subplugins independently with the given header files (nnstreamer-dev).
+
+- GStreamer Elements
+    - All main tensor-\* elements.
+    - ROS extensions are **not** released. Users may build theirs with given ROS packages.
+- Extra Elements and Subplugins
+    - Enabled
+        - tensorflow
+        - tensorflow-lite
+        - protobuf
+        - flatbuf
+        - caffe2
+        - edgetpu
+        - openvino
+        - python
+        - pytorch
+    - Disabled
+        - verisilicon/vivante
+        - armnn
+        - tensorflow2
+        - tensorflow2-lite
+        - nnfw runtime
+        - snap
+        - snpe
+        - and others
diff --git a/Documentation/hotdoc/sitemap.txt b/Documentation/hotdoc/sitemap.txt
@@ -5,6 +5,7 @@ index.md
 		Documentation/contributing.md
 		Documentation/doxygen-documentation.md
 		Documentation/edge-ai.md
+		Documentation/features-per-distro.md 
 		Documentation/getting-started.md
 			Documentation/getting-started-android.md
 			Documentation/getting-started-macos.md

diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ neural network developers to manage neural network pipelines and their filters e
 
 |     | [Tizen](http://download.tizen.org/snapshots/tizen/unified/latest/repos/standard/packages/) | [Ubuntu](https://launchpad.net/~nnstreamer/+archive/ubuntu/ppa) | Android/NDK Build | Android/APK | Yocto | macOS |
 | :-- | :--: | :--: | :--: | :--: | :--: | :--: |
-|     | 5.5M2 and later | 16.04/18.04 | 9/P | 9/P | TBD |   |
+|     | 5.5M2 and later | 16.04/18.04/20.04 | 9/P | 9/P | Zeus and later |   |
 | arm | [![armv7l badge](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/badge/armv7l_result_badge.svg)](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/build_result/) | Available  | Ready | Available| Ready | N/A |
 | arm64 |  [![aarch64 badge](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/badge/aarch64_result_badge.svg)](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/build_result/) | Available  | Ready | [![android badge](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/badge/android_result_badge.svg)](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/build_result/) | Planned | N/A |
 | x64 | [![x64 badge](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/badge/x86_64_result_badge.svg)](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/build_result/)  | [![ubuntu badge](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/badge/ubuntu_result_badge.svg)](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/build_result/)  | Ready  | Ready | Ready | Available |
@@ -42,6 +42,7 @@ neural network developers to manage neural network pipelines and their filters e
 - Available: binary packages are released and deployed automatically and periodically along with CI tests.
 - [Daily Release](http://nnsuite.mooo.com/nnstreamer/ci/daily-build/build_result/)
 - SDK Support: Tizen Studio (5.5 M2+) / Android Studio (JCenter, "nnstreamer")
+- [Enabled features of official releases](Documentation/features-per-distro.md)