tvm
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
tvm::relay::FunctionNode Class Reference

Relay Function container. More...

#include <function.h>

Inheritance diagram for tvm::relay::FunctionNode:
Collaboration diagram for tvm::relay::FunctionNode:

Public Member Functions

void VisitAttrs (tvm::AttrVisitor *v)
 
bool SEqualReduce (const FunctionNode *other, SEqualReducer equal) const
 
void SHashReduce (SHashReducer hash_reduce) const
 
FuncType func_type_annotation () const
 Return the derived function annotation of this expression. More...
 
 TVM_DECLARE_FINAL_OBJECT_INFO (FunctionNode, BaseFuncNode)
 
- Public Member Functions inherited from tvm::BaseFuncNode
template<typename TObjectRef >
Optional< TObjectRef > GetAttr (const std::string &attr_key, Optional< TObjectRef > default_value=Optional< TObjectRef >(nullptr)) const
 Get a function attribute. More...
 
template<typename TObjectRef >
Optional< TObjectRef > GetAttr (const std::string &attr_key, TObjectRef default_value) const
 
bool HasNonzeroAttr (const std::string &attr_key) const
 Check whether the function has an non-zero integer attr. More...
 
LinkageType GetLinkageType () const
 Get the type of the linkage. More...
 
 TVM_DECLARE_BASE_OBJECT_INFO (BaseFuncNode, RelayExprNode)
 
- Public Member Functions inherited from tvm::RelayExprNode
const Typechecked_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)
 
Objectoperator= (const Object &other)
 
Objectoperator= (Object &&other)
 

Public Attributes

tvm::Array< Varparams
 Function parameters. More...
 
Expr body
 The expression which represents the computation of the function, the expression may reference the parameters, and the type of it or sub-expressions may reference the type variables. More...
 
Type ret_type
 User annotated return type of the function. More...
 
tvm::Array< TypeVartype_params
 Type parameters of the function. Enables the function to vary its type based on these. This corresponds to template paramaters in c++'s terminology. More...
 
- Public Attributes inherited from tvm::BaseFuncNode
DictAttrs attrs
 Additional attributes storing the meta-data. More...
 
- Public Attributes inherited from tvm::RelayExprNode
Type checked_type_ = Type(nullptr)
 Stores the result of type inference(type checking). More...
 
Optional< ObjectRefstruct_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 = "relay.Function"
 
- Static Public Attributes inherited from tvm::BaseFuncNode
static constexpr const char * _type_key = "BaseFunc"
 
static constexpr const uint32_t _type_child_slots = 2
 
- Static Public Attributes inherited from tvm::RelayExprNode
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

Relay Function container.

See also
Function

Member Function Documentation

◆ func_type_annotation()

FuncType tvm::relay::FunctionNode::func_type_annotation ( ) const

Return the derived function annotation of this expression.

Returns
The function type annotation.
Note
The function type annotation can contain IncompleteType.

◆ SEqualReduce()

bool tvm::relay::FunctionNode::SEqualReduce ( const FunctionNode other,
SEqualReducer  equal 
) const
inline

◆ SHashReduce()

void tvm::relay::FunctionNode::SHashReduce ( SHashReducer  hash_reduce) const
inline

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::relay::FunctionNode::TVM_DECLARE_FINAL_OBJECT_INFO ( FunctionNode  ,
BaseFuncNode   
)

◆ VisitAttrs()

void tvm::relay::FunctionNode::VisitAttrs ( tvm::AttrVisitor v)
inline

Member Data Documentation

◆ _type_key

constexpr const char* tvm::relay::FunctionNode::_type_key = "relay.Function"
staticconstexpr

◆ body

Expr tvm::relay::FunctionNode::body

The expression which represents the computation of the function, the expression may reference the parameters, and the type of it or sub-expressions may reference the type variables.

◆ params

tvm::Array<Var> tvm::relay::FunctionNode::params

Function parameters.

◆ ret_type

Type tvm::relay::FunctionNode::ret_type

User annotated return type of the function.

◆ type_params

tvm::Array<TypeVar> tvm::relay::FunctionNode::type_params

Type parameters of the function. Enables the function to vary its type based on these. This corresponds to template paramaters in c++'s terminology.

Note
This can be usually empty for non-polymorphic functions.

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