TensorRT 8.6.0
nvuffparser::IUffParser Class Referenceabstract

Class used for parsing models described using the UFF format. More...

#include <NvUffParser.h>

Public Member Functions

virtual bool registerInput (char const *inputName, nvinfer1::Dims inputDims, UffInputOrder inputOrder) noexcept=0
 Register an input name of a UFF network with the associated Dimensions. More...
 
virtual bool registerOutput (char const *outputName) noexcept=0
 Register an output name of a UFF network. More...
 
virtual bool parse (char const *file, nvinfer1::INetworkDefinition &network, nvinfer1::DataType weightsType=nvinfer1::DataType::kFLOAT) noexcept=0
 Parse a UFF file. More...
 
virtual bool parseBuffer (char const *buffer, std::size_t size, nvinfer1::INetworkDefinition &network, nvinfer1::DataType weightsType=nvinfer1::DataType::kFLOAT) noexcept=0
 Parse a UFF buffer, useful if the file already live in memory. More...
 
virtual TRT_DEPRECATED void destroy () noexcept=0
 
virtual int32_t getUffRequiredVersionMajor () noexcept=0
 Return Version Major of the UFF. More...
 
virtual int32_t getUffRequiredVersionMinor () noexcept=0
 Return Version Minor of the UFF. More...
 
virtual int32_t getUffRequiredVersionPatch () noexcept=0
 Return Patch Version of the UFF. More...
 
virtual void setPluginNamespace (char const *libNamespace) noexcept=0
 Set the namespace used to lookup and create plugins in the network. More...
 
virtual ~IUffParser () noexcept=default
 
virtual void setErrorRecorder (nvinfer1::IErrorRecorder *recorder) noexcept=0
 Set the ErrorRecorder for this interface. More...
 
virtual nvinfer1::IErrorRecordergetErrorRecorder () const noexcept=0
 get the ErrorRecorder assigned to this interface. More...
 

Detailed Description

Class used for parsing models described using the UFF format.

Warning
Do not inherit from this class, as doing so will break forward-compatibility of the API and ABI.

Constructor & Destructor Documentation

◆ ~IUffParser()

virtual nvuffparser::IUffParser::~IUffParser ( )
virtualdefaultnoexcept

Member Function Documentation

◆ destroy()

virtual TRT_DEPRECATED void nvuffparser::IUffParser::destroy ( )
pure virtualnoexcept
Deprecated:
Use delete instead. Deprecated in TRT 8.0.

◆ getErrorRecorder()

virtual nvinfer1::IErrorRecorder * nvuffparser::IUffParser::getErrorRecorder ( ) const
pure virtualnoexcept

get the ErrorRecorder assigned to this interface.

Retrieves the assigned error recorder object for the given class. A nullptr will be returned if setErrorRecorder has not been called.

Returns
A pointer to the IErrorRecorder object that has been registered.
See also
setErrorRecorder()

◆ getUffRequiredVersionMajor()

virtual int32_t nvuffparser::IUffParser::getUffRequiredVersionMajor ( )
pure virtualnoexcept

Return Version Major of the UFF.

◆ getUffRequiredVersionMinor()

virtual int32_t nvuffparser::IUffParser::getUffRequiredVersionMinor ( )
pure virtualnoexcept

Return Version Minor of the UFF.

◆ getUffRequiredVersionPatch()

virtual int32_t nvuffparser::IUffParser::getUffRequiredVersionPatch ( )
pure virtualnoexcept

Return Patch Version of the UFF.

◆ parse()

virtual bool nvuffparser::IUffParser::parse ( char const *  file,
nvinfer1::INetworkDefinition network,
nvinfer1::DataType  weightsType = nvinfer1::DataType::kFLOAT 
)
pure virtualnoexcept

Parse a UFF file.

Parameters
fileFile name of the UFF file.
networkNetwork in which the UFFParser will fill the layers.
weightsTypeThe type on which the weights will transformed in.

◆ parseBuffer()

virtual bool nvuffparser::IUffParser::parseBuffer ( char const *  buffer,
std::size_t  size,
nvinfer1::INetworkDefinition network,
nvinfer1::DataType  weightsType = nvinfer1::DataType::kFLOAT 
)
pure virtualnoexcept

Parse a UFF buffer, useful if the file already live in memory.

Parameters
bufferBuffer of the UFF file.
sizeSize of buffer of the UFF file.
networkNetwork in which the UFFParser will fill the layers.
weightsTypeThe type on which the weights will transformed in.

◆ registerInput()

virtual bool nvuffparser::IUffParser::registerInput ( char const *  inputName,
nvinfer1::Dims  inputDims,
UffInputOrder  inputOrder 
)
pure virtualnoexcept

Register an input name of a UFF network with the associated Dimensions.

Parameters
inputNameInput name.
inputDimsInput dimensions.
inputOrderInput order on which the framework input was originally.

◆ registerOutput()

virtual bool nvuffparser::IUffParser::registerOutput ( char const *  outputName)
pure virtualnoexcept

Register an output name of a UFF network.

Parameters
outputNameOutput name.

◆ setErrorRecorder()

virtual void nvuffparser::IUffParser::setErrorRecorder ( nvinfer1::IErrorRecorder recorder)
pure virtualnoexcept

Set the ErrorRecorder for this interface.

Assigns the ErrorRecorder to this interface. The ErrorRecorder will track all errors during execution. This function will call incRefCount of the registered ErrorRecorder at least once. Setting recorder to nullptr unregisters the recorder with the interface, resulting in a call to decRefCount if a recorder has been registered.

If an error recorder is not set, messages will be sent to the global log stream.

Parameters
recorderThe error recorder to register with this interface.
See also
getErrorRecorder()

◆ setPluginNamespace()

virtual void nvuffparser::IUffParser::setPluginNamespace ( char const *  libNamespace)
pure virtualnoexcept

Set the namespace used to lookup and create plugins in the network.


The documentation for this class was generated from the following file: