Documentation and top-level makefile updates
[tidl/tidl-api.git] / docs / source / viewer.rst
1 **************
2 Network Viewer
3 **************
5 The TIDL network viewer utility, ``tidl_viewer``, can be used to view the network graph. If the ``dot`` utility is available, ``tidl_viewer`` uses it to convert the dot file to svg. ``dot`` is included in the ``Graphviz`` Ubuntu package and typically installed to ``/usr/bin/dot``.
7 For example, the following command will generate a dot graph description for the ``tidl_net_jdetNet_ssd.bin`` network binary in ``ssd.dot``.
9 .. code-block:: bash
11     $ tidl_viewer examples/test/testvecs/config/tidl_models/tidl_net_jdetNet_ssd.bin -d ssd.dot
13 On x86/Linux, if ``/usr/bin/dot`` is available, ``tidl_viewer`` also generates an svg file, ``ssd.dot.svg``.
15 .. figure:: images/ssd.dot.svg
16     :align: center
17     :scale: 30
18     :width: 30%
19     :alt: SVG generated by dot
21     svg file generated by tidl_viewer (click to enlarge)
23 .. note::
24     If ``dot`` is not installed in ``/usr/bin/dot``, ``tidl_viewer`` will not convert the dot to svg. The following command can be used to generate the svg file as a separate step: ``dot -Tsvg ssd.dot -o ssd.dot.svg``. Additional information on ``Graphviz`` and ``dot`` available at:
26     * `Graphviz <https://www.graphviz.org/>`_
27     * `Ubuntu Graphviz package <https://packages.ubuntu.com/search?keywords=graphviz>`_