Compilation target. More...

#include <target.h>

Inheritance diagram for tvm::TargetNode:

Collaboration diagram for tvm::TargetNode:

Public Member Functions
const std::string &	str () const
	The raw string representation of the target. More...

Map< String, ObjectRef >	Export () const

Optional< Target >	GetHost () const

int	GetTargetDeviceType () const

bool	HasKey (const std::string &query_key) const
	Check if the target contains a key. More...

String	ToDebugString () const
	Returns a human readable representation of `Target` which includes all fields, especially the host. Useful for diagnostic messages and debugging. More...

void	VisitAttrs (AttrVisitor *v)

template<typename TObjectRef >
Optional< TObjectRef >	GetAttr (const std::string &attr_key, Optional< TObjectRef > default_value=Optional< TObjectRef >(nullptr)) const
	Get an entry from attrs of the target. More...

template<typename TObjectRef >
Optional< TObjectRef >	GetAttr (const std::string &attr_key, TObjectRef default_value) const
	Get an entry from attrs of the target. More...

template<typename TObjectRef >
Optional< TObjectRef >	GetFeature (const std::string &feature_key, Optional< TObjectRef > default_value=Optional< TObjectRef >(nullptr)) const
	Get a Target feature. More...

template<typename TObjectRef >
Optional< TObjectRef >	GetFeature (const std::string &attr_key, TObjectRef default_value) const

std::vector< std::string >	GetKeys () const
	Get the keys for this target as a vector of string. More...

std::unordered_set< std::string >	GetLibs () const
	Get the keys for this target as an unordered_set of string. More...

bool	SEqualReduce (const TargetNode *other, SEqualReducer equal) const

