[Tools/Confchk] Show custom property description for sub-plugins @open sesame 10/15 19:48 #2800

dongju-chae · 2020-10-15T08:46:44Z

This patch adds feature to show custom property description for
registered sub-plugins.

Related issue: #2782

Please share your opinions on better text formatting or recommended structure that contains related info.

For example, we can expect the following result

$ ./nnstreamer-check
...
NNStreamer registered sub-plugins:                                                           
============================================================                                 
                                                                                             
[Filter]                                                                                     
  cpp                                                                                        
    - No custom property found                                                               
  openvino                                                                                   
    - No custom property found                                                               
  tensorflow-lite                                                                            
    - Prop1: Descriptions1                                                                   
    - Prop2: Descriptions2                                                                   
  snpe                                                                                       
    - No custom property found                                                               
  caffe2                                                                                     
    - No custom property found                                                               
  python3                                                                                    
    - No custom property found                                                               
  python2                                                                                    
    - No custom property found                                                               
  edgetpu                                                                                    
    - No custom property found                                                               
  pytorch                                                                                    
    - No custom property found                                                               
  tensorflow                                                                                 
    - No custom property found                                                               
                                                                                             
[Decoder]                                                                                    
  image_segment                                                                              
    - No custom property found                                                               
  direct_video                                                                               
    - No custom property found                                                               
  flatbuf                                                                                    
    - No custom property found                                                               
  bounding_boxes                                                                             
    - No custom property found                                                               
  protobuf                                                                                   
    - Prop1: Descriptions1                                                                   
    - Prop2: Descriptions2                                                                   
  image_labeling                                                                             
    - No custom property found                                                               
  pose_estimation                                                                            
    - No custom property found                                                               
                                                                                             
[Conterver]                                                                                  
  libnnstreamer_converter_protobuf                                                           
    - No custom property found                                                               
  libnnstreamer_converter_flatbuf                                                            
    - Prop1: Descriptions1                                                                   
    - Prop2: Descriptions2

if we add descriptions for custom properties like below

diff --git a/ext/nnstreamer/tensor_converter/tensor_converter_flatbuf.cc b/ext/nnstreamer/tensor_converter/tensor_converter_flatbuf.cc
index 0a216f1..7f95711 100644
--- a/ext/nnstreamer/tensor_converter/tensor_converter_flatbuf.cc
+++ b/ext/nnstreamer/tensor_converter/tensor_converter_flatbuf.cc
@@ -163,6 +163,10 @@ void
 init_fbc (void)
 {
   registerExternalConverter (&flatBuf);
+  nnstreamer_converter_set_custom_property_desc (converter_subplugin_flatbuf,
+      "Prop1", "Descriptions1",
+      "Prop2", "Descriptions2",
+      NULL);
 }
 
 /** @brief Destruct this object for tensor converter sub-plugin */
diff --git a/ext/nnstreamer/tensor_decoder/tensordec-protobuf.cc b/ext/nnstreamer/tensor_decoder/tensordec-protobuf.cc
index af3f726..a3fcc34 100644
--- a/ext/nnstreamer/tensor_decoder/tensordec-protobuf.cc
+++ b/ext/nnstreamer/tensor_decoder/tensordec-protobuf.cc
@@ -95,6 +95,11 @@ void
 init_pb (void)
 {
   nnstreamer_decoder_probe (&protobuf);
+  nnstreamer_decoder_set_custom_property_desc (decoder_subplugin_protobuf,
+      "Prop1", "Descriptions1",
+      "Prop2", "Descriptions2",
+      NULL);
+
 }
 
 /** @brief Destruct this object for tensordec-plugin */
diff --git a/ext/nnstreamer/tensor_filter/tensor_filter_tensorflow_lite.cc b/ext/nnstreamer/tensor_filter/tensor_filter_tensorflow_lite.cc
index 0dac5f5..c40cc70 100644
--- a/ext/nnstreamer/tensor_filter/tensor_filter_tensorflow_lite.cc
+++ b/ext/nnstreamer/tensor_filter/tensor_filter_tensorflow_lite.cc
@@ -1180,6 +1180,10 @@ void
 init_filter_tflite (void)
 {
   nnstreamer_filter_probe (&NNS_support_tensorflow_lite);
+  nnstreamer_filter_set_custom_property_desc (filter_subplugin_tensorflow_lite,
+      "Prop1", "Descriptions1",
+      "Prop2", "Descriptions2",
+      NULL);
 }
 
 /** @brief Destruct the subplugin */

