tvm::runtime::profiling::MetricCollectorNode Class Reference

Interface for user defined profiling metric collection. More...

#include <profiling.h>

Inheritance diagram for tvm::runtime::profiling::MetricCollectorNode:

Collaboration diagram for tvm::runtime::profiling::MetricCollectorNode:

Public Member Functions
virtual void	Init (Array< DeviceWrapper > devs)=0
	Initialization call. Called before profiling has started. Any expensive precomputation should happen here. More...
virtual ObjectRef	Start (Device dev)=0
	Start colling metrics for a function call. More...
virtual Map< String, ObjectRef >	Stop (ObjectRef obj)=0
	Stop collecting metrics. More...
virtual	~MetricCollectorNode ()
	TVM_DECLARE_BASE_OBJECT_INFO (MetricCollectorNode, 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 = "runtime.profiling.MetricCollector"
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

Interface for user defined profiling metric collection.

Users can register their own collector by registering a packed function with the name "runtime.profiling.metrics.my_collector_name" where "my_collector_name" is the name of their collector. This function should take an Array of Device as input which contains the devices the collector will be run on.

MetricCollectorNodes will be called in the following fashion.

MetricCollector mc;
for (auto op : model) {
  auto o = mc.Start();
  op();
  auto metrics = mc.Stop(o); // metrics are added the profiling report
}

Constructor & Destructor Documentation

~MetricCollectorNode()

virtual tvm::runtime::profiling::MetricCollectorNode::~MetricCollectorNode ( )

inlinevirtual

Member Function Documentation

Init()

virtual void tvm::runtime::profiling::MetricCollectorNode::Init ( Array< DeviceWrapper >  devs )

pure virtual

Initialization call. Called before profiling has started. Any expensive precomputation should happen here.

Parameters

devs	The list of devices this collector will be run on.

Start()

virtual ObjectRef tvm::runtime::profiling::MetricCollectorNode::Start ( Device  dev )

pure virtual

Start colling metrics for a function call.

Parameters

dev	The device the call will be run on.

Returns

An object used to maintain state of the metric collection. This object will be passed to the corresponding Stop call. If the device is not supported, this function will return a nullptr ObjectRef.

Stop()

virtual Map<String, ObjectRef> tvm::runtime::profiling::MetricCollectorNode::Stop ( ObjectRef  obj )

pure virtual

Stop collecting metrics.

Parameters

obj	The object created by the corresponding Start call.

Returns

A set of metric names and the associated values. Values must be one of DurationNode, PercentNode, CountNode, or StringObj.

TVM_DECLARE_BASE_OBJECT_INFO()

tvm::runtime::profiling::MetricCollectorNode::TVM_DECLARE_BASE_OBJECT_INFO	(	MetricCollectorNode	,
		Object
	)

Member Data Documentation

_type_key

constexpr const char* tvm::runtime::profiling::MetricCollectorNode::_type_key = "runtime.profiling.MetricCollector"

staticconstexpr

---

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

• include/tvm/runtime/profiling.h