tvm
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
tvm::meta_schedule::RunnerFutureNode Class Reference

A class to asynchronously fetch runner's output. More...

#include <runner.h>

Inheritance diagram for tvm::meta_schedule::RunnerFutureNode:
Collaboration diagram for tvm::meta_schedule::RunnerFutureNode:

Public Types

using FDone = runtime::TypedPackedFunc< bool()>
 The function type to check whether the runner has finished. More...
 
using FResult = runtime::TypedPackedFunc< RunnerResult()>
 The function type to fetch runner output if it is ready. More...
 
- Public Types inherited from tvm::runtime::Object
typedef void(* FDeleter) (Object *self)
 Object deleter. More...
 
using RefCounterType = std::atomic< int32_t >
 

Public Member Functions

void VisitAttrs (tvm::AttrVisitor *v)
 
bool Done () const
 Check whether the runner has finished. More...
 
RunnerResult Result () const
 Fetch the runner's output if it is ready. More...
 
 TVM_DECLARE_FINAL_OBJECT_INFO (RunnerFutureNode, runtime::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

FDone f_done
 The packed function to check whether the runner has finished. More...
 
FResult f_result
 The packed function to fetch runner output if it is ready. More...
 

Static Public Attributes

static constexpr const char * _type_key = "meta_schedule.RunnerFuture"
 
- 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

- 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 class to asynchronously fetch runner's output.

Note
The API design is consistent with python's concurrent.futures.Future: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future

Member Typedef Documentation

◆ FDone

The function type to check whether the runner has finished.

Returns
Whether the runner's output is ready.

◆ FResult

The function type to fetch runner output if it is ready.

Returns
The runner's output.

Member Function Documentation

◆ Done()

bool tvm::meta_schedule::RunnerFutureNode::Done ( ) const
inline

Check whether the runner has finished.

Returns
A boolean indicating whether the runner has finished.

◆ Result()

RunnerResult tvm::meta_schedule::RunnerFutureNode::Result ( ) const
inline

Fetch the runner's output if it is ready.

Returns
The runner's output.

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::meta_schedule::RunnerFutureNode::TVM_DECLARE_FINAL_OBJECT_INFO ( RunnerFutureNode  ,
runtime::Object   
)

◆ VisitAttrs()

void tvm::meta_schedule::RunnerFutureNode::VisitAttrs ( tvm::AttrVisitor v)
inline

Member Data Documentation

◆ _type_key

constexpr const char* tvm::meta_schedule::RunnerFutureNode::_type_key = "meta_schedule.RunnerFuture"
staticconstexpr

◆ f_done

FDone tvm::meta_schedule::RunnerFutureNode::f_done

The packed function to check whether the runner has finished.

◆ f_result

FResult tvm::meta_schedule::RunnerFutureNode::f_result

The packed function to fetch runner output if it is ready.


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