org.bytedeco.tensorrt.nvinfer

Class ILayer

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tensorrt.nvinfer.INoCopy

org.bytedeco.tensorrt.nvinfer.ILayer

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

IActivationLayer, IAssertionLayer, ICastLayer, IConcatenationLayer, IConstantLayer, IConvolutionLayer, IDeconvolutionLayer, IDequantizeLayer, IEinsumLayer, IElementWiseLayer, IFillLayer, IGatherLayer, IGridSampleLayer, IIdentityLayer, IIfConditionalBoundaryLayer, ILoopBoundaryLayer, ILRNLayer, IMatrixMultiplyLayer, INMSLayer, INonZeroLayer, INormalizationLayer, IOneHotLayer, IPaddingLayer, IParametricReLULayer, IPluginV2Layer, IPluginV3Layer, IPoolingLayer, IQuantizeLayer, IRaggedSoftMaxLayer, IReduceLayer, IResizeLayer, IReverseSequenceLayer, IScaleLayer, IScatterLayer, ISelectLayer, IShapeLayer, IShuffleLayer, ISliceLayer, ISoftMaxLayer, ITopKLayer, IUnaryLayer

@Namespace(value="nvinfer1")
 @NoOffset
 @Properties(inherit=nvinfer.class)
public class ILayer
extends INoCopy

\class ILayer \brief 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.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
ILayer(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
ITensor	getInput(int index) \brief Get the layer input corresponding to the given index.
String	getMetadata() \brief Get the metadata of the layer.
String	getName() \brief Return the name of a layer.
int	getNbInputs() \brief Get the number of inputs of a layer.
int	getNbOutputs() \brief Get the number of outputs of a layer.
ITensor	getOutput(int index) \brief Get the layer output corresponding to the given index.
nvinfer.DataType	getOutputType(int index) \brief get the output type of this layer
nvinfer.DataType	getPrecision() \brief get the computational precision of this layer
nvinfer.LayerType	getType() \brief Return the type of a layer.
boolean	outputTypeIsSet(int index) \brief whether the output type has been set for this layer
boolean	precisionIsSet() \brief whether the computational precision has been set for this layer
void	resetOutputType(int index) \brief reset the output type for this layer
void	resetPrecision() \brief reset the computational precision for this layer
void	setInput(int index, ITensor tensor) \brief Replace an input of this layer with a specific tensor.
void	setMetadata(BytePointer metadata)
void	setMetadata(String metadata) \brief Set the metadata for this layer.
void	setName(BytePointer name)
void	setName(String name) \brief Set the name of a layer.
void	setOutputType(int index, int dataType)
void	setOutputType(int index, nvinfer.DataType dataType) \brief Set the output type of this layer in a weakly-typed network.
void	setPrecision(int dataType)
void	setPrecision(nvinfer.DataType dataType) \brief Set the preferred or required computational precision of this layer in a weakly-typed network.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ILayer

public ILayer(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

getType

@NoException(value=true)
public nvinfer.LayerType getType()

\brief Return the type of a layer.

See Also:

nvinfer.LayerType

setName

@NoException(value=true)
public void setName(String name)

\brief 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()

setName

@NoException(value=true)
public void setName(@Cast(value="const char*")
                                              BytePointer name)

getName

@NoException(value=true)
public String getName()

\brief Return the name of a layer.

See Also:

setName()

getNbInputs

@NoException(value=true)
public int getNbInputs()

\brief Get the number of inputs of a layer.

getInput

@NoException(value=true)
public ITensor getInput(int index)

\brief 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 (\ref ISliceLayer).

getNbOutputs

@NoException(value=true)
public int getNbOutputs()

\brief Get the number of outputs of a layer.

getOutput

@NoException(value=true)
public ITensor getOutput(int index)

\brief 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.

setInput

@NoException(value=true)
public void setInput(int index,
                                               @ByRef
                                               ITensor tensor)

\brief 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.

setPrecision

@NoException(value=true)
public void setPrecision(nvinfer.DataType dataType)

\brief Set the preferred or required computational precision of this layer in a weakly-typed network. Setting the precision directs TensorRT to choose an implementation that runs 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/uint8, the precision must be one of those types, otherwise it must be either the input or output type. Strongly-typed networks reject calls to method setPrecision. In strongly-typed networks, the computation precision is typically controlled by casting the input tensors to the desired type.

Parameters:

dataType - the computational precision.

See Also:

precisionIsSet() resetPrecision()

setPrecision

@NoException(value=true)
public void setPrecision(@Cast(value="nvinfer1::DataType")
                                                   int dataType)

getPrecision

@NoException(value=true)
public nvinfer.DataType getPrecision()

\brief get the computational precision of this layer

Returns:

the computational precision

See Also:

precisionIsSet() resetPrecision()

precisionIsSet

@Cast(value="bool")
 @NoException(value=true)
public boolean precisionIsSet()

\brief whether the computational precision has been set for this layer

Returns:

whether the computational precision has been explicitly set

See Also:

getPrecision() resetPrecision()

resetPrecision

@NoException(value=true)
public void resetPrecision()

\brief reset the computational precision for this layer

See Also:

getPrecision() precisionIsSet()

setOutputType

@NoException(value=true)
public void setOutputType(int index,
                                                    nvinfer.DataType dataType)

\brief Set the output type of this layer in a weakly-typed network. 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. Strongly-typed networks reject calls to method setOutputType. Instead, the output type can be set only for layers that define method setToType(). Those layers are: * ICastLayer * IDequantizeLayer * IFillLayer * IQuantizeLayer

Parameters:

index - the index of the output to set

dataType - the type of the output

See Also:

outputTypeIsSet() resetOutputType()

setOutputType

@NoException(value=true)
public void setOutputType(int index,
                                                    @Cast(value="nvinfer1::DataType")
                                                    int dataType)

getOutputType

@NoException(value=true)
public nvinfer.DataType getOutputType(int index)

\brief 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:

outputTypeIsSet() resetOutputType()

outputTypeIsSet

@Cast(value="bool")
 @NoException(value=true)
public boolean outputTypeIsSet(int index)

\brief 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:

getOutputType() resetOutputType()

resetOutputType

@NoException(value=true)
public void resetOutputType(int index)

\brief reset the output type for this layer

Parameters:

index - the index of the output

See Also:

getOutputType() outputTypeIsSet()

setMetadata

@NoException(value=true)
public void setMetadata(String metadata)

\brief 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()

setMetadata

@NoException(value=true)
public void setMetadata(@Cast(value="const char*")
                                                  BytePointer metadata)

getMetadata

@NoException(value=true)
public String getMetadata()

\brief 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()