diff options
author | Jim Flynn <jim.flynn@arm.com> | 2020-03-19 17:03:14 +0000 |
---|---|---|
committer | Jim Flynn <jim.flynn@arm.com> | 2020-03-19 17:03:14 +0000 |
commit | 0e2bab81442ee6cc2b94e4f7881ed0c5c6af65e7 (patch) | |
tree | b0af08b5a0b74149fca422151127ac6310385399 /Documentation/structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml | |
parent | 8c3259fa007d43fcc5ea56fe6928526dbe79f3c0 (diff) | |
download | armnn-0e2bab81442ee6cc2b94e4f7881ed0c5c6af65e7.tar.gz |
Creating gh-pages documentation for ArmNN
Signed-off-by: Jim Flynn <jim.flynn@arm.com>
Diffstat (limited to 'Documentation/structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml')
-rw-r--r-- | Documentation/structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml | 269 |
1 files changed, 269 insertions, 0 deletions
diff --git a/Documentation/structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml b/Documentation/structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml new file mode 100644 index 0000000000..d5f7f3ec1f --- /dev/null +++ b/Documentation/structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml @@ -0,0 +1,269 @@ +<!-- 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::ExternalProfilingOptions 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">20.02</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_1_1_external_profiling_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="#pub-methods">Public Member Functions</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">IRuntime::CreationOptions::ExternalProfilingOptions 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="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:ad290ff73f5e32ea7e4e549d743815ff8"><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_1_1_external_profiling_options.xhtml#ad290ff73f5e32ea7e4e549d743815ff8">ExternalProfilingOptions</a> ()</td></tr> +<tr class="separator:ad290ff73f5e32ea7e4e549d743815ff8"><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:a26d42007440bb01a1a6d0ab3b5a657ee"><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_1_1_external_profiling_options.xhtml#a26d42007440bb01a1a6d0ab3b5a657ee">m_EnableProfiling</a></td></tr> +<tr class="separator:a26d42007440bb01a1a6d0ab3b5a657ee"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa0d6aa79d683bc79d20d4ddcf7db87db"><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_1_1_external_profiling_options.xhtml#aa0d6aa79d683bc79d20d4ddcf7db87db">m_OutgoingCaptureFile</a></td></tr> +<tr class="separator:aa0d6aa79d683bc79d20d4ddcf7db87db"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a36dd18e4f73d470e3234d72198aa5fef"><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_1_1_external_profiling_options.xhtml#a36dd18e4f73d470e3234d72198aa5fef">m_IncomingCaptureFile</a></td></tr> +<tr class="separator:a36dd18e4f73d470e3234d72198aa5fef"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad8f8cb971cad412664cd7df58df7eb1e"><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_1_1_external_profiling_options.xhtml#ad8f8cb971cad412664cd7df58df7eb1e">m_FileOnly</a></td></tr> +<tr class="separator:ad8f8cb971cad412664cd7df58df7eb1e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2239347f38747f993c324bdd8b1eb146"><td class="memItemLeft" align="right" valign="top">uint32_t </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> +<tr class="separator:a2239347f38747f993c324bdd8b1eb146"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"> +<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> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ad290ff73f5e32ea7e4e549d743815ff8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad290ff73f5e32ea7e4e549d743815ff8">◆ </a></span>ExternalProfilingOptions()</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_1_1_external_profiling_options.xhtml">ExternalProfilingOptions</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#l00062">62</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  : <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>  , <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">""</span>)</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  , <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">""</span>)</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  , <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>  , <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>  {}</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> +<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> +<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> +<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> +<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> +<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> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a2239347f38747f993c324bdd8b1eb146"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2239347f38747f993c324bdd8b1eb146">◆ </a></span>m_CapturePeriod</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">uint32_t m_CapturePeriod</td> + </tr> + </table> +</div><div class="memdoc"> + +<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> + +<p class="reference">Referenced by <a class="el" href="_execute_network_8cpp_source.xhtml#l00009">main()</a>.</p> + +</div> +</div> +<a id="a26d42007440bb01a1a6d0ab3b5a657ee"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a26d42007440bb01a1a6d0ab3b5a657ee">◆ </a></span>m_EnableProfiling</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool m_EnableProfiling</td> + </tr> + </table> +</div><div class="memdoc"> + +<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> + +<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> + +</div> +</div> +<a id="ad8f8cb971cad412664cd7df58df7eb1e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad8f8cb971cad412664cd7df58df7eb1e">◆ </a></span>m_FileOnly</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool m_FileOnly</td> + </tr> + </table> +</div><div class="memdoc"> + +<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> + +<p class="reference">Referenced by <a class="el" href="_execute_network_8cpp_source.xhtml#l00009">main()</a>.</p> + +</div> +</div> +<a id="a36dd18e4f73d470e3234d72198aa5fef"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a36dd18e4f73d470e3234d72198aa5fef">◆ </a></span>m_IncomingCaptureFile</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string m_IncomingCaptureFile</td> + </tr> + </table> +</div><div class="memdoc"> + +<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> + +<p class="reference">Referenced by <a class="el" href="_execute_network_8cpp_source.xhtml#l00009">main()</a>.</p> + +</div> +</div> +<a id="aa0d6aa79d683bc79d20d4ddcf7db87db"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa0d6aa79d683bc79d20d4ddcf7db87db">◆ </a></span>m_OutgoingCaptureFile</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string m_OutgoingCaptureFile</td> + </tr> + </table> +</div><div class="memdoc"> + +<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> + +<p class="reference">Referenced by <a class="el" href="_execute_network_8cpp_source.xhtml#l00009">main()</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="navelem"><a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml">ExternalProfilingOptions</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:18 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> |