1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
/******************************************************************************
* Copyright (c) 2017-2018 Texas Instruments Incorporated - http://www.ti.com/
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of Texas Instruments Incorporated nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*****************************************************************************/
#pragma once
//! @file configuration.h
#include <string>
#include <map>
#include <vector>
#include <iostream>
namespace tidl {
/*! @class Configuration
@brief Specifies the configuration required for a network
The Configuration object is used to specify various parameters required
for network execution. Applications can directly initialize fields in an
instance of Configuration or use the ReadFromFile method to read the
configuration from a file.
*/
class Configuration
{
public:
//! Number of frames of input data (can be 0 if data is not read from file)
int numFrames;
//! Height of the input image. Used by the API, must be specified.
int inHeight;
//! Width of the input image. Used by the API, must be specified.
int inWidth;
//! Number of channels in the input frame (e.g. 3 for BGR)
//! Used by the API, must be specified.
int inNumChannels;
//! @private
int noZeroCoeffsPercentage;
//! Pre-processing type applied to the input frame
//! Specific to each network, can take values from 0 to 4, default is 0
//! 0 -> Caffe-Jacinto models
//! 1 -> Caffe models (SqueezeNet)
//! 2 -> TensorFlow (Inception, MobileNet)
//! 3 -> CIFAR 10
//! 4 -> JdetNet
int preProcType;
//! Force to run all layers, regardless of layersGroupId partitioning
bool runFullNet;
//! @brief Size of the device side network heap
//! This heap is used for allocating memory required to
//! run the network on the device. One per Execution Object.
size_t NETWORK_HEAP_SIZE;
//! @brief Size of the device side heap used for parameter data.
//! The size depends on the size of the parameter binary file. The
//! constructor for ``Configuration`` sets PARAM_HEAP_SIZE to 9MB.
//! There is one parameter heap for each instance of ``Executor`` .
size_t PARAM_HEAP_SIZE;
//! @brief Path to the input image file.
//! This field is not used by the TIDL API itself. It can be used by
//! applications to load an input image into a buffer. Can be empty if
//! the application uses frameworks such as OpenCV to read images. Refer
//! examples/test/main.cpp for usage.
std::string inData;
//! @brief Path to the output image file.
//! This field is not used by the TIDL API itself. It can be used by
//! applications to specify a name for the output file. Can be empty
//! if the application uses frameworks such as OpenCV to read images.
//! Refer examples/test/main.cpp for usage.
std::string outData;
//! Path to the TIDL network binary file.
//! Used by the API, must be specified.
std::string netBinFile;
//! Path to the TIDL parameter binary file
//! Used by the API, must be specified.
std::string paramsBinFile;
//! Map of layer index to layer group id. Used to override layer group
//! assigment for layers. Any layer not specified in this map will
//! retain its existing mapping.
std::map<int, int> layerIndex2LayerGroupId;
//! Enable tracing of output buffers associated with each layer
bool enableOutputTrace;
//! Debug - Generates a trace of host and device function calls
bool enableApiTrace;
//! Debug - Shows total size of PARAM and NETWORK heaps. Also shows bytes
//! available after all allocations. Can be used to adjust the heap
//! size.
bool showHeapStats;
//! Weight in percentage applied to previously processed input frame during
//! application startup (first 10 frames of input).
//!
//! TIDL maintains range statistics for previously processed frames.
//! It quantizes the current inference activations using these range
//! statistics from previous inputs (weighted average range). Therefore,
//! the results observed when the input is processed on the device will
//! not be identical to that observed during the import stage.
//! Parameters to control quantization:
//! @see quantHistoryParam1, quantHistoryParam2, quantMargin
int quantHistoryParam1;
//! Weight in percentage applied to previously processed input frames
//! after the first 10 input frames.
int quantHistoryParam2;
//! Margin added to the average in percentage.
int quantMargin;
//! subgraph data conversion type at subgraph inputs
//! 0: float <-> Q, 1: float <-> float, 2: Q <-> Q
std::vector<int> inConvType;
//! subgraph is signed data at subgraph inputs
std::vector<int> inIsSigned;
//! subgraph scaleF2Q factor at subgraph inputs
std::vector<float> inScaleF2Q;
//! subgraph is external tensor NCHW layout at subgraph inputs
std::vector<int> inIsNCHW;
//! subgraph data conversion type at subgraph outputs
//! 0: float <-> Q, 1: float <-> float, 2: Q <-> Q
std::vector<int> outConvType;
//! subgraph is signed data at subgraph outputs
std::vector<int> outIsSigned;
//! subgraph scaleF2Q factor at subgraph outputs
std::vector<float> outScaleF2Q;
//! subgraph is external tensor NCHW layout at subgraph outputs
std::vector<int> outIsNCHW;
//! Default constructor.
Configuration();
//! Validate the fields in the configuration object
bool Validate() const;
//! Debug - Print the configuration.
void Print(std::ostream& os = std::cout) const;
//! Read a configuration from the specified file and validate
bool ReadFromFile(const std::string& file_name);
};
}
|
