nvinfer1::ILayer Class Reference

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 (char const *name) noexcept
	Set the name of a layer. More...
char const *	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...
DataType	getOutputType (int32_t index) const noexcept
	get the output type of this layer More...
void	setMetadata (char const *metadata) noexcept
	Set the metadata for this layer. More...
char const *	getMetadata () const noexcept
	Get the metadata of the layer. More...
bool	setNbRanks (int32_t nbRanks) noexcept
	Set the number of ranks for multi-device execution. More...
int32_t	getNbRanks () const noexcept
	Get the number of ranks for multi-device execution. More...

Protected Member Functions
virtual	~ILayer () noexcept=0
Protected Member Functions inherited from nvinfer1::INoCopy
	INoCopy ()=default
virtual	~INoCopy ()=default
	INoCopy (INoCopy const &other)=delete
INoCopy &	operator= (INoCopy const &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()

nvinfer1::ILayer::~ILayer ( )

inlineprotectedpure virtualdefaultnoexcept

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

getMetadata()

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

inlinenoexcept

Get the metadata of the layer.

Returns

The metadata as a null-terminated C-style string. If setMetadata() has not been called, an empty string "" will be returned as a default value.

See also

setMetadata()

getName()

char const * 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.

getNbRanks()

int32_t nvinfer1::ILayer::getNbRanks ( ) const

inlinenoexcept

Get the number of ranks for multi-device execution.

Returns

The number of ranks configured for multi-device execution. Default is 1.

See also

setNbRanks()

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.

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 inferred output type.

See also

getOutputType() outputTypeIsSet() resetOutputType()

getType()

LayerType nvinfer1::ILayer::getType ( ) const

inlinenoexcept

Return the type of a layer.

See also

LayerType

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, INMSLayer, 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.

setMetadata()

void nvinfer1::ILayer::setMetadata ( char const *  metadata )

inlinenoexcept

Set the metadata for this layer.

The metadata is emitted in the JSON returned by IEngineInspector with ProfilingVerbosity set to kDETAILED.

Parameters

metadata

The per-layer metadata.

Warning

The string name must be null-terminated and be at most 4096 bytes including the terminator.

See also

getMetadata()

getLayerInformation()

setName()

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

inlinenoexcept

Set the name of a layer.

This method copies the name string.

Warning

The string name must be null-terminated, and be at most 4096 bytes including the terminator.

See also

getName()

setNbRanks()

bool nvinfer1::ILayer::setNbRanks ( int32_t  nbRanks )

inlinenoexcept

Set the number of ranks for multi-device execution.

Setting nbRanks > 1 is only allowed for specific layer types that support multi-device execution:

• IDistCollectiveLayer: Determines output shape for kALL_GATHER and kREDUCE_SCATTER operations.

For attention layers, use IAttention::setNbRanks() instead. For all other layer types, nbRanks must be 1.

Parameters

nbRanks

The number of ranks for multi-device execution. Must be >= 1.

Returns

true if successful, false if the layer type does not support the specified nbRanks value.

See also

getNbRanks()

IAttention::setNbRanks()

Member Data Documentation

mLayer

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

protected

---

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

• NvInfer.h