TensorRT 10.0.1
nvinfer1::v_1_0::IProgressMonitor Class Referenceabstract

#include <NvInfer.h>

Inheritance diagram for nvinfer1::v_1_0::IProgressMonitor:
nvinfer1::IVersionedInterface

Public Member Functions

 IProgressMonitor ()=default
 
virtual ~IProgressMonitor () noexcept=default
 
InterfaceInfo getInterfaceInfo () const noexcept override
 Return version information associated with this interface. Applications must not override this method. More...
 
virtual void phaseStart (char const *phaseName, char const *parentPhase, int32_t nbSteps) noexcept=0
 Signal that a phase of the optimizer has started. More...
 
virtual bool stepComplete (char const *phaseName, int32_t step) noexcept=0
 Signal that a step of an optimizer phase has finished. More...
 
virtual void phaseFinish (char const *phaseName) noexcept=0
 Signal that a phase of the optimizer has finished. More...
 
- Public Member Functions inherited from nvinfer1::IVersionedInterface
virtual APILanguage getAPILanguage () const noexcept
 The language used to build the implementation of this Interface. More...
 
virtual ~IVersionedInterface () noexcept=default
 

Additional Inherited Members

- Protected Member Functions inherited from nvinfer1::IVersionedInterface
 IVersionedInterface ()=default
 
 IVersionedInterface (IVersionedInterface const &)=default
 
 IVersionedInterface (IVersionedInterface &&)=default
 
IVersionedInterfaceoperator= (IVersionedInterface const &) &=default
 
IVersionedInterfaceoperator= (IVersionedInterface &&) &=default
 

Constructor & Destructor Documentation

◆ IProgressMonitor()

nvinfer1::v_1_0::IProgressMonitor::IProgressMonitor ( )
default

◆ ~IProgressMonitor()

virtual nvinfer1::v_1_0::IProgressMonitor::~IProgressMonitor ( )
virtualdefaultnoexcept

Member Function Documentation

◆ getInterfaceInfo()

InterfaceInfo nvinfer1::v_1_0::IProgressMonitor::getInterfaceInfo ( ) const
inlineoverridevirtualnoexcept

Return version information associated with this interface. Applications must not override this method.

Implements nvinfer1::IVersionedInterface.

◆ phaseFinish()

virtual void nvinfer1::v_1_0::IProgressMonitor::phaseFinish ( char const *  phaseName)
pure virtualnoexcept

Signal that a phase of the optimizer has finished.

Parameters
phaseNameThe name of the phase that has finished.

The phaseFinish function signals to the application that the phase is complete. This function may be called before all steps in the range [0, nbSteps) have been reported to stepComplete. This scenario can be triggered by error handling, internal optimizations, or when stepComplete returns false to request cancellation of the build.

See also
phaseStart

◆ phaseStart()

virtual void nvinfer1::v_1_0::IProgressMonitor::phaseStart ( char const *  phaseName,
char const *  parentPhase,
int32_t  nbSteps 
)
pure virtualnoexcept

Signal that a phase of the optimizer has started.

Parameters
phaseNameThe name of this phase for tracking purposes.
parentPhaseThe parent phase that this phase belongs to, or nullptr if there is no parent.
nbStepsThe number of steps that are involved in this phase.

The phaseStart function signals to the application that the current phase is beginning, and that it has a certain number of steps to perform. If phaseParent is nullptr, then the phaseStart is beginning an independent phase, and if phaseParent is specified, then the current phase, specified by phaseName, is within the scope of the parent phase. nbSteps will always be a positive number. The phaseStart function implies that the first step is being executed. TensorRT will signal when each step is complete.

Phase names are human readable English strings which are unique within a single phase hierarchy but which can be reused once the previous instance has completed. Phase names and their hierarchies may change between versions of TensorRT.

See also
phaseFinish

◆ stepComplete()

virtual bool nvinfer1::v_1_0::IProgressMonitor::stepComplete ( char const *  phaseName,
int32_t  step 
)
pure virtualnoexcept

Signal that a step of an optimizer phase has finished.

Parameters
phaseNameThe name of the innermost phase being executed.
stepThe step number that was completed.

The stepComplete function signals to the application that TensorRT has finished the current step for the phase phaseName, and will move onto the next step if there is one. The application can return false for TensorRT to exit the build early. The step value will increase on subsequent calls in the range [0, nbSteps).

Returns
true to continue to the next step or false to stop the build.

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

  Copyright © 2024 NVIDIA Corporation
  Privacy Policy | Manage My Privacy | Do Not Sell or Share My Data | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact