tvm::VirtualDevice Class Reference

Managed reference class to VirtualDeviceNode. More...

#include <virtual_device.h>

Inheritance diagram for tvm::VirtualDevice:

Collaboration diagram for tvm::VirtualDevice:

Public Member Functions
	VirtualDevice (int device_type_int=kInvalidDeviceType, int virtual_device_id=-1, Target target={}, MemoryScope memory_scope={})
	Construct a virtual device. More...
	TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE (VirtualDevice, ObjectRef, VirtualDeviceNode)

Static Public Member Functions
static VirtualDevice	FullyUnconstrained ()
	Returns the unique fully unconstrained VirtualDevice. More...
static VirtualDevice	ForDeviceType (DLDeviceType device_type, int virtual_device_id=-1)
	Returns the VirtualDevice for device_type and (if not -1) virtual_device_id. The target and memory scope will be unconstrained. More...
static VirtualDevice	ForDeviceType (int device_type, int virtual_device_id=-1)
static VirtualDevice	ForDeviceType (const Integer &device_type, int virtual_device_id=-1)
static VirtualDevice	ForDevice (const Device &device)
	Returns the VirtualDevice for device. More...
static VirtualDevice	ForDeviceAndTarget (const Device &device, Target target)
	Returns the VirtualDevice for device and target. More...
static VirtualDevice	ForTarget (Target target)
	Returns the VirtualDevice for target. More...
static VirtualDevice	ForMemoryScope (MemoryScope memory_scope)
	Returns the VirtualDevice for memory_scope alone. More...
static VirtualDevice	ForDeviceTargetAndMemoryScope (const Device &device, Target target, MemoryScope memory_scope)
	Returns the VirtualDevice for device, target and memory_scope. More...
static ffi::Optional< VirtualDevice >	Join (const VirtualDevice &lhs, const VirtualDevice &rhs)
	Returns the 'join' of lhs and rhs. The result will agree pointwise with lhs and rhs on all their constrained fields. Returns the null optional if no such join exists, ie there's disagreement on at least one constrained field. More...
static VirtualDevice	Default (const VirtualDevice &lhs, const VirtualDevice &rhs)
	Returns the 'default' of lhs and rhs. The result will be lhs, except any unconstrained fields in lhs will take their value from rhs. Always well-defined. More...

Friends
class	VirtualDeviceCache

Detailed Description

Managed reference class to VirtualDeviceNode.

Constructor & Destructor Documentation

VirtualDevice()

tvm::VirtualDevice::VirtualDevice ( int  device_type_int = kInvalidDeviceType, int  virtual_device_id = -1, Target  target = {}, MemoryScope  memory_scope = {}  )

explicit

Construct a virtual device.

Parameters

device_type_int	The device type for the virtual device, or kInvalidDeviceType if unconstrained. If target is defined then must match its target->GetTargetDeviceType().
virtual_device_id	The device id for the virtual device, or -1 if unconstrained.
target	The target describing how to compile for the virtual device, or null if unconstrained.
memory_scope	The memory scope w.r.t. the virtual device which holds data, or "" if unconstrained.

Member Function Documentation

Default()

static VirtualDevice tvm::VirtualDevice::Default ( const VirtualDevice &  lhs, const VirtualDevice &  rhs  )

static

Returns the 'default' of lhs and rhs. The result will be lhs, except any unconstrained fields in lhs will take their value from rhs. Always well-defined.

ForDevice()

static VirtualDevice tvm::VirtualDevice::ForDevice ( const Device &  device )

inlinestatic

Returns the VirtualDevice for device.

ForDeviceAndTarget()

static VirtualDevice tvm::VirtualDevice::ForDeviceAndTarget ( const Device &  device, Target  target  )

inlinestatic

Returns the VirtualDevice for device and target.

ForDeviceTargetAndMemoryScope()

static VirtualDevice tvm::VirtualDevice::ForDeviceTargetAndMemoryScope ( const Device &  device, Target  target, MemoryScope  memory_scope  )

inlinestatic

Returns the VirtualDevice for device, target and memory_scope.

ForDeviceType() [1/3]

static VirtualDevice tvm::VirtualDevice::ForDeviceType ( const Integer &  device_type, int  virtual_device_id = -1  )

inlinestatic

ForDeviceType() [2/3]

static VirtualDevice tvm::VirtualDevice::ForDeviceType ( DLDeviceType  device_type, int  virtual_device_id = -1  )

inlinestatic

Returns the VirtualDevice for device_type and (if not -1) virtual_device_id. The target and memory scope will be unconstrained.

ForDeviceType() [3/3]

static VirtualDevice tvm::VirtualDevice::ForDeviceType ( int  device_type, int  virtual_device_id = -1  )

inlinestatic

ForMemoryScope()

static VirtualDevice tvm::VirtualDevice::ForMemoryScope ( MemoryScope  memory_scope )

inlinestatic

Returns the VirtualDevice for memory_scope alone.

ForTarget()

static VirtualDevice tvm::VirtualDevice::ForTarget ( Target  target )

inlinestatic

Returns the VirtualDevice for target.

FullyUnconstrained()

static VirtualDevice tvm::VirtualDevice::FullyUnconstrained ( )

static

Returns the unique fully unconstrained VirtualDevice.

Join()

static ffi::Optional<VirtualDevice> tvm::VirtualDevice::Join ( const VirtualDevice &  lhs, const VirtualDevice &  rhs  )

static

Returns the 'join' of lhs and rhs. The result will agree pointwise with lhs and rhs on all their constrained fields. Returns the null optional if no such join exists, ie there's disagreement on at least one constrained field.

TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE()

tvm::VirtualDevice::TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE	(	VirtualDevice	,
		ObjectRef	,
		VirtualDeviceNode
	)

Friends And Related Function Documentation

VirtualDeviceCache

friend class VirtualDeviceCache

friend

---

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

• include/tvm/target/virtual_device.h