eVision::EasyDeepLearning::EDeepLearningDevice Class Reference

Class representing a device that can run a neural network. A device is fully described by its EDeepLearningDevice::GetName and EDeepLearningDevice::GetEngineName. More...

#include <eVision/Easy/EasyDeepLearning/EDeepLearningDevice.h>

Collaboration diagram for eVision::EasyDeepLearning::EDeepLearningDevice:

Public Member Functions
	EDeepLearningDevice ()
	Default constructor. The resulting device will be invalid.
	EDeepLearningDevice (const eVision::EasyDeepLearning::EDeepLearningDevice &other)
	Copy constructor.
virtual	~EDeepLearningDevice () throw ()
eVision::EasyDeepLearning::EDeepLearningDevice &	operator= (const eVision::EasyDeepLearning::EDeepLearningDevice &other)
	Copy operator.
bool	operator== (const eVision::EasyDeepLearning::EDeepLearningDevice &other) const
	Equality operator.
bool	operator!= (const eVision::EasyDeepLearning::EDeepLearningDevice &other) const
	Inequality operator.
std::string	GetName () const
	Name of the device.
std::string	GetFullName () const
	A full name of the device.
std::string	GetEngineName () const
	The name of the engine supporting this device.
eVision::EasyDeepLearning::EDeepLearningDeviceType	GetDeviceType () const
	The device type.
std::string	GetDeviceTypeDescription () const
	Textual description of the device type.
int	GetDeviceId () const
	A device index corresponding to the index of the device within the engine.
bool	HasTrainingCapability () const
	Whether the device can perform training or not.
bool	HasInferenceCapability () const
	Whether the device can perform inference or not.
std::vector< eVision::EasyDeepLearning::EDeepLearningInferencePrecision >	GetSupportedPrecisions () const
	Precisions supported by the device.
eVision::EasyDeepLearning::EDeepLearningInferencePrecision	GetDefaultPrecision () const
	Default precision for this device. If supported by the device, the default precision will be FLOAT32.
bool	IsPrecisionSupported (eVision::EasyDeepLearning::EDeepLearningInferencePrecision precision) const
	Whether the given precision is supported by the device or not.
bool	IsValid () const
	Whether this instance represents a usable device or not.
	EDeepLearningDevice (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Class representing a device that can run a neural network. A device is fully described by its EDeepLearningDevice::GetName and EDeepLearningDevice::GetEngineName.

The other properties are information about the device and its capabilities.

License(s): BasicTypes

Constructor & Destructor Documentation

EDeepLearningDevice() [1/3]

eVision::EasyDeepLearning::EDeepLearningDevice::EDeepLearningDevice

(

)

Default constructor. The resulting device will be invalid.

EDeepLearningDevice() [2/3]

eVision::EasyDeepLearning::EDeepLearningDevice::EDeepLearningDevice

(

const eVision::EasyDeepLearning::EDeepLearningDevice &

other

)

Copy constructor.

Parameters

other

Device to copy

~EDeepLearningDevice()

eVision::EasyDeepLearning::EDeepLearningDevice::~EDeepLearningDevice ( ) throw (  )

virtual

EDeepLearningDevice() [3/3]

eVision::EasyDeepLearning::EDeepLearningDevice::EDeepLearningDevice

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

GetDefaultPrecision()

eVision::EasyDeepLearning::EDeepLearningInferencePrecision eVision::EasyDeepLearning::EDeepLearningDevice::GetDefaultPrecision

(

)

const

Default precision for this device. If supported by the device, the default precision will be FLOAT32.

GetDeviceId()

int eVision::EasyDeepLearning::EDeepLearningDevice::GetDeviceId

(

)

const

A device index corresponding to the index of the device within the engine.

With the default engine, the device index is the index of the NVIDIA GPU for example.

GetDeviceType()

eVision::EasyDeepLearning::EDeepLearningDeviceType eVision::EasyDeepLearning::EDeepLearningDevice::GetDeviceType

(

)

const

The device type.

GetDeviceTypeDescription()

std::string eVision::EasyDeepLearning::EDeepLearningDevice::GetDeviceTypeDescription

(

)

const

Textual description of the device type.

GetEngineName()

std::string eVision::EasyDeepLearning::EDeepLearningDevice::GetEngineName

(

)

const

The name of the engine supporting this device.

GetFullName()

std::string eVision::EasyDeepLearning::EDeepLearningDevice::GetFullName

(

)

const

A full name of the device.

GetName()

std::string eVision::EasyDeepLearning::EDeepLearningDevice::GetName

(

)

const

Name of the device.

GetSupportedPrecisions()

std::vector< eVision::EasyDeepLearning::EDeepLearningInferencePrecision > eVision::EasyDeepLearning::EDeepLearningDevice::GetSupportedPrecisions

(

)

const

Precisions supported by the device.

HasInferenceCapability()

bool eVision::EasyDeepLearning::EDeepLearningDevice::HasInferenceCapability

(

)

const

Whether the device can perform inference or not.

HasTrainingCapability()

bool eVision::EasyDeepLearning::EDeepLearningDevice::HasTrainingCapability

(

)

const

Whether the device can perform training or not.

IsPrecisionSupported()

bool eVision::EasyDeepLearning::EDeepLearningDevice::IsPrecisionSupported

(

eVision::EasyDeepLearning::EDeepLearningInferencePrecision

precision

)

const

Whether the given precision is supported by the device or not.

Parameters

precision

Precision to check

IsValid()

bool eVision::EasyDeepLearning::EDeepLearningDevice::IsValid

(

)

const

Whether this instance represents a usable device or not.

operator!=()

bool eVision::EasyDeepLearning::EDeepLearningDevice::operator!=

(

const eVision::EasyDeepLearning::EDeepLearningDevice &

other

)

const

Inequality operator.

Parameters

other

Device to compare with

operator=()

eVision::EasyDeepLearning::EDeepLearningDevice & eVision::EasyDeepLearning::EDeepLearningDevice::operator=

(

const eVision::EasyDeepLearning::EDeepLearningDevice &

other

)

Copy operator.

Parameters

other

Device to copy

operator==()

bool eVision::EasyDeepLearning::EDeepLearningDevice::operator==

(

const eVision::EasyDeepLearning::EDeepLearningDevice &

other

)

const

Equality operator.

Parameters

other

Device to compare with

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::EasyDeepLearning::EDeepLearningDevice::wrappedClass_