Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 753560b55dbf6656389b95efc8d4df07ac43cc9a / . / Documentation / structarmnn_1_1_i_runtime_1_1_creation_options.html
blob: 6c1b606d79bad4bcfe818b7cf8771381e83d1fb6 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: IRuntime::CreationOptions Struct Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('structarmnn_1_1_i_runtime_1_1_creation_options.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="summary">
84<a href="#nested-classes">Classes</a> &#124;
85<a href="#pub-methods">Public Member Functions</a> &#124;
86<a href="#pub-attribs">Public Attributes</a> &#124;
87<a href="structarmnn_1_1_i_runtime_1_1_creation_options-members.html">List of all members</a> </div>
88 <div class="headertitle">
89<div class="title">IRuntime::CreationOptions Struct Reference</div> </div>
90</div><!--header-->
91<div class="contents">
92
93<p><code>#include &lt;<a class="el" href="_i_runtime_8hpp_source.html">IRuntime.hpp</a>&gt;</code></p>
94<table class="memberdecls">
95<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
96Classes</h2></td></tr>
97<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html">ExternalProfilingOptions</a></td></tr>
98<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
99</table><table class="memberdecls">
100<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
101Public Member Functions</h2></td></tr>
102<tr class="memitem:a899860966ff7a5d7901e5b33bcad88fd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.html#a899860966ff7a5d7901e5b33bcad88fd">CreationOptions</a> ()</td></tr>
103<tr class="separator:a899860966ff7a5d7901e5b33bcad88fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
104</table><table class="memberdecls">
105<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
106Public Attributes</h2></td></tr>
107<tr class="memitem:a515d755116f35e5b3ab30b7a78a712f1"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classarmnn_1_1_i_gpu_acc_tuned_parameters.html">IGpuAccTunedParameters</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.html#a515d755116f35e5b3ab30b7a78a712f1">m_GpuAccTunedParameters</a></td></tr>
108<tr class="separator:a515d755116f35e5b3ab30b7a78a712f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
109<tr class="memitem:a2fe8c3eadf4f4f9c0c664a24a2a298f9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.html#a2fe8c3eadf4f4f9c0c664a24a2a298f9">m_EnableGpuProfiling</a></td></tr>
110<tr class="separator:a2fe8c3eadf4f4f9c0c664a24a2a298f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
111<tr class="memitem:ae43cf4b5df0068ee6a9151c98947248b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.html#ae43cf4b5df0068ee6a9151c98947248b">m_DynamicBackendsPath</a></td></tr>
112<tr class="separator:ae43cf4b5df0068ee6a9151c98947248b"><td class="memSeparator" colspan="2">&#160;</td></tr>
113<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.html">ExternalProfilingOptions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.html#a30412a91cadff138686eaeb12f5357cc">m_ProfilingOptions</a></td></tr>
114<tr class="separator:a30412a91cadff138686eaeb12f5357cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<tr class="memitem:aecebc69597fe0d38a3964031c6eeb0a8"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structarmnn_1_1_backend_options.html">BackendOptions</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.html#aecebc69597fe0d38a3964031c6eeb0a8">m_BackendOptions</a></td></tr>
116<tr class="separator:aecebc69597fe0d38a3964031c6eeb0a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
117</table>
118<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
119<div class="textblock">
120<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.html#l00041">41</a> of file <a class="el" href="_i_runtime_8hpp_source.html">IRuntime.hpp</a>.</p>
121</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
122<a id="a899860966ff7a5d7901e5b33bcad88fd"></a>
123<h2 class="memtitle"><span class="permalink"><a href="#a899860966ff7a5d7901e5b33bcad88fd">&#9670;&nbsp;</a></span>CreationOptions()</h2>
124
125<div class="memitem">
126<div class="memproto">
127<table class="mlabels">
128 <tr>
129 <td class="mlabels-left">
130 <table class="memname">
131 <tr>
132 <td class="memname"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.html">CreationOptions</a> </td>
133 <td>(</td>
134 <td class="paramname"></td><td>)</td>
135 <td></td>
136 </tr>
137 </table>
138 </td>
139 <td class="mlabels-right">
140<span class="mlabels"><span class="mlabel">inline</span></span> </td>
141 </tr>
142</table>
143</div><div class="memdoc">
144
145<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.html#l00043">43</a> of file <a class="el" href="_i_runtime_8hpp_source.html">IRuntime.hpp</a>.</p>
146<div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; : <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.html#a515d755116f35e5b3ab30b7a78a712f1">m_GpuAccTunedParameters</a>(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.html#a2fe8c3eadf4f4f9c0c664a24a2a298f9">m_EnableGpuProfiling</a>(<span class="keyword">false</span>)</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.html#ae43cf4b5df0068ee6a9151c98947248b">m_DynamicBackendsPath</a>(<span class="stringliteral">&quot;&quot;</span>)</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {}</div><div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_html_a2fe8c3eadf4f4f9c0c664a24a2a298f9"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.html#a2fe8c3eadf4f4f9c0c664a24a2a298f9">armnn::IRuntime::CreationOptions::m_EnableGpuProfiling</a></div><div class="ttdeci">bool m_EnableGpuProfiling</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.html#l00054">IRuntime.hpp:54</a></div></div>
147<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_html_ae43cf4b5df0068ee6a9151c98947248b"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.html#ae43cf4b5df0068ee6a9151c98947248b">armnn::IRuntime::CreationOptions::m_DynamicBackendsPath</a></div><div class="ttdeci">std::string m_DynamicBackendsPath</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.html#l00058">IRuntime.hpp:58</a></div></div>
148<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_html_a515d755116f35e5b3ab30b7a78a712f1"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.html#a515d755116f35e5b3ab30b7a78a712f1">armnn::IRuntime::CreationOptions::m_GpuAccTunedParameters</a></div><div class="ttdeci">std::shared_ptr&lt; IGpuAccTunedParameters &gt; m_GpuAccTunedParameters</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.html#l00051">IRuntime.hpp:51</a></div></div>
149</div><!-- fragment -->
150</div>
151</div>
152<h2 class="groupheader">Member Data Documentation</h2>
153<a id="aecebc69597fe0d38a3964031c6eeb0a8"></a>
154<h2 class="memtitle"><span class="permalink"><a href="#aecebc69597fe0d38a3964031c6eeb0a8">&#9670;&nbsp;</a></span>m_BackendOptions</h2>
155
156<div class="memitem">
157<div class="memproto">
158 <table class="memname">
159 <tr>
160 <td class="memname">std::vector&lt;<a class="el" href="structarmnn_1_1_backend_options.html">BackendOptions</a>&gt; m_BackendOptions</td>
161 </tr>
162 </table>
163</div><div class="memdoc">
164<p>Pass backend specific options.</p>
165<p>For example, to enable GpuAcc tuning add the following m_BackendOption.emplace_back( <a class="el" href="structarmnn_1_1_backend_options.html" title="Struct for the users to pass backend specific options. ">BackendOptions</a>{"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( <a class="el" href="structarmnn_1_1_backend_options.html" title="Struct for the users to pass backend specific options. ">BackendOptions</a>{"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] </p>
166
167<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.html#l00104">104</a> of file <a class="el" href="_i_runtime_8hpp_source.html">IRuntime.hpp</a>.</p>
168
169<p class="reference">Referenced by <a class="el" href="_runtime_tests_8cpp_source.html#l00291">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_cl_backend_context_8cpp_source.html#l00153">ClBackendContext::ClBackendContext()</a>.</p>
170
171</div>
172</div>
173<a id="ae43cf4b5df0068ee6a9151c98947248b"></a>
174<h2 class="memtitle"><span class="permalink"><a href="#ae43cf4b5df0068ee6a9151c98947248b">&#9670;&nbsp;</a></span>m_DynamicBackendsPath</h2>
175
176<div class="memitem">
177<div class="memproto">
178 <table class="memname">
179 <tr>
180 <td class="memname">std::string m_DynamicBackendsPath</td>
181 </tr>
182 </table>
183</div><div class="memdoc">
184
185<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.html#l00058">58</a> of file <a class="el" href="_i_runtime_8hpp_source.html">IRuntime.hpp</a>.</p>
186
187<p class="reference">Referenced by <a class="el" href="_inference_model_8hpp_source.html#l00371">InferenceModel&lt; IParser, TDataType &gt;::InferenceModel()</a>, <a class="el" href="_execute_network_8cpp_source.html#l00009">main()</a>, <a class="el" href="_runtime_8cpp_source.html#l00155">Runtime::Runtime()</a>, and <a class="el" href="_dynamic_backend_tests_8hpp_source.html#l01331">RuntimeInvalidOverridePathTestImpl()</a>.</p>
188
189</div>
190</div>
191<a id="a2fe8c3eadf4f4f9c0c664a24a2a298f9"></a>
192<h2 class="memtitle"><span class="permalink"><a href="#a2fe8c3eadf4f4f9c0c664a24a2a298f9">&#9670;&nbsp;</a></span>m_EnableGpuProfiling</h2>
193
194<div class="memitem">
195<div class="memproto">
196 <table class="memname">
197 <tr>
198 <td class="memname">bool m_EnableGpuProfiling</td>
199 </tr>
200 </table>
201</div><div class="memdoc">
202
203<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.html#l00054">54</a> of file <a class="el" href="_i_runtime_8hpp_source.html">IRuntime.hpp</a>.</p>
204
205<p class="reference">Referenced by <a class="el" href="_cl_backend_context_8cpp_source.html#l00153">ClBackendContext::ClBackendContext()</a>, <a class="el" href="_json_printer_test_impl_8cpp_source.html#l00120">GetSoftmaxProfilerJson()</a>, <a class="el" href="_inference_model_8hpp_source.html#l00371">InferenceModel&lt; IParser, TDataType &gt;::InferenceModel()</a>, and <a class="el" href="_execute_network_8cpp_source.html#l00009">main()</a>.</p>
206
207</div>
208</div>
209<a id="a515d755116f35e5b3ab30b7a78a712f1"></a>
210<h2 class="memtitle"><span class="permalink"><a href="#a515d755116f35e5b3ab30b7a78a712f1">&#9670;&nbsp;</a></span>m_GpuAccTunedParameters</h2>
211
212<div class="memitem">
213<div class="memproto">
214 <table class="memname">
215 <tr>
216 <td class="memname">std::shared_ptr&lt;<a class="el" href="classarmnn_1_1_i_gpu_acc_tuned_parameters.html">IGpuAccTunedParameters</a>&gt; m_GpuAccTunedParameters</td>
217 </tr>
218 </table>
219</div><div class="memdoc">
220<p>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. </p>
221
222<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.html#l00051">51</a> of file <a class="el" href="_i_runtime_8hpp_source.html">IRuntime.hpp</a>.</p>
223
224<p class="reference">Referenced by <a class="el" href="_cl_backend_context_8cpp_source.html#l00153">ClBackendContext::ClBackendContext()</a>.</p>
225
226</div>
227</div>
228<a id="a30412a91cadff138686eaeb12f5357cc"></a>
229<h2 class="memtitle"><span class="permalink"><a href="#a30412a91cadff138686eaeb12f5357cc">&#9670;&nbsp;</a></span>m_ProfilingOptions</h2>
230
231<div class="memitem">
232<div class="memproto">
233 <table class="memname">
234 <tr>
235 <td class="memname"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html">ExternalProfilingOptions</a> m_ProfilingOptions</td>
236 </tr>
237 </table>
238</div><div class="memdoc">
239
240<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.html#l00076">76</a> of file <a class="el" href="_i_runtime_8hpp_source.html">IRuntime.hpp</a>.</p>
241
242<p class="reference">Referenced by <a class="el" href="_runtime_tests_8cpp_source.html#l00381">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_execute_network_8cpp_source.html#l00009">main()</a>, <a class="el" href="_runtime_8cpp_source.html#l00155">Runtime::Runtime()</a>, and <a class="el" href="_profiling_test_utils_8cpp_source.html#l00355">VerifyPostOptimisationStructureTestImpl()</a>.</p>
243
244</div>
245</div>
246<hr/>The documentation for this struct was generated from the following file:<ul>
247<li>include/armnn/<a class="el" href="_i_runtime_8hpp_source.html">IRuntime.hpp</a></li>
248</ul>
249</div><!-- contents -->
250</div><!-- doc-content -->
251<!-- start footer part -->
252<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
253 <ul>
254 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_runtime.html">IRuntime</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options.html">CreationOptions</a></li>
255 <li class="footer">Generated on Fri Mar 13 2020 16:07:03 for ArmNN by
256 <a href="http://www.doxygen.org/index.html">
257 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
258 </ul>
259</div>
260</body>
261</html>