eVision Python API
Loading...
Searching...
No Matches
eVision.EasyDeepLearning.EDeepLearningDevice Class Reference

Class representing a device that can run a neural network. More...

Public Member Functions

None __init__ (self)
 Default constructor.
None __init__ (self, eVision.EasyDeepLearning.EDeepLearningDevice other)
 Copy constructor.
bool HasTrainingCapability (self)
 Whether the device can perform training or not.
bool HasInferenceCapability (self)
 Whether the device can perform inference or not.
bool IsPrecisionSupported (self, eVision.EasyDeepLearning.EDeepLearningInferencePrecision precision)
 Whether the given precision is supported by the device or not.
bool IsValid (self)
 Whether this instance represents a usable device or not.

Protected Member Functions

str _Name__getter (self)
 \cond
str _FullName__getter (self)
 \cond
str _EngineName__getter (self)
 \cond
eVision.EasyDeepLearning.EDeepLearningDeviceType _DeviceType__getter (self)
 \cond
str _DeviceTypeDescription__getter (self)
 \cond
int _DeviceId__getter (self)
 \cond
list[eVision._eVision.EasyDeepLearning.EDeepLearningInferencePrecision] _SupportedPrecisions__getter (self)
 \cond
eVision.EasyDeepLearning.EDeepLearningInferencePrecision _DefaultPrecision__getter (self)
 \cond

Properties

 Name = property(_Name__getter, None)
 \endcond
 FullName = property(_FullName__getter, None)
 \endcond
 EngineName = property(_EngineName__getter, None)
 \endcond
 DeviceType = property(_DeviceType__getter, None)
 \endcond
 DeviceTypeDescription = property(_DeviceTypeDescription__getter, None)
 \endcond
 DeviceId = property(_DeviceId__getter, None)
 \endcond
 SupportedPrecisions = property(_SupportedPrecisions__getter, None)
 \endcond
 DefaultPrecision = property(_DefaultPrecision__getter, None)
 \endcond

Detailed Description

Class representing a device that can run a neural network.

A device is fully described by its eVision.EasyDeepLearning.EDeepLearningDevice.Name and eVision.EasyDeepLearning.EDeepLearningDevice.EngineName.

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

Remarks:

License(s): BasicTypes

Constructor & Destructor Documentation

◆ __init__() [1/2]

None eVision.EasyDeepLearning.EDeepLearningDevice.__init__ ( self)

Default constructor.

The resulting device will be invalid.

◆ __init__() [2/2]

None eVision.EasyDeepLearning.EDeepLearningDevice.__init__ ( self,
eVision.EasyDeepLearning.EDeepLearningDevice other )

Copy constructor.

Parameters
otherDevice to copy

Member Function Documentation

◆ _DefaultPrecision__getter()

eVision.EasyDeepLearning.EDeepLearningInferencePrecision eVision.EasyDeepLearning.EDeepLearningDevice._DefaultPrecision__getter ( self)
protected

\cond

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

◆ _DeviceId__getter()

int eVision.EasyDeepLearning.EDeepLearningDevice._DeviceId__getter ( self)
protected

\cond

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.

◆ _DeviceType__getter()

eVision.EasyDeepLearning.EDeepLearningDeviceType eVision.EasyDeepLearning.EDeepLearningDevice._DeviceType__getter ( self)
protected

\cond

The device type.

◆ _DeviceTypeDescription__getter()

str eVision.EasyDeepLearning.EDeepLearningDevice._DeviceTypeDescription__getter ( self)
protected

\cond

Textual description of the device type.

◆ _EngineName__getter()

str eVision.EasyDeepLearning.EDeepLearningDevice._EngineName__getter ( self)
protected

\cond

The name of the engine supporting this device.

◆ _FullName__getter()

str eVision.EasyDeepLearning.EDeepLearningDevice._FullName__getter ( self)
protected

\cond

A full name of the device.

◆ _Name__getter()

str eVision.EasyDeepLearning.EDeepLearningDevice._Name__getter ( self)
protected

\cond

Name of the device.

◆ _SupportedPrecisions__getter()

list[eVision._eVision.EasyDeepLearning.EDeepLearningInferencePrecision] eVision.EasyDeepLearning.EDeepLearningDevice._SupportedPrecisions__getter ( self)
protected

\cond

Precisions supported by the device.

◆ HasInferenceCapability()

bool eVision.EasyDeepLearning.EDeepLearningDevice.HasInferenceCapability ( self)

Whether the device can perform inference or not.

◆ HasTrainingCapability()

bool eVision.EasyDeepLearning.EDeepLearningDevice.HasTrainingCapability ( self)

Whether the device can perform training or not.

◆ IsPrecisionSupported()

bool eVision.EasyDeepLearning.EDeepLearningDevice.IsPrecisionSupported ( self,
eVision.EasyDeepLearning.EDeepLearningInferencePrecision precision )

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

Parameters
precisionPrecision to check

◆ IsValid()

bool eVision.EasyDeepLearning.EDeepLearningDevice.IsValid ( self)

Whether this instance represents a usable device or not.

Property Documentation

◆ DefaultPrecision

eVision.EasyDeepLearning.EDeepLearningDevice.DefaultPrecision = property(_DefaultPrecision__getter, None)
static

\endcond

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

◆ DeviceId

eVision.EasyDeepLearning.EDeepLearningDevice.DeviceId = property(_DeviceId__getter, None)
static

\endcond

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.

◆ DeviceType

eVision.EasyDeepLearning.EDeepLearningDevice.DeviceType = property(_DeviceType__getter, None)
static

\endcond

The device type.

◆ DeviceTypeDescription

eVision.EasyDeepLearning.EDeepLearningDevice.DeviceTypeDescription = property(_DeviceTypeDescription__getter, None)
static

\endcond

Textual description of the device type.

◆ EngineName

eVision.EasyDeepLearning.EDeepLearningDevice.EngineName = property(_EngineName__getter, None)
static

\endcond

The name of the engine supporting this device.

◆ FullName

eVision.EasyDeepLearning.EDeepLearningDevice.FullName = property(_FullName__getter, None)
static

\endcond

A full name of the device.

◆ Name

eVision.EasyDeepLearning.EDeepLearningDevice.Name = property(_Name__getter, None)
static

\endcond

Name of the device.

◆ SupportedPrecisions

eVision.EasyDeepLearning.EDeepLearningDevice.SupportedPrecisions = property(_SupportedPrecisions__getter, None)
static

\endcond

Precisions supported by the device.