Merge branch 'release/v01.05.00'v01.05.00

12 files changed, 132 insertions, 50 deletions

diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
index 38910d8..42c4cf1 100644
--- a/docs/source/changelog.rst
+++ b/docs/source/changelog.rst
@@ -2,6 +2,12 @@
 Changelog
 #########
 
+1.5.0 [Processor Linux SDK 6.3]
+===============================
+**Changed**
+
+#. Cleaned up subgraph cfg file entries.  Added TIDL_SUBGRAPH_DIR env var.
+
 1.4.0 [Processor Linux SDK 6.2]
 ===============================
 **Added**
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 203aabf..60de98a 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -53,16 +53,16 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'TIDL API User\'s Guide'
-copyright = u'2018, Texas Instruments Incorporated'
+copyright = u'2018-2019, Texas Instruments Incorporated'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '1.2.x'
+version = '1.5.x'
 # The full version, including alpha/beta/rc tags.
-release = '1.2.x'
+release = '1.5.x'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/docs/source/using_api.rst b/docs/source/using_api.rst
index 80d8a74..d56bd52 100644
--- a/docs/source/using_api.rst
+++ b/docs/source/using_api.rst
@@ -313,3 +313,27 @@ See ``examples/layer_output/main.cpp, ProcessTrace()`` for examples of using the
 
 .. _Processor SDK Linux Software Developer's Guide: http://software-dl.ti.com/processor-sdk-linux/esd/docs/latest/linux/index.html
 .. _Processor SDK Linux Software Developer's Guide (TIDL chapter): http://software-dl.ti.com/processor-sdk-linux/esd/docs/latest/linux/Foundational_Components_TIDL.html
+
+Subgraph runtime
+++++++++++++++++
+
+TIDL API subgraph runtime are intended for interfacing with external inference
+frameworks.  Subgraph runtime are not intended for direct use in user
+applications.
+
+Subgraph config file
+====================
+
+Subgraph config file are named as "subgraph<number>.cfg", while <number>
+is the subgraph index in the original graph/network.  The environment
+variable `TIDL_SUBGRAPH_DIR` speicifies the directory where subgraph config
+files reside.  If not specified, the current directory is assumed.
+
+Subgraph config file requires extra parameters to describe data conversion
+at the subgraph boundaries.  Please see
+`examples/mobilenet_subgraph/subgraph0.cfg` for an example of minimal
+set of required parameters.
+
+Subgraph runtime API
+====================
+Please see `tidl_api/inc/subgraph_runtime.h` for details.
diff --git a/examples/mcbench/scripts/all_5729.sh b/examples/mcbench/scripts/all_5729.sh
index defec72..0fee8a1 100755
--- a/examples/mcbench/scripts/all_5729.sh
+++ b/examples/mcbench/scripts/all_5729.sh
@@ -7,8 +7,7 @@ export TIDL_NETWORK_HEAP_SIZE_DSP=56623104
 export TIDL_NETWORK_HEAP_SIZE_EVE=67108864
 export TIDL_NETWORK_HEAP_SIZE_DSP=8388608
 ./mcbench -g 2 -d 1 -e 4 -c ../test/testvecs/config/infer/tidl_config_mobileNet1_lg2.txt -f 50 -i ../test/testvecs/input/preproc_2_224x224_multi.y
-./mcbench -g 2 -d 2 -e 4 -c ../test/testvecs/config/infer/tidl_config_mobileNet1_lg2.txt -f 50 -i ../test/testvecs/input/preproc_2_224x224_multi.y
-./mcbench -g 2 -d 2 -e 4 -c ../test/testvecs/config/infer/tidl_config_mobileNet2_lg2.txt -f 50 -i ../test/testvecs/input/preproc_2_224x224_multi.y
-./mcbench -g 2 -d 2 -e 4 -c ../test/testvecs/config/infer/tidl_config_inceptionNetv1_lg2.txt -f 50 -i ../test/testvecs/input/preproc_0_224x224_multi.y
-./mcbench -g 2 -d 2 -e 4 -c ../test/testvecs/config/infer/tidl_config_j11_v2_lg2.txt -f 50 -i ../test/testvecs/input/preproc_0_224x224_multi.y
-./mcbench -g 2 -d 2 -e 4 -c ../test/testvecs/config/infer/tidl_config_j11_v2_dense_lg2.txt -f 50 -i ../test/testvecs/input/preproc_0_224x224_multi.y
+./mcbench -g 2 -d 1 -e 4 -c ../test/testvecs/config/infer/tidl_config_mobileNet2_lg2.txt -f 50 -i ../test/testvecs/input/preproc_2_224x224_multi.y
+./mcbench -g 2 -d 1 -e 4 -c ../test/testvecs/config/infer/tidl_config_inceptionNetv1_lg2.txt -f 50 -i ../test/testvecs/input/preproc_0_224x224_multi.y
+./mcbench -g 2 -d 1 -e 4 -c ../test/testvecs/config/infer/tidl_config_j11_v2_lg2.txt -f 50 -i ../test/testvecs/input/preproc_0_224x224_multi.y
+./mcbench -g 2 -d 1 -e 4 -c ../test/testvecs/config/infer/tidl_config_j11_v2_dense_lg2.txt -f 50 -i ../test/testvecs/input/preproc_0_224x224_multi.y
diff --git a/examples/mobilenet_subgraph/subgraph0.cfg b/examples/mobilenet_subgraph/subgraph0.cfg
index 404c70d..fac8180 100644
--- a/examples/mobilenet_subgraph/subgraph0.cfg
+++ b/examples/mobilenet_subgraph/subgraph0.cfg
@@ -1,12 +1,5 @@
-numFrames   = 1
-preProcType = 2
-inData   = "../test/testvecs/input/preproc_2_224x224.y"
-outData   = "./stats_tool_out.bin"
 netBinFile      = "../test/testvecs/config/tidl_models/tidl_net_mobilenet_1_224.bin"
 paramsBinFile   = "../test/testvecs/config/tidl_models/tidl_param_mobilenet_1_224.bin"
