tvm
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
tvm::te::OperationNode Class Referenceabstract

Base class of all operation nodes. More...

#include <operation.h>

Inheritance diagram for tvm::te::OperationNode:
Collaboration diagram for tvm::te::OperationNode:

Public Member Functions

virtual ~OperationNode ()
 
virtual int num_outputs () const =0
 
virtual Array< IterVarroot_iter_vars () const =0
 
virtual DataType output_dtype (size_t i) const =0
 Get data type. i-th output tensor. More...
 
virtual Array< PrimExproutput_shape (size_t i) const =0
 Get shape of i-th output tensor. More...
 
virtual Array< TensorInputTensors () const =0
 List all the input Tensors. More...
 
virtual Operation ReplaceInputs (const Operation &self, const std::unordered_map< Tensor, Tensor > &rmap) const =0
 Replace the input of the operation by pattern specified by rmap. More...
 
virtual void PropBoundToInputs (const Operation &self, arith::Analyzer *analyzer, const std::unordered_map< const VarNode *, IntSet > &dom_map, std::unordered_map< Tensor, TensorDom > *out_dom_map) const =0
 Propagate the bounds to inputs. More...
 
virtual void GatherBound (const Operation &self, const std::unordered_map< Tensor, TensorDom > &tensor_dom, std::unordered_map< IterVar, Range > *out_dom_map) const =0
 Gather the bound from output tensor. Set the range of each root_iter_vars in the op to out_dom_map. More...
 
virtual Stmt BuildRealize (const Stage &stage, const std::unordered_map< IterVar, Range > &realize_map, const Stmt &body, String storage_scope="") const =0
 Build the Realize statement that realizes the op's output tensors. More...
 
