diff options
| author | Nikhil Raj <nikhil.raj@arm.com> | 2021-11-17 13:16:45 +0000 |
|---|---|---|
| committer | Nikhil Raj <nikhil.raj@arm.com> | 2021-11-17 13:16:45 +0000 |
| commit | 9aed8fb43441228343b925b42464a55042c47ca0 (patch) | |
| tree | 4c34534eea1c8e82655ac1f60e3633b9618cc40d /21.11/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml | |
| parent | f86be93b7492b381370cae7bf71eca8572a0cbae (diff) | |
| download | armnn-9aed8fb43441228343b925b42464a55042c47ca0.tar.gz | |
IVGCVSW-6040 Update 21.11 Doxygen Documents
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: Ia36ec98c4bebc27a69103911ea3409cd7db587a5
Diffstat (limited to '21.11/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml')
| -rw-r--r-- | 21.11/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml | 364 |
1 files changed, 364 insertions, 0 deletions
diff --git a/21.11/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml b/21.11/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml new file mode 100644 index 0000000000..e918244d20 --- /dev/null +++ b/21.11/structarmnn_1_1_i_runtime_1_1_creation_options.xhtml @@ -0,0 +1,364 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: IRuntime::CreationOptions Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="stylesheet.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">21.11</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('structarmnn_1_1_i_runtime_1_1_creation_options.xhtml','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="structarmnn_1_1_i_runtime_1_1_creation_options-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">IRuntime::CreationOptions Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml">ExternalProfilingOptions</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a899860966ff7a5d7901e5b33bcad88fd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a899860966ff7a5d7901e5b33bcad88fd">CreationOptions</a> ()</td></tr> +<tr class="separator:a899860966ff7a5d7901e5b33bcad88fd"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:a515d755116f35e5b3ab30b7a78a712f1"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml">IGpuAccTunedParameters</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a515d755116f35e5b3ab30b7a78a712f1">m_GpuAccTunedParameters</a></td></tr> +<tr class="memdesc:a515d755116f35e5b3ab30b7a78a712f1"><td class="mdescLeft"> </td><td class="mdescRight">If set, uses the GpuAcc tuned parameters from the given object when executing GPU workloads. <a href="#a515d755116f35e5b3ab30b7a78a712f1">More...</a><br /></td></tr> +<tr class="separator:a515d755116f35e5b3ab30b7a78a712f1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2fe8c3eadf4f4f9c0c664a24a2a298f9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a2fe8c3eadf4f4f9c0c664a24a2a298f9">m_EnableGpuProfiling</a></td></tr> +<tr class="memdesc:a2fe8c3eadf4f4f9c0c664a24a2a298f9"><td class="mdescLeft"> </td><td class="mdescRight">Setting this flag will allow the user to obtain GPU profiling information from the runtime. <a href="#a2fe8c3eadf4f4f9c0c664a24a2a298f9">More...</a><br /></td></tr> +<tr class="separator:a2fe8c3eadf4f4f9c0c664a24a2a298f9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae43cf4b5df0068ee6a9151c98947248b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#ae43cf4b5df0068ee6a9151c98947248b">m_DynamicBackendsPath</a></td></tr> +<tr class="memdesc:ae43cf4b5df0068ee6a9151c98947248b"><td class="mdescLeft"> </td><td class="mdescRight">Setting this value will override the paths set by the DYNAMIC_BACKEND_PATHS compiler directive Only a single path is allowed for the override It defines the path to search for any <a class="el" href="md_src_dynamic__r_e_a_d_m_e.xhtml">dynamic backend libraries</a>. <a href="#ae43cf4b5df0068ee6a9151c98947248b">More...</a><br /></td></tr> +<tr class="separator:ae43cf4b5df0068ee6a9151c98947248b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad89c99e4063390ba824022c60b885561"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#ad89c99e4063390ba824022c60b885561">m_ProtectedMode</a></td></tr> +<tr class="memdesc:ad89c99e4063390ba824022c60b885561"><td class="mdescLeft"> </td><td class="mdescRight">Setting this flag will allow the user to create the Runtime in protected mode. <a href="#ad89c99e4063390ba824022c60b885561">More...</a><br /></td></tr> +<tr class="separator:ad89c99e4063390ba824022c60b885561"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a939528f239e70c85f833c87c5fe41d83"><td class="memItemLeft" align="right" valign="top">std::map< <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>, std::shared_ptr< <a class="el" href="classarmnn_1_1_i_custom_allocator.xhtml">ICustomAllocator</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a939528f239e70c85f833c87c5fe41d83">m_CustomAllocatorMap</a></td></tr> +<tr class="memdesc:a939528f239e70c85f833c87c5fe41d83"><td class="mdescLeft"> </td><td class="mdescRight">A map to define a custom memory allocator for specific backend Ids. <a href="#a939528f239e70c85f833c87c5fe41d83">More...</a><br /></td></tr> +<tr class="separator:a939528f239e70c85f833c87c5fe41d83"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6e8601cb2ffa03a83dbfae67b598ba4e"><td class="memItemLeft" align="right" valign="top">std::map< <a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>, std::shared_ptr< <a class="el" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml">IMemoryOptimizerStrategy</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a6e8601cb2ffa03a83dbfae67b598ba4e">m_MemoryOptimizerStrategyMap</a></td></tr> +<tr class="memdesc:a6e8601cb2ffa03a83dbfae67b598ba4e"><td class="mdescLeft"> </td><td class="mdescRight">A map to define a custom memory optimizer strategy for specific backend Ids. <a href="#a6e8601cb2ffa03a83dbfae67b598ba4e">More...</a><br /></td></tr> +<tr class="separator:a6e8601cb2ffa03a83dbfae67b598ba4e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a30412a91cadff138686eaeb12f5357cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml">ExternalProfilingOptions</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a30412a91cadff138686eaeb12f5357cc">m_ProfilingOptions</a></td></tr> +<tr class="separator:a30412a91cadff138686eaeb12f5357cc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aecebc69597fe0d38a3964031c6eeb0a8"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="structarmnn_1_1_backend_options.xhtml">BackendOptions</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#aecebc69597fe0d38a3964031c6eeb0a8">m_BackendOptions</a></td></tr> +<tr class="memdesc:aecebc69597fe0d38a3964031c6eeb0a8"><td class="mdescLeft"> </td><td class="mdescRight">Pass backend specific options. <a href="#aecebc69597fe0d38a3964031c6eeb0a8">More...</a><br /></td></tr> +<tr class="separator:aecebc69597fe0d38a3964031c6eeb0a8"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><dl><dt><b>Examples: </b></dt><dd><a class="el" href="_async_execution_sample_8cpp-example.xhtml#_a16">AsyncExecutionSample.cpp</a>, <a class="el" href="_custom_memory_allocator_sample_8cpp-example.xhtml#_a22">CustomMemoryAllocatorSample.cpp</a>, <a class="el" href="_dynamic_sample_8cpp-example.xhtml#_a10">DynamicSample.cpp</a>, and <a class="el" href="_simple_sample_8cpp-example.xhtml#_a16">SimpleSample.cpp</a>.</dd> +</dl> +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00108">108</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a899860966ff7a5d7901e5b33bcad88fd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a899860966ff7a5d7901e5b33bcad88fd">◆ </a></span>CreationOptions()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml">CreationOptions</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00110">110</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  : <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a515d755116f35e5b3ab30b7a78a712f1">m_GpuAccTunedParameters</a>(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a2fe8c3eadf4f4f9c0c664a24a2a298f9">m_EnableGpuProfiling</a>(<span class="keyword">false</span>)</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#ae43cf4b5df0068ee6a9151c98947248b">m_DynamicBackendsPath</a>(<span class="stringliteral">""</span>)</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#ad89c99e4063390ba824022c60b885561">m_ProtectedMode</a>(<span class="keyword">false</span>)</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a939528f239e70c85f833c87c5fe41d83">m_CustomAllocatorMap</a>()</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a6e8601cb2ffa03a83dbfae67b598ba4e">m_MemoryOptimizerStrategyMap</a>()</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  {}</div><div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_xhtml_a6e8601cb2ffa03a83dbfae67b598ba4e"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a6e8601cb2ffa03a83dbfae67b598ba4e">armnn::IRuntime::CreationOptions::m_MemoryOptimizerStrategyMap</a></div><div class="ttdeci">std::map< BackendId, std::shared_ptr< IMemoryOptimizerStrategy > > m_MemoryOptimizerStrategyMap</div><div class="ttdoc">A map to define a custom memory optimizer strategy for specific backend Ids. </div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00153">IRuntime.hpp:153</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_xhtml_a515d755116f35e5b3ab30b7a78a712f1"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a515d755116f35e5b3ab30b7a78a712f1">armnn::IRuntime::CreationOptions::m_GpuAccTunedParameters</a></div><div class="ttdeci">std::shared_ptr< IGpuAccTunedParameters > m_GpuAccTunedParameters</div><div class="ttdoc">If set, uses the GpuAcc tuned parameters from the given object when executing GPU workloads...</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00121">IRuntime.hpp:121</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_xhtml_a939528f239e70c85f833c87c5fe41d83"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a939528f239e70c85f833c87c5fe41d83">armnn::IRuntime::CreationOptions::m_CustomAllocatorMap</a></div><div class="ttdeci">std::map< BackendId, std::shared_ptr< ICustomAllocator > > m_CustomAllocatorMap</div><div class="ttdoc">A map to define a custom memory allocator for specific backend Ids. </div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00145">IRuntime.hpp:145</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_xhtml_ad89c99e4063390ba824022c60b885561"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#ad89c99e4063390ba824022c60b885561">armnn::IRuntime::CreationOptions::m_ProtectedMode</a></div><div class="ttdeci">bool m_ProtectedMode</div><div class="ttdoc">Setting this flag will allow the user to create the Runtime in protected mode. </div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00136">IRuntime.hpp:136</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_xhtml_ae43cf4b5df0068ee6a9151c98947248b"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#ae43cf4b5df0068ee6a9151c98947248b">armnn::IRuntime::CreationOptions::m_DynamicBackendsPath</a></div><div class="ttdeci">std::string m_DynamicBackendsPath</div><div class="ttdoc">Setting this value will override the paths set by the DYNAMIC_BACKEND_PATHS compiler directive Only a...</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00129">IRuntime.hpp:129</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_xhtml_a2fe8c3eadf4f4f9c0c664a24a2a298f9"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml#a2fe8c3eadf4f4f9c0c664a24a2a298f9">armnn::IRuntime::CreationOptions::m_EnableGpuProfiling</a></div><div class="ttdeci">bool m_EnableGpuProfiling</div><div class="ttdoc">Setting this flag will allow the user to obtain GPU profiling information from the runtime...</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00124">IRuntime.hpp:124</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="aecebc69597fe0d38a3964031c6eeb0a8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aecebc69597fe0d38a3964031c6eeb0a8">◆ </a></span>m_BackendOptions</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::vector<<a class="el" href="structarmnn_1_1_backend_options.xhtml">BackendOptions</a>> m_BackendOptions</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Pass backend specific options. </p> +<p>For example, to enable GpuAcc tuning add the following </p><div class="fragment"><div class="line">m_BackendOption.emplace_back(</div><div class="line"> BackendOptions{<span class="stringliteral">"GpuAcc"</span>,</div><div class="line"> {</div><div class="line"> {<span class="stringliteral">"TuningLevel"</span>, 2},</div><div class="line"> {<span class="stringliteral">"TuningFile"</span>, filename}</div><div class="line"> {<span class="stringliteral">"MemoryOptimizerStrategy"</span>, strategyname}</div><div class="line"> }</div><div class="line"> });</div></div><!-- fragment --><p> 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. </p><div class="fragment"><div class="line">m_BackendOption.emplace_back(</div><div class="line"> BackendOptions{<span class="stringliteral">"GpuAcc"</span>,</div><div class="line"> {</div><div class="line"> {<span class="stringliteral">"TuningFile"</span>, filename}</div><div class="line"> }</div><div class="line"> });</div></div><!-- fragment --><p>The following backend options are available: AllBackends: "MemoryOptimizerStrategy" : string [stategynameString] (Existing Memory <a class="el" href="classarmnn_1_1_optimizer.xhtml">Optimizer</a> Strategies: <a class="el" href="classarmnn_1_1_constant_memory_strategy.xhtml">ConstantMemoryStrategy</a>) GpuAcc: "TuningLevel" : int [0..3] (0=UseOnly(default) | 1=RapidTuning | 2=NormalTuning | 3=ExhaustiveTuning) "TuningFile" : string [filenameString] "KernelProfilingEnabled" : bool [true | false] </p> + +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00220">220</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_delegate_options_8hpp_source.xhtml#l00203">DelegateOptions::AddBackendOption()</a>, <a class="el" href="_cl_backend_context_8cpp_source.xhtml#l00140">ClBackendContext::ClBackendContext()</a>, <a class="el" href="_delegate_options_8hpp_source.xhtml#l00197">DelegateOptions::GetBackendOptions()</a>, <a class="el" href="_execute_network_program_options_8cpp_source.xhtml#l00442">ProgramOptions::ParseOptions()</a>, <a class="el" href="_runtime_8cpp_source.xhtml#l00291">RuntimeImpl::RuntimeImpl()</a>, and <a class="el" href="_runtime_tests_8cpp_source.xhtml#l00037">TEST_SUITE()</a>.</p> + +</div> +</div> +<a id="a939528f239e70c85f833c87c5fe41d83"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a939528f239e70c85f833c87c5fe41d83">◆ </a></span>m_CustomAllocatorMap</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::map<<a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>, std::shared_ptr<<a class="el" href="classarmnn_1_1_i_custom_allocator.xhtml">ICustomAllocator</a>> > m_CustomAllocatorMap</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>A map to define a custom memory allocator for specific backend Ids. </p> +<p>A Custom <a class="el" href="structarmnn_1_1_allocator.xhtml">Allocator</a> is used for allocation of working memory in the backends. Set this if you need to take control of how memory is allocated on a backend. Required for Protected Mode in order to correctly allocate Protected Memory</p> +<dl class="section note"><dt>Note</dt><dd>Only supported for GpuAcc </dd></dl> +<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_custom_memory_allocator_sample_8cpp-example.xhtml#a23">CustomMemoryAllocatorSample.cpp</a>.</dd> +</dl> +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00145">145</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_runtime_8cpp_source.xhtml#l00291">RuntimeImpl::RuntimeImpl()</a>, and <a class="el" href="_cl_custom_allocator_tests_8cpp_source.xhtml#l00095">TEST_SUITE()</a>.</p> + +</div> +</div> +<a id="ae43cf4b5df0068ee6a9151c98947248b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae43cf4b5df0068ee6a9151c98947248b">◆ </a></span>m_DynamicBackendsPath</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string m_DynamicBackendsPath</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Setting this value will override the paths set by the DYNAMIC_BACKEND_PATHS compiler directive Only a single path is allowed for the override It defines the path to search for any <a class="el" href="md_src_dynamic__r_e_a_d_m_e.xhtml">dynamic backend libraries</a>. </p> + +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00129">129</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_delegate_options_8hpp_source.xhtml#l00183">DelegateOptions::GetDynamicBackendsPath()</a>, <a class="el" href="_inference_model_8hpp_source.xhtml#l00436">InferenceModel< IParser, TDataType >::InferenceModel()</a>, <a class="el" href="_tf_lite_yolo_v3_big-_armnn_8cpp_source.xhtml#l00484">main()</a>, <a class="el" href="_execute_network_program_options_8cpp_source.xhtml#l00442">ProgramOptions::ParseOptions()</a>, <a class="el" href="_execute_network_program_options_8cpp_source.xhtml#l00171">ProgramOptions::ProgramOptions()</a>, <a class="el" href="_runtime_8cpp_source.xhtml#l00291">RuntimeImpl::RuntimeImpl()</a>, <a class="el" href="_dynamic_backend_tests_8hpp_source.xhtml#l01374">RuntimeInvalidOverridePathTestImpl()</a>, and <a class="el" href="_delegate_options_8hpp_source.xhtml#l00179">DelegateOptions::SetDynamicBackendsPath()</a>.</p> + +</div> +</div> +<a id="a2fe8c3eadf4f4f9c0c664a24a2a298f9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2fe8c3eadf4f4f9c0c664a24a2a298f9">◆ </a></span>m_EnableGpuProfiling</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool m_EnableGpuProfiling</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Setting this flag will allow the user to obtain GPU profiling information from the runtime. </p> + +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00124">124</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_cl_backend_context_8cpp_source.xhtml#l00140">ClBackendContext::ClBackendContext()</a>, <a class="el" href="_delegate_options_8hpp_source.xhtml#l00192">DelegateOptions::GetGpuProfilingState()</a>, <a class="el" href="_json_printer_test_impl_8cpp_source.xhtml#l00120">GetSoftmaxProfilerJson()</a>, <a class="el" href="_inference_model_8hpp_source.xhtml#l00436">InferenceModel< IParser, TDataType >::InferenceModel()</a>, <a class="el" href="_execute_network_program_options_8cpp_source.xhtml#l00442">ProgramOptions::ParseOptions()</a>, and <a class="el" href="_delegate_options_8hpp_source.xhtml#l00188">DelegateOptions::SetGpuProfilingState()</a>.</p> + +</div> +</div> +<a id="a515d755116f35e5b3ab30b7a78a712f1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a515d755116f35e5b3ab30b7a78a712f1">◆ </a></span>m_GpuAccTunedParameters</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<<a class="el" href="classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml">IGpuAccTunedParameters</a>> m_GpuAccTunedParameters</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>If set, uses the GpuAcc tuned parameters from the given object when executing GPU workloads. </p> +<p>It will also be updated with new tuned parameters if it is configured to do so. </p> + +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00121">121</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_cl_backend_context_8cpp_source.xhtml#l00140">ClBackendContext::ClBackendContext()</a>.</p> + +</div> +</div> +<a id="a6e8601cb2ffa03a83dbfae67b598ba4e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6e8601cb2ffa03a83dbfae67b598ba4e">◆ </a></span>m_MemoryOptimizerStrategyMap</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::map<<a class="el" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>, std::shared_ptr<<a class="el" href="classarmnn_1_1_i_memory_optimizer_strategy.xhtml">IMemoryOptimizerStrategy</a>> > m_MemoryOptimizerStrategyMap</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>A map to define a custom memory optimizer strategy for specific backend Ids. </p> +<p>A Memory <a class="el" href="classarmnn_1_1_optimizer.xhtml">Optimizer</a> Strategy provides a solution to an abstract representation of a network's memory requirements. This can also be used to return a pre-computed solution for a specific network. Set this if you want to implement a Custom Memory <a class="el" href="classarmnn_1_1_optimizer.xhtml">Optimizer</a> Strategy for a given backend. </p> + +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00153">153</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_runtime_8cpp_source.xhtml#l00291">RuntimeImpl::RuntimeImpl()</a>, and <a class="el" href="_custom_memory_optimizer_strategy_tests_8cpp_source.xhtml#l00047">TEST_SUITE()</a>.</p> + +</div> +</div> +<a id="a30412a91cadff138686eaeb12f5357cc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a30412a91cadff138686eaeb12f5357cc">◆ </a></span>m_ProfilingOptions</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml">ExternalProfilingOptions</a> m_ProfilingOptions</td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00184">184</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_execute_network_8cpp_source.xhtml#l00047">CheckInferenceTimeThreshold()</a>, <a class="el" href="_execute_network_program_options_8cpp_source.xhtml#l00171">ProgramOptions::ProgramOptions()</a>, <a class="el" href="_runtime_8cpp_source.xhtml#l00291">RuntimeImpl::RuntimeImpl()</a>, <a class="el" href="_runtime_tests_8cpp_source.xhtml#l00037">TEST_SUITE()</a>, <a class="el" href="_execute_network_program_options_8cpp_source.xhtml#l00161">ProgramOptions::ValidateRuntimeOptions()</a>, and <a class="el" href="_profiling_test_utils_8cpp_source.xhtml#l00363">VerifyPostOptimisationStructureTestImpl()</a>.</p> + +</div> +</div> +<a id="ad89c99e4063390ba824022c60b885561"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad89c99e4063390ba824022c60b885561">◆ </a></span>m_ProtectedMode</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool m_ProtectedMode</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Setting this flag will allow the user to create the Runtime in protected mode. </p> +<p>It will run all the inferences on protected memory and will make sure that <a class="el" href="structarmnn_1_1_i_network_properties.xhtml#a111a52fb2bd24aee9fc125f28c2eb1cb" title="Deprecated and will be removed in future release. ">INetworkProperties::m_ImportEnabled</a> set to true with <a class="el" href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277a7f9067c59dd34aca0ad09a7f283ed1f8">MemorySource::DmaBufProtected</a> option This requires that the backend supports Protected Memory and has an allocator capable of allocating Protected Memory associated with it. </p> + +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00136">136</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_runtime_8cpp_source.xhtml#l00291">RuntimeImpl::RuntimeImpl()</a>.</p> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>include/armnn/<a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_runtime.xhtml">IRuntime</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.xhtml">CreationOptions</a></li> + <li class="footer">Generated on Wed Nov 17 2021 12:59:43 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |