Update changelog for version 1.3.1
[tidl/tidl-api.git] / docs / source / changelog.rst
1 #########
2 Changelog
3 #########
5 1.3.1 [Processor Linux SDK 6.1]
6 ===============================
7 **Added**
9 #. Added imagenet python example.
11 **Changed**
13 #. Trace data now also include dataQ/minValue/maxValue info.
15 #. ssd_multibox example now can also run the whole netework on a single core.
17 #. Shipped network binaries are in new file format, of size 484384 bytes.
19 1.3.0 [Processor Linux SDK 5.3]
20 ===============================
21 **Added**
23 #. Added DSP support for MNIST example.
25 **Changed**
27 #. PSDK 5.3 and TIDL-API 1.3 use a slightly modified TIDL network binary
28    format to support ONNX network import.  TIDL-API 1.3, as well as
29    tidl-viewer utility, can read both network formats before and after the
30    change.  Network binary in TIDL-API 1.2 and earlier is of size 483364
31    bytes, network binary in TIDL-API 1.3 is of size 484384 bytes.
33 #. Improved performance of concat layer on C66x DSP.
35 1.2.2 [Processor Linux SDK 5.2]
36 ===============================
37 **Added**
39 #. Updated API implementation to minimize TIDL API/OpenCL dispatch overhead using multiple execution contexts in the :term:`ExecutionObject`.
40    Refer to :ref:`mnist-example` example for details.
42 #. Execution Graph generation
44     Enable a two phase approach to generating execution graphs. Use the
45     following API function to enable timestamp generation:
47     .. code:: cpp
49         bool EnableTimeStamps(const std::string& file = "timestamp.log", size_t num_frames=32);
51     The generated log file can be viewed by using the execution_graph.py script. Refer to :ref:`execution-graph` for details.
53 #. 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``.
55    .. code:: bash
57         root@am57xx-evm:~# export PYTHONPATH=/home/root/tidl-api/tidl_api
58         root@am57xx-evm:~# python3
59         >>> import tidl
60         >>> help (tidl)
62 **Removed**
64 #. Configuration::enableInternalInput. Not used by the API.
66 #. Execution::GetExecutionObjects().
68    Use Execution::operator[] and Execution::GetNumExecutionObjects() instead.
69    See :ref:`examples` for usage.
71 #. The timing methods for host execution in EOPs and EOs:
73    * GetProcessTimeInMilliSeconds()
74    * GetHostProcessTimeInMilliSeconds()
76    These methods were replaced by a timestamp based approach because they were
77    no longer accurate with multiple ExecutionObject contexts and pipelining.
78    Refer to :ref:`execution-graph` for details.
80 1.1.0 [Processor Linux SDK 5.1]
81 ===============================
82 **Added**
84 #. :term:`ExecutionObjectPipeline` class to hide complexity of executing network across C66x/EVE
85 #. API methods for tracing outputs from intermediate network layers - see :ref:`network_layer_output`.
86 #. Support for updating layer group id assignment before execution - see :ref:`layer-group-override`.
87 #. Provide feedback to the user on parameter and network heap size requirements - see :ref:`sizing_device_heaps`.
90 1.0.0 [Processor Linux SDK 5.0]
91 ===============================
92 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.
94 **Supported AM57x Sitara Processors**
96  * `AM5749`_ (offload to EVEs and C66x DSPs)
97  * `AM571x`_ (offload to C66x DSPs)
98  * `AM5728`_ (offload to C66x DSPs)
99  * `AM5748`_ (offload to C66x DSPs)
101 **Supported Evaluation Modules (EVMs)**
103  * `AM574x IDK EVM`_
104  * `AM572x EVM`_
105  * `AM571x IDK EVM`_
108 .. _AM572x EVM:  http://www.ti.com/tool/tmdsevm572x
109 .. _AM571x IDK EVM:  http://www.ti.com/tool/tmdxidk5718
110 .. _AM574x IDK EVM:  http://www.ti.com/tool/tmdsidk574
111 .. _AM571x:     http://www.ti.com/processors/sitara/arm-cortex-a15/am57x/products.html#p2098=1%20C66x&p809=2;2
112 .. _AM5728:     http://www.ti.com/product/AM5728
113 .. _AM5748:     http://www.ti.com/product/am5748
114 .. _AM5749:     http://www.ti.com/product/am5749
115 .. _AM574x:     http://www.ti.com/processors/sitara/arm-cortex-a15/am57x/products.html#p2098=2%20C66x&p815=ECC