TensorRT  8.2.0
NvCaffeParser.h
Go to the documentation of this file.
1 /*
2  * Copyright 1993-2021 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 noexcept = 0;
90 
91 protected:
92  virtual ~IBlobNameToTensor() {}
93 };
94 
105 {
106 public:
107  virtual const void* getData() noexcept = 0;
108  virtual nvinfer1::Dims4 getDimensions() noexcept = 0;
109  virtual nvinfer1::DataType getDataType() noexcept = 0;
115  TRT_DEPRECATED virtual void destroy() noexcept = 0;
116  virtual ~IBinaryProtoBlob() noexcept = default;
117 };
118 
125 {
126 public:
132  virtual bool isPluginV2(const char* layerName) noexcept = 0;
133 
142  virtual nvinfer1::IPluginV2* createPlugin(const char* layerName, const nvinfer1::Weights* weights,
143  int32_t nbWeights, const char* libNamespace = "") noexcept
144  = 0;
145 
146  virtual ~IPluginFactoryV2() noexcept = default;
147 };
158 {
159 public:
173  virtual const IBlobNameToTensor* parse(const char* deploy, const char* model, nvinfer1::INetworkDefinition& network,
174  nvinfer1::DataType weightType) noexcept
175  = 0;
176 
192  virtual const IBlobNameToTensor* parseBuffers(const uint8_t* deployBuffer, std::size_t deployLength,
193  const uint8_t* modelBuffer, std::size_t modelLength, nvinfer1::INetworkDefinition& network,
194  nvinfer1::DataType weightType) noexcept
195  = 0;
196 
209  virtual IBinaryProtoBlob* parseBinaryProto(const char* fileName) noexcept = 0;
210 
218  virtual void setProtobufBufferSize(size_t size) noexcept = 0;
219 
227  TRT_DEPRECATED virtual void destroy() noexcept = 0;
228 
234  virtual void setPluginFactoryV2(IPluginFactoryV2* factory) noexcept = 0;
235 
239  virtual void setPluginNamespace(const char* libNamespace) noexcept = 0;
240 
241  virtual ~ICaffeParser() noexcept = default;
242 
243 public:
258  virtual void setErrorRecorder(nvinfer1::IErrorRecorder* recorder) noexcept = 0;
259 
270  virtual nvinfer1::IErrorRecorder* getErrorRecorder() const noexcept = 0;
271 };
272 
283 TENSORRTAPI ICaffeParser* createCaffeParser() noexcept;
284 
290 TENSORRTAPI void shutdownProtobufLibrary() noexcept;
291 } // namespace nvcaffeparser1
292 
297 extern "C" TENSORRTAPI void* createNvCaffeParser_INTERNAL() noexcept;
298 #endif
nvcaffeparser1::ICaffeParser
Class used for parsing Caffe models.
Definition: NvCaffeParser.h:157
nvcaffeparser1::IBinaryProtoBlob::destroy
virtual TRT_DEPRECATED void destroy() noexcept=0
nvcaffeparser1::ICaffeParser::setPluginFactoryV2
virtual void setPluginFactoryV2(IPluginFactoryV2 *factory) noexcept=0
Set the IPluginFactoryV2 used to create the user defined pluginV2 objects.
nvinfer1::INetworkDefinition
A network definition for input to the builder.
Definition: NvInfer.h:6009
nvinfer1::Weights
An array of weights used as a layer parameter.
Definition: NvInferRuntime.h:155
nvcaffeparser1::IBlobNameToTensor::find
virtual nvinfer1::ITensor * find(const char *name) const noexcept=0
Given a blob name, returns a pointer to a ITensor object.
nvcaffeparser1::ICaffeParser::setPluginNamespace
virtual void setPluginNamespace(const char *libNamespace) noexcept=0
Set the namespace used to lookup and create plugins in the network.
nvcaffeparser1::shutdownProtobufLibrary
void shutdownProtobufLibrary() noexcept
Shuts down protocol buffers library.
nvcaffeparser1::createCaffeParser
ICaffeParser * createCaffeParser() noexcept
Creates a ICaffeParser object.
nvcaffeparser1::ICaffeParser::setProtobufBufferSize
virtual void setProtobufBufferSize(size_t size) noexcept=0
Set buffer size for the parsing and storage of the learned model.
nvinfer1::IPluginV2
Plugin class for user-implemented layers.
Definition: NvInferRuntimeCommon.h:409
nvcaffeparser1::ICaffeParser::parseBuffers
virtual const IBlobNameToTensor * parseBuffers(const uint8_t *deployBuffer, std::size_t deployLength, const uint8_t *modelBuffer, std::size_t modelLength, nvinfer1::INetworkDefinition &network, nvinfer1::DataType weightType) noexcept=0
Parse a deploy prototxt and a binaryproto Caffe model from memory buffers to extract network definiti...
nvcaffeparser1::ICaffeParser::setErrorRecorder
virtual void setErrorRecorder(nvinfer1::IErrorRecorder *recorder) noexcept=0
Set the ErrorRecorder for this interface.
nvcaffeparser1::ICaffeParser::getErrorRecorder
virtual nvinfer1::IErrorRecorder * getErrorRecorder() const noexcept=0
get the ErrorRecorder assigned to this interface.
nvcaffeparser1::ICaffeParser::parseBinaryProto
virtual IBinaryProtoBlob * parseBinaryProto(const char *fileName) noexcept=0
Parse and extract data stored in binaryproto file.
nvcaffeparser1::IPluginFactoryV2::isPluginV2
virtual bool isPluginV2(const char *layerName) noexcept=0
A user implemented function that determines if a layer configuration is provided by an IPluginV2.
nvcaffeparser1
The TensorRT Caffe parser API namespace.
nvcaffeparser1::IPluginFactoryV2
Plugin factory used to configure plugins.
Definition: NvCaffeParser.h:124
nvinfer1::DataType
DataType
The type of weights and tensors.
Definition: NvInferRuntimeCommon.h:150
nvinfer1::ITensor
A tensor in a network definition.
Definition: NvInfer.h:193
nvcaffeparser1::ICaffeParser::destroy
virtual TRT_DEPRECATED void destroy() noexcept=0
Destroy this ICaffeParser object.
nvcaffeparser1::ICaffeParser::parse
virtual const IBlobNameToTensor * parse(const char *deploy, const char *model, nvinfer1::INetworkDefinition &network, nvinfer1::DataType weightType) noexcept=0
Parse a prototxt file and a binaryproto Caffe model to extract network definition and weights associa...
nvinfer1::IErrorRecorder
Reference counted application-implemented error reporting interface for TensorRT objects.
Definition: NvInferRuntimeCommon.h:1439
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::IPluginFactoryV2::createPlugin
virtual nvinfer1::IPluginV2 * createPlugin(const char *layerName, const nvinfer1::Weights *weights, int32_t nbWeights, const char *libNamespace="") noexcept=0
Creates a plugin.
nvinfer1::Dims4
Descriptor for four-dimensional data.
Definition: NvInferLegacyDims.h:195
nvcaffeparser1::IBinaryProtoBlob
Object used to store and query data extracted from a binaryproto file using the ICaffeParser.
Definition: NvCaffeParser.h:104
TRT_DEPRECATED
#define TRT_DEPRECATED
< Items that are marked as deprecated will be removed in a future release.
Definition: NvInferRuntimeCommon.h:77