void	SHashReduce (SHashReducer hash_reduce) const

	TVM_DECLARE_FINAL_OBJECT_INFO (TargetNode, 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
TargetKind	kind
	The kind of the target device. More...

Optional< ObjectRef >	host
	Target host information, must be Target type. More...

String	tag
	Tag of the target, can be empty. More...

Array< String >	keys
	Keys for this target. More...

Map< String, ObjectRef >	attrs
	Collection of attributes. More...

Map< String, ObjectRef >	features
	Target features. More...

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

static constexpr const bool	_type_has_method_sequal_reduce = true

static constexpr const bool	_type_has_method_shash_reduce = true

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

Friends
class	TargetInternal

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

Compilation target.

See also: Target

Member Function Documentation

◆ Export()

Map<String, ObjectRef> tvm::TargetNode::Export ( ) const

Returns: Export target to JSON-like configuration

◆ GetAttr() [1/2]

template<typename TObjectRef >

Optional<TObjectRef> tvm::TargetNode::GetAttr	(	const std::string &	attr_key,
		Optional< TObjectRef >	default_value = `Optional<TObjectRef>(nullptr)`
	)		const

inline

Get an entry from attrs of the target.

Template Parameters

TObjectRef Type of the attribute

Parameters

attr_key	The name of the attribute key
default_value	The value returned if the key is not present

Returns: An optional, NullOpt if not found, otherwise the value found

◆ GetAttr() [2/2]

template<typename TObjectRef >

Optional<TObjectRef> tvm::TargetNode::GetAttr	(	const std::string &	attr_key,
		TObjectRef	default_value
	)		const

inline

Get an entry from attrs of the target.

Template Parameters

TObjectRef Type of the attribute

Parameters

attr_key	The name of the attribute key
default_value	The value returned if the key is not present

Returns: An optional, NullOpt if not found, otherwise the value found

◆ GetFeature() [1/2]

template<typename TObjectRef >

Optional<TObjectRef> tvm::TargetNode::GetFeature	(	const std::string &	attr_key,
		TObjectRef	default_value
	)		const

inline

◆ GetFeature() [2/2]

template<typename TObjectRef >

Optional<TObjectRef> tvm::TargetNode::GetFeature	(	const std::string &	feature_key,
		Optional< TObjectRef >	default_value = `Optional<TObjectRef>(nullptr)`
	)		const

inline

Get a Target feature.

Parameters

feature_key	The feature key.
default_value	The default value if the key does not exist, defaults to nullptr.

Returns: The result

Template Parameters

TOBjectRef the expected object type.

Exceptions

Error if the key exists but the value does not match TObjectRef

void GetTargetFeature(const Target& target) {
  Bool has_feature = target->GetFeature<Bool>("has_feature", false).value();
}

◆ GetHost()

Optional<Target> tvm::TargetNode::GetHost ( ) const

Returns: The Optional<Target> typed target host of the TargetNode

◆ GetKeys()

std::vector<std::string> tvm::TargetNode::GetKeys ( ) const

Get the keys for this target as a vector of string.

◆ GetLibs()

std::unordered_set<std::string> tvm::TargetNode::GetLibs ( ) const

Get the keys for this target as an unordered_set of string.

◆ GetTargetDeviceType()

int tvm::TargetNode::GetTargetDeviceType ( ) const

Returns: The device type for this target

◆ HasKey()

bool tvm::TargetNode::HasKey ( const std::string & query_key ) const

Check if the target contains a key.

Parameters

query_key The string name of the key to be checked

Returns: True if the target's TargetNode::keys contains the specified key, False otherwise.

◆ SEqualReduce()

bool tvm::TargetNode::SEqualReduce	(	const TargetNode *	other,
		SEqualReducer	equal
	)		const

◆ SHashReduce()

void tvm::TargetNode::SHashReduce ( SHashReducer hash_reduce ) const

◆ str()

const std::string& tvm::TargetNode::str ( ) const

The raw string representation of the target.

Returns: the full device string to pass to codegen::Build

Note: It will be deprecated after the Target RFC is fully landed.

◆ ToDebugString()

String tvm::TargetNode::ToDebugString ( ) const

Returns a human readable representation of Target which includes all fields, especially the host. Useful for diagnostic messages and debugging.

TODO(mbs): The ReprPrinter version should perhaps switch to this form, however currently code depends on str() and << being the same.

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::TargetNode::TVM_DECLARE_FINAL_OBJECT_INFO	(	TargetNode	,
		Object
	)

◆ VisitAttrs()

void tvm::TargetNode::VisitAttrs ( AttrVisitor * v )

inline

Friends And Related Function Documentation

◆ TargetInternal

friend class TargetInternal

friend

Member Data Documentation

◆ _type_has_method_sequal_reduce

constexpr const bool tvm::TargetNode::_type_has_method_sequal_reduce = true

staticconstexpr

◆ _type_has_method_shash_reduce

constexpr const bool tvm::TargetNode::_type_has_method_shash_reduce = true

staticconstexpr

◆ _type_key

constexpr const char* tvm::TargetNode::_type_key = "Target"

staticconstexpr

◆ attrs

Map<String, ObjectRef> tvm::TargetNode::attrs

Collection of attributes.

◆ features

Map<String, ObjectRef> tvm::TargetNode::features

Target features.

◆ host

Optional<ObjectRef> tvm::TargetNode::host

Target host information, must be Target type.

◆ keys

Array<String> tvm::TargetNode::keys

Keys for this target.

◆ kind

TargetKind tvm::TargetNode::kind

The kind of the target device.

◆ tag

String tvm::TargetNode::tag

Tag of the target, can be empty.

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

include/tvm/target/target.h

Public Member Functions

Public Attributes

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Export()

◆ GetAttr() [1/2]

◆ GetAttr() [2/2]

◆ GetFeature() [1/2]

◆ GetFeature() [2/2]

◆ GetHost()

◆ GetKeys()

◆ GetLibs()

◆ GetTargetDeviceType()

◆ HasKey()

◆ SEqualReduce()

◆ SHashReduce()

◆ str()

◆ ToDebugString()

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

◆ VisitAttrs()

Friends And Related Function Documentation

◆ TargetInternal

Member Data Documentation

◆ _type_has_method_sequal_reduce

◆ _type_has_method_shash_reduce

◆ _type_key

◆ attrs

◆ features

◆ host

◆ keys

◆ kind

◆ tag