org.bytedeco.tensorrt.nvinfer

Class IBuilder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.tensorrt.nvinfer.INoCopy

org.bytedeco.tensorrt.nvinfer.IBuilder

All Implemented Interfaces:

AutoCloseable

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

\class IBuilder \brief Builds an engine from 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
IBuilder() Default native constructor.
IBuilder(long size) Native array allocator.
IBuilder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
ICudaEngine	buildEngineWithConfig(INetworkDefinition network, IBuilderConfig config) Deprecated. Deprecated in TensorRT 8.0. Superseded by IBuilder::buildSerializedNetwork().
IHostMemory	buildSerializedNetwork(INetworkDefinition network, IBuilderConfig config) \brief Builds and serializes a network for the given INetworkDefinition and IBuilderConfig.
IBuilderConfig	createBuilderConfig() \brief Create a builder configuration object.
INetworkDefinition	createNetworkV2(int flags) \brief Create a network definition object Creates a network definition object with immutable properties specified using the flags parameter.
IOptimizationProfile	createOptimizationProfile() \brief Create a new optimization profile.
void	destroy() Deprecated. Deprecated in TensorRT 8.0. Superseded by delete. \warning Calling destroy on a managed pointer will result in a double-free error.
IErrorRecorder	getErrorRecorder() \brief get the ErrorRecorder assigned to this interface.
ILogger	getLogger() \brief get the logger with which the builder was created
int	getMaxBatchSize() Deprecated. Deprecated in TensorRT 8.4.
int	getMaxDLABatchSize() \brief Get the maximum batch size DLA can support.
int	getMaxThreads() \brief get the maximum number of threads that can be used by the builder.
int	getNbDLACores() \brief Return the number of DLA engines available to this builder.
IPluginRegistry	getPluginRegistry() \brief get the local plugin registry that can be used by the builder.
IBuilder	getPointer(long i)
boolean	isNetworkSupported(INetworkDefinition network, IBuilderConfig config) \brief Checks that a network is within the scope of the IBuilderConfig settings.
boolean	platformHasFastFp16() \brief Determine whether the platform has fast native fp16.
boolean	platformHasFastInt8() \brief Determine whether the platform has fast native int8.
boolean	platformHasTf32() \brief Determine whether the platform has TF32 support.
IBuilder	position(long position)
void	reset() \brief Resets the builder state to default values.
void	setErrorRecorder(IErrorRecorder recorder)
void	setGpuAllocator(IGpuAllocator allocator) \brief Set the GPU allocator.
void	setMaxBatchSize(int batchSize) Deprecated. Deprecated in TensorRT 8.4.
boolean	setMaxThreads(int maxThreads) \brief Set the maximum number of threads.

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, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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

IBuilder

public IBuilder()

Default native constructor.

IBuilder

public IBuilder(long size)

Native array allocator. Access with Pointer.position(long).

IBuilder

public IBuilder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public IBuilder position(long position)

Overrides:

position in class Pointer

getPointer

public IBuilder getPointer(long i)

Overrides:

getPointer in class Pointer

setMaxBatchSize

@Deprecated
 @NoException(value=true)
public void setMaxBatchSize(int batchSize)

Deprecated. Deprecated in TensorRT 8.4.

\brief Set the maximum batch size. This has no effect for networks created with explicit batch dimension mode.

Parameters:

batchSize - The maximum batch size which can be used at execution time, and also the batch size for which the engine will be optimized.

See Also:

getMaxBatchSize()

getMaxBatchSize

@Deprecated
 @NoException(value=true)
public int getMaxBatchSize()

Deprecated. Deprecated in TensorRT 8.4.

\brief Get the maximum batch size.

Returns:

The maximum batch size.

See Also:

setMaxBatchSize(), getMaxDLABatchSize()

platformHasFastFp16

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

\brief Determine whether the platform has fast native fp16.

platformHasFastInt8

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

\brief Determine whether the platform has fast native int8.

destroy

@Deprecated
 @NoException(value=true)
public void destroy()

Deprecated. Deprecated in TensorRT 8.0. Superseded by delete. \warning Calling destroy on a managed pointer will result in a double-free error.

\brief Destroy this object.

getMaxDLABatchSize

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

\brief Get the maximum batch size DLA can support. For any tensor the total volume of index dimensions combined(dimensions other than CHW) with the requested batch size should not exceed the value returned by this function. \warning getMaxDLABatchSize does not work with dynamic shapes.

getNbDLACores

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

\brief Return the number of DLA engines available to this builder.

setGpuAllocator

@NoException(value=true)
public void setGpuAllocator(IGpuAllocator allocator)

\brief Set the GPU allocator.

Parameters:

allocator - Set the GPU allocator to be used by the builder. All GPU memory acquired will use this allocator. If NULL is passed, the default allocator will be used. Default: uses cudaMalloc/cudaFree. \note This allocator will be passed to any engines created via the builder; thus the lifetime of the allocator must span the lifetime of those engines as well as that of the builder. If nullptr is passed, the default allocator will be used.

