tvm::runtime::TimerObj Class Reference

Base class for all timer implementations. More...

#include <timer.h>

Inheritance diagram for tvm::runtime::TimerObj:

Collaboration diagram for tvm::runtime::TimerObj:

Public Member Functions
virtual void	Start ()=0
	Start the timer.
virtual void	Stop ()=0
	Stop the timer.
virtual int64_t	SyncAndGetElapsedNanos ()=0
	Synchronize timer state and return elapsed time between Start and Stop.
virtual	~TimerObj ()
	TVM_FFI_DECLARE_OBJECT_INFO ("runtime.TimerNode", TimerObj, ffi::Object)

Static Public Attributes
static constexpr const bool	_type_mutable = true

Detailed Description

Base class for all timer implementations.

New implementations of this interface should make sure that Start and Stop are as lightweight as possible. Expensive state synchronization should be done in SyncAndGetElapsedNanos.

Constructor & Destructor Documentation

~TimerObj()

virtual tvm::runtime::TimerObj::~TimerObj ( )

inlinevirtual

Member Function Documentation

Start()

virtual void tvm::runtime::TimerObj::Start ( )

pure virtual

Start the timer.

Note: this function should only be called once per object.

Stop()

virtual void tvm::runtime::TimerObj::Stop ( )

pure virtual

Stop the timer.

Note: this function should only be called once per object.

SyncAndGetElapsedNanos()

virtual int64_t tvm::runtime::TimerObj::SyncAndGetElapsedNanos ( )

pure virtual

Synchronize timer state and return elapsed time between Start and Stop.

Returns

The time in nanoseconds between Start and Stop.

This function is necessary because we want to avoid timing the overhead of doing timing. When using multiple timers, it is recommended to stop all of them before calling SyncAndGetElapsedNanos on any of them.

Note: this function should be only called once per object. It may incur a large synchronization overhead (for example, with GPUs).

TVM_FFI_DECLARE_OBJECT_INFO()

tvm::runtime::TimerObj::TVM_FFI_DECLARE_OBJECT_INFO	(	"runtime.TimerNode"	,
		TimerObj	,
		ffi::Object
	)

Member Data Documentation

_type_mutable

constexpr const bool tvm::runtime::TimerObj::_type_mutable = true

staticconstexpr

---

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

• include/tvm/runtime/timer.h