tvm
Public Member Functions | Static Public Attributes | List of all members
tvm::meta_schedule::DatabaseNode Class Referenceabstract

#include <database.h>

Inheritance diagram for tvm::meta_schedule::DatabaseNode:
Collaboration diagram for tvm::meta_schedule::DatabaseNode:

Public Member Functions

 DatabaseNode (String mod_eq_name="structural")
 Constructor. More...
 
virtual ~DatabaseNode ()
 Default destructor. More...
 
virtual bool HasWorkload (const IRModule &mod)=0
 Check if the database has the given workload. More...
 
virtual Workload CommitWorkload (const IRModule &mod)=0
 Look up or add workload to the database if missing. More...
 
virtual void CommitTuningRecord (const TuningRecord &record)=0
 Add a tuning record to the database. More...
 
virtual Array< TuningRecordGetTopK (const Workload &workload, int top_k)=0
 Get the top K valid tuning records of given workload from the database. More...
 
virtual Array< TuningRecordGetAllTuningRecords ()=0
 Get all tuning records from the database. More...
 
virtual int64_t Size ()=0
 Get the size of the database. More...
 
virtual Optional< TuningRecordQueryTuningRecord (const IRModule &mod, const Target &target, const String &workload_name)
 Query the best record of the given workload from the database. More...
 
virtual Optional< tir::ScheduleQuerySchedule (const IRModule &mod, const Target &target, const String &workload_name)
 Query the best schedule of the given workload from the database. More...
 
virtual Optional< IRModuleQueryIRModule (const IRModule &mod, const Target &target, const String &workload_name)
 Query the best IRModule of the given workload from the database. More...
 
void DumpPruned (Database destination)
 Prune the database and dump it a given database. More...
 
const ModuleEquality & GetModuleEquality () const
 Return a reference to the owned module equality method instance. More...
 
 TVM_DECLARE_BASE_OBJECT_INFO (DatabaseNode, runtime::Object)
 

Static Public Attributes

static constexpr const char * _type_key = "meta_schedule.Database"
 

Constructor & Destructor Documentation

◆ DatabaseNode()

tvm::meta_schedule::DatabaseNode::DatabaseNode ( String  mod_eq_name = "structural")
explicit

Constructor.

Parameters
mod_eq_nameA string to specify the module equality testing and hashing method. It must be one of the followings:
  • "structural": Use StructuralEqual/Hash
  • "ignore-ndarray": Same as "structural", but ignore ndarray raw data during equality testing and hashing.
  • "anchor-block": Apply equality testing and hashing on the anchor block extracted from a given module. The "ignore-ndarray" varint is used for the extracted blocks or in case no anchor block is found. For the definition of the anchor block, see tvm/tir/analysis.h.

◆ ~DatabaseNode()

virtual tvm::meta_schedule::DatabaseNode::~DatabaseNode ( )
virtual

Default destructor.

Member Function Documentation

◆ CommitTuningRecord()

virtual void tvm::meta_schedule::DatabaseNode::CommitTuningRecord ( const TuningRecord record)
pure virtual

Add a tuning record to the database.

Parameters
recordThe tuning record to be added.

Implemented in tvm::meta_schedule::PyDatabaseNode.

◆ CommitWorkload()

virtual Workload tvm::meta_schedule::DatabaseNode::CommitWorkload ( const IRModule mod)
pure virtual

Look up or add workload to the database if missing.

Parameters
modThe IRModule to be searched for or added.
Returns
The workload corresponding to the given IRModule.

Implemented in tvm::meta_schedule::PyDatabaseNode.

◆ DumpPruned()

void tvm::meta_schedule::DatabaseNode::DumpPruned ( Database  destination)

Prune the database and dump it a given database.

Parameters
destinationThe destination database to be dumped to.

◆ GetAllTuningRecords()

virtual Array<TuningRecord> tvm::meta_schedule::DatabaseNode::GetAllTuningRecords ( )
pure virtual

Get all tuning records from the database.

Returns
An Array of all the tuning records in the database.

Implemented in tvm::meta_schedule::PyDatabaseNode.

◆ GetModuleEquality()

const ModuleEquality& tvm::meta_schedule::DatabaseNode::GetModuleEquality ( ) const
inline

Return a reference to the owned module equality method instance.

◆ GetTopK()

virtual Array<TuningRecord> tvm::meta_schedule::DatabaseNode::GetTopK ( const Workload workload,
int  top_k 
)
pure virtual

Get the top K valid tuning records of given workload from the database.

Parameters
workloadThe workload to be searched for.
top_kThe number of top records to be returned.
Returns
An array of top K tuning records for the given workload.

Implemented in tvm::meta_schedule::PyDatabaseNode.

◆ HasWorkload()

virtual bool tvm::meta_schedule::DatabaseNode::HasWorkload ( const IRModule mod)
pure virtual

Check if the database has the given workload.

Parameters
modThe IRModule to be searched for.
Returns
Whether the database has the given workload.

Implemented in tvm::meta_schedule::PyDatabaseNode.

◆ QueryIRModule()

virtual Optional<IRModule> tvm::meta_schedule::DatabaseNode::QueryIRModule ( const IRModule mod,
const Target target,
const String &  workload_name 
)
virtual

Query the best IRModule of the given workload from the database.

Parameters
modThe IRModule to be searched for.
targetThe target to be searched for.
workload_nameThe name of the workload to be searched for.
Returns
The IRModule in the best IRModule of the given workload; std::nullopt if not found.

Reimplemented in tvm::meta_schedule::PyDatabaseNode.

◆ QuerySchedule()

virtual Optional<tir::Schedule> tvm::meta_schedule::DatabaseNode::QuerySchedule ( const IRModule mod,
const Target target,
const String &  workload_name 
)
virtual

Query the best schedule of the given workload from the database.

Parameters
modThe IRModule to be searched for.
targetThe target to be searched for.
workload_nameThe name of the workload to be searched for.
Returns
The schedule in the best schedule of the given workload; std::nullopt if not found.

Reimplemented in tvm::meta_schedule::PyDatabaseNode.

◆ QueryTuningRecord()

virtual Optional<TuningRecord> tvm::meta_schedule::DatabaseNode::QueryTuningRecord ( const IRModule mod,
const Target target,
const String &  workload_name 
)
virtual

Query the best record of the given workload from the database.

Parameters
modThe IRModule to be searched for.
targetThe target to be searched for.
workload_nameThe name of the workload to be searched for.
Returns
The best record of the given workload; std::nullopt if not found.

Reimplemented in tvm::meta_schedule::PyDatabaseNode.

◆ Size()

virtual int64_t tvm::meta_schedule::DatabaseNode::Size ( )
pure virtual

Get the size of the database.

Returns
The size of the database.

Implemented in tvm::meta_schedule::PyDatabaseNode.

◆ TVM_DECLARE_BASE_OBJECT_INFO()

tvm::meta_schedule::DatabaseNode::TVM_DECLARE_BASE_OBJECT_INFO ( DatabaseNode  ,
runtime::Object   
)

Member Data Documentation

◆ _type_key

constexpr const char* tvm::meta_schedule::DatabaseNode::_type_key = "meta_schedule.Database"
staticconstexpr

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