-inWidth = 224
-inHeight = 224
-inNumChannels = 3
 # The following information should be space separated list,
 #   corresponding to vector of inputs and vector of outputs
 #   Quant_value  = float_value * scaleF2Q
diff --git a/tidl_api/Makefile b/tidl_api/Makefile
index a04e604..3a5ea69 100644
--- a/tidl_api/Makefile
+++ b/tidl_api/Makefile
@@ -37,6 +37,8 @@ all: $(LIB_NAME) $(LIB_IMGUTIL_NAME) $(PY_LIB_NAME) \
 include make.inc
 include make.buildid
 
+SO_VER=$(MAJOR_VER).$(MINOR_VER).$(PATCH_VER)
+
 RM = rm
 AR = ar
 
@@ -95,7 +97,10 @@ $(LIB_NAME): $(HOST_OBJ_FILES)
         $(AR) cr $@ $(HOST_OBJ_FILES)
 
 $(SHARED_LIB_NAME): $(HOST_OBJ_FILES)
-        $(CXX) $(CXXFLAGS) -Wl,-Bsymbolic -shared -lOpenCL $(HOST_OBJ_FILES) -o $@
+        $(CXX) $(CXXFLAGS) -Wl,-Bsymbolic -shared -Wl,-soname,$@.$(MAJOR_VER) \
+                -lOpenCL $(HOST_OBJ_FILES) -o $@.$(SO_VER)
+        ln -sf $@.$(SO_VER) $@.$(MAJOR_VER)
+        ln -sf $@.$(MAJOR_VER) $@
 
 $(PY_LIB_NAME): $(HOST_OBJ_PYBIND_FILES) $(LIB_NAME)
         $(CXX) $(CXXFLAGS) -Wl,-Bsymbolic -shared -lOpenCL -locl_util $^ -o $@
@@ -104,10 +109,14 @@ $(LIB_IMGUTIL_NAME): $(HOST_OBJ_IMGUTIL_FILES)
         $(AR) cr $@ $(HOST_OBJ_IMGUTIL_FILES)
 
 $(SHARED_LIB_IMGUTIL_NAME): $(HOST_OBJ_IMGUTIL_FILES)
-        $(CXX) $(CXXFLAGS) -Wl,-Bsymbolic -shared $(HOST_OBJ_IMGUTIL_FILES) -o $@
+        $(CXX) $(CXXFLAGS) -Wl,-Bsymbolic -shared -Wl,-soname,$@.$(MAJOR_VER) \
+                $(HOST_OBJ_IMGUTIL_FILES) -o $@.$(SO_VER)
+        ln -sf $@.$(SO_VER) $@.$(MAJOR_VER)
+        ln -sf $@.$(MAJOR_VER) $@
 
 clean::
         $(RM) -f $(LIB_NAME) $(PY_LIB_NAME)
         $(RM) -f $(LIB_IMGUTIL_NAME)
+        $(RM) -f $(SHARED_LIB_NAME)* $(SHARED_LIB_IMGUTIL_NAME)*
         $(RM) -rf obj
 
diff --git a/tidl_api/inc/configuration.h b/tidl_api/inc/configuration.h
index c76ba7f..5de89f2 100644
--- a/tidl_api/inc/configuration.h
+++ b/tidl_api/inc/configuration.h
@@ -146,30 +146,43 @@ class Configuration
     //! Margin added to the average in percentage.
     int quantMargin;
 
