A wrapper object to provide injection point for printer of each IR. More...

#include <ir_docsifier.h>

Inheritance diagram for tvm::script::printer::RootNodeContainerNode:

Collaboration diagram for tvm::script::printer::RootNodeContainerNode:

Public Member Functions
void	VisitAttrs (tvm::AttrVisitor *v)

	TVM_DECLARE_FINAL_OBJECT_INFO (RootNodeContainerNode, 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)

Public Attributes
ObjectRef	root_node
	The root node to print. More...

Static Public Attributes
static constexpr const char *	_type_key = "script.printer.RootNodeContainer"

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

A wrapper object to provide injection point for printer of each IR.

For any IR node to be transformed by IRDocsifier, it will be wrapped by RootNodeContainer and be dispatched to the corresponding function first. This provides an injection point for each IR's printer implemention to add specialized logic, for example, pushing a special Frame to the IRDocsifier before doing any IR->Doc transformation.

TVM_STATIC_IR_FUNCTOR(IRDocsifier, vtable)
    .set_dispatch("relax", [](TracedObject<RootNodeContainer> obj, IRDocsifier p) {
      const ObjectRef& root_node = obj.Get()->root_node;
      // For example, relax printer can create a Frame specialized to Relax here
      RelaxGeneralFrame frame;
      auto ctx = p->WithFrame(frame);
      // More specialized logic for your IR.
      return p->AsDoc<Doc>(MakeTraced(root_node));
    });

Member Function Documentation

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::script::printer::RootNodeContainerNode::TVM_DECLARE_FINAL_OBJECT_INFO	(	RootNodeContainerNode	,
		Object
	)

◆ VisitAttrs()

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

inline

Member Data Documentation

◆ _type_key

constexpr const char* tvm::script::printer::RootNodeContainerNode::_type_key = "script.printer.RootNodeContainer"

static

◆ root_node

ObjectRef tvm::script::printer::RootNodeContainerNode::root_node

The root node to print.

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

include/tvm/script/printer/ir_docsifier.h

Public Member Functions

Public Attributes

Static Public Attributes