Report memory usage when device allocation fails
[tidl/tidl-api.git] / tidl_api / inc / configuration.h
1 /******************************************************************************
2  * Copyright (c) 2017-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 #pragma once
31 //! @file configuration.h
33 #include <string>
34 #include <map>
35 #include <iostream>
37 namespace tidl {
39 /*! @class Configuration
40     @brief Specifies the configuration required for a network
41 */
42 class Configuration
43 {
44   public:
46     //! Number of frames of input data (can be 0 if data is not read from file)
47     int     numFrames;
49     //! Height of the input frame
50     int     inHeight;
52     //! Width of the input frame
53     int     inWidth;
55     //! Number of channels in the input frame (e.g. 3 for BGR)
56     int     inNumChannels;
58     //! @private
59     int     noZeroCoeffsPercentage;
61     //! Pre-processing type applied to the input frame
62     //! Specific to each network, can take values from 0 to 4, default is 0
63     int     preProcType;
65     //! Force to run all layers, regardless of layersGroupId partitioning
66     bool    runFullNet;
68     //! When set, inputs are taken from TIDL internal buffers that contain
69     //! outputs of previous layersGroupId, instead of from user application
70     bool     enableInternalInput;
72     //! Size of the device side heap, used for allocating memory required to
73     //! run the network on the device. One per Execution Object.
74     size_t NETWORK_HEAP_SIZE;
76     //! Size of the heap used for parameter data. One per Executor.
77     size_t PARAM_HEAP_SIZE;
79     //! @brief Location of the input file
80     //! Can be empty if input data is provided by frameworks such as OpenCV.
81     std::string inData;
83     //! Location of the output file
84     //! Can be empty if output data is consumed by frameworks such as OpenCV.
85     std::string outData;
87     //! Path to the TIDL network binary file
88     std::string netBinFile;
90     //! Path to the TIDL parameter binary file
91     std::string paramsBinFile;
93     //! Enable tracing of output buffers associated with each layer
94     bool enableOutputTrace;
96     //! Debug - Generates a trace of host and device function calls
97     bool enableApiTrace;
99     //! Debug - Shows total size of PARAM and NETWORK heaps. Also shows bytes
100     //! available after all allocations. Can be used to adjust the heap
101     //! size
102     bool showHeapStats;
104     //! Map of layer index to layer group id. Used to override layer group
105     //! assigment for layers. Any layer not specified in this map will
106     //! retain its existing mapping.
107     std::map<int, int> layerIndex2LayerGroupId;
109     //! Default constructor.
110     Configuration();
112     //! Validate the fields in the configuration object
113     bool Validate() const;
115     //! Print the configuration
116     void Print(std::ostream& os = std::cout) const;
118     //! Read a configuration from the specified file and validate
119     bool ReadFromFile(const std::string& file_name);
121 };