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

Class representing the settings of a Deep Learning benchmark. More...

Public Member Functions

None __init__ (self)
 Constructor.
None __init__ (self, eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings other)
 Constructor.
None Load (self, str filePath)
 Loads a eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings object.
None Load (self, eVision.ESerializer|None serializer)
 Loads a eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings object.
None Save (self, str filePath)
 Saves the eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings object.
None Save (self, eVision.ESerializer|None serializer)
 Saves the eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings object.

Protected Member Functions

str _Name__getter (self)
 \cond
 _Name__setter (self, str value)
 Name of the benchmark.
str _Engine__getter (self)
 \cond
 _Engine__setter (self, str value)
 Deep Learning engine to use for the benchmark.
eVision.EasyDeepLearning.EDeepLearningDevice _Device__getter (self)
 \cond
 _Device__setter (self, eVision.EasyDeepLearning.EDeepLearningDevice value)
 Device to use for the benchmark.
eVision.EasyDeepLearning.EDeepLearningInferencePrecision _InferencePrecision__getter (self)
 \cond
 _InferencePrecision__setter (self, eVision.EasyDeepLearning.EDeepLearningInferencePrecision value)
 Inference precision to use for the benchmark.
int _NumExternalThreads__getter (self)
 \cond
 _NumExternalThreads__setter (self, int value)
 Number of external threads.
int _NumInternalThreads__getter (self)
 \cond
 _NumInternalThreads__setter (self, int value)
 Number of internal threads.
float _CameraSpeed__getter (self)
 \cond
 _CameraSpeed__setter (self, float value)
 Camera speed to simulate.
int _BatchSize__getter (self)
 \cond
 _BatchSize__setter (self, int value)
 Batch size.
int _NumInferences__getter (self)
 \cond
 _NumInferences__setter (self, int value)
 Number of iterations to use during the benchmark.
bool _InternalResizeDisabled__getter (self)
 \cond
 _InternalResizeDisabled__setter (self, bool value)
 Whether to disable the internal resize operation performed by the Deep Learning tools.
bool _OptimizedBatchSize__getter (self)
 \cond
 _OptimizedBatchSize__setter (self, bool value)
 Whether to enable the auto setup of the batch size.

Properties

 Name = property(_Name__getter, _Name__setter)
 \endcond
 Engine = property(_Engine__getter, _Engine__setter)
 \endcond
 Device = property(_Device__getter, _Device__setter)
 \endcond
 InferencePrecision = property(_InferencePrecision__getter, _InferencePrecision__setter)
 \endcond
 NumExternalThreads = property(_NumExternalThreads__getter, _NumExternalThreads__setter)
 \endcond
 NumInternalThreads = property(_NumInternalThreads__getter, _NumInternalThreads__setter)
 \endcond
 CameraSpeed = property(_CameraSpeed__getter, _CameraSpeed__setter)
 \endcond
 BatchSize = property(_BatchSize__getter, _BatchSize__setter)
 \endcond
 NumInferences = property(_NumInferences__getter, _NumInferences__setter)
 \endcond
 InternalResizeDisabled = property(_InternalResizeDisabled__getter, _InternalResizeDisabled__setter)
 \endcond
 OptimizedBatchSize = property(_OptimizedBatchSize__getter, _OptimizedBatchSize__setter)
 \endcond

Detailed Description

Class representing the settings of a Deep Learning benchmark.

Remarks:

License(s): EasyClassify or EasySegment or EasyLocate

Constructor & Destructor Documentation

◆ __init__() [1/2]

None eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.__init__ ( self)

Constructor.

◆ __init__() [2/2]

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

Constructor.

Parameters
otherThe other eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings that we will copy into this one.

Member Function Documentation

◆ _BatchSize__getter()

int eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._BatchSize__getter ( self)
protected

\cond

Batch size.

◆ _BatchSize__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._BatchSize__setter ( self,
int value )
protected

Batch size.

◆ _CameraSpeed__getter()

float eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._CameraSpeed__getter ( self)
protected

\cond

Camera speed to simulate. If equal to 0, the benchmark will produce images as fast as possible.

Remarks:

Camera speed higher than 500 frame per seconds will lead to unreliable results.

◆ _CameraSpeed__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._CameraSpeed__setter ( self,
float value )
protected

Camera speed to simulate.

If equal to 0, the benchmark will produce images as fast as possible.

Remarks:

Camera speed higher than 500 frame per seconds will lead to unreliable results.

◆ _Device__getter()

eVision.EasyDeepLearning.EDeepLearningDevice eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._Device__getter ( self)
protected

\cond

Device to use for the benchmark.

◆ _Device__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._Device__setter ( self,
eVision.EasyDeepLearning.EDeepLearningDevice value )
protected

Device to use for the benchmark.

◆ _Engine__getter()

str eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._Engine__getter ( self)
protected

\cond

Deep Learning engine to use for the benchmark.

◆ _Engine__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._Engine__setter ( self,
str value )
protected

Deep Learning engine to use for the benchmark.

◆ _InferencePrecision__getter()

