Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 36eed46563a2a254e674865eb8ede62a1558c997 / . / Documentation / structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml
blob: d5f7f3ec1fb6a028bcbe2121b222e2e3ecedae23 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: IRuntime::CreationOptions::ExternalProfilingOptions Struct Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">20.02</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="#pub-attribs">Public Attributes</a> &#124;
100<a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">IRuntime::CreationOptions::ExternalProfilingOptions Struct Reference</div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p><code>#include &lt;<a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>&gt;</code></p>
107<table class="memberdecls">
108<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
109Public Member Functions</h2></td></tr>
110<tr class="memitem:ad290ff73f5e32ea7e4e549d743815ff8"><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_1_1_external_profiling_options.xhtml#ad290ff73f5e32ea7e4e549d743815ff8">ExternalProfilingOptions</a> ()</td></tr>
111<tr class="separator:ad290ff73f5e32ea7e4e549d743815ff8"><td class="memSeparator" colspan="2">&#160;</td></tr>
112</table><table class="memberdecls">
113<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
114Public Attributes</h2></td></tr>
115<tr class="memitem:a26d42007440bb01a1a6d0ab3b5a657ee"><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_1_1_external_profiling_options.xhtml#a26d42007440bb01a1a6d0ab3b5a657ee">m_EnableProfiling</a></td></tr>
116<tr class="separator:a26d42007440bb01a1a6d0ab3b5a657ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<tr class="memitem:aa0d6aa79d683bc79d20d4ddcf7db87db"><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_1_1_external_profiling_options.xhtml#aa0d6aa79d683bc79d20d4ddcf7db87db">m_OutgoingCaptureFile</a></td></tr>
118<tr class="separator:aa0d6aa79d683bc79d20d4ddcf7db87db"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<tr class="memitem:a36dd18e4f73d470e3234d72198aa5fef"><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_1_1_external_profiling_options.xhtml#a36dd18e4f73d470e3234d72198aa5fef">m_IncomingCaptureFile</a></td></tr>
120<tr class="separator:a36dd18e4f73d470e3234d72198aa5fef"><td class="memSeparator" colspan="2">&#160;</td></tr>
121<tr class="memitem:ad8f8cb971cad412664cd7df58df7eb1e"><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_1_1_external_profiling_options.xhtml#ad8f8cb971cad412664cd7df58df7eb1e">m_FileOnly</a></td></tr>
122<tr class="separator:ad8f8cb971cad412664cd7df58df7eb1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
123<tr class="memitem:a2239347f38747f993c324bdd8b1eb146"><td class="memItemLeft" align="right" valign="top">uint32_t&#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.xhtml#a2239347f38747f993c324bdd8b1eb146">m_CapturePeriod</a></td></tr>
124<tr class="separator:a2239347f38747f993c324bdd8b1eb146"><td class="memSeparator" colspan="2">&#160;</td></tr>
125</table>
126<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
127<div class="textblock">
128<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00060">60</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p>
129</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
130<a id="ad290ff73f5e32ea7e4e549d743815ff8"></a>
131<h2 class="memtitle"><span class="permalink"><a href="#ad290ff73f5e32ea7e4e549d743815ff8">&#9670;&nbsp;</a></span>ExternalProfilingOptions()</h2>
132
133<div class="memitem">
134<div class="memproto">
135<table class="mlabels">
136 <tr>
137 <td class="mlabels-left">
138 <table class="memname">
139 <tr>
140 <td class="memname"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml">ExternalProfilingOptions</a> </td>
141 <td>(</td>
142 <td class="paramname"></td><td>)</td>
143 <td></td>
144 </tr>
145 </table>
146 </td>
147 <td class="mlabels-right">
148<span class="mlabels"><span class="mlabel">inline</span></span> </td>
149 </tr>
150</table>
151</div><div class="memdoc">
152
153<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00062">62</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p>
154<div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; : <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a26d42007440bb01a1a6d0ab3b5a657ee">m_EnableProfiling</a>(<span class="keyword">false</span>)</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#aa0d6aa79d683bc79d20d4ddcf7db87db">m_OutgoingCaptureFile</a>(<span class="stringliteral">&quot;&quot;</span>)</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a36dd18e4f73d470e3234d72198aa5fef">m_IncomingCaptureFile</a>(<span class="stringliteral">&quot;&quot;</span>)</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#ad8f8cb971cad412664cd7df58df7eb1e">m_FileOnly</a>(<span class="keyword">false</span>)</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; , <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a2239347f38747f993c324bdd8b1eb146">m_CapturePeriod</a>(<a class="code" href="namespacearmnn.xhtml#a602ddc6408c3347ba4c1eba623003984">LOWEST_CAPTURE_PERIOD</a>)</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; {}</div><div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_aa0d6aa79d683bc79d20d4ddcf7db87db"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#aa0d6aa79d683bc79d20d4ddcf7db87db">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_OutgoingCaptureFile</a></div><div class="ttdeci">std::string m_OutgoingCaptureFile</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00071">IRuntime.hpp:71</a></div></div>
155<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_a36dd18e4f73d470e3234d72198aa5fef"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a36dd18e4f73d470e3234d72198aa5fef">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_IncomingCaptureFile</a></div><div class="ttdeci">std::string m_IncomingCaptureFile</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00072">IRuntime.hpp:72</a></div></div>
156<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_a26d42007440bb01a1a6d0ab3b5a657ee"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a26d42007440bb01a1a6d0ab3b5a657ee">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_EnableProfiling</a></div><div class="ttdeci">bool m_EnableProfiling</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00070">IRuntime.hpp:70</a></div></div>
157<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_ad8f8cb971cad412664cd7df58df7eb1e"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#ad8f8cb971cad412664cd7df58df7eb1e">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_FileOnly</a></div><div class="ttdeci">bool m_FileOnly</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00073">IRuntime.hpp:73</a></div></div>
158<div class="ttc" id="namespacearmnn_xhtml_a602ddc6408c3347ba4c1eba623003984"><div class="ttname"><a href="namespacearmnn.xhtml#a602ddc6408c3347ba4c1eba623003984">armnn::LOWEST_CAPTURE_PERIOD</a></div><div class="ttdeci">constexpr unsigned int LOWEST_CAPTURE_PERIOD</div><div class="ttdoc">The lowest performance data capture interval we support is 10 miliseconds. </div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.xhtml#l00021">Types.hpp:21</a></div></div>
159<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_a2239347f38747f993c324bdd8b1eb146"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a2239347f38747f993c324bdd8b1eb146">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_CapturePeriod</a></div><div class="ttdeci">uint32_t m_CapturePeriod</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00074">IRuntime.hpp:74</a></div></div>
160</div><!-- fragment -->
161</div>
162</div>
163<h2 class="groupheader">Member Data Documentation</h2>
164<a id="a2239347f38747f993c324bdd8b1eb146"></a>
165<h2 class="memtitle"><span class="permalink"><a href="#a2239347f38747f993c324bdd8b1eb146">&#9670;&nbsp;</a></span>m_CapturePeriod</h2>
166
167<div class="memitem">
168<div class="memproto">
169 <table class="memname">
170 <tr>
171 <td class="memname">uint32_t m_CapturePeriod</td>
172 </tr>
173 </table>
174</div><div class="memdoc">
175
176<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00074">74</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p>
177
178<p class="reference">Referenced by <a class="el" href="_execute_network_8cpp_source.xhtml#l00009">main()</a>.</p>
179
180</div>
181</div>
182<a id="a26d42007440bb01a1a6d0ab3b5a657ee"></a>
183<h2 class="memtitle"><span class="permalink"><a href="#a26d42007440bb01a1a6d0ab3b5a657ee">&#9670;&nbsp;</a></span>m_EnableProfiling</h2>
184
185<div class="memitem">
186<div class="memproto">
187 <table class="memname">
188 <tr>
189 <td class="memname">bool m_EnableProfiling</td>
190 </tr>
191 </table>
192</div><div class="memdoc">
193
194<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00070">70</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p>
195
196<p class="reference">Referenced by <a class="el" href="_runtime_tests_8cpp_source.xhtml#l00365">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_profiling_service_8cpp_source.xhtml#l00039">ProfilingService::ConfigureProfilingService()</a>, <a class="el" href="_profiling_service_8hpp_source.xhtml#l00112">ProfilingService::IsEnabled()</a>, <a class="el" href="_profiling_service_8cpp_source.xhtml#l00034">ProfilingService::IsProfilingEnabled()</a>, <a class="el" href="_execute_network_8cpp_source.xhtml#l00009">main()</a>, <a class="el" href="_profiling_service_8cpp_source.xhtml#l00089">ProfilingService::Update()</a>, and <a class="el" href="_profiling_test_utils_8cpp_source.xhtml#l00290">VerifyPostOptimisationStructureTestImpl()</a>.</p>
197
198</div>
199</div>
200<a id="ad8f8cb971cad412664cd7df58df7eb1e"></a>
201<h2 class="memtitle"><span class="permalink"><a href="#ad8f8cb971cad412664cd7df58df7eb1e">&#9670;&nbsp;</a></span>m_FileOnly</h2>
202
203<div class="memitem">
204<div class="memproto">
205 <table class="memname">
206 <tr>
207 <td class="memname">bool m_FileOnly</td>
208 </tr>
209 </table>
210</div><div class="memdoc">
211
212<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00073">73</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p>
213
214<p class="reference">Referenced by <a class="el" href="_execute_network_8cpp_source.xhtml#l00009">main()</a>.</p>
215
216</div>
217</div>
218<a id="a36dd18e4f73d470e3234d72198aa5fef"></a>
219<h2 class="memtitle"><span class="permalink"><a href="#a36dd18e4f73d470e3234d72198aa5fef">&#9670;&nbsp;</a></span>m_IncomingCaptureFile</h2>
220
221<div class="memitem">
222<div class="memproto">
223 <table class="memname">
224 <tr>
225 <td class="memname">std::string m_IncomingCaptureFile</td>
226 </tr>
227 </table>
228</div><div class="memdoc">
229
230<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00072">72</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p>
231
232<p class="reference">Referenced by <a class="el" href="_execute_network_8cpp_source.xhtml#l00009">main()</a>.</p>
233
234</div>
235</div>
236<a id="aa0d6aa79d683bc79d20d4ddcf7db87db"></a>
237<h2 class="memtitle"><span class="permalink"><a href="#aa0d6aa79d683bc79d20d4ddcf7db87db">&#9670;&nbsp;</a></span>m_OutgoingCaptureFile</h2>
238
239<div class="memitem">
240<div class="memproto">
241 <table class="memname">
242 <tr>
243 <td class="memname">std::string m_OutgoingCaptureFile</td>
244 </tr>
245 </table>
246</div><div class="memdoc">
247
248<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00071">71</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p>
249
250<p class="reference">Referenced by <a class="el" href="_execute_network_8cpp_source.xhtml#l00009">main()</a>.</p>
251
252</div>
253</div>
254<hr/>The documentation for this struct was generated from the following file:<ul>
255<li>include/armnn/<a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a></li>
256</ul>
257</div><!-- contents -->
258</div><!-- doc-content -->
259<!-- start footer part -->
260<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
261 <ul>
262 <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="navelem"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml">ExternalProfilingOptions</a></li>
263 <li class="footer">Generated on Fri Mar 13 2020 16:09:18 for ArmNN by
264 <a href="http://www.doxygen.org/index.html">
265 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
266 </ul>
267</div>
268</body>
269</html>