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

#include <NvInfer.h>

Inheritance diagram for nvinfer1::ILayer:

Public Member Functions
LayerType	getType () const noexcept
	Return the type of a layer. More...

void	setName (const char *name) noexcept
	Set the name of a layer. More...

const char *	getName () const noexcept
	Return the name of a layer. More...

int32_t	getNbInputs () const noexcept
	Get the number of inputs of a layer. More...

ITensor *	getInput (int32_t index) const noexcept
	Get the layer input corresponding to the given index. More...

int32_t	getNbOutputs () const noexcept
	Get the number of outputs of a layer. More...

ITensor *	getOutput (int32_t index) const noexcept
	Get the layer output corresponding to the given index. More...

void	setInput (int32_t index, ITensor &tensor) noexcept
	Replace an input of this layer with a specific tensor. More...

void	setPrecision (DataType dataType) noexcept
	Set the computational precision of this layer. More...

DataType	getPrecision () const noexcept
	get the computational precision of this layer More...

bool	precisionIsSet () const noexcept
	whether the computational precision has been set for this layer More...

void	resetPrecision () noexcept
	reset the computational precision for this layer More...

void	setOutputType (int32_t index, DataType dataType) noexcept
	Set the output type of this layer. More...

DataType	getOutputType (int32_t index) const noexcept
	get the output type of this layer More...

bool	outputTypeIsSet (int32_t index) const noexcept
	whether the output type has been set for this layer More...

void	resetOutputType (int32_t index) noexcept
	reset the output type for this layer More...

Protected Member Functions
virtual	~ILayer () noexcept=default

Protected Member Functions inherited from nvinfer1::INoCopy
	INoCopy ()=default

virtual	~INoCopy ()=default

	INoCopy (const INoCopy &other)=delete

INoCopy &	operator= (const INoCopy &other)=delete

	INoCopy (INoCopy &&other)=delete

INoCopy &	operator= (INoCopy &&other)=delete

Protected Attributes
apiv::VLayer *	mLayer

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.

Constructor & Destructor Documentation

◆ ~ILayer()

virtual nvinfer1::ILayer::~ILayer ( )

protectedvirtualdefaultnoexcept

Member Function Documentation

◆ getInput()

ITensor * nvinfer1::ILayer::getInput ( int32_t index ) const

inlinenoexcept

Get the layer input corresponding to the given index.

Parameters

index The index of the input tensor.

Returns: The input tensor, or nullptr if the index is out of range or the tensor is optional (ISliceLayer and IRNNv2Layer).

◆ getName()

const char * nvinfer1::ILayer::getName ( ) const

inlinenoexcept

Return the name of a layer.

See also: setName()

◆ getNbInputs()

int32_t nvinfer1::ILayer::getNbInputs ( ) const

inlinenoexcept

Get the number of inputs of a layer.

◆ getNbOutputs()

int32_t nvinfer1::ILayer::getNbOutputs ( ) const

inlinenoexcept

Get the number of outputs of a layer.

◆ getOutput()

ITensor * nvinfer1::ILayer::getOutput ( int32_t index ) const

inlinenoexcept

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 (IRNNv2Layer).

◆ getOutputType()

DataType nvinfer1::ILayer::getOutputType ( int32_t index ) const

inlinenoexcept

get the output type of this layer

Parameters

index the 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()

◆ getPrecision()

DataType nvinfer1::ILayer::getPrecision ( ) const

inlinenoexcept

get the computational precision of this layer

Returns: the computational precision

See also: setPrecision() precisionIsSet() resetPrecision()

◆ getType()

LayerType nvinfer1::ILayer::getType ( ) const

inlinenoexcept

Return the type of a layer.

See also: LayerType

◆ outputTypeIsSet()

bool nvinfer1::ILayer::outputTypeIsSet ( int32_t index ) const

inlinenoexcept

whether the output type has been set for this layer

Parameters

index the index of the output

Returns: whether the output type has been explicitly set

See also: setOutputType() getOutputType() resetOutputType()

◆ precisionIsSet()

bool nvinfer1::ILayer::precisionIsSet ( ) const

inlinenoexcept

whether the computational precision has been set for this layer

Returns: whether the computational precision has been explicitly set

See also: setPrecision() getPrecision() resetPrecision()

◆ resetOutputType()

void nvinfer1::ILayer::resetOutputType ( int32_t index )

inlinenoexcept

reset the output type for this layer

Parameters

index the index of the output

See also: setOutputType() getOutputType() outputTypeIsSet()

◆ resetPrecision()

void nvinfer1::ILayer::resetPrecision ( )

inlinenoexcept

reset the computational precision for this layer

See also: setPrecision() getPrecision() precisionIsSet()

◆ setInput()

void nvinfer1::ILayer::setInput	(	int32_t	index,
		ITensor &	tensor
	)

inlinenoexcept

Replace an input of this layer with a specific tensor.

Parameters

index	the index of the input to modify.
tensor	the new input tensor

Except for IFillLayer, ILoopOutputLayer, IResizeLayer, IShuffleLayer, and ISliceLayer, this method cannot change the number of inputs to a layer. The index argument must be less than the value of getNbInputs().

See comments for overloads of setInput() for layers with special behavior.

◆ setName()

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

inlinenoexcept

Set the name of a layer.

This method copies the name string.

See also: getName()

◆ setOutputType()

void nvinfer1::ILayer::setOutputType	(	int32_t	index,
		DataType	dataType
	)

inlinenoexcept

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. To force choosing the requested output type, set exactly one of the following flags, which differ in what happens if no such implementation exists:

BuilderFlag::kOBEY_PRECISION_CONSTRAINTS - build fails with an error message.
BuilderFlag::kPREFER_PRECISION_CONSTRAINTS - TensorRT falls back to an implementation with a non-conforming output type.

In case layer precision is not specified, or falling back, the output type depends on the 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

index	the index of the output to set
dataType	the type of the output

See also: getOutputType() outputTypeIsSet() resetOutputType()

◆ setPrecision()

void nvinfer1::ILayer::setPrecision ( DataType dataType )

inlinenoexcept

Set the computational precision of this layer.

Setting the precision allows TensorRT to choose an implementation which run at this computational precision. TensorRT could still choose a non-conforming fastest implementation that ignores the requested precision. To force choosing an implementation with the requested precision, set exactly one of the following flags, which differ in what happens if no such implementation exists:

BuilderFlag::kOBEY_PRECISION_CONSTRAINTS - build fails with an error message.
BuilderFlag::kPREFER_PRECISION_CONSTRAINTS - TensorRT falls back to an implementation without the requested precision.

If precision is not set, or falling back, TensorRT will select the layer computational precision and layer input type based on global performance considerations and the flags specified to the builder.

For a IIdentityLayer: If it casts to/from float/half/int8, the precision must be one of those types, otherwise it must be either the input or output type.

Parameters

dataType the computational precision.

See also: getPrecision() precisionIsSet() resetPrecision()

Member Data Documentation

◆ mLayer

apiv::VLayer* nvinfer1::ILayer::mLayer

protected

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

NvInfer.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~ILayer()

Member Function Documentation

◆ getInput()

◆ getName()

◆ getNbInputs()

◆ getNbOutputs()

◆ getOutput()

◆ getOutputType()

◆ getPrecision()

◆ getType()

◆ outputTypeIsSet()

◆ precisionIsSet()

◆ resetOutputType()

◆ resetPrecision()

◆ setInput()

◆ setName()

◆ setOutputType()

◆ setPrecision()

Member Data Documentation

◆ mLayer