TensorRT  7.2.2.0
NvCaffeParser.h
Go to the documentation of this file.
1 /*
2  * Copyright 1993-2020 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_CAFFE_PARSER_H
51 #define NV_CAFFE_PARSER_H
52 
53 #include "NvInfer.h"
54 
60 
66 namespace nvcaffeparser1
67 {
68 
81 {
82 public:
89  virtual nvinfer1::ITensor* find(const char* name) const TRTNOEXCEPT = 0;
90 
91 protected:
92  virtual ~IBlobNameToTensor() {}
93 };
94 
105 {
106 public:
107  virtual const void* getData() TRTNOEXCEPT = 0;
108  virtual nvinfer1::DimsNCHW getDimensions() TRTNOEXCEPT = 0;
109  virtual nvinfer1::DataType getDataType() TRTNOEXCEPT = 0;
110  virtual void destroy() TRTNOEXCEPT = 0;
111 
112 protected:
113  virtual ~IBinaryProtoBlob() {}
114 };
115 
122 {
123 public:
129  virtual bool isPlugin(const char* layerName) TRTNOEXCEPT = 0;
130 
139  const char* layerName, const nvinfer1::Weights* weights, int32_t nbWeights) TRTNOEXCEPT = 0;
140 
141  virtual ~IPluginFactory() {}
142 };
143 
150 {
151 public:
152  virtual int32_t getVersion() const TRTNOEXCEPT
153  {
154  return NV_TENSORRT_VERSION;
155  }
156 
162  virtual bool isPluginExt(const char* layerName) TRTNOEXCEPT = 0;
163 };
164 
171 {
172 public:
178  virtual bool isPluginV2(const char* layerName) TRTNOEXCEPT = 0;
179 
188  virtual nvinfer1::IPluginV2* createPlugin(const char* layerName, const nvinfer1::Weights* weights,
189  int32_t nbWeights, const char* libNamespace = "") TRTNOEXCEPT = 0;
190 
191  virtual ~IPluginFactoryV2() {}
192 };
203 {
204 public:
218  virtual const IBlobNameToTensor* parse(const char* deploy,
219  const char* model,
221  nvinfer1::DataType weightType) TRTNOEXCEPT = 0;
222 
238  virtual const IBlobNameToTensor* parseBuffers(const char* deployBuffer,
239  std::size_t deployLength,
240  const char* modelBuffer,
241  std::size_t modelLength,
243  nvinfer1::DataType weightType) TRTNOEXCEPT = 0;
244 
257  virtual IBinaryProtoBlob* parseBinaryProto(const char* fileName) TRTNOEXCEPT = 0;
258 
266  virtual void setProtobufBufferSize(size_t size) TRTNOEXCEPT = 0;
267 
273  virtual void setPluginFactory(IPluginFactory* factory) TRTNOEXCEPT = 0;
274 
280  virtual void setPluginFactoryExt(IPluginFactoryExt* factory) TRTNOEXCEPT = 0;
281 
285  virtual void destroy() TRTNOEXCEPT = 0;
286 
292  virtual void setPluginFactoryV2(IPluginFactoryV2* factory) TRTNOEXCEPT = 0;
293 
297  virtual void setPluginNamespace(const char* libNamespace) TRTNOEXCEPT = 0;
298 
299 protected:
300  virtual ~ICaffeParser() {}
301 
302 public:
315  virtual void setErrorRecorder(nvinfer1::IErrorRecorder* recorder) TRTNOEXCEPT = 0;
316 
328 };
329 
338 
344 TENSORRTAPI void shutdownProtobufLibrary() TRTNOEXCEPT;
345 } // namespace nvcaffeparser1
346 
351 extern "C" TENSORRTAPI void* createNvCaffeParser_INTERNAL();
352 #endif
nvcaffeparser1::ICaffeParser::parseBuffers
virtual const IBlobNameToTensor * parseBuffers(const char *deployBuffer, std::size_t deployLength, const char *modelBuffer, std::size_t modelLength, nvinfer1::INetworkDefinition &network, nvinfer1::DataType weightType)=0
Parse a deploy prototxt a binaryproto Caffe model from memory buffers to extract network definition a...
nvcaffeparser1::ICaffeParser::destroy
virtual void destroy()=0
Destroy this ICaffeParser object.
nvcaffeparser1::ICaffeParser
Class used for parsing Caffe models.
Definition: NvCaffeParser.h:202
nvinfer1::INetworkDefinition
A network definition for input to the builder.
Definition: NvInfer.h:4927
nvinfer1::Weights
An array of weights used as a layer parameter.
Definition: NvInferRuntime.h:110
nvcaffeparser1::shutdownProtobufLibrary
void shutdownProtobufLibrary()
Shuts down protocol buffers library.
nvcaffeparser1::ICaffeParser::setPluginNamespace
virtual void setPluginNamespace(const char *libNamespace)=0
Set the namespace used to lookup and create plugins in the network.
nvinfer1::IPluginV2
Plugin class for user-implemented layers.
Definition: NvInferRuntimeCommon.h:402
nvcaffeparser1::ICaffeParser::setPluginFactory
virtual void setPluginFactory(IPluginFactory *factory)=0
Set the IPluginFactory used to create the user defined plugins.
nvcaffeparser1::IPluginFactoryV2::createPlugin
virtual nvinfer1::IPluginV2 * createPlugin(const char *layerName, const nvinfer1::Weights *weights, int32_t nbWeights, const char *libNamespace="")=0
Creates a plugin.
nvcaffeparser1::IPluginFactoryExt::isPluginExt
virtual bool isPluginExt(const char *layerName)=0
A user implemented function that determines if a layer configuration is provided by an IPluginExt.
nvcaffeparser1::ICaffeParser::setPluginFactoryV2
virtual void setPluginFactoryV2(IPluginFactoryV2 *factory)=0
Set the IPluginFactoryV2 used to create the user defined pluginV2 objects.
TRTNOEXCEPT
#define TRTNOEXCEPT
Definition: NvInferRuntimeCommon.h:103
nvcaffeparser1::ICaffeParser::parseBinaryProto
virtual IBinaryProtoBlob * parseBinaryProto(const char *fileName)=0
Parse and extract data stored in binaryproto file.
nvcaffeparser1::IBlobNameToTensor::find
virtual nvinfer1::ITensor * find(const char *name) const =0
Given a blob name, returns a pointer to a ITensor object.
nvcaffeparser1::IPluginFactory::createPlugin
virtual nvinfer1::IPlugin * createPlugin(const char *layerName, const nvinfer1::Weights *weights, int32_t nbWeights)=0
Creates a plugin.
nvcaffeparser1
The TensorRT Caffe parser API namespace.
nvcaffeparser1::IPluginFactory
Plugin factory used to configure plugins.
Definition: NvCaffeParser.h:121
nvcaffeparser1::createCaffeParser
ICaffeParser * createCaffeParser()
Creates a ICaffeParser object.
nvcaffeparser1::IPluginFactoryV2
Plugin factory used to configure plugins.
Definition: NvCaffeParser.h:170
nvinfer1::DataType
DataType
The type of weights and tensors.
Definition: NvInferRuntimeCommon.h:169
nvinfer1::DimsNCHW
Descriptor for data with one index dimension, one channel dimension and two spatial dimensions.
Definition: NvInfer.h:346
nvinfer1::ITensor
A tensor in a network definition.
Definition: NvInfer.h:522
nvinfer1::IErrorRecorder
Reference counted application-implemented error reporting interface for TensorRT objects.
Definition: NvInferRuntimeCommon.h:1235
nvcaffeparser1::IPluginFactoryV2::isPluginV2
virtual bool isPluginV2(const char *layerName)=0
A user implemented function that determines if a layer configuration is provided by an IPluginV2.
nvcaffeparser1::ICaffeParser::parse
virtual const IBlobNameToTensor * parse(const char *deploy, const char *model, nvinfer1::INetworkDefinition &network, nvinfer1::DataType weightType)=0
Parse a prototxt file and a binaryproto Caffe model to extract network definition and weights associa...
nvcaffeparser1::IPluginFactory::isPlugin
virtual bool isPlugin(const char *layerName)=0
A user implemented function that determines if a layer configuration is provided by an IPlugin.
nvcaffeparser1::ICaffeParser::getErrorRecorder
virtual nvinfer1::IErrorRecorder * getErrorRecorder() const =0
get the ErrorRecorder assigned to this interface.
nvcaffeparser1::ICaffeParser::setErrorRecorder
virtual void setErrorRecorder(nvinfer1::IErrorRecorder *recorder)=0
Set the ErrorRecorder for this interface.
nvcaffeparser1::IPluginFactoryExt
Plugin factory used to configure plugins with added support for TRT versioning.
Definition: NvCaffeParser.h:149
nvcaffeparser1::IBlobNameToTensor
Object used to store and query Tensors after they have been extracted from a Caffe model using the IC...
Definition: NvCaffeParser.h:80
NvInfer.h
nvcaffeparser1::ICaffeParser::setPluginFactoryExt
virtual void setPluginFactoryExt(IPluginFactoryExt *factory)=0
Set the IPluginFactoryExt used to create the user defined pluginExts.
nvinfer1::IPlugin
Plugin class for user-implemented layers.
Definition: NvInferRuntime.h:146
nvcaffeparser1::IBinaryProtoBlob
Object used to store and query data extracted from a binaryproto file using the ICaffeParser.
Definition: NvCaffeParser.h:104
nvcaffeparser1::ICaffeParser::setProtobufBufferSize
virtual void setProtobufBufferSize(size_t size)=0
Set buffer size for the parsing and storage of the learned model.