TensorRT  7.0.0.11
nvinfer1::ILayer Class Referenceabstract

Base class for all layer classes in a network definition. More...

#include <NvInfer.h>

Inheritance diagram for nvinfer1::ILayer:
nvinfer1::IActivationLayer nvinfer1::IConcatenationLayer nvinfer1::IConstantLayer nvinfer1::IConvolutionLayer nvinfer1::IDeconvolutionLayer nvinfer1::IElementWiseLayer nvinfer1::IFillLayer nvinfer1::IFullyConnectedLayer nvinfer1::IGatherLayer nvinfer1::IIdentityLayer nvinfer1::ILoopBoundaryLayer nvinfer1::ILRNLayer nvinfer1::IMatrixMultiplyLayer nvinfer1::IPaddingLayer nvinfer1::IParametricReLULayer nvinfer1::IPluginLayer nvinfer1::IPluginV2Layer nvinfer1::IPoolingLayer nvinfer1::IRaggedSoftMaxLayer nvinfer1::IReduceLayer nvinfer1::IResizeLayer nvinfer1::IRNNLayer nvinfer1::IRNNv2Layer nvinfer1::IScaleLayer nvinfer1::ISelectLayer nvinfer1::IShapeLayer nvinfer1::IShuffleLayer nvinfer1::ISliceLayer nvinfer1::ISoftMaxLayer nvinfer1::ITopKLayer nvinfer1::IUnaryLayer

Public Member Functions

virtual LayerType getType () const =0
 Return the type of a layer. More...
 
virtual void setName (const char *name)=0
 Set the name of a layer. More...
 
virtual const char * getName () const =0
 Return the name of a layer. More...
 
virtual int getNbInputs () const =0
 Get the number of inputs of a layer.
 
virtual ITensorgetInput (int index) const =0
 Get the layer input corresponding to the given index. More...
 
virtual int getNbOutputs () const =0
 Get the number of outputs of a layer.
 
virtual ITensorgetOutput (int index) const =0
 Get the layer output corresponding to the given index. More...
 
virtual void setInput (int index, ITensor &tensor)=0
 Replace an input of this layer with a specific tensor. More...
 
virtual void setPrecision (DataType dataType)=0
 Set the computational precision of this layer. More...
 
virtual DataType getPrecision () const =0
 get the computational precision of this layer More...
 
virtual bool precisionIsSet () const =0
 whether the computational precision has been set for this layer More...
 
virtual void resetPrecision ()=0
 reset the computational precision for this layer More...
 
virtual void setOutputType (int index, DataType dataType)=0
 Set the output type of this layer. More...
 
virtual DataType getOutputType (int index) const =0
 get the output type of this layer More...
 
virtual bool outputTypeIsSet (int index) const =0
 whether the output type has been set for this layer More...
 
virtual void resetOutputType (int index)=0
 reset the output type for this layer More...
 

Detailed Description

Base class for all layer classes in a network definition.

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

Member Function Documentation

virtual ITensor* nvinfer1::ILayer::getInput ( int  index) const
pure virtual

Get the layer input corresponding to the given index.

Parameters
indexThe index of the input tensor.
Returns
The input tensor, or nullptr if the index is out of range or the tensor is optional (ISliceLayer, IRNNLayer and IRNNv2Layer).
virtual const char* nvinfer1::ILayer::getName ( ) const
pure virtual

Return the name of a layer.

See also
setName()
virtual ITensor* nvinfer1::ILayer::getOutput ( int  index) const
pure virtual

Get the layer output corresponding to the given index.

Returns
The indexed output tensor, or nullptr if the index is out of range or the tensor is optional (IRNNLayer and IRNNv2Layer).
virtual DataType nvinfer1::ILayer::getOutputType ( int  index) const
pure virtual

get the output type of this layer

Parameters
indexthe index of the output
Returns
the output precision. If no precision has been set, DataType::kFLOAT will be returned, unless the output type is inherently DataType::kINT32.
See also
getOutputType() outputTypeIsSet() resetOutputType()
virtual DataType nvinfer1::ILayer::getPrecision ( ) const
pure virtual

get the computational precision of this layer

