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 (ffi::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 ffi::Map< ffi::String, ffi::Any >	Stop (ffi::ObjectRef obj)=0
	Stop collecting metrics. More...
virtual	~MetricCollectorNode ()
	TVM_FFI_DECLARE_OBJECT_INFO ("runtime.profiling.MetricCollector", MetricCollectorNode, Object)

Static Public Attributes
static constexpr const bool	_type_mutable = true

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 ( ffi::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 ffi::Map<ffi::String, ffi::Any> tvm::runtime::profiling::MetricCollectorNode::Stop ( ffi::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 String.

TVM_FFI_DECLARE_OBJECT_INFO()

tvm::runtime::profiling::MetricCollectorNode::TVM_FFI_DECLARE_OBJECT_INFO	(	"runtime.profiling.MetricCollector"	,
		MetricCollectorNode	,
		Object
	)

Member Data Documentation

_type_mutable

constexpr const bool tvm::runtime::profiling::MetricCollectorNode::_type_mutable = true

staticconstexpr

---

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

• include/tvm/runtime/profiling.h