virtual Stmt BuildProvide (const Stage &stage, const std::unordered_map< IterVar, Range > &dom_map, bool debug_keep_trivial_loop) const =0
 Build the statement that provide the output tensors. More...
 
 TVM_DECLARE_BASE_OBJECT_INFO (OperationNode, 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

std::string name
 optional name of the operation More...
 
std::string tag
 optional tag of the operation More...
 
Map< String, ObjectRefattrs
 additional attributes of the operation More...
 

Static Public Attributes

static constexpr const char * _type_key = "Operation"
 
- 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 class of all operation nodes.

Constructor & Destructor Documentation

◆ ~OperationNode()

virtual tvm::te::OperationNode::~OperationNode ( )
inlinevirtual

Member Function Documentation

◆ BuildProvide()

virtual Stmt tvm::te::OperationNode::BuildProvide ( const Stage stage,
const std::unordered_map< IterVar, Range > &  dom_map,
bool  debug_keep_trivial_loop 
) const
pure virtual

Build the statement that provide the output tensors.

Parameters
stageThe schedule stage of the op.
dom_mapThe domain map of all iteration domains.
debug_keep_trivial_loopWhether keep trivial loops with extent of 1
Returns
A statement that add production and wraps consumer.

Implemented in tvm::te::HybridOpNode, tvm::te::ExternOpNode, tvm::te::ScanOpNode, tvm::te::TensorComputeOpNode, tvm::te::ComputeOpNode, and tvm::te::PlaceholderOpNode.

◆ BuildRealize()

virtual Stmt tvm::te::OperationNode::BuildRealize ( const Stage stage,
const std::unordered_map< IterVar, Range > &  realize_map,
const Stmt body,
String  storage_scope = "" 
) const
pure virtual

Build the Realize statement that realizes the op's output tensors.

Parameters
stagethe op's stage.
realize_mapThe realization domain map of the operators.
bodyThe body that is going to get
storage_scopeThe storage scope associated with this realization
Returns
A realization statement that wraps body.

Implemented in tvm::te::HybridOpNode, tvm::te::ExternOpNode, tvm::te::ScanOpNode, tvm::te::BaseComputeOpNode, and tvm::te::PlaceholderOpNode.

◆ GatherBound()

virtual void tvm::te::OperationNode::GatherBound ( const Operation self,
const std::unordered_map< Tensor, TensorDom > &  tensor_dom,
std::unordered_map< IterVar, Range > *  out_dom_map 
) const
pure virtual

Gather the bound from output tensor. Set the range of each root_iter_vars in the op to out_dom_map.

Parameters
selfThe reference to self.
tensor_domDomain map of Tensor->access set of each dimension.
out_dom_mapThe output domain map of each IterVar to be setted.

Implemented in tvm::te::HybridOpNode, tvm::te::ExternOpNode, tvm::te::ScanOpNode, tvm::te::BaseComputeOpNode, and tvm::te::PlaceholderOpNode.

◆ InputTensors()

virtual Array<Tensor> tvm::te::OperationNode::InputTensors ( ) const
pure virtual

◆ num_outputs()

virtual int tvm::te::OperationNode::num_outputs ( ) const
pure virtual

◆ output_dtype()

virtual DataType tvm::te::OperationNode::output_dtype ( size_t  i) const
pure virtual

Get data type. i-th output tensor.

Parameters
iThe output index.
Returns
type of i-th output.

Implemented in tvm::te::HybridOpNode, tvm::te::ExternOpNode, tvm::te::ScanOpNode, tvm::te::TensorComputeOpNode, tvm::te::ComputeOpNode, and tvm::te::PlaceholderOpNode.

◆ output_shape()

virtual Array<PrimExpr> tvm::te::OperationNode::output_shape ( size_t  i) const
pure virtual

Get shape of i-th output tensor.

Parameters
iThe output index.
Returns
shape of i-th output.

Implemented in tvm::te::BaseComputeOpNode, tvm::te::HybridOpNode, tvm::te::ExternOpNode, tvm::te::ScanOpNode, and tvm::te::PlaceholderOpNode.

◆ PropBoundToInputs()

virtual void tvm::te::OperationNode::PropBoundToInputs ( const Operation self,
arith::Analyzer analyzer,
const std::unordered_map< const VarNode *, IntSet > &  dom_map,
std::unordered_map< Tensor, TensorDom > *  out_dom_map 
) const
pure virtual

Propagate the bounds to inputs.

Parameters
selfThe reference to self.
analyzerThe analyzer to be used in the function.
dom_mapthe domain map of Variables(corresponds to root_iter_vars)
out_dom_mapThe output domain. The function is only asked to fill the bounds for Tensors that is already in the out_dom_map

Implemented in tvm::te::HybridOpNode, tvm::te::ExternOpNode, tvm::te::ScanOpNode, tvm::te::TensorComputeOpNode, tvm::te::ComputeOpNode, and tvm::te::PlaceholderOpNode.

◆ ReplaceInputs()

virtual Operation tvm::te::OperationNode::ReplaceInputs ( const Operation self,
const std::unordered_map< Tensor, Tensor > &  rmap 
) const
pure virtual

Replace the input of the operation by pattern specified by rmap.

Parameters
selfThe reference to self.
rmapThe replacement map.
Returns
self if nothing is replaced, otherwise return replaced op.

Implemented in tvm::te::HybridOpNode, tvm::te::ExternOpNode, tvm::te::ScanOpNode, tvm::te::TensorComputeOpNode, tvm::te::ComputeOpNode, and tvm::te::PlaceholderOpNode.

◆ root_iter_vars()

virtual Array<IterVar> tvm::te::OperationNode::root_iter_vars ( ) const
pure virtual
Returns
The list of iteration variable at root
Note
root_iter_vars decides the shape of the outputs.

Implemented in tvm::te::HybridOpNode, tvm::te::ExternOpNode, tvm::te::ScanOpNode, tvm::te::BaseComputeOpNode, and tvm::te::PlaceholderOpNode.

◆ TVM_DECLARE_BASE_OBJECT_INFO()

tvm::te::OperationNode::TVM_DECLARE_BASE_OBJECT_INFO ( OperationNode  ,
Object   
)

Member Data Documentation

◆ _type_key

constexpr const char* tvm::te::OperationNode::_type_key = "Operation"
staticconstexpr

◆ attrs

Map<String, ObjectRef> tvm::te::OperationNode::attrs

additional attributes of the operation

◆ name

std::string tvm::te::OperationNode::name

optional name of the operation

◆ tag

std::string tvm::te::OperationNode::tag

optional tag of the operation


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