tvm
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Friends | List of all members
tvm::Target Class Reference

Managed reference class to TargetObj. More...

#include <target.h>

Inheritance diagram for tvm::Target:
Collaboration diagram for tvm::Target:

Public Member Functions

TVM_TIRX_DLL Target (const ffi::String &tag_or_config_or_target_str)
 Construct a Target given a string.
 
TVM_TIRX_DLL Target (const ffi::Map< ffi::String, ffi::Any > &config)
 Construct a Target using a JSON-like configuration.
 
TVM_TIRX_DLL Target (Target target, ffi::Optional< Target > host)
 Construct a Target given target and host.
 
 Target (ffi::UnsafeInit tag, ffi::ObjectPtr< TargetObj > n)
 
 TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE (Target, ffi::ObjectRef, TargetObj)
 
Target WithoutHost () const
 

Static Public Member Functions

static TVM_TIRX_DLL ffi::Optional< Target > Current (bool allow_not_defined=true)
 Get the current target context from thread local storage.
 
static Target WithHost (const Target &target, const ffi::Optional< Target > &host)
 

Friends

class TargetInternal
 
class With< Target >
 

Detailed Description

Managed reference class to TargetObj.

See also
TargetObj

Constructor & Destructor Documentation

◆ Target() [1/4]

TVM_TIRX_DLL tvm::Target::Target ( const ffi::String &  tag_or_config_or_target_str)
explicit

Construct a Target given a string.

Parameters
tag_or_config_or_target_strthe string to parse for target

◆ Target() [2/4]

TVM_TIRX_DLL tvm::Target::Target ( const ffi::Map< ffi::String, ffi::Any > &  config)
explicit

Construct a Target using a JSON-like configuration.

Parameters
configThe JSON-like configuration for target

◆ Target() [3/4]

TVM_TIRX_DLL tvm::Target::Target ( Target  target,
ffi::Optional< Target >  host 
)
explicit

Construct a Target given target and host.

Parameters
targetThe Target typed object with host field undefined for target
hostThe Target typed object for target host

◆ Target() [4/4]

tvm::Target::Target ( ffi::UnsafeInit  tag,
ffi::ObjectPtr< TargetObj >  n 
)
inlineexplicit

Member Function Documentation

◆ Current()

static TVM_TIRX_DLL ffi::Optional< Target > tvm::Target::Current ( bool  allow_not_defined = true)
static

Get the current target context from thread local storage.

Parameters
allow_not_definedIf the context stack is empty and this is set to true, std::nullopt will be returned. Otherwise, an empty context stack will cause a runtime error.
Returns
The target that is the current context. The result may be absent if allow_not_defined is true.

◆ TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE()

tvm::Target::TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE ( Target  ,
ffi::ObjectRef  ,
TargetObj   
)

◆ WithHost()

static Target tvm::Target::WithHost ( const Target &  target,
const ffi::Optional< Target > &  host 
)
static

◆ WithoutHost()

Target tvm::Target::WithoutHost ( ) const
Returns
The target with the host stripped out

Friends And Related Symbol Documentation

◆ TargetInternal

friend class TargetInternal
friend

◆ With< Target >

friend class With< Target >
friend

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