Returns
the computational precision
See also
setPrecision() precisionIsSet() resetPrecision()
virtual LayerType nvinfer1::ILayer::getType ( ) const
pure virtual

Return the type of a layer.

See also
LayerType
virtual bool nvinfer1::ILayer::outputTypeIsSet ( int  index) const
pure virtual

whether the output type has been set for this layer

Parameters
indexthe index of the output
Returns
whether the output type has been explicitly set
See also
setOutputType() getOutputType() resetOutputType()
virtual bool nvinfer1::ILayer::precisionIsSet ( ) const
pure virtual

whether the computational precision has been set for this layer

Returns
whether the computational precision has been explicitly set
See also
setPrecision() getPrecision() resetPrecision()
virtual void nvinfer1::ILayer::resetOutputType ( int  index)
pure virtual

reset the output type for this layer

Parameters
indexthe index of the output
See also
setOutputType() getOutputType() outputTypeIsSet()
virtual void nvinfer1::ILayer::resetPrecision ( )
pure virtual

reset the computational precision for this layer

See also
setPrecision() getPrecision() precisionIsSet()
virtual void nvinfer1::ILayer::setInput ( int  index,
ITensor tensor 
)
pure virtual

Replace an input of this layer with a specific tensor.

Parameters
indexthe index of the input to modify.
tensorthe new input tensor Except for IShuffleLayer, ISliceLayer, IResizeLayer and ILoopOutputLayer, this method cannot change the number of inputs to a layer. The index argument must be less than the value of getNbInputs().

See overloaded setInput() comments for the layers special behavior.

Parameters
indexthe index of the input to modify.
tensorthe new input tensor

Implemented in nvinfer1::IFillLayer, nvinfer1::ILoopOutputLayer, nvinfer1::IRecurrenceLayer, nvinfer1::IResizeLayer, nvinfer1::ISliceLayer, nvinfer1::IShuffleLayer, nvinfer1::IDeconvolutionLayer, nvinfer1::IFullyConnectedLayer, and nvinfer1::IConvolutionLayer.

virtual void nvinfer1::ILayer::setName ( const char *  name)
pure virtual

Set the name of a layer.

This method copies the name string.

See also
getName()
virtual void nvinfer1::ILayer::setOutputType ( int  index,
DataType  dataType 
)
pure virtual

Set the output type of this layer.

Setting the output type constrains TensorRT to choose implementations which generate output data with the given type. If it is not set, TensorRT will select output type based on layer computational precision. TensorRT could still choose non-conforming output type based on fastest implementation. Use BuilderFlag::kSTRICT_TYPES to force choose requested output type. In case layer precision is not specified, output type would depend on chosen implementation based on performance considerations and the flags specified to the builder.

This method cannot be used to set the data type of the second output tensor of the TopK layer. The data type of the second output tensor of the topK layer is always Int32. Also the output type of all layers that are shape operations must be DataType::kINT32, and all attempts to set the output type to some other data type will be ignored except for issuing an error message.

Note that the layer output type is generally not identical to the data type of the output tensor, as TensorRT may insert implicit reformatting operations to convert the former to the latter. Calling layer->setOutputType(i, type) has no effect on the data type of the i-th output tensor of layer, and users need to call layer->getOutput(i)->setType(type) to change the tensor data type. This is particularly relevant if the tensor is marked as a network output, since only setType() [but not setOutputType()] will affect the data representation in the corresponding output binding.

Parameters
indexthe index of the output to set
dataTypethe type of the output
See also
getOutputType() outputTypeIsSet() resetOutputType()
virtual void nvinfer1::ILayer::setPrecision ( DataType  dataType)
pure virtual

Set the computational precision of this layer.

Setting the precision allows TensorRT to choose implementation which run at this computational precision. Layer input type would also get inferred from layer computational precision. TensorRT could still choose a non-conforming fastest implementation ignoring set layer precision. Use BuilderFlag::kSTRICT_TYPES to force choose implementations with requested precision. In case no implementation is found with requested precision, TensorRT would choose available fastest implementation. If precision is not set, TensorRT will select the layer computational precision and layer input type based on performance considerations and the flags specified to the builder.

Parameters
precisionthe computational precision.
See also
getPrecision() precisionIsSet() resetPrecision()

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