Updated parameter description in doxygen comments
authorAjay Jayaraj <ajayj@ti.com>
Tue, 13 Nov 2018 21:46:30 +0000 (15:46 -0600)
committerAjay Jayaraj <ajayj@ti.com>
Tue, 13 Nov 2018 22:04:39 +0000 (16:04 -0600)
(MCT-1084)

docs/source/api.rst
docs/source/changelog.rst
tidl_api/inc/configuration.h

index d6033a8700b12d04905f77c23020a212873d37c7..940ee43d2c9275b046f3138310546133765779c1 100644 (file)
@@ -29,6 +29,10 @@ TIDL API allows the user to create a Configuration object by reading from a file
     * netBinFile
     * paramsBinFile
 
+    * quantHistoryParam1
+    * quantHistoryParam2
+    * quantMargin
+
     * enableTrace
 
 An example configuration file:
index 17fbe83b416c4a6569b025aaa3a11bf44cef9fcf..8eb92315572913b8a029485bb199b8df2425249d 100644 (file)
@@ -6,6 +6,8 @@ Changelog
 ===============================
 **Added**
 
+#. Updated API implementation to minimize TIDL API/OpenCL dispatch overhead using multiple execution contexts in the :term:`ExecutionObject`.
+
 #. Execution Graph generation
 
     Enable a two phase approach to generating execution graphs. Use the
@@ -17,7 +19,14 @@ Changelog
 
     The generated log file can be viewed by using the execution_graph.py script. Refer to :ref:`execution-graph` for details.
 
-#. Python 3 bindings for TIDL API
+#. Added Python 3 bindings for TIDL API. See the ``examples/pybind`` directory for examples of using the Python bindings. Set PYTHONPATH to the location of ``tidl.so``.
+
+   .. code::
+
+        root@am57xx-evm:~# export PYTHONPATH=/home/root/tidl-api/tidl_api
+        root@am57xx-evm:~# python3
+        >>> import tidl
+        >>> help (tidl)
 
 **Removed**
 
index 6e2128e59967e94c27c3789437ca969f575fd63f..0a1c77cad1aa00d146c37792a5afaa6b84a17920 100644 (file)
@@ -126,9 +126,24 @@ class Configuration
     //! size.
     bool showHeapStats;
 
-    int    quantHistoryParam1;
-    int    quantHistoryParam2;
-    int    quantMargin;
+    //! Weight in percentage applied to previously processed input frame during
+    //! application startup (first 10 frames of input).
+    //!
+    //! TIDL maintains range statistics for previously processed frames.
+    //! It quantizes the current inference activations using these range
+    //! statistics from previous inputs (weighted average range). Therefore,
+    //! the results observed when the input is processed on the device will
+    //! not be identical to that observed during the import stage.
+    //! Parameters to control quantization:
+    //! @see quantHistoryParam1, quantHistoryParam2, quantMargin
+    int quantHistoryParam1;
+
+    //! Weight in percentage applied to previously processed input frames
+    //! after the first 10 input frames.
+    int quantHistoryParam2;
+
+    //! Margin added to the average in percentage.
+    int quantMargin;
 
     //! Default constructor.
     Configuration();