-    //! subgraph data conversion type at subgraph inputs
-    //! 0: float <-> Q, 1: float <-> float, 2: Q <-> Q
+    //! Subgraph: config file for subgraph runtime, default to false
+    //!   (intended for interfacing with external inference frameworks,
+    //!    not intended for direct use in user applications)
+    //! The following {in,out}* parameters describe the tensor(s) value/layout
+    //! conversion at the subgraph boundaries for subgraph runtime.
+    //! Each parameter (vector) can be a space separated list, corresponding to
+    //! multiple input tensors and multiple output tensors, if applicable.
+    bool isSubgraphCfg;
+
+    //! subgraph: data value conversion type at subgraph input boundary,
+    //! between external tensors and TIDL tensors
+    //! 0: float -> Q, 1: float -> float, 2: Q -> Q
     std::vector<int> inConvType;
 
-    //! subgraph is signed data at subgraph inputs
+    //! subgraph: are external input tensors signed data
     std::vector<int> inIsSigned;
 
-    //! subgraph scaleF2Q factor at subgraph inputs
+    //! subgraph: scaleF2Q factor for converting values of input tensors
+    //! saturation(float_value * inScaleF2Q) = quantized_value
     std::vector<float> inScaleF2Q;
 
-    //! subgraph is external tensor NCHW layout at subgraph inputs
+    //! subgraph: are external input tensors in NCHW layout
     std::vector<int> inIsNCHW;
 
-    //! subgraph data conversion type at subgraph outputs
-    //! 0: float <-> Q, 1: float <-> float, 2: Q <-> Q
+    //! subgraph: data value conversion type at subgraph output boundary,
+    //! between TIDL tensors and external tensors
+    //! 0: Q -> float, 1: float -> float, 2: Q -> Q
     std::vector<int> outConvType;
 
-    //! subgraph is signed data at subgraph outputs
+    //! subgraph: are external output tensors signed data
     std::vector<int> outIsSigned;
 
-    //! subgraph scaleF2Q factor at subgraph outputs
+    //! subgraph: scaleF2Q factor for converting values of output tensors
+    //! quantized_value / outScaleF2Q = float_value
     std::vector<float> outScaleF2Q;
 
-    //! subgraph is external tensor NCHW layout at subgraph outputs
+    //! subgraph: are external output tensors in NCHW layout
     std::vector<int> outIsNCHW;
 
     //! Default constructor.
diff --git a/tidl_api/make.buildid b/tidl_api/make.buildid
index c2efbc5..9d8ec36 100644
--- a/tidl_api/make.buildid
+++ b/tidl_api/make.buildid
@@ -25,7 +25,7 @@
 # THE POSSIBILITY OF SUCH DAMAGE.
 
 MAJOR_VER=1
-MINOR_VER=4
+MINOR_VER=5
 PATCH_VER=0
 
 ifeq ($(shell git rev-parse --short HEAD 2>&1 1>/dev/null; echo $$?),0)
diff --git a/tidl_api/src/configuration.cpp b/tidl_api/src/configuration.cpp
index c67b22c..3ec242e 100644
--- a/tidl_api/src/configuration.cpp
+++ b/tidl_api/src/configuration.cpp
@@ -46,7 +46,16 @@ Configuration::Configuration(): numFrames(0), inHeight(0), inWidth(0),
                      showHeapStats(false),
                      quantHistoryParam1(20),
                      quantHistoryParam2(5),
-                     quantMargin(0)
+                     quantMargin(0),
+                     isSubgraphCfg(false),
+                     inConvType(),
+                     inIsSigned(),
+                     inScaleF2Q(),
+                     inIsNCHW(),
+                     outConvType(),
+                     outIsSigned(),
+                     outScaleF2Q(),
+                     outIsNCHW()
 {
 }
 
@@ -70,35 +79,57 @@ void Configuration::Print(std::ostream &os) const
 bool Configuration::Validate() const
 {
     int errors = 0;
+    struct stat buffer;
 
-    if (inHeight == 0 || inWidth == 0)
+    if (! isSubgraphCfg)
     {
-        std::cerr << "inHeight, inWidth must be > 0" << std::endl;
-        errors++;
-    }
+        if (inHeight == 0 || inWidth == 0)
+        {
+            std::cerr << "cfg: inHeight, inWidth must be > 0" << std::endl;
+            errors++;
+        }
 
-    if (inNumChannels < 1)
+        if (inNumChannels < 1)
+        {
+            std::cerr << "cfg: inNumChannels must be > 1" << std::endl;
+            errors++;
+        }
+
+        if (!inData.empty() && stat(inData.c_str(), &buffer) != 0)
+        {
+            std::cerr << "cfg: inData not found: " << inData << std::endl;
+            errors++;
+        }
+    }
+    else
     {
-        std::cerr << "inNumChannels must be > 1" << std::endl;
-        errors++;
+        if (inConvType.size() == 0 || inIsSigned.size() == 0 ||
+            inScaleF2Q.size() == 0 || inIsNCHW.size() == 0 ||
+            outConvType.size() == 0 || outIsSigned.size() == 0 ||
+            outScaleF2Q.size() == 0 || outIsNCHW.size() == 0)
+        {
+            std::cerr << "cfg: subgraph data info not found" << std::endl;
+            errors++;
+        }
+
+        if (inConvType.size() != inIsNCHW.size() ||
+            outConvType.size() != outIsNCHW.size())
+        {
+            std::cerr << "cfg: Mismatching subgraph data info" << std::endl;
+            errors++;
+        }
     }
 
