Base node of all non-primitive expressions. More...

#include <expr.h>

Inheritance diagram for tvm::RelayExprNode:

Collaboration diagram for tvm::RelayExprNode:

Public Member Functions
const Type &	checked_type () const

template<typename TTypeNode >
const TTypeNode *	type_as () const
	Check if the inferred(checked) type of the Expr is backed by a TTypeNode and return it. More...

VirtualDevice	virtual_device () const

	TVM_DECLARE_BASE_OBJECT_INFO (RelayExprNode, BaseExprNode)

Public Member Functions inherited from tvm::BaseExprNode
	TVM_DECLARE_BASE_OBJECT_INFO (BaseExprNode, 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
Type	checked_type_ = Type(nullptr)
	Stores the result of type inference(type checking). More...

Optional< ObjectRef >	struct_info_ = Optional<ObjectRef>()
	Stores the result of structure information of the expression that encapsulate both static shape and runtime information such as shape. More...

ObjectRef	virtual_device_
	The virtual device (VirtualDevice) for this node (the result of device planning). For first-order expressions (non functions), this describes where the result of evaluating the expression should be stored. Note that currently, all composite first-order values (tuples, references, ADTs) must be stored on the same virtual device. This means that it is not possible to store two tuple fields on different devices, so we only need one virtual device for these types. More...

Public Attributes inherited from tvm::BaseExprNode
Span	span
	Span that points to the original source code. Reserved debug information. More...

Static Public Attributes
static constexpr const char *	_type_key = "RelayExpr"

static constexpr const uint32_t	_type_child_slots = 22

Static Public Attributes inherited from tvm::BaseExprNode
static constexpr const char *	_type_key = "BaseExpr"

static constexpr const bool	_type_has_method_sequal_reduce = true

static constexpr const bool	_type_has_method_shash_reduce = true

static constexpr const uint32_t	_type_child_slots = 62

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

Base node of all non-primitive expressions.

RelayExpr supports tensor types, functions and ADT as first class citizens. The life-cycle of the corresponding objects are implicitly managed by the language.

See also: RelayExpr

Member Function Documentation

◆ checked_type()

const Type & tvm::RelayExprNode::checked_type ( ) const

inline

Returns: The checked_type

◆ TVM_DECLARE_BASE_OBJECT_INFO()

tvm::RelayExprNode::TVM_DECLARE_BASE_OBJECT_INFO	(	RelayExprNode	,
		BaseExprNode
	)

◆ type_as()

template<typename TTypeNode >

const TTypeNode * tvm::RelayExprNode::type_as

inline

Check if the inferred(checked) type of the Expr is backed by a TTypeNode and return it.

Note: This function will thrown an error if the node type of this Expr is not TTypeNode.

Returns: The corresponding TTypeNode pointer.

Template Parameters

The	specific TypeNode we look for.

◆ virtual_device()

VirtualDevice tvm::RelayExprNode::virtual_device ( ) const

Returns: The virtual device (VirtualDevice). If the virtual device is not defined, returns VirtualDevice::FullyUnconstrained(). Note that for function types, the virtual device is the device where the result of a call to the function is stored, not where the function itself lives. For example, the virtual device of f = fn(x) { body } is the virtual device of f(y), not where the function itself is stored. Note that f(y)'s virtual device will be the same as the virtual device of body.

See the documentation of the virtual_device_ field (above) for more details.

Member Data Documentation

◆ _type_child_slots

constexpr const uint32_t tvm::RelayExprNode::_type_child_slots = 22

staticconstexpr

◆ _type_key

constexpr const char* tvm::RelayExprNode::_type_key = "RelayExpr"

staticconstexpr

◆ checked_type_

Type tvm::RelayExprNode::checked_type_ = Type(nullptr)

mutable

Stores the result of type inference(type checking).

Note: This can be undefined before type inference. This value is discarded during serialization.

◆ struct_info_

Optional<ObjectRef> tvm::RelayExprNode::struct_info_ = Optional<ObjectRef>()

mutable

Stores the result of structure information of the expression that encapsulate both static shape and runtime information such as shape.

◆ virtual_device_

ObjectRef tvm::RelayExprNode::virtual_device_

mutable

The virtual device (VirtualDevice) for this node (the result of device planning). For first-order expressions (non functions), this describes where the result of evaluating the expression should be stored. Note that currently, all composite first-order values (tuples, references, ADTs) must be stored on the same virtual device. This means that it is not possible to store two tuple fields on different devices, so we only need one virtual device for these types.

For expressions that have the function type, the virtual device describes where the result of the call to the function or closure is stored (instead of where the function itself is stored). For example, the virtual device of f = fn(x) { body } is the virtual device of f(y), not where the function itself is stored. Note that f(y)'s virtual device will be the same as the virtual device of body. For more details, see the documentation in src/relay/transforms/device_planner.cc.

The VirtualDevice's Target field describes how the body of the function should be compiled.

Set to VirtualDevice::FullyUnconstrained by default.

Note: Unfortunately, the type of virtual_device_ needs to be ObjectRef to avoid a circular import.

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

include/tvm/ir/expr.h

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ checked_type()

◆ TVM_DECLARE_BASE_OBJECT_INFO()

◆ type_as()

◆ virtual_device()

Member Data Documentation

◆ _type_child_slots

◆ _type_key

◆ checked_type_

◆ struct_info_

◆ virtual_device_