From fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf Mon Sep 17 00:00:00 2001 From: Jan Eilers Date: Thu, 25 Feb 2021 17:44:00 +0000 Subject: IVGCVSW-5687 Update Doxygen Docu * Update Doxygen Documentation for 21.02 release Signed-off-by: Jan Eilers Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5 --- ...classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml | 450 +++++++++++++++++++++ 1 file changed, 450 insertions(+) create mode 100644 21.02/classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml (limited to '21.02/classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml') diff --git a/21.02/classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml b/21.02/classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml new file mode 100644 index 0000000000..e4d11b5903 --- /dev/null +++ b/21.02/classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml @@ -0,0 +1,450 @@ + + + + + + + + + + + + + +ArmNN: IGpuAccTunedParameters Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Member Functions | +List of all members
+
+
IGpuAccTunedParameters Class Referenceabstract
+
+
+ +

Manages a set of GpuAcc parameters which have been tuned for maximum performance. + More...

+ +

#include <IRuntime.hpp>

+
+Inheritance diagram for IGpuAccTunedParameters:
+
+
+ + +ClTunedParameters + +
+ + + + + + +

+Public Types

enum  Mode { UseTunedParameters, +UpdateTunedParameters + }
 
enum  TuningLevel { Rapid = 0, +Normal = 1, +Exhaustive = 2 + }
 
+ + + + + + + +

+Public Member Functions

virtual void Load (const char *filename)=0
 Loads an existing set of tuned parameters from the given file. More...
 
virtual void Save (const char *filename) const =0
 Saves the current set of tuned parameters to the given file. More...
 
+ + + + + + + + + +

+Static Public Member Functions

static void Destroy (IGpuAccTunedParameters *params)
 
static IGpuAccTunedParameters * CreateRaw (Mode mode, TuningLevel tunerMode)
 Creates an IClTunedParameters with the given mode. More...
 
static IGpuAccTunedParametersPtr Create (Mode mode, TuningLevel tunerMode)
 
+ + + +

+Protected Member Functions

virtual ~IGpuAccTunedParameters ()
 
+

Detailed Description

+

Manages a set of GpuAcc parameters which have been tuned for maximum performance.

+

Passes an instance of this object to the IRuntime::Create() method (via IRuntime::CreationOptions) to use it for all GPU workload execution.

+

Can be created in two modes:

    +
  • In UseTunedParameters mode, the parameters stored in this object are used to execute GPU workloads.
    • +
  • In UpdateTunedParameters mode, additionally, whenever a GPU workload is executed for the first time, the optimum parameters will be found and stored in this object. WARNING - This tuning can be slow.
    • +
+

The parameters can be loaded from and saved to a file so that you can first run a slow initial read-write execution, save the parameters for later and then run fast read-only executions using the optimised parameters.

+ +

Definition at line 195 of file IRuntime.hpp.

+

Member Enumeration Documentation

+ +

◆ Mode

+ +
+
+ + + + + +
+ + + + +
enum Mode
+ 		+strong
+
+ + + +
Enumerator
UseTunedParameters 
UpdateTunedParameters 
+ +

Definition at line 198 of file IRuntime.hpp.

+
199  {
200  UseTunedParameters,
201  UpdateTunedParameters
202  };
+
+
+ +

◆ TuningLevel

+ +
+
+ + + + + +
+ + + + +
enum TuningLevel
+ 		+strong
+
+ + + + +
Enumerator
Rapid 
Normal 
Exhaustive 
+ +

Definition at line 204 of file IRuntime.hpp.

+
205  {
206  Rapid = 0,
207  Normal = 1,
208  Exhaustive = 2
209  };
+ + +
+
+
+

Constructor & Destructor Documentation

+ +

◆ ~IGpuAccTunedParameters()

+ +
+
+ + + + + +
+ + + + + + + +
virtual ~IGpuAccTunedParameters ()
+ 		+inlineprotectedvirtual
+
+ +

Definition at line 227 of file IRuntime.hpp.

+
227 {};
+
+
+

Member Function Documentation

+ +

◆ Create()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
armnn::IGpuAccTunedParametersPtr Create (Mode mode,
TuningLevel tunerMode 
)
+ 		+static
+
+ +

Definition at line 175 of file ClContextControl.cpp.

+ +

References IGpuAccTunedParameters::Destroy().

+
177 {
178  return IGpuAccTunedParametersPtr(CreateRaw(mode, tuningLevel), &IGpuAccTunedParameters::Destroy);
179 }
armnn::IGpuAccTunedParameters::CreateRaw
static IGpuAccTunedParameters * CreateRaw(Mode mode, TuningLevel tunerMode)
Creates an IClTunedParameters with the given mode.
Definition: ClContextControl.cpp:169
+
armnn::IGpuAccTunedParameters::Destroy
static void Destroy(IGpuAccTunedParameters *params)
Definition: ClContextControl.cpp:181
+
armnn::IGpuAccTunedParametersPtr
std::shared_ptr< IGpuAccTunedParameters > IGpuAccTunedParametersPtr
The following API is replaced by the backend options API.
Definition: IRuntime.hpp:182
+
+
+
+ +

◆ CreateRaw()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
armnn::IGpuAccTunedParameters * CreateRaw (Mode mode,
TuningLevel tunerMode 
)
+ 		+static
+
+ +

Creates an IClTunedParameters with the given mode.

+ +

Definition at line 169 of file ClContextControl.cpp.

+
171 {
172  return new ClTunedParameters(mode, tuningLevel);
173 }
+
+
+ +

◆ Destroy()

+ +
+
+ + + + + +
+ + + + + + + + +
void Destroy (IGpuAccTunedParameters * params)
+ 		+static
+
+ +

Definition at line 181 of file ClContextControl.cpp.

+ +

Referenced by IGpuAccTunedParameters::Create().

+
182 {
183  delete params;
184 }
+
+
+ +

◆ Load()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Load (const char * filename)
+ 		+pure virtual
+
+ +

Loads an existing set of tuned parameters from the given file.

+

If there is an error loading the file, an armnn::Exception is thrown.

+ +

Implemented in ClTunedParameters.

+ +
+
+ +

◆ Save()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual void Save (const char * filename) const
+ 		+pure virtual
+
+ +

Saves the current set of tuned parameters to the given file.

+

If there is an error saving to the file, an armnn::Exception is thrown.

+ +

Implemented in ClTunedParameters.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1