docs/source/api.rst

   1 .. _api-documentation:
   2
   3 *************
   4 API Reference
   5 *************
   6
   7 .. _api-ref-configuration:
   8
   9 Configuration
  10 +++++++++++++
  11 .. doxygenclass:: tidl::Configuration
  12     :members:
  13
  14 Configuration file
  15 ==================
  16
  17 TIDL API allows the user to create a Configuration object by reading from a file or by initializing it directly. Configuration settings supported by ``Configuration::ReadFromFile``:
  18
  19     * numFrames
  20     * inWidth
  21     * inHeight
  22     * inNumChannels
  23     * preProcType
  24     * layerIndex2LayerGroupId
  25
  26     * inData
  27     * outData
  28
  29     * netBinFile
  30     * paramsBinFile
  31
  32     * quantHistoryParam1
  33     * quantHistoryParam2
  34     * quantMargin
  35
  36     * enableTrace
  37
  38 An example configuration file:
  39
  40 .. literalinclude:: ../../examples/layer_output/j11_v2_trace.txt
  41     :language: bash
  42
  43
  44 .. _layer-group-override:
  45
  46 Overriding layer group assignment
  47 =================================
  48 The `TIDL device translation tool`_ assigns layer group ids to layers during the translation process. TIDL API 1.1 and higher allows the user to override this assignment by specifying explicit mappings. There are two ways for the user to provide an updated mapping:
  49
  50 1. Specify a mapping in the configuration file to indicate that layers 12, 13 and 14 are assigned to layer group 2:
  51
  52 .. code-block:: c++
  53
  54     layerIndex2LayerGroupId = { {12, 2}, {13, 2}, {14, 2} }
  55
  56
  57 2. User can also provide the layer index to group mapping in the code:
  58
  59 .. code-block:: c++
  60
  61     Configuration c;
  62     c.ReadFromFile("test.cfg");
  63     c.layerIndex2LayerGroupId = { {12, 2}, {13, 2}, {14, 2} };
  64
  65
  66 .. role:: cpp(code)
  67    :language: c++
  68
  69
  70 .. _api-ref-executor:
  71
  72 Executor
  73 ++++++++
  74 .. doxygenclass:: tidl::Executor
  75     :members:
  76
  77 .. _api-ref-eo:
  78
  79 ExecutionObject
  80 +++++++++++++++
  81 .. doxygenclass:: tidl::ExecutionObject
  82     :members:
  83
  84 .. _api-ref-eop:
  85
  86 ExecutionObjectPipeline
  87 +++++++++++++++++++++++
  88 .. doxygenclass:: tidl::ExecutionObjectPipeline
  89     :members:
  90
  91
  92 .. refer https://breathe.readthedocs.io/en/latest/directives.html
  93
  94 .. _TIDL device translation tool: http://software-dl.ti.com/processor-sdk-linux/esd/docs/latest/linux/Foundational_Components_TIDL.html#import-process