tvm::script::printer::FrameNode Class Reference

#include <ir_docsifier.h>

Inheritance diagram for tvm::script::printer::FrameNode:

Collaboration diagram for tvm::script::printer::FrameNode:

Public Member Functions
void	VisitAttrs (tvm::AttrVisitor *v)
	TVM_DECLARE_BASE_OBJECT_INFO (FrameNode, Object)
virtual	~FrameNode ()=default
template<typename TCallback >
void	AddExitCallback (TCallback &&cb)
	Add a callback function to be called when this frame exits. More...
void	AddDispatchToken (const IRDocsifier &d, const String &token)
	Add a dispatch token to the docsifier, and a callback that pops the token when this frame exits. More...
virtual void	EnterWithScope ()
	Method that's called when Frame enters the scope. More...
virtual void	ExitWithScope ()
	Method that's called when Frame exits the scope. More...
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)

Public Attributes
Array< StmtDoc >	stmts
IRDocsifierNode *	d
std::vector< std::function< void()> >	callbacks

Static Public Attributes
static constexpr const char *	_type_key = "script.printer.Frame"
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

Frame is the core data structure for semantic information when printing IR graph into TVMScript code.

Constructor & Destructor Documentation

~FrameNode()

virtual tvm::script::printer::FrameNode::~FrameNode ( )

virtualdefault

Member Function Documentation

AddDispatchToken()

void tvm::script::printer::FrameNode::AddDispatchToken ( const IRDocsifier &  d, const String &  token  )

inline

Add a dispatch token to the docsifier, and a callback that pops the token when this frame exits.

Parameters

d	The docsifier.
token	The token to be added.

AddExitCallback()

template<typename TCallback >

void tvm::script::printer::FrameNode::AddExitCallback ( TCallback &&  cb )

inline

Add a callback function to be called when this frame exits.

Parameters

cb	The callback function. It should have signature void().

EnterWithScope()

void tvm::script::printer::FrameNode::EnterWithScope ( )

inlinevirtual

Method that's called when Frame enters the scope.

ExitWithScope()

void tvm::script::printer::FrameNode::ExitWithScope ( )

inlinevirtual

Method that's called when Frame exits the scope.

TVM_DECLARE_BASE_OBJECT_INFO()

tvm::script::printer::FrameNode::TVM_DECLARE_BASE_OBJECT_INFO	(	FrameNode	,
		Object
	)

VisitAttrs()

void tvm::script::printer::FrameNode::VisitAttrs ( tvm::AttrVisitor *  v )

inline

Member Data Documentation

_type_key

constexpr const char* tvm::script::printer::FrameNode::_type_key = "script.printer.Frame"

staticconstexpr

callbacks

std::vector<std::function<void()> > tvm::script::printer::FrameNode::callbacks

The callbacks that are going to be invoked when the frame exits

d

IRDocsifierNode* tvm::script::printer::FrameNode::d

The corresponding IRDocsifier

stmts

Array<StmtDoc> tvm::script::printer::FrameNode::stmts

The docs generated in the frame

---

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

• include/tvm/script/printer/ir_docsifier.h