Signed-off-by: Dongju Chae dongju.chae@samsung.com

taos-ci · 2020-10-15T08:46:46Z

📝 TAOS-CI Version: 1.5.20200324. Thank you for submitting PR #2800. Please a submit 1commit/1PR (one commit per one PR) policy to get comments quickly from reviewers. Your PR must pass all verificiation processes of cibot before starting a review process from reviewers. If you are new member to join this project, please read manuals in documentation folder and wiki page. In order to monitor a progress status of your PR in more detail, visit http://nnsuite.mooo.com/.

taos-ci · 2020-10-15T08:46:53Z

cibot: @dongju-chae, tools/development/confchk/confchk.c does not include Doxygen tags such as @file @brief @author @bug. You must include the Doxygen tags in the source code. Please refer to a Doxygen manual at http://github.com/nnsuite/TAOS-CI/blob/master/ci/doc/doxygen-documentation.md

taos-ci · 2020-10-15T08:47:00Z

cibot: @dongju-chae, tools/development/confchk/confchk.c includes bug(s). Please fix incorrect coding constructs in your commit before entering a review process.

taos-ci · 2020-10-15T08:47:10Z

cibot: @dongju-chae, One of the module of prebuild group is failed. If you want to get a hint to fix this issue, please go to https://github.com/nnstreamer/nnstreamer/wiki/.

taos-ci · 2020-10-15T09:03:53Z

cibot: @dongju-chae, apptest could not be completed. To find out the reasons, please go to http://nnsuite.mooo.com//nnstreamer/ci/repo-workers/pr-checker/2800-202010151746470.42231607437134-0817366d64e7cd7541e78089411bb10a270a6a70

taos-ci · 2020-10-15T09:03:55Z

cibot: @dongju-chae, A builder checker could not be completed because one of the checkers is not completed. In order to find out a reason, please go to http://nnsuite.mooo.com/nnstreamer/ci/repo-workers/pr-checker/2800-202010151746470.42231607437134-0817366d64e7cd7541e78089411bb10a270a6a70/.

taos-ci · 2020-10-15T09:59:29Z

cibot: @dongju-chae, tools/development/confchk/confchk.c includes bug(s). Please fix incorrect coding constructs in your commit before entering a review process.

taos-ci · 2020-10-15T09:59:39Z

cibot: @dongju-chae, One of the module of prebuild group is failed. If you want to get a hint to fix this issue, please go to https://github.com/nnstreamer/nnstreamer/wiki/.

dongju-chae · 2020-10-15T10:07:32Z

~~The CI task for cppcheck looks strange...?~~
Now, the cppcheck in the CI server is upgraded to v2.2, which is the latest version.

taos-ci · 2020-10-15T10:36:04Z

cibot: @dongju-chae, gst/nnstreamer/nnstreamer_conf.c includes bug(s). Please fix incorrect coding constructs in your commit before entering a review process.

taos-ci · 2020-10-15T10:36:14Z

cibot: @dongju-chae, One of the module of prebuild group is failed. If you want to get a hint to fix this issue, please go to https://github.com/nnstreamer/nnstreamer/wiki/.

taos-ci · 2020-10-22T02:16:08Z

cibot: @dongju-chae, apptest could not be completed. To find out the reasons, please go to http://nnsuite.mooo.com//nnstreamer/ci/repo-workers/pr-checker/2800-202010221043090.19204998016357-9906d2be2de8ffb3c4026f5d5837c9af43071cf6

myungjoo · 2020-10-26T10:45:55Z

Wouldn't it be more intuitive if you simply add a list of "name" and "description" pairs to the Framework struct (e.g., add an optional property at the end of the GstTensorFilterFramework data structure)

dongju-chae · 2020-10-26T11:48:53Z

Wouldn't it be more intuitive if you simply add a list of "name" and "description" pairs to the Framework struct (e.g., add an optional property at the end of the GstTensorFilterFramework data structure)

I have also considered your suggestion, but this feature should be common interface for sub-plugins (e.g., filter, decoder, and converter). So, that's why I utilized more abstract structure (i.e., nnstreamer_subplugin).

myungjoo · 2020-10-28T05:36:27Z

Ok, then, please rename the function.
E.g.,
nnstreamer_filter_set_custom_property
==>
nnstreamer_filter_set_custom_property_description

myungjoo

LGTM. (Rename API names)

