TensorRT  5.1.5.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
NvUffParser.h
1 /*
2  * Copyright 1993-2019 NVIDIA Corporation. All rights reserved.
3  *
4  * NOTICE TO LICENSEE:
5  *
6  * This source code and/or documentation ("Licensed Deliverables") are
7  * subject to NVIDIA intellectual property rights under U.S. and
8  * international Copyright laws.
9  *
10  * These Licensed Deliverables contained herein is PROPRIETARY and
11  * CONFIDENTIAL to NVIDIA and is being provided under the terms and
12  * conditions of a form of NVIDIA software license agreement by and
13  * between NVIDIA and Licensee ("License Agreement") or electronically
14  * accepted by Licensee. Notwithstanding any terms or conditions to
15  * the contrary in the License Agreement, reproduction or disclosure
16  * of the Licensed Deliverables to any third party without the express
17  * written consent of NVIDIA is prohibited.
18  *
19  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
20  * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
21  * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE. IT IS
22  * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
23  * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
24  * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
25  * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
26  * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
27  * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
28  * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
29  * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
30  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
31  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
32  * OF THESE LICENSED DELIVERABLES.
33  *
34  * U.S. Government End Users. These Licensed Deliverables are a
35  * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
36  * 1995), consisting of "commercial computer software" and "commercial
37  * computer software documentation" as such terms are used in 48
38  * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
39  * only as a commercial end item. Consistent with 48 C.F.R.12.212 and
40  * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
41  * U.S. Government End Users acquire the Licensed Deliverables with
42  * only those rights set forth herein.
43  *
44  * Any use of the Licensed Deliverables in individual and commercial
45  * software must include, in the user documentation and internal
46  * comments to the code, the above Disclaimer and U.S. Government End
47  * Users Notice.
48  */
49 
50 #ifndef NV_UFF_PARSER_H
51 #define NV_UFF_PARSER_H
52 
53 #include "NvInfer.h"
54 
55 //Current supported Universal Framework Format (UFF) version for the parser.
56 #define UFF_REQUIRED_VERSION_MAJOR 0
57 #define UFF_REQUIRED_VERSION_MINOR 6
58 #define UFF_REQUIRED_VERSION_PATCH 3
59 
60 namespace nvuffparser
61 {
62 
67 enum class UffInputOrder : int
68 {
69  kNCHW = 0,
70  kNHWC = 1,
71  kNC = 2
72 };
73 
78 
79 enum class FieldType : int
80 {
81  kFLOAT = 0,
82  kINT32 = 1,
83  kCHAR = 2,
84  kDIMS = 4,
85  kDATATYPE = 5,
86  kUNKNOWN = 6
87 };
88 
98 class TENSORRTAPI FieldMap
99 {
100 public:
101  const char* name;
102  const void* data;
103  FieldType type = FieldType::kUNKNOWN;
104  int length = 1;
105 
106  FieldMap(const char* name, const void* data, const FieldType type, int length = 1);
107 };
108 
110 {
111  int nbFields;
112  const FieldMap* fields;
113 };
114 
121 {
122 public:
128  virtual bool isPlugin(const char* layerName) = 0;
129 
140  virtual nvinfer1::IPlugin* createPlugin(const char* layerName, const nvinfer1::Weights* weights, int nbWeights,
141  const FieldCollection fc) = 0;
142 
143 };
144 
151 {
152 public:
153  virtual int getVersion() const
154  {
155  return NV_TENSORRT_VERSION;
156  }
157 
163  virtual bool isPluginExt(const char* layerName) = 0;
164 };
165 
174 {
175 public:
183  virtual bool registerInput(const char* inputName, nvinfer1::Dims inputDims, UffInputOrder inputOrder) = 0;
184 
190  virtual bool registerOutput(const char* outputName) = 0;
191 
199  virtual bool parse(const char* file,
202 
211  virtual bool parseBuffer(const char* buffer, std::size_t size,
214 
215  virtual void destroy() = 0;
216 
220  virtual int getUffRequiredVersionMajor() = 0;
221 
225  virtual int getUffRequiredVersionMinor() = 0;
226 
230  virtual int getUffRequiredVersionPatch() = 0;
231 
237  virtual void setPluginFactory(IPluginFactory* factory) = 0;
238 
244  virtual void setPluginFactoryExt(IPluginFactoryExt* factory) = 0;
245 
249  virtual void setPluginNamespace(const char* libNamespace) = 0;
250 
251 protected:
252  virtual ~IUffParser() {}
253 };
254 
262 TENSORRTAPI IUffParser* createUffParser();
263 
269 TENSORRTAPI void shutdownProtobufLibrary(void);
270 
271 }
272 
273 extern "C" TENSORRTAPI void* createNvUffParser_INTERNAL();
274 
275 #endif /* !NV_UFF_PARSER_H */
DataType
The type of weights and tensors.
Definition: NvInfer.h:125
Class used for parsing models described using the UFF format.
Definition: NvUffParser.h:173
Definition: NvUffParser.h:109
virtual int getUffRequiredVersionMajor()=0
Return Version Major of the UFF.
virtual bool registerOutput(const char *outputName)=0
Register an output name of a UFF network.
virtual int getUffRequiredVersionPatch()=0
Return Patch Version of the UFF.
Plugin class for user-implemented layers.
Definition: NvInfer.h:2849
An array of field params used as a layer parameter for plugin layers.
Definition: NvUffParser.h:98
virtual void setPluginNamespace(const char *libNamespace)=0
Set the namespace used to lookup and create plugins in the network.
A network definition for input to the builder.
Definition: NvInfer.h:4102
virtual bool registerInput(const char *inputName, nvinfer1::Dims inputDims, UffInputOrder inputOrder)=0
Register an input name of a UFF network with the associated Dimensions.
virtual bool isPluginExt(const char *layerName)=0
A user implemented function that determines if a layer configuration is provided by an IPluginExt...
nvinfer1::Dims field type.
virtual void setPluginFactory(IPluginFactory *factory)=0
Set the IPluginFactory used to create the user defined plugins.
Structure to define the dimensions of a tensor.
Definition: NvInfer.h:181
virtual bool parse(const char *file, nvinfer1::INetworkDefinition &network, nvinfer1::DataType weightsType=nvinfer1::DataType::kFLOAT)=0
Parse a UFF file.
virtual nvinfer1::IPlugin * createPlugin(const char *layerName, const nvinfer1::Weights *weights, int nbWeights, const FieldCollection fc)=0
Creates a plugin.
An array of weights used as a layer parameter.
Definition: NvInfer.h:516
virtual void setPluginFactoryExt(IPluginFactoryExt *factory)=0
Set the IPluginFactoryExt used to create the user defined pluginExts.
virtual int getUffRequiredVersionMinor()=0
Return Version Minor of the UFF.
Plugin factory used to configure plugins with added support for TRT versioning.
Definition: NvUffParser.h:150
Plugin factory used to configure plugins.
Definition: NvUffParser.h:120
virtual bool parseBuffer(const char *buffer, std::size_t size, nvinfer1::INetworkDefinition &network, nvinfer1::DataType weightsType=nvinfer1::DataType::kFLOAT)=0
Parse a UFF buffer, useful if the file already live in memory.
virtual bool isPlugin(const char *layerName)=0
A user implemented function that determines if a layer configuration is provided by an IPlugin...