-    struct stat buffer;
     if (stat(netBinFile.c_str(), &buffer) != 0)
     {
-        std::cerr << "netBinFile not found: " << netBinFile << std::endl;
+        std::cerr << "cfg: netBinFile not found: " << netBinFile << std::endl;
         errors++;
     }
 
     if (stat(paramsBinFile.c_str(), &buffer) != 0)
     {
-        std::cerr << "paramsBinFile not found: " << paramsBinFile << std::endl;
-        errors++;
-    }
-
-    if (!inData.empty() && stat(inData.c_str(), &buffer) != 0)
-    {
-        std::cerr << "inData not found: " << inData << std::endl;
+        std::cerr << "cfg: paramsBinFile not found: " << paramsBinFile
+                  << std::endl;
         errors++;
     }
 
diff --git a/tidl_api/src/configuration_parser.cpp b/tidl_api/src/configuration_parser.cpp
index 3ad0d2c..e0db7bb 100644
--- a/tidl_api/src/configuration_parser.cpp
+++ b/tidl_api/src/configuration_parser.cpp
@@ -118,7 +118,10 @@ bool Configuration::ReadFromFile(const std::string &file_name)
     std::ifstream IFS(file_name);
 
     if (!IFS.good())
+    {
+        std::cerr << "cfg: cannot read file: " << file_name << std::endl;
         return false;
+    }
 
     typedef ConfigParser<std::string::const_iterator> ConfigParser;
 
@@ -141,7 +144,7 @@ bool Configuration::ReadFromFile(const std::string &file_name)
 
         if (!result)
         {
-            std::cout << "Parsing failed on line " << line_num
+            std::cout << "cfg: parsing failed on line " << line_num
                       << ": " << str << std::endl;
             break;
         }
diff --git a/tidl_api/src/subgraph_runtime.cpp b/tidl_api/src/subgraph_runtime.cpp
index 9d068b2..5ac6e97 100644
--- a/tidl_api/src/subgraph_runtime.cpp
+++ b/tidl_api/src/subgraph_runtime.cpp
@@ -250,6 +250,10 @@ void ResM::InitSubgraph(uint32_t subgraph_id)
 
     // Read config file
     std::string cfg_file = "subgraph" + std::to_string(subgraph_id) + ".cfg";
+    char *subgraph_dir = getenv("TIDL_SUBGRAPH_DIR");
+    if (subgraph_dir != nullptr)
+      cfg_file = std::string(subgraph_dir) + "/" + cfg_file;
+    cs_m[subgraph_id].isSubgraphCfg = true;
     bool status = cs_m[subgraph_id].ReadFromFile(cfg_file);
     assert(status);
 
diff --git a/tidl_api_manifest.html b/tidl_api_manifest.html
index e4a5577..57d4f89 100644
--- a/tidl_api_manifest.html
+++ b/tidl_api_manifest.html
@@ -197,7 +197,7 @@ Publicly Available
  TIDL API 

  </td> 

                 <td id="version" name="version" rowspan="2"> 

- 1.3.x 

+ 1.5.x 

  </td> 

                 <td id="license" name="license" rowspan="2"> 

  BSD-3-Clause 

@@ -226,7 +226,7 @@ Publicly Available
  TIDL examples 

  </td> 

                 <td id="version" name="version" rowspan="2"> 

- 1.3.x 

+ 1.5.x 

  </td> 

                 <td id="license" name="license" rowspan="2"> 

  BSD-3-Clause 

@@ -255,7 +255,7 @@ Publicly Available
  TIDL viewer 

  </td> 

                 <td id="version" name="version" rowspan="2"> 

- 1.3.x 

+ 1.5.x 

  </td> 

                 <td id="license" name="license" rowspan="2"> 

  BSD-3-Clause 

@@ -471,4 +471,4 @@ Publicly Available
   with 100,000+ analog ICs and embedded processors, along with software, tools


   and the industry's largest sales/support staff.</p>


 </footer>


-</body></html>
\ No newline at end of file
+</body></html>