TensorRT  8.0.2
nvinfer1::IInt8Calibrator Class Referenceabstract

Application-implemented interface for calibration. More...

#include <NvInfer.h>

Inheritance diagram for nvinfer1::IInt8Calibrator:
nvinfer1::IInt8EntropyCalibrator nvinfer1::IInt8EntropyCalibrator2 nvinfer1::IInt8LegacyCalibrator nvinfer1::IInt8MinMaxCalibrator

Public Member Functions

virtual int32_t getBatchSize () const noexcept=0
 Get the batch size used for calibration batches. More...
 
virtual bool getBatch (void *bindings[], const char *names[], int32_t nbBindings) noexcept=0
 Get a batch of input for calibration. More...
 
virtual const void * readCalibrationCache (std::size_t &length) noexcept=0
 Load a calibration cache. More...
 
virtual void writeCalibrationCache (const void *ptr, std::size_t length) noexcept=0
 Save a calibration cache. More...
 
virtual CalibrationAlgoType getAlgorithm () noexcept=0
 Get the algorithm used by this calibrator. More...
 

Detailed Description

Application-implemented interface for calibration.

Calibration is a step performed by the builder when deciding suitable scale factors for 8-bit inference.

It must also provide a method for retrieving representative images which the calibration process can use to examine the distribution of activations. It may optionally implement a method for caching the calibration result for reuse on subsequent runs.

Member Function Documentation

◆ getAlgorithm()

virtual CalibrationAlgoType nvinfer1::IInt8Calibrator::getAlgorithm ( )
pure virtualnoexcept

Get the algorithm used by this calibrator.

Returns
The algorithm used by the calibrator.

Implemented in nvinfer1::IInt8LegacyCalibrator, nvinfer1::IInt8MinMaxCalibrator, nvinfer1::IInt8EntropyCalibrator2, and nvinfer1::IInt8EntropyCalibrator.

◆ getBatch()

virtual bool nvinfer1::IInt8Calibrator::getBatch ( void *  bindings[],
const char *  names[],
int32_t  nbBindings 
)
pure virtualnoexcept

Get a batch of input for calibration.

The batch size of the input must match the batch size returned by getBatchSize().

Parameters
bindingsAn array of pointers to device memory that must be updated to point to device memory containing each network input data.
namesThe names of the network input for each pointer in the binding array.
nbBindingsThe number of pointers in the bindings array.
Returns
False if there are no more batches for calibration.
See also
getBatchSize()

◆ getBatchSize()

virtual int32_t nvinfer1::IInt8Calibrator::getBatchSize ( ) const
pure virtualnoexcept

Get the batch size used for calibration batches.

Returns
The batch size.

◆ readCalibrationCache()

virtual const void* nvinfer1::IInt8Calibrator::readCalibrationCache ( std::size_t &  length)
pure virtualnoexcept

Load a calibration cache.

Calibration is potentially expensive, so it can be useful to generate the calibration data once, then use it on subsequent builds of the network. The cache includes the regression cutoff and quantile values used to generate it, and will not be used if these do not batch the settings of the current calibrator. However, the network should also be recalibrated if its structure changes, or the input data set changes, and it is the responsibility of the application to ensure this.

Parameters
lengthThe length of the cached data, that should be set by the called function. If there is no data, this should be zero.
Returns
A pointer to the cache, or nullptr if there is no data.

◆ writeCalibrationCache()

virtual void nvinfer1::IInt8Calibrator::writeCalibrationCache ( const void *  ptr,
std::size_t  length 
)
pure virtualnoexcept

Save a calibration cache.

Parameters
ptrA pointer to the data to cache.
lengthThe length in bytes of the data to cache.
See also
readCalibrationCache()

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