tvm::runtime::TimerNode Class Reference

Base class for all implementations. More...

#include <profiling.h>

Inheritance diagram for tvm::runtime::TimerNode:

Collaboration diagram for tvm::runtime::TimerNode:

Public Member Functions
virtual void	Start ()=0
	Start the timer. More...
virtual void	Stop ()=0
	Stop the timer. More...
virtual int64_t	SyncAndGetElapsedNanos ()=0
	Synchronize timer state and return elapsed time between Start and Stop. More...
virtual	~TimerNode ()
	TVM_DECLARE_BASE_OBJECT_INFO (TimerNode, Object)
Public Member Functions inherited from tvm::runtime::Object
uint32_t	type_index () const
std::string	GetTypeKey () const
size_t	GetTypeKeyHash () const
template<typename TargetType >
bool	IsInstance () const
bool	unique () const
	Object ()
	Object (const Object &other)
	Object (Object &&other)
Object &	operator= (const Object &other)
Object &	operator= (Object &&other)

Static Public Attributes
static constexpr const char *	_type_key = "TimerNode"
Static Public Attributes inherited from tvm::runtime::Object
static constexpr const char *	_type_key = "runtime.Object"
static constexpr bool	_type_final = false
static constexpr uint32_t	_type_child_slots = 0
static constexpr bool	_type_child_slots_can_overflow = true
static constexpr bool	_type_has_method_visit_attrs = true
static constexpr bool	_type_has_method_sequal_reduce = false
static constexpr bool	_type_has_method_shash_reduce = false
static constexpr uint32_t	_type_index = TypeIndex::kDynamic

Additional Inherited Members
Public Types inherited from tvm::runtime::Object
typedef void(*	FDeleter) (Object *self)
	Object deleter. More...
using	RefCounterType = std::atomic< int32_t >
Static Public Member Functions inherited from tvm::runtime::Object
static std::string	TypeIndex2Key (uint32_t tindex)
	Get the type key of the corresponding index from runtime. More...
static size_t	TypeIndex2KeyHash (uint32_t tindex)
	Get the type key hash of the corresponding index from runtime. More...
static uint32_t	TypeKey2Index (const std::string &key)
	Get the type index of the corresponding key from runtime. More...
static uint32_t	_GetOrAllocRuntimeTypeIndex ()
static uint32_t	RuntimeTypeIndex ()
Protected Member Functions inherited from tvm::runtime::Object
void	IncRef ()
	developer function, increases reference counter. More...
void	DecRef ()
	developer function, decrease reference counter. More...
Static Protected Member Functions inherited from tvm::runtime::Object
static uint32_t	GetOrAllocRuntimeTypeIndex (const std::string &key, uint32_t static_tindex, uint32_t parent_tindex, uint32_t type_child_slots, bool type_child_slots_can_overflow)
	Get the type index using type key. More...
Protected Attributes inherited from tvm::runtime::Object
uint32_t	type_index_ {0}
	Type index(tag) that indicates the type of the object. More...
RefCounterType	ref_counter_ {0}
	The internal reference counter. More...
FDeleter	deleter_ = nullptr
	deleter of this object to enable customized allocation. If the deleter is nullptr, no deletion will be performed. The creator of the object must always set the deleter field properly. More...

Detailed Description

Base class for all 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

~TimerNode()

virtual tvm::runtime::TimerNode::~TimerNode ( )

inlinevirtual

Member Function Documentation

Start()

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

pure virtual

Start the timer.

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

Stop()

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

pure virtual

Stop the timer.

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

SyncAndGetElapsedNanos()

virtual int64_t tvm::runtime::TimerNode::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_DECLARE_BASE_OBJECT_INFO()

tvm::runtime::TimerNode::TVM_DECLARE_BASE_OBJECT_INFO	(	TimerNode	,
		Object
	)

Member Data Documentation

_type_key

constexpr const char* tvm::runtime::TimerNode::_type_key = "TimerNode"

staticconstexpr

---

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

• include/tvm/runtime/profiling.h