dongju-chae · 2020-10-28T05:47:54Z

Ok, then, please rename the function.

Got it. thanks.

taos-ci · 2020-10-28T05:59:41Z

cibot: @dongju-chae, One of the module of prebuild group is failed. If you want to get a hint to fix this issue, please go to https://github.com/nnstreamer/nnstreamer/wiki/.

taos-ci · 2020-10-28T06:00:02Z

cibot: @dongju-chae, One of the module of prebuild group is failed. If you want to get a hint to fix this issue, please go to https://github.com/nnstreamer/nnstreamer/wiki/.

This patch adds feature to show custom property description for registered sub-plugins. Signed-off-by: Dongju Chae <dongju.chae@samsung.com>

anyj0527

LGTM Thanks! Near future We should update the custom_property_desc of each module!

dongju-chae requested review from again4you, anyj0527, gichan-jang, helloahn, jaeyun-jung, jijoongmoon, kparichay, leemgs, myungjoo, wooksong, zhoonit and a team as code owners October 15, 2020 08:46

dongju-chae added the discussion label Oct 15, 2020

dongju-chae force-pushed the custom_property branch from 0817366 to 9906d2b Compare October 15, 2020 09:59

dongju-chae changed the title ~~[Tools/Confchk] Show custom property description for sub-plugins~~ [Tools/Confchk] Show custom property description for sub-plugins @open sesame 10/15 19:35 Oct 15, 2020

dongju-chae changed the title ~~[Tools/Confchk] Show custom property description for sub-plugins @open sesame 10/15 19:35~~ [Tools/Confchk] Show custom property description for sub-plugins @open sesame 10/15 19:48 Oct 15, 2020

dongju-chae force-pushed the custom_property branch from 9906d2b to 3fbfdcd Compare October 22, 2020 02:21

myungjoo approved these changes Oct 28, 2020

View reviewed changes

dongju-chae force-pushed the custom_property branch from 3fbfdcd to b1eb668 Compare October 28, 2020 05:59

[Tools/Confchk] Show custom property description for sub-plugins

24b33fa

This patch adds feature to show custom property description for registered sub-plugins. Signed-off-by: Dongju Chae <dongju.chae@samsung.com>

dongju-chae force-pushed the custom_property branch from b1eb668 to 24b33fa Compare October 28, 2020 06:00

dongju-chae added PR/Ready2Go and removed discussion labels Oct 28, 2020

anyj0527 approved these changes Nov 20, 2020

View reviewed changes

myungjoo merged commit 0026577 into nnstreamer:main Nov 20, 2020

dongju-chae deleted the custom_property branch December 1, 2020 09:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Tools/Confchk] Show custom property description for sub-plugins @open sesame 10/15 19:48 #2800

[Tools/Confchk] Show custom property description for sub-plugins @open sesame 10/15 19:48 #2800

dongju-chae commented Oct 15, 2020 •

edited

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

dongju-chae commented Oct 15, 2020 •

edited

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 22, 2020

myungjoo commented Oct 26, 2020 •

edited

dongju-chae commented Oct 26, 2020 •

edited

myungjoo commented Oct 28, 2020

myungjoo left a comment

dongju-chae commented Oct 28, 2020

taos-ci commented Oct 28, 2020

taos-ci commented Oct 28, 2020

anyj0527 left a comment

[Tools/Confchk] Show custom property description for sub-plugins @open sesame 10/15 19:48 #2800

[Tools/Confchk] Show custom property description for sub-plugins @open sesame 10/15 19:48 #2800

Conversation

dongju-chae commented Oct 15, 2020 • edited

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

dongju-chae commented Oct 15, 2020 • edited

taos-ci commented Oct 15, 2020

taos-ci commented Oct 15, 2020

taos-ci commented Oct 22, 2020

myungjoo commented Oct 26, 2020 • edited

dongju-chae commented Oct 26, 2020 • edited

myungjoo commented Oct 28, 2020

myungjoo left a comment

Choose a reason for hiding this comment

dongju-chae commented Oct 28, 2020

taos-ci commented Oct 28, 2020

taos-ci commented Oct 28, 2020

anyj0527 left a comment

Choose a reason for hiding this comment

dongju-chae commented Oct 15, 2020 •

edited

dongju-chae commented Oct 15, 2020 •

edited

myungjoo commented Oct 26, 2020 •

edited

dongju-chae commented Oct 26, 2020 •

edited