Updated TIDL API manifest for v1.1
authorAjay Jayaraj <ajayj@ti.com>
Fri, 7 Sep 2018 19:02:12 +0000 (14:02 -0500)
committerAjay Jayaraj <ajayj@ti.com>
Fri, 7 Sep 2018 19:02:12 +0000 (14:02 -0500)
(MCT-1050)

docs/source/overview.rst
docs/source/using_api.rst
tidl_api_manifest.html

index ae57c59b2607feb950b02067a8c26280ed63932d..344ea6344c3cf0d6d4203dd0f08c0f2be04d0e19 100644 (file)
@@ -49,7 +49,12 @@ Terminology
 
     ExecutionObjectPipeline
     EOP
-        A TIDL API class. Used to pipeline execution of a single input frame across multiple Execution Objects. Refer :ref:`api-ref-eop` for a description of the ExecutionObjectPipeline class and methods.
+        A TIDL API class. Two use cases:
+
+        * Pipeline execution of a single input frame across multiple Execution Objects (:ref:`use-case-2`).
+        * Double buffering using the input and output buffer associated with an instance of ExecutionObjectPipeline (:ref:`use-case-3`).
+
+        Refer :ref:`api-ref-eop` for a description of the ExecutionObjectPipeline class and methods.
 
     Configuration
         A TIDL API class. Used to specify a configuration for the Executor, including pointers to the network and parameter binary files. Refer :ref:`api-ref-configuration` for a description of the Configuration class and methods.
index 37ebc34b1fa0190a5afa3b28752a20f01bef6370..9d216d00e9b5cda2e2ee2eae07684976bac73220 100644 (file)
@@ -11,7 +11,7 @@ This section illustrates using TIDL APIs to leverage deep learning in user appli
 * Use the :term:`Execution Objects<EO>` (EO) created by the Executor to process :term:`frames<Frame>`. There are two approaches to processing frames using Execution Objects:
 
   #. Each EO processes a single frame.
-  #. Split processing frame across multiple EOs.
+  #. Split processing frame across multiple EOs using an :term:`ExecutionObjectPipeline`.
 
 Refer Section :ref:`api-documentation` for API documentation.
 
@@ -82,6 +82,9 @@ In this approach, the :term:`network<Network>` is set up as a single :term:`Laye
 
 The complete example is available at ``/usr/share/ti/tidl/examples/one_eo_per_frame/main.cpp``.
 
+.. note::
+    The double buffering technique described in :ref:`use-case-3` can be used with a single :term:`ExecutionObject` to overlap reading a frame with the processing of the previous frame.
+
 .. _use-case-2:
 
 Frame split across EOs
@@ -155,8 +158,9 @@ The complete example is available at ``/usr/share/ti/tidl/examples/two_eo_per_fr
 
 .. _use-case-3:
 
-Frame split across EOs with double buffering
-============================================
+Using EOPs for double buffering
+===============================
+
 The timeline shown in :numref:`frame-across-eos` indicates that EO-EVE1 waits for processing on E0-DSP1 to complete before it starts processing its next frame. It is possible to optimize the example further and overlap processing F :sub:`n-2` on EO-DSP1 and F :sub:`n` on E0-EVE1. This is illustrated in :numref:`frame-across-eos-opt`.
 
 .. _frame-across-eos-opt:
index 9b2108d5153a915149646a68684dd0c65376a0e4..248ced417c3e978e9deb71ea269ffab0783e3139 100644 (file)
@@ -31,14 +31,14 @@ Multicore Tools - TIDL API Manifest
 \r\r
 <h4 id="ReleaseDate">\r\r
 <!-- @Start Date -->\r\r
-05-22-2018\r\r
+09-07-2018\r\r
 <!-- @End Date -->\r\r
 </h4>\r\r
 \r\r
 \r\r
 <h4 id="SRASID">\r\r
 <!-- @Start Date -->\r\r
-Manifest ID - SRAS00005051\r\r
+Manifest ID - SRAS00005506\r\r
 <!-- @End Date -->\r\r
 </h4>\r\r
 </div><div id="content">\r\r
@@ -197,7 +197,7 @@ Publicly Available
  TIDL API \r
  </td> \r
                <td id="version" name="version" rowspan="2"> \r
- 1.0.0 \r
+ 1.1.0 \r
  </td> \r
                <td id="license" name="license" rowspan="2"> \r
  BSD-3-Clause \r
@@ -226,7 +226,7 @@ Publicly Available
  TIDL examples \r
  </td> \r
                <td id="version" name="version" rowspan="2"> \r
- 1.0.0 \r
+ 1.1.0 \r
  </td> \r
                <td id="license" name="license" rowspan="2"> \r
  BSD-3-Clause \r
@@ -255,7 +255,7 @@ Publicly Available
  TIDL viewer \r
  </td> \r
                <td id="version" name="version" rowspan="2"> \r
- 1.0.0 \r
+ 1.1.0 \r
  </td> \r
                <td id="license" name="license" rowspan="2"> \r
  BSD-3-Clause \r