From a983e4699082a0b1ef685bab7354f2ad9cd37a44 Mon Sep 17 00:00:00 2001 From: Colm Donelan Date: Wed, 20 May 2020 16:12:19 +0100 Subject: Updating Doxygen documentation for 20.05 release. Change-Id: I4d624343ed5fd6ae269c3d53532903084508fd14 Signed-off-by: Colm Donelan --- ...tarmnn_1_1_i_runtime_1_1_creation_options.xhtml | 286 +++++++++++++++++++++ 1 file changed, 286 insertions(+) create mode 100644 20.05/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml (limited to '20.05/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml') diff --git a/20.05/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml b/20.05/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml new file mode 100644 index 0000000000..d8ab7dd51f --- /dev/null +++ b/20.05/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml @@ -0,0 +1,286 @@ + + + + + + + + + + + + + +ArmNN: IRuntime::CreationOptions Struct Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  20.05 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Classes | +Public Member Functions | +Public Attributes | +List of all members
+
+
IRuntime::CreationOptions Struct Reference
+
+
+ +

#include <IRuntime.hpp>

+ + + + +

+Classes

struct  ExternalProfilingOptions
 
+ + + +

+Public Member Functions

 CreationOptions ()
 
+ + + + + + + + + + + + + + + +

+Public Attributes

std::shared_ptr< IGpuAccTunedParameters > m_GpuAccTunedParameters
 If set, uses the GpuAcc tuned parameters from the given object when executing GPU workloads. More...
 
bool m_EnableGpuProfiling
 Setting this flag will allow the user to obtain GPU profiling information from the runtime. More...
 
std::string m_DynamicBackendsPath
 Setting this value will override the paths set by the DYNAMIC_BACKEND_PATHS compiler directive Only a single path is allowed for the override. More...
 
ExternalProfilingOptions m_ProfilingOptions
 
std::vector< BackendOptions > m_BackendOptions
 Pass backend specific options. More...
 
+

Detailed Description

+
+

Definition at line 42 of file IRuntime.hpp.

+

Constructor & Destructor Documentation

+ +

◆ CreationOptions()

+ +
+
+ + + + + +
+ + + + + + + +
CreationOptions ()
+ 		+inline
+
+ +

Definition at line 44 of file IRuntime.hpp.

+
45  : m_GpuAccTunedParameters(nullptr)
46  , m_EnableGpuProfiling(false)
47  , m_DynamicBackendsPath("")
48  {}
armnn::IRuntime::CreationOptions::m_GpuAccTunedParameters
std::shared_ptr< IGpuAccTunedParameters > m_GpuAccTunedParameters
If set, uses the GpuAcc tuned parameters from the given object when executing GPU workloads...
Definition: IRuntime.hpp:52
+
armnn::IRuntime::CreationOptions::m_DynamicBackendsPath
std::string m_DynamicBackendsPath
Setting this value will override the paths set by the DYNAMIC_BACKEND_PATHS compiler directive Only a...
Definition: IRuntime.hpp:59
+
armnn::IRuntime::CreationOptions::m_EnableGpuProfiling
bool m_EnableGpuProfiling
Setting this flag will allow the user to obtain GPU profiling information from the runtime...
Definition: IRuntime.hpp:55
+
+
+
+

Member Data Documentation

+ +

◆ m_BackendOptions

+ +
+
+ + + + +
std::vector<BackendOptions> m_BackendOptions
+
+ +

Pass backend specific options.

+

For example, to enable GpuAcc tuning add the following

m_BackendOption.emplace_back(
BackendOptions{"GpuAcc",
{
{"TuningLevel", 2},
{"TuningFile", filename}
}
});

Execute representative workloads through the runtime to generate tuning data. The tuning file is written once the runtime is destroyed To execute with the tuning data, start up with just the tuning file specified.

m_BackendOption.emplace_back(
BackendOptions{"GpuAcc",
{
{"TuningFile", filename}
}
});

The following backend options are available: GpuAcc: "TuningLevel" : int [0..3] (0=UseOnly(default) | 1=RapidTuning | 2=NormalTuning | 3=ExhaustiveTuning) "TuningFile" : string [filenameString] "KernelProfilingEnabled" : bool [true | false]

+ +

Definition at line 115 of file IRuntime.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), ClBackendContext::ClBackendContext(), main(), and RunCLTuning().

+ +
+
+ +

◆ m_DynamicBackendsPath

+ +
+
+ + + + +
std::string m_DynamicBackendsPath
+
+ +

Setting this value will override the paths set by the DYNAMIC_BACKEND_PATHS compiler directive Only a single path is allowed for the override.

+ +

Definition at line 59 of file IRuntime.hpp.

+ +

Referenced by InferenceModel< IParser, TDataType >::InferenceModel(), main(), Runtime::Runtime(), and RuntimeInvalidOverridePathTestImpl().

+ +
+
+ +

◆ m_EnableGpuProfiling

+ +
+
+ + + + +
bool m_EnableGpuProfiling
+
+ +

Setting this flag will allow the user to obtain GPU profiling information from the runtime.

+ +

Definition at line 55 of file IRuntime.hpp.

+ +

Referenced by ClBackendContext::ClBackendContext(), GetSoftmaxProfilerJson(), InferenceModel< IParser, TDataType >::InferenceModel(), and main().

+ +
+
+ +

◆ m_GpuAccTunedParameters

+ +
+
+ + + + +
std::shared_ptr<IGpuAccTunedParameters> m_GpuAccTunedParameters
+
+ +

If set, uses the GpuAcc tuned parameters from the given object when executing GPU workloads.

+

It will also be updated with new tuned parameters if it is configured to do so.

+ +

Definition at line 52 of file IRuntime.hpp.

+ +

Referenced by ClBackendContext::ClBackendContext().

+ +
+
+ +

◆ m_ProfilingOptions

+ +
+
+ + + + +
ExternalProfilingOptions m_ProfilingOptions
+
+ +

Definition at line 83 of file IRuntime.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), main(), Runtime::Runtime(), and VerifyPostOptimisationStructureTestImpl().

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