eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings Class Reference

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

#include <eVision/EasyDeepLearning/EDeepLearningBenchmarkSettings.h>

Collaboration diagram for eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings:

Public Member Functions

 EDeepLearningBenchmarkSettings ()
 Constructor.
 EDeepLearningBenchmarkSettings (const eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings &other)
 Constructor.
virtual ~EDeepLearningBenchmarkSettings () throw ()
eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings & operator= (const eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings &other)
 Assignment operator.
virtual void Load (const std::string &filePath)
 Loads a EDeepLearningBenchmarkSettings object. The given ESerializer must have been created for reading.
virtual void Load (eVision::ESerializer *serializer)
 Loads a EDeepLearningBenchmarkSettings object. The given ESerializer must have been created for reading.
virtual void Save (const std::string &filePath)
 Saves the EDeepLearningBenchmarkSettings object. The given ESerializer must have been created for writing.
virtual void Save (eVision::ESerializer *serializer)
 Saves the EDeepLearningBenchmarkSettings object. The given ESerializer must have been created for writing.
std::string GetName () const
 Name of the benchmark.
void SetName (const std::string &benchName)
 Name of the benchmark.
std::string GetEngine () const
 Deep Learning engine to use for the benchmark.
void SetEngine (const std::string &engine)
 Deep Learning engine to use for the benchmark.
eVision::EasyDeepLearning::EDeepLearningDevice GetDevice () const
 Device to use for the benchmark.
void SetDevice (const eVision::EasyDeepLearning::EDeepLearningDevice &dev)
 Device to use for the benchmark.
eVision::EasyDeepLearning::EDeepLearningInferencePrecision GetInferencePrecision () const
 Inference precision to use for the benchmark.
void SetInferencePrecision (eVision::EasyDeepLearning::EDeepLearningInferencePrecision prec)
 Inference precision to use for the benchmark.
int GetNumExternalThreads () const
 Number of external threads.
void SetNumExternalThreads (int val)
 Number of external threads.
int GetNumInternalThreads () const
 Number of internal threads.
void SetNumInternalThreads (int val)
 Number of internal threads.
void SetCameraSpeed (float fps)
 Camera speed to simulate. If equal to 0, the benchmark will produce images as fast as possible.
float GetCameraSpeed () const
 Camera speed to simulate. If equal to 0, the benchmark will produce images as fast as possible.
int GetBatchSize () const
 Batch size.
void SetBatchSize (int val)
 Batch size.
int GetNumInferences () const
 Number of iterations to use during the benchmark.
void SetNumInferences (int val)
 Number of iterations to use during the benchmark.
bool GetInternalResizeDisabled () const
 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.
void SetInternalResizeDisabled (bool disabled)
 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.
bool GetOptimizedBatchSize () const
 Whether to enable the auto setup of the batch size.
void SetOptimizedBatchSize (bool enable)
 Whether to enable the auto setup of the batch size.
 EDeepLearningBenchmarkSettings (CppWrapperInternal::InternalConstructor)

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

Class representing the settings of a Deep Learning benchmark.

License(s): EasyClassify or EasySegment or EasyLocate

Constructor & Destructor Documentation

◆ EDeepLearningBenchmarkSettings() [1/3]

eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::EDeepLearningBenchmarkSettings ( )

Constructor.

◆ EDeepLearningBenchmarkSettings() [2/3]

eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::EDeepLearningBenchmarkSettings ( const eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings & other)

Constructor.

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

◆ ~EDeepLearningBenchmarkSettings()

eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::~EDeepLearningBenchmarkSettings ( )
throw ( )
virtual

◆ EDeepLearningBenchmarkSettings() [3/3]

eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::EDeepLearningBenchmarkSettings ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ GetBatchSize()

int eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetBatchSize ( ) const

Batch size.

◆ GetCameraSpeed()

float eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetCameraSpeed ( ) const

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

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

◆ GetDevice()

eVision::EasyDeepLearning::EDeepLearningDevice eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetDevice ( ) const

Device to use for the benchmark.

◆ GetEngine()

std::string eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetEngine ( ) const

Deep Learning engine to use for the benchmark.

◆ GetInferencePrecision()

eVision::EasyDeepLearning::EDeepLearningInferencePrecision eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetInferencePrecision ( ) const

Inference precision to use for the benchmark.

◆ GetInternalResizeDisabled()

bool eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetInternalResizeDisabled ( ) const

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.

◆ GetName()

std::string eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetName ( ) const

Name of the benchmark.

◆ GetNumExternalThreads()

int eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetNumExternalThreads ( ) const

Number of external threads.

◆ GetNumInferences()

int eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetNumInferences ( ) const

Number of iterations to use during the benchmark.

◆ GetNumInternalThreads()

int eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetNumInternalThreads ( ) const

Number of internal threads.

◆ GetOptimizedBatchSize()

bool eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::GetOptimizedBatchSize ( ) const

Whether to enable the auto setup of the batch size.

◆ Load() [1/2]

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::Load ( const std::string & filePath)
virtual

Loads a EDeepLearningBenchmarkSettings object. The given ESerializer must have been created for reading.

Parameters
filePathFile path.

◆ Load() [2/2]

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::Load ( eVision::ESerializer * serializer)
virtual

Loads a EDeepLearningBenchmarkSettings object. The given ESerializer must have been created for reading.

Parameters
serializerPointer to the ESerializer created for reading.

◆ operator=()

eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings & eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::operator= ( const eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings & other)

Assignment operator.

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

◆ Save() [1/2]

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::Save ( const std::string & filePath)
virtual

Saves the EDeepLearningBenchmarkSettings object. The given ESerializer must have been created for writing.

Parameters
filePathFile path.

◆ Save() [2/2]

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::Save ( eVision::ESerializer * serializer)
virtual

Saves the EDeepLearningBenchmarkSettings object. The given ESerializer must have been created for writing.

Parameters
serializerPointer to the ESerializer created for writing.

◆ SetBatchSize()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetBatchSize ( int val)

Batch size.

Parameters
valBatch size

◆ SetCameraSpeed()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetCameraSpeed ( float fps)

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

Parameters
fpsCamera frame rate

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

◆ SetDevice()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetDevice ( const eVision::EasyDeepLearning::EDeepLearningDevice & dev)

Device to use for the benchmark.

Parameters
devDevice to use for the benchmark

◆ SetEngine()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetEngine ( const std::string & engine)

Deep Learning engine to use for the benchmark.

Parameters
engineEngine to use for the benchmark

◆ SetInferencePrecision()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetInferencePrecision ( eVision::EasyDeepLearning::EDeepLearningInferencePrecision prec)

Inference precision to use for the benchmark.

Parameters
precInference precision to use for the benchmark

◆ SetInternalResizeDisabled()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetInternalResizeDisabled ( bool disabled)

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.

Parameters
disabledWhether to disable the internal resize

◆ SetName()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetName ( const std::string & benchName)

Name of the benchmark.

Parameters
benchNameName for the benchmark

◆ SetNumExternalThreads()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetNumExternalThreads ( int val)

Number of external threads.

Parameters
valNew number of external threads

◆ SetNumInferences()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetNumInferences ( int val)

Number of iterations to use during the benchmark.

Parameters
valNumber of iterations

◆ SetNumInternalThreads()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetNumInternalThreads ( int val)

Number of internal threads.

Parameters
valNew number of internal threads

◆ SetOptimizedBatchSize()

void eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::SetOptimizedBatchSize ( bool enable)

Whether to enable the auto setup of the batch size.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::EasyDeepLearning::EDeepLearningBenchmarkSettings::wrappedClass_