createBuilderConfig

@NoException(value=true)
public IBuilderConfig createBuilderConfig()

\brief Create a builder configuration object.

See Also:

IBuilderConfig

buildEngineWithConfig

@Deprecated
 @NoException(value=true)
public ICudaEngine buildEngineWithConfig(@ByRef
                                                                               INetworkDefinition network,
                                                                               @ByRef
                                                                               IBuilderConfig config)

Deprecated. Deprecated in TensorRT 8.0. Superseded by IBuilder::buildSerializedNetwork().

\brief Builds an engine for the given INetworkDefinition and given IBuilderConfig. It enables the builder to build multiple engines based on the same network definition, but with different builder configurations. \note This function will synchronize the cuda stream returned by \p config.getProfileStream() before returning.

createNetworkV2

@NoException(value=true)
public INetworkDefinition createNetworkV2(@Cast(value="nvinfer1::NetworkDefinitionCreationFlags")
                                                                   int flags)

\brief Create a network definition object Creates a network definition object with immutable properties specified using the flags parameter. CreateNetworkV2 supports dynamic shapes and explicit batch dimensions when used with NetworkDefinitionCreationFlag::kEXPLICIT_BATCH flag. Creating a network without NetworkDefinitionCreationFlag::kEXPLICIT_BATCH flag has been deprecated.

Parameters:

flags - Bitset of NetworkDefinitionCreationFlags specifying network properties combined with bitwise OR. e.g., 1U << NetworkDefinitionCreationFlag::kEXPLICIT_BATCH

See Also:

INetworkDefinition, NetworkDefinitionCreationFlags

createOptimizationProfile

@NoException(value=true)
public IOptimizationProfile createOptimizationProfile()

\brief Create a new optimization profile. If the network has any dynamic input tensors, the appropriate calls to setDimensions() must be made. Likewise, if there are any shape input tensors, the appropriate calls to setShapeValues() are required. The builder retains ownership of the created optimization profile and returns a raw pointer, i.e. the users must not attempt to delete the returned pointer.

See Also:

IOptimizationProfile

setErrorRecorder

@NoException(value=true)
public void setErrorRecorder(IErrorRecorder recorder)

See Also:

/**

getErrorRecorder

@NoException(value=true)
public IErrorRecorder getErrorRecorder()

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

reset

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

\brief Resets the builder state to default values.

platformHasTf32

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

\brief Determine whether the platform has TF32 support.

buildSerializedNetwork

@NoException(value=true)
public IHostMemory buildSerializedNetwork(@ByRef
                                                                   INetworkDefinition network,
                                                                   @ByRef
                                                                   IBuilderConfig config)

\brief Builds and serializes a network for the given INetworkDefinition and IBuilderConfig. This function allows building and serialization of a network without creating an engine.

Parameters:

network - Network definition.

config - Builder configuration.

Returns:

A pointer to a IHostMemory object that contains a serialized network. \note This function will synchronize the cuda stream returned by \p config.getProfileStream() before returning.

See Also:

INetworkDefinition, IBuilderConfig, IHostMemory

isNetworkSupported

@Cast(value="bool")
 @NoException(value=true)
public boolean isNetworkSupported(@Const @ByRef
                                                                                INetworkDefinition network,
                                                                                @Const @ByRef
                                                                                IBuilderConfig config)

\brief Checks that a network is within the scope of the IBuilderConfig settings.

Parameters:

network - The network definition to check for configuration compliance.

config - The configuration of the builder to use when checking \p network. Given an INetworkDefinition, \p network, and an IBuilderConfig, \p config, check if the network falls within the constraints of the builder configuration based on the EngineCapability, BuilderFlag, and DeviceType. If the network is within the constraints, then the function returns true, and false if a violation occurs. This function reports the conditions that are violated to the registered ErrorRecorder.

Returns:

True if network is within the scope of the restrictions specified by the builder config, false otherwise. \note This function will synchronize the cuda stream returned by \p config.getProfileStream() before returning. This function is only supported in NVIDIA Drive(R) products.

getLogger

@NoException(value=true)
public ILogger getLogger()

\brief get the logger with which the builder was created

Returns:

the logger

setMaxThreads

@Cast(value="bool")
 @NoException(value=true)
public boolean setMaxThreads(int maxThreads)

\brief Set the maximum number of threads.

Parameters:

maxThreads - The maximum number of threads that can be used by the builder.

Returns:

True if successful, false otherwise. The default value is 1 and includes the current thread. A value greater than 1 permits TensorRT to use multi-threaded algorithms. A value less than 1 triggers a kINVALID_ARGUMENT error.

getMaxThreads

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

\brief get the maximum number of threads that can be used by the builder. Retrieves the maximum number of threads that can be used by the builder.

Returns:

The maximum number of threads that can be used by the builder.

See Also:

setMaxThreads()

getPluginRegistry

@ByRef
 @NoException(value=true)
public IPluginRegistry getPluginRegistry()

\brief get the local plugin registry that can be used by the builder.

Returns:

The local plugin registry that can be used by the builder.