Added Python 3 bindings for TIDL API
[tidl/tidl-api.git] / tidl_api / src / pybind_configuration.cpp
1 /******************************************************************************
2  * Copyright (c) 2018-2018 Texas Instruments Incorporated - http://www.ti.com/
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *      * Redistributions of source code must retain the above copyright
8  *        notice, this list of conditions and the following disclaimer.
9  *      * Redistributions in binary form must reproduce the above copyright
10  *        notice, this list of conditions and the following disclaimer in the
11  *        documentation and/or other materials provided with the distribution.
12  *      * Neither the name of Texas Instruments Incorporated nor the
13  *        names of its contributors may be used to endorse or promote products
14  *        derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
26  *  THE POSSIBILITY OF SUCH DAMAGE.
27  *****************************************************************************/
29 #include "pybind_common.h"
31 void init_configuration(module &m)
32 {
33     class_<Configuration>(m, "Configuration")
34                 .def(init<>())
35         .def_readwrite("num_frames", &Configuration::numFrames,
36             "Number of frames of input data. Can be 0 if data is\n"
37             "not read from file")
39         .def_readwrite("height", &Configuration::inHeight)
41         .def_readwrite("width", &Configuration::inWidth)
43         .def_readwrite("channels", &Configuration::inNumChannels)
45         .def_readwrite("pre_proc_type", &Configuration::preProcType,
46             "Pre-processing type applied to the input frame")
48         .def_readwrite("run_full_net", &Configuration::runFullNet,
49             "Force to run all layers, regardless of layersGroupId partitioning")
51         .def_readwrite("network_binary", &Configuration::netBinFile,
52             "Path to the TIDL network binary file")
54         .def_readwrite("parameter_binary", &Configuration::paramsBinFile,
55             "Path to the TIDL parameter binary file")
57         .def_readwrite("network_heap_size", &Configuration::NETWORK_HEAP_SIZE,
58             "Size of the device side network heap\n"
59             "This heap is used for allocating memory required to"
60             "run the network on the device. One per ExecutionObject.")
62         .def_readwrite("param_heap_size", &Configuration::PARAM_HEAP_SIZE,
63             "Size of the device side heap used for parameter data.\n"
64             "The size depends on the size of the parameter binary file.\n"
65             "There is one parameter heap for each instance of Executor\n")
67         .def_readwrite("enable_api_trace", &Configuration::enableApiTrace,
68             "Debug - Set to True to generate a trace of host/device\n"
69             "function calls")
71         .def_readwrite("enable_layer_dump", &Configuration::enableOutputTrace,
72             "Debug - Enable dump of output buffers associated with each layer")
74         .def_readwrite("show_heap_stats", &Configuration::showHeapStats,
75             "Debug - Shows total size of PARAM and NETWORK heaps. Also \n"
76             "shows bytes free after all allocations. Used to adjust heap sizes")
78         .def_readwrite("layer_index_to_layer_group_id",
79                        &Configuration::layerIndex2LayerGroupId,
80             "Map of layer index to layer group id. Used to override \n"
81             "layer group assigment for layers. Any layer not specified\n"
82             "in this map will retain its existing mapping")
84         .def_readwrite("in_data", &Configuration::inData)
86         .def_readwrite("out_data", &Configuration::outData)
88         .def("read_from_file", &Configuration::ReadFromFile,
89              "Read a configuration from the specified file");
90 }