Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / a24952b12a56da56b6acabfd07cc60b1663720f9 / . / 21.02 / classarmnn_1_1_cl_backend_model_context.xhtml
blob: b3b7dbb598b1f975c227749ee7542956a11617db [file] [log] [blame]
<!-- 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: ClBackendModelContext Class 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">
&#160;<span id="projectnumber">21.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('classarmnn_1_1_cl_backend_model_context.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> &#124;
<a href="classarmnn_1_1_cl_backend_model_context-members.xhtml">List of all members</a> </div>
<div class="headertitle">
<div class="title">ClBackendModelContext Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classarmnn_1_1_cl_backend_model_context.xhtml" title="The ClBackendModelContext is used to pass in CL specific backend ModelOptions. ">ClBackendModelContext</a> is used to pass in CL specific backend ModelOptions.
<a href="classarmnn_1_1_cl_backend_model_context.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_cl_backend_model_context_8hpp_source.xhtml">ClBackendModelContext.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ClBackendModelContext:</div>
<div class="dyncontent">
<div class="center">
<img src="classarmnn_1_1_cl_backend_model_context.png" usemap="#ClBackendModelContext_map" alt=""/>
<map id="ClBackendModelContext_map" name="ClBackendModelContext_map">
<area href="classarmnn_1_1_i_backend_model_context.xhtml" alt="IBackendModelContext" shape="rect" coords="0,0,150,24"/>
</map>
</div></div>
<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:a337185fa5f1502a2e641b3aabdf24dcc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_model_context.xhtml#a337185fa5f1502a2e641b3aabdf24dcc">ClBackendModelContext</a> (const <a class="el" href="namespacearmnn.xhtml#a5b6893cda5b69359a4244c06054da18f">ModelOptions</a> &amp;modelOptions)</td></tr>
<tr class="separator:a337185fa5f1502a2e641b3aabdf24dcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af63da34dc5a594a3a3458fca1f83571e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_model_context.xhtml#af63da34dc5a594a3a3458fca1f83571e">GetCachedNetworkFilePath</a> () const</td></tr>
<tr class="separator:af63da34dc5a594a3a3458fca1f83571e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe9aa4fa74aca0f9a925752bbbb0f79"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_model_context.xhtml#abfe9aa4fa74aca0f9a925752bbbb0f79">IsFastMathEnabled</a> () const</td></tr>
<tr class="separator:abfe9aa4fa74aca0f9a925752bbbb0f79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9640684f215321d0d93f6f3cb14d5da1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_model_context.xhtml#a9640684f215321d0d93f6f3cb14d5da1">SaveCachedNetwork</a> () const</td></tr>
<tr class="separator:a9640684f215321d0d93f6f3cb14d5da1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classarmnn_1_1_i_backend_model_context"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1_i_backend_model_context')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarmnn_1_1_i_backend_model_context.xhtml">IBackendModelContext</a></td></tr>
<tr class="memitem:a340bc2d4320c899e1506c3a4c099e063 inherit pub_methods_classarmnn_1_1_i_backend_model_context"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_backend_model_context.xhtml#a340bc2d4320c899e1506c3a4c099e063">~IBackendModelContext</a> ()</td></tr>
<tr class="separator:a340bc2d4320c899e1506c3a4c099e063 inherit pub_methods_classarmnn_1_1_i_backend_model_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classarmnn_1_1_cl_backend_model_context.xhtml" title="The ClBackendModelContext is used to pass in CL specific backend ModelOptions. ">ClBackendModelContext</a> is used to pass in CL specific backend ModelOptions. </p>
<p>The supported backend ModelOptions are:</p><ul>
<li>"FastMathEnabled"<br />
Using the fast_math flag can lead to performance improvements in fp32 and fp16 layers but may result in<br />
results with reduced or different precision. The fast_math flag will not have any effect on int8 performance.</li>
<li>"SaveCachedNetwork"<br />
Using the save_cached_network flag enables saving the cached network<br />
to a file given with the cached_network_file_path option.</li>
<li>"CachedNetworkFilePath"<br />
If the cached_network_file_path is a valid file and the save_cached_network flag is present<br />
then the cached network will be saved to the given file.<br />
If the cached_network_file_path is a valid file and the save_cached_network flag is not present<br />
then the cached network will be loaded from the given file.<br />
This will remove the time taken for initial compilation of kernels and speed up the first execution. </li>
</ul>
<p class="definition">Definition at line <a class="el" href="_cl_backend_model_context_8hpp_source.xhtml#l00028">28</a> of file <a class="el" href="_cl_backend_model_context_8hpp_source.xhtml">ClBackendModelContext.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a337185fa5f1502a2e641b3aabdf24dcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a337185fa5f1502a2e641b3aabdf24dcc">&#9670;&nbsp;</a></span>ClBackendModelContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarmnn_1_1_cl_backend_model_context.xhtml">ClBackendModelContext</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacearmnn.xhtml#a5b6893cda5b69359a4244c06054da18f">ModelOptions</a> &amp;&#160;</td>
<td class="paramname"><em>modelOptions</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_cl_backend_model_context_8cpp_source.xhtml#l00034">34</a> of file <a class="el" href="_cl_backend_model_context_8cpp_source.xhtml">ClBackendModelContext.cpp</a>.</p>
<p class="reference">References <a class="el" href="_cl_backend_context_8cpp_source.xhtml#l00106">armnn::ParseFile()</a>, and <a class="el" href="_backend_options_8hpp_source.xhtml#l00283">armnn::ParseOptions()</a>.</p>
<div class="fragment"><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; : m_CachedNetworkFilePath(<span class="stringliteral">&quot;&quot;</span>), m_IsFastMathEnabled(<span class="keyword">false</span>), m_SaveCachedNetwork(<span class="keyword">false</span>)</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">if</span> (!modelOptions.empty())</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="namespacearmnn.xhtml#af457790132251cde6545072d879c7684">ParseOptions</a>(modelOptions, <span class="stringliteral">&quot;GpuAcc&quot;</span>, [&amp;](std::string name, <span class="keyword">const</span> BackendOptions::Var&amp; value)</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">if</span> (name == <span class="stringliteral">&quot;FastMathEnabled&quot;</span>)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; m_IsFastMathEnabled |= ParseBool(value, <span class="keyword">false</span>);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">if</span> (name == <span class="stringliteral">&quot;SaveCachedNetwork&quot;</span>)</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; m_SaveCachedNetwork |= ParseBool(value, <span class="keyword">false</span>);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; }</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">if</span> (name == <span class="stringliteral">&quot;CachedNetworkFilePath&quot;</span>)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; m_CachedNetworkFilePath = <a class="code" href="namespacearmnn.xhtml#a4e9a59f936f3d2050a17597d22825f53">ParseFile</a>(value, <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; });</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}</div><div class="ttc" id="namespacearmnn_xhtml_af457790132251cde6545072d879c7684"><div class="ttname"><a href="namespacearmnn.xhtml#af457790132251cde6545072d879c7684">armnn::ParseOptions</a></div><div class="ttdeci">void ParseOptions(const std::vector&lt; BackendOptions &gt; &amp;options, BackendId backend, F f)</div><div class="ttdef"><b>Definition:</b> <a href="_backend_options_8hpp_source.xhtml#l00283">BackendOptions.hpp:283</a></div></div>
<div class="ttc" id="namespacearmnn_xhtml_a4e9a59f936f3d2050a17597d22825f53"><div class="ttname"><a href="namespacearmnn.xhtml#a4e9a59f936f3d2050a17597d22825f53">armnn::ParseFile</a></div><div class="ttdeci">std::string ParseFile(const BackendOptions::Var &amp;value, std::string defaultValue)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8cpp_source.xhtml#l00106">ClBackendContext.cpp:106</a></div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af63da34dc5a594a3a3458fca1f83571e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af63da34dc5a594a3a3458fca1f83571e">&#9670;&nbsp;</a></span>GetCachedNetworkFilePath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string GetCachedNetworkFilePath </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_cl_backend_model_context_8cpp_source.xhtml#l00057">57</a> of file <a class="el" href="_cl_backend_model_context_8cpp_source.xhtml">ClBackendModelContext.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="_cl_workload_factory_8cpp_source.xhtml#l00063">ClWorkloadFactory::AfterWorkloadsCreated()</a>.</p>
<div class="fragment"><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;{</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">return</span> m_CachedNetworkFilePath;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<a id="abfe9aa4fa74aca0f9a925752bbbb0f79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfe9aa4fa74aca0f9a925752bbbb0f79">&#9670;&nbsp;</a></span>IsFastMathEnabled()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IsFastMathEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_cl_backend_model_context_8cpp_source.xhtml#l00062">62</a> of file <a class="el" href="_cl_backend_model_context_8cpp_source.xhtml">ClBackendModelContext.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="_cl_workload_factory_8cpp_source.xhtml#l00271">ClWorkloadFactory::CreateConvolution2d()</a>, <a class="el" href="_cl_layer_support_8cpp_source.xhtml#l00337">ClLayerSupport::IsConvolution2dSupported()</a>, and <a class="el" href="_cl_backend_8cpp_source.xhtml#l00144">ClBackend::OptimizeSubgraphView()</a>.</p>
<div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;{</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">return</span> m_IsFastMathEnabled;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<a id="a9640684f215321d0d93f6f3cb14d5da1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9640684f215321d0d93f6f3cb14d5da1">&#9670;&nbsp;</a></span>SaveCachedNetwork()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SaveCachedNetwork </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="_cl_backend_model_context_8cpp_source.xhtml#l00067">67</a> of file <a class="el" href="_cl_backend_model_context_8cpp_source.xhtml">ClBackendModelContext.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;{</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">return</span> m_SaveCachedNetwork;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/backends/cl/<a class="el" href="_cl_backend_model_context_8hpp_source.xhtml">ClBackendModelContext.hpp</a></li>
<li>src/backends/cl/<a class="el" href="_cl_backend_model_context_8cpp_source.xhtml">ClBackendModelContext.cpp</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_cl_backend_model_context.xhtml">ClBackendModelContext</a></li>
<li class="footer">Generated on Fri Mar 19 2021 15:26:10 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>