blob: 03644a5d1213437c71f3dbfd99eb3e1399f95db7 [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +01001<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: NeonBackendModelContext Class Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.05</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('classarmnn_1_1_neon_backend_model_context.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="classarmnn_1_1_neon_backend_model_context-members.html">List of all members</a> </div>
98 <div class="headertitle">
99<div class="title">NeonBackendModelContext Class Reference</div> </div>
100</div><!--header-->
101<div class="contents">
102
103<p>The <a class="el" href="classarmnn_1_1_neon_backend_model_context.html" title="The NeonBackendModelContext is used to pass in Neon specific backend ModelOptions.">NeonBackendModelContext</a> is used to pass in Neon specific backend ModelOptions.
104 <a href="classarmnn_1_1_neon_backend_model_context.html#details">More...</a></p>
105
106<p><code>#include &lt;<a class="el" href="_neon_backend_model_context_8hpp_source.html">NeonBackendModelContext.hpp</a>&gt;</code></p>
107<div class="dynheader">
108Inheritance diagram for NeonBackendModelContext:</div>
109<div class="dyncontent">
110<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_neon_backend_model_context__inherit__graph.svg" width="214" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
111</div>
112<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
113<div class="dynheader">
114Collaboration diagram for NeonBackendModelContext:</div>
115<div class="dyncontent">
116<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_neon_backend_model_context__coll__graph.svg" width="214" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
117</div>
118<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
119<table class="memberdecls">
120<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
121Public Member Functions</h2></td></tr>
122<tr class="memitem:ad294d1b0a3cacd966314a512d96f46fb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_neon_backend_model_context.html#ad294d1b0a3cacd966314a512d96f46fb">NeonBackendModelContext</a> (const <a class="el" href="namespacearmnn.html#a5b6893cda5b69359a4244c06054da18f">ModelOptions</a> &amp;modelOptions)</td></tr>
123<tr class="separator:ad294d1b0a3cacd966314a512d96f46fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<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_neon_backend_model_context.html#abfe9aa4fa74aca0f9a925752bbbb0f79">IsFastMathEnabled</a> () const</td></tr>
125<tr class="separator:abfe9aa4fa74aca0f9a925752bbbb0f79"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:ab496797d400c4976d0d4b15b110bf7d9"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_neon_backend_model_context.html#ab496797d400c4976d0d4b15b110bf7d9">GetNumberOfThreads</a> () const</td></tr>
127<tr class="separator:ab496797d400c4976d0d4b15b110bf7d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
128<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.html">IBackendModelContext</a></td></tr>
129<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.html#a340bc2d4320c899e1506c3a4c099e063">~IBackendModelContext</a> ()</td></tr>
130<tr class="separator:a340bc2d4320c899e1506c3a4c099e063 inherit pub_methods_classarmnn_1_1_i_backend_model_context"><td class="memSeparator" colspan="2">&#160;</td></tr>
131</table>
132<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
133<div class="textblock"><p>The <a class="el" href="classarmnn_1_1_neon_backend_model_context.html" title="The NeonBackendModelContext is used to pass in Neon specific backend ModelOptions.">NeonBackendModelContext</a> is used to pass in Neon specific backend ModelOptions. </p>
134<p>The supported backend ModelOptions are:</p><ul>
135<li>"FastMathEnabled"<br />
136 Using the fast_math flag can lead to performance improvements in fp32 and fp16 layers but may result in<br />
137 results with reduced or different precision. The fast_math flag will not have any effect on int8 performance.</li>
138<li>"NumberOfThreads"<br />
139 Specify the number of threads used by the CpuAcc backend. </li>
140</ul>
141
142<p class="definition">Definition at line <a class="el" href="_neon_backend_model_context_8hpp_source.html#l00019">19</a> of file <a class="el" href="_neon_backend_model_context_8hpp_source.html">NeonBackendModelContext.hpp</a>.</p>
143</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
144<a id="ad294d1b0a3cacd966314a512d96f46fb"></a>
145<h2 class="memtitle"><span class="permalink"><a href="#ad294d1b0a3cacd966314a512d96f46fb">&#9670;&nbsp;</a></span>NeonBackendModelContext()</h2>
146
147<div class="memitem">
148<div class="memproto">
149 <table class="memname">
150 <tr>
151 <td class="memname"><a class="el" href="classarmnn_1_1_neon_backend_model_context.html">NeonBackendModelContext</a> </td>
152 <td>(</td>
153 <td class="paramtype">const <a class="el" href="namespacearmnn.html#a5b6893cda5b69359a4244c06054da18f">ModelOptions</a> &amp;&#160;</td>
154 <td class="paramname"><em>modelOptions</em></td><td>)</td>
155 <td></td>
156 </tr>
157 </table>
158</div><div class="memdoc">
159
160<p class="definition">Definition at line <a class="el" href="_neon_backend_model_context_8cpp_source.html#l00034">34</a> of file <a class="el" href="_neon_backend_model_context_8cpp_source.html">NeonBackendModelContext.cpp</a>.</p>
161<div class="fragment"><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; : m_IsFastMathEnabled(<span class="keyword">false</span>), m_NumberOfThreads(0)</div>
162<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div>
163<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">if</span> (!modelOptions.empty())</div>
164<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; {</div>
165<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="namespacearmnn.html#af457790132251cde6545072d879c7684">ParseOptions</a>(modelOptions, <span class="stringliteral">&quot;CpuAcc&quot;</span>, [&amp;](std::string name, <span class="keyword">const</span> BackendOptions::Var&amp; value)</div>
166<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; {</div>
167<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>
168<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; {</div>
169<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; m_IsFastMathEnabled |= ParseBool(value, <span class="keyword">false</span>);</div>
170<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div>
171<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">if</span> (name == <span class="stringliteral">&quot;NumberOfThreads&quot;</span>)</div>
172<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; {</div>
173<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; m_NumberOfThreads |= ParseUnsignedInt(value, 0);</div>
174<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; }</div>
175<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; });</div>
176<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
177<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;}</div>
178</div><!-- fragment -->
179<p class="reference">References <a class="el" href="_backend_options_8hpp_source.html#l00297">armnn::ParseOptions()</a>.</p>
180
181</div>
182</div>
183<h2 class="groupheader">Member Function Documentation</h2>
184<a id="ab496797d400c4976d0d4b15b110bf7d9"></a>
185<h2 class="memtitle"><span class="permalink"><a href="#ab496797d400c4976d0d4b15b110bf7d9">&#9670;&nbsp;</a></span>GetNumberOfThreads()</h2>
186
187<div class="memitem">
188<div class="memproto">
189 <table class="memname">
190 <tr>
191 <td class="memname">unsigned int GetNumberOfThreads </td>
192 <td>(</td>
193 <td class="paramname"></td><td>)</td>
194 <td> const</td>
195 </tr>
196 </table>
197</div><div class="memdoc">
198
199<p class="definition">Definition at line <a class="el" href="_neon_backend_model_context_8cpp_source.html#l00058">58</a> of file <a class="el" href="_neon_backend_model_context_8cpp_source.html">NeonBackendModelContext.cpp</a>.</p>
200<div class="fragment"><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;{</div>
201<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> m_NumberOfThreads;</div>
202<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div>
203</div><!-- fragment -->
204</div>
205</div>
206<a id="abfe9aa4fa74aca0f9a925752bbbb0f79"></a>
207<h2 class="memtitle"><span class="permalink"><a href="#abfe9aa4fa74aca0f9a925752bbbb0f79">&#9670;&nbsp;</a></span>IsFastMathEnabled()</h2>
208
209<div class="memitem">
210<div class="memproto">
211 <table class="memname">
212 <tr>
213 <td class="memname">bool IsFastMathEnabled </td>
214 <td>(</td>
215 <td class="paramname"></td><td>)</td>
216 <td> const</td>
217 </tr>
218 </table>
219</div><div class="memdoc">
220
221<p class="definition">Definition at line <a class="el" href="_neon_backend_model_context_8cpp_source.html#l00053">53</a> of file <a class="el" href="_neon_backend_model_context_8cpp_source.html">NeonBackendModelContext.cpp</a>.</p>
222<div class="fragment"><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;{</div>
223<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">return</span> m_IsFastMathEnabled;</div>
224<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;}</div>
225</div><!-- fragment -->
226<p class="reference">Referenced by <a class="el" href="_neon_workload_factory_8cpp_source.html#l00134">NeonWorkloadFactory::CreateWorkload()</a>, <a class="el" href="_neon_layer_support_8cpp_source.html#l00808">NeonLayerSupport::IsBatchMatMulSupported()</a>, <a class="el" href="_neon_layer_support_8cpp_source.html#l00975">NeonLayerSupport::IsConvolution2dSupported()</a>, and <a class="el" href="_neon_layer_support_8cpp_source.html#l01008">NeonLayerSupport::IsConvolution3dSupported()</a>.</p>
227
228</div>
229</div>
230<hr/>The documentation for this class was generated from the following files:<ul>
231<li>src/backends/neon/<a class="el" href="_neon_backend_model_context_8hpp_source.html">NeonBackendModelContext.hpp</a></li>
232<li>src/backends/neon/<a class="el" href="_neon_backend_model_context_8cpp_source.html">NeonBackendModelContext.cpp</a></li>
233</ul>
234</div><!-- contents -->
235</div><!-- doc-content -->
236<div class="ttc" id="anamespacearmnn_html_af457790132251cde6545072d879c7684"><div class="ttname"><a href="namespacearmnn.html#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.html#l00297">BackendOptions.hpp:297</a></div></div>
237<!-- start footer part -->
238<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
239 <ul>
240 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_neon_backend_model_context.html">NeonBackendModelContext</a></li>
241 <li class="footer">Generated on Thu May 16 2024 09:31:57 for Arm NN by
242 <a href="http://www.doxygen.org/index.html">
243 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
244 </ul>
245</div>
246</body>
247</html>