The ir_builder frame for the relax function. More...

#include <frame.h>

Inheritance diagram for tvm::script::ir_builder::relax::FunctionFrameNode:

Collaboration diagram for tvm::script::ir_builder::relax::FunctionFrameNode:

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

	TVM_DECLARE_FINAL_OBJECT_INFO (FunctionFrameNode, SeqExprFrameNode)

void	EnterWithScope () final
	The method called when entering RAII scope. More...

void	ExitWithScope () final
	The method called when exiting RAII scope. More...

Public Member Functions inherited from tvm::script::ir_builder::relax::SeqExprFrameNode
void	VisitAttrs (tvm::AttrVisitor *v)

	TVM_DECLARE_BASE_OBJECT_INFO (SeqExprFrameNode, RelaxFrameNode)

Public Member Functions inherited from tvm::script::ir_builder::relax::RelaxFrameNode
void	VisitAttrs (tvm::AttrVisitor *v)

	TVM_DECLARE_BASE_OBJECT_INFO (RelaxFrameNode, IRBuilderFrameNode)

Public Member Functions inherited from tvm::script::ir_builder::IRBuilderFrameNode
void	VisitAttrs (tvm::AttrVisitor *v)

	TVM_DECLARE_BASE_OBJECT_INFO (IRBuilderFrameNode, runtime::Object)

virtual	~IRBuilderFrameNode ()=default
	Default destructor. More...

void	AddCallback (runtime::TypedPackedFunc< void()> callback)
	Add a callback method invoked when exiting the RAII 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
Optional< String >	name
	The function name. More...

Array< tvm::relax::Var >	params
	The function params. More...

Optional< tvm::relax::StructInfo >	ret_struct_info
	The function return struct info. More...

Optional< Bool >	is_pure
	Whether the function is annotated as pure. More...

Optional< Bool >	is_private
	Whether the function is annotated as private. More...

Map< String, ObjectRef >	attrs
	The function attributes. More...

tvm::relax::BlockBuilder	block_builder
	The block builder to create Relax function. More...

Public Attributes inherited from tvm::script::ir_builder::relax::SeqExprFrameNode
Array< tvm::relax::BindingBlock >	binding_blocks
	The binding blocks inside the frame. More...

Optional< tvm::relax::Expr >	output
	The frame output expr. `NullOpt` when undefined. More...

Public Attributes inherited from tvm::script::ir_builder::IRBuilderFrameNode
std::vector< runtime::TypedPackedFunc< void()> >	callbacks
	A list of callbacks used when exiting the frame. More...

Static Public Attributes
static constexpr const char *	_type_key = "script.ir_builder.relax.FunctionFrame"

Static Public Attributes inherited from tvm::script::ir_builder::relax::SeqExprFrameNode
static constexpr const char *	_type_key = "script.ir_builder.relax.SeqExprFrame"

Static Public Attributes inherited from tvm::script::ir_builder::relax::RelaxFrameNode
static constexpr const char *	_type_key = "script.ir_builder.relax.RelaxFrame"

Static Public Attributes inherited from tvm::script::ir_builder::IRBuilderFrameNode
static constexpr const char *	_type_key = "script.ir_builder.IRBuilderFrame"

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

The ir_builder frame for the relax function.

Member Function Documentation

◆ EnterWithScope()

void tvm::script::ir_builder::relax::FunctionFrameNode::EnterWithScope ( )

finalvirtual

The method called when entering RAII scope.

See also: tvm::support::With

Reimplemented from tvm::script::ir_builder::relax::SeqExprFrameNode.

◆ ExitWithScope()

void tvm::script::ir_builder::relax::FunctionFrameNode::ExitWithScope ( )

finalvirtual

The method called when exiting RAII scope.

See also: tvm::support::With

Reimplemented from tvm::script::ir_builder::relax::SeqExprFrameNode.

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::script::ir_builder::relax::FunctionFrameNode::TVM_DECLARE_FINAL_OBJECT_INFO	(	FunctionFrameNode	,
		SeqExprFrameNode
	)

◆ VisitAttrs()

void tvm::script::ir_builder::relax::FunctionFrameNode::VisitAttrs ( tvm::AttrVisitor * v )

inline

Member Data Documentation

◆ _type_key

constexpr const char* tvm::script::ir_builder::relax::FunctionFrameNode::_type_key = "script.ir_builder.relax.FunctionFrame"

staticconstexpr

◆ attrs

Map<String, ObjectRef> tvm::script::ir_builder::relax::FunctionFrameNode::attrs

The function attributes.

◆ block_builder

tvm::relax::BlockBuilder tvm::script::ir_builder::relax::FunctionFrameNode::block_builder

The block builder to create Relax function.

◆ is_private

Optional<Bool> tvm::script::ir_builder::relax::FunctionFrameNode::is_private

Whether the function is annotated as private.

◆ is_pure

Optional<Bool> tvm::script::ir_builder::relax::FunctionFrameNode::is_pure

Whether the function is annotated as pure.

◆ name

Optional<String> tvm::script::ir_builder::relax::FunctionFrameNode::name

The function name.

Note: The name will not be specified in constructor, so it is "Optional", However, we must specify the name by R.func_name before exit this frame.

◆ params

Array<tvm::relax::Var> tvm::script::ir_builder::relax::FunctionFrameNode::params

The function params.

◆ ret_struct_info

Optional<tvm::relax::StructInfo> tvm::script::ir_builder::relax::FunctionFrameNode::ret_struct_info

The function return struct info.

Note: Usually the function return type can be deduced by the function body. But we can use this field to specify a more "accurate" return type. i.e. If the ret_struct_info is None, try to use the deduced type from body If the ret_struct_info is not None, we can still take body.struct_info if we ret_struct_info is base of body.struct_info. If not, we will take the specified ret_struct_info.

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

include/tvm/script/ir_builder/relax/frame.h

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members