38910d81848177197f891ca88a2b0653c38ccc7c
[tidl/tidl-api.git] / docs / source / changelog.rst
1 #########
2 Changelog
3 #########
5 1.4.0 [Processor Linux SDK 6.2]
6 ===============================
7 **Added**
9 #. Subgraph execution support.
11 1.3.3 [Processor Linux SDK 6.1]
12 ===============================
13 **Added**
15 #. Added imagenet python example.
17 #. Added MobileNet v2 support.
19 #. Added environment variables to control pre-allocated network memory sizes.
20    TIDL_{PARAM,NETWORK}_HEAP_SIZE_{DSP,EVE}
22 **Changed**
24 #. Trace data now also include dataQ/minValue/maxValue info.
26 #. ssd_multibox example now can also run the whole netework on a single core.
28 #. Shipped network binaries are in new file format, of size 484384 bytes.
30 1.3.0 [Processor Linux SDK 5.3]
31 ===============================
32 **Added**
34 #. Added DSP support for MNIST example.
36 **Changed**
38 #. PSDK 5.3 and TIDL-API 1.3 use a slightly modified TIDL network binary
39    format to support ONNX network import.  TIDL-API 1.3, as well as
40    tidl-viewer utility, can read both network formats before and after the
41    change.  Network binary in TIDL-API 1.2 and earlier is of size 483364
42    bytes, network binary in TIDL-API 1.3 is of size 484384 bytes.
44 #. Improved performance of concat layer on C66x DSP.
46 1.2.2 [Processor Linux SDK 5.2]
47 ===============================
48 **Added**
50 #. Updated API implementation to minimize TIDL API/OpenCL dispatch overhead using multiple execution contexts in the :term:`ExecutionObject`.
51    Refer to :ref:`mnist-example` example for details.
53 #. Execution Graph generation
55     Enable a two phase approach to generating execution graphs. Use the
56     following API function to enable timestamp generation:
58     .. code:: cpp
60         bool EnableTimeStamps(const std::string& file = "timestamp.log", size_t num_frames=32);
62     The generated log file can be viewed by using the execution_graph.py script. Refer to :ref:`execution-graph` for details.
64 #. 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``.
66    .. code:: bash
68         root@am57xx-evm:~# export PYTHONPATH=/home/root/tidl-api/tidl_api
69         root@am57xx-evm:~# python3
70         >>> import tidl
71         >>> help (tidl)
73 **Removed**
75 #. Configuration::enableInternalInput. Not used by the API.
77 #. Execution::GetExecutionObjects().
79    Use Execution::operator[] and Execution::GetNumExecutionObjects() instead.
80    See :ref:`examples` for usage.
82 #. The timing methods for host execution in EOPs and EOs:
84    * GetProcessTimeInMilliSeconds()
85    * GetHostProcessTimeInMilliSeconds()
87    These methods were replaced by a timestamp based approach because they were
88    no longer accurate with multiple ExecutionObject contexts and pipelining.
89    Refer to :ref:`execution-graph` for details.
91 1.1.0 [Processor Linux SDK 5.1]
92 ===============================
93 **Added**
95 #. :term:`ExecutionObjectPipeline` class to hide complexity of executing network across C66x/EVE
96 #. API methods for tracing outputs from intermediate network layers - see :ref:`network_layer_output`.
97 #. Support for updating layer group id assignment before execution - see :ref:`layer-group-override`.
98 #. Provide feedback to the user on parameter and network heap size requirements - see :ref:`sizing_device_heaps`.
101 1.0.0 [Processor Linux SDK 5.0]
102 ===============================
103 First release of the TI Deep Learning API. TIDL API brings deep learning to the edge by enabling applications to leverage TI's proprietary, highly optimized CNN/DNN implementation on the EVE and C66x DSP compute engines. TIDL will initially target Vision/2D use cases.
105 **Supported AM57x Sitara Processors**
107  * `AM5749`_ (offload to EVEs and C66x DSPs)
108  * `AM571x`_ (offload to C66x DSPs)
109  * `AM5728`_ (offload to C66x DSPs)
110  * `AM5748`_ (offload to C66x DSPs)
112 **Supported Evaluation Modules (EVMs)**
114  * `AM574x IDK EVM`_
115  * `AM572x EVM`_
116  * `AM571x IDK EVM`_
119 .. _AM572x EVM:  http://www.ti.com/tool/tmdsevm572x
120 .. _AM571x IDK EVM:  http://www.ti.com/tool/tmdxidk5718
121 .. _AM574x IDK EVM:  http://www.ti.com/tool/tmdsidk574
122 .. _AM571x:     http://www.ti.com/processors/sitara/arm-cortex-a15/am57x/products.html#p2098=1%20C66x&p809=2;2
123 .. _AM5728:     http://www.ti.com/product/AM5728
124 .. _AM5748:     http://www.ti.com/product/am5748
125 .. _AM5749:     http://www.ti.com/product/am5749
126 .. _AM574x:     http://www.ti.com/processors/sitara/arm-cortex-a15/am57x/products.html#p2098=2%20C66x&p815=ECC