eVision.EasyDeepLearning.EDeepLearningInferencePrecision eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._InferencePrecision__getter ( self)
protected

\cond

Inference precision to use for the benchmark.

◆ _InferencePrecision__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._InferencePrecision__setter ( self,
eVision.EasyDeepLearning.EDeepLearningInferencePrecision value )
protected

Inference precision to use for the benchmark.

◆ _InternalResizeDisabled__getter()

bool eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._InternalResizeDisabled__getter ( self)
protected

\cond

Whether to disable the internal resize operation performed by the Deep Learning tools. When disabled, the benchmark will generate images at the optimal size for the tool.

◆ _InternalResizeDisabled__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._InternalResizeDisabled__setter ( self,
bool value )
protected

Whether to disable the internal resize operation performed by the Deep Learning tools.

When disabled, the benchmark will generate images at the optimal size for the tool.

◆ _Name__getter()

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

\cond

Name of the benchmark.

◆ _Name__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._Name__setter ( self,
str value )
protected

Name of the benchmark.

◆ _NumExternalThreads__getter()

int eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._NumExternalThreads__getter ( self)
protected

\cond

Number of external threads.

◆ _NumExternalThreads__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._NumExternalThreads__setter ( self,
int value )
protected

Number of external threads.

◆ _NumInferences__getter()

int eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._NumInferences__getter ( self)
protected

\cond

Number of iterations to use during the benchmark.

◆ _NumInferences__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._NumInferences__setter ( self,
int value )
protected

Number of iterations to use during the benchmark.

◆ _NumInternalThreads__getter()

int eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._NumInternalThreads__getter ( self)
protected

\cond

Number of internal threads.

◆ _NumInternalThreads__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._NumInternalThreads__setter ( self,
int value )
protected

Number of internal threads.

◆ _OptimizedBatchSize__getter()

bool eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._OptimizedBatchSize__getter ( self)
protected

\cond

Whether to enable the auto setup of the batch size.

◆ _OptimizedBatchSize__setter()

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings._OptimizedBatchSize__setter ( self,
bool value )
protected

Whether to enable the auto setup of the batch size.

◆ Load() [1/2]

None eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.Load ( self,
eVision.ESerializer | None serializer )

Loads a eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings object.

The given eVision.ESerializer must have been created for reading.

Parameters
serializerPointer to the eVision.ESerializer created for reading.

◆ Load() [2/2]

None eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.Load ( self,
str filePath )

Loads a eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings object.

The given eVision.ESerializer must have been created for reading.

Parameters
filePathFile path.

◆ Save() [1/2]

None eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.Save ( self,
eVision.ESerializer | None serializer )

Saves the eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings object.

The given eVision.ESerializer must have been created for writing.

Parameters
serializerPointer to the eVision.ESerializer created for writing.

◆ Save() [2/2]

None eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.Save ( self,
str filePath )

Saves the eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings object.

The given eVision.ESerializer must have been created for writing.

Parameters
filePathFile path.

Property Documentation

◆ BatchSize

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.BatchSize = property(_BatchSize__getter, _BatchSize__setter)
static

\endcond

Batch size.

◆ CameraSpeed

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.CameraSpeed = property(_CameraSpeed__getter, _CameraSpeed__setter)
static

\endcond

Camera speed to simulate. If equal to 0, the benchmark will produce images as fast as possible.

Remarks:

Camera speed higher than 500 frame per seconds will lead to unreliable results.

◆ Device

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.Device = property(_Device__getter, _Device__setter)
static

\endcond

Device to use for the benchmark.

◆ Engine

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.Engine = property(_Engine__getter, _Engine__setter)
static

\endcond

Deep Learning engine to use for the benchmark.

◆ InferencePrecision

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.InferencePrecision = property(_InferencePrecision__getter, _InferencePrecision__setter)
static

\endcond

Inference precision to use for the benchmark.

◆ InternalResizeDisabled

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.InternalResizeDisabled = property(_InternalResizeDisabled__getter, _InternalResizeDisabled__setter)
static

\endcond

Whether to disable the internal resize operation performed by the Deep Learning tools. When disabled, the benchmark will generate images at the optimal size for the tool.

◆ Name

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.Name = property(_Name__getter, _Name__setter)
static

\endcond

Name of the benchmark.

◆ NumExternalThreads

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.NumExternalThreads = property(_NumExternalThreads__getter, _NumExternalThreads__setter)
static

\endcond

Number of external threads.

◆ NumInferences

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.NumInferences = property(_NumInferences__getter, _NumInferences__setter)
static

\endcond

Number of iterations to use during the benchmark.

◆ NumInternalThreads

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.NumInternalThreads = property(_NumInternalThreads__getter, _NumInternalThreads__setter)
static

\endcond

Number of internal threads.

◆ OptimizedBatchSize

eVision.EasyDeepLearning.EDeepLearningBenchmarkSettings.OptimizedBatchSize = property(_OptimizedBatchSize__getter, _OptimizedBatchSize__setter)
static

\endcond

Whether to enable the auto setup of the batch size.