Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1dc83febfb76d6a770bdf3ba16c4034a970c2320 / . / 24.05 / classarmnn_1_1_optimizer.html
blob: e8e30af2f3966b12a270ab28981b581b1726ed32 [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100[diff] [blame^]1<!-- 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: Optimizer 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_optimizer.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-types">Public Types</a> &#124;
97<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
98<a href="classarmnn_1_1_optimizer-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">Optimizer Class Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103
104<p><code>#include &lt;<a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a>&gt;</code></p>
105<table class="memberdecls">
106<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
107Public Types</h2></td></tr>
108<tr class="memitem:a621bdb49c4a2f879b27d27e771693a46"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimizer.html#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a> = std::unique_ptr&lt; <a class="el" href="classarmnn_1_1_optimization.html">Optimization</a> &gt;</td></tr>
109<tr class="separator:a621bdb49c4a2f879b27d27e771693a46"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<tr class="memitem:ad1794808004025d6e06c176507197b24"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimizer.html#ad1794808004025d6e06c176507197b24">Optimizations</a> = std::vector&lt; <a class="el" href="classarmnn_1_1_optimizer.html#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a> &gt;</td></tr>
111<tr class="separator:ad1794808004025d6e06c176507197b24"><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-static-methods"></a>
114Static Public Member Functions</h2></td></tr>
115<tr class="memitem:a1f48ba622b76ea04d15c9b62f642bf08"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_optimizer.html#a1f48ba622b76ea04d15c9b62f642bf08">Pass</a> (<a class="el" href="classarmnn_1_1_graph.html">Graph</a> &amp;graph, const <a class="el" href="classarmnn_1_1_optimizer.html#ad1794808004025d6e06c176507197b24">Optimizations</a> &amp;optimizations)</td></tr>
116<tr class="separator:a1f48ba622b76ea04d15c9b62f642bf08"><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="_optimizer_8hpp_source.html#l00014">14</a> of file <a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a>.</p>
121</div><h2 class="groupheader">Member Typedef Documentation</h2>
122<a id="a621bdb49c4a2f879b27d27e771693a46"></a>
123<h2 class="memtitle"><span class="permalink"><a href="#a621bdb49c4a2f879b27d27e771693a46">&#9670;&nbsp;</a></span>OptimizationPtr</h2>
124
125<div class="memitem">
126<div class="memproto">
127 <table class="memname">
128 <tr>
129 <td class="memname">using <a class="el" href="classarmnn_1_1_optimizer.html#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a> = std::unique_ptr&lt;<a class="el" href="classarmnn_1_1_optimization.html">Optimization</a>&gt;</td>
130 </tr>
131 </table>
132</div><div class="memdoc">
133
134<p class="definition">Definition at line <a class="el" href="_optimizer_8hpp_source.html#l00017">17</a> of file <a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a>.</p>
135
136</div>
137</div>
138<a id="ad1794808004025d6e06c176507197b24"></a>
139<h2 class="memtitle"><span class="permalink"><a href="#ad1794808004025d6e06c176507197b24">&#9670;&nbsp;</a></span>Optimizations</h2>
140
141<div class="memitem">
142<div class="memproto">
143 <table class="memname">
144 <tr>
145 <td class="memname">using <a class="el" href="classarmnn_1_1_optimizer.html#ad1794808004025d6e06c176507197b24">Optimizations</a> = std::vector&lt;<a class="el" href="classarmnn_1_1_optimizer.html#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a>&gt;</td>
146 </tr>
147 </table>
148</div><div class="memdoc">
149
150<p class="definition">Definition at line <a class="el" href="_optimizer_8hpp_source.html#l00018">18</a> of file <a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a>.</p>
151
152</div>
153</div>
154<h2 class="groupheader">Member Function Documentation</h2>
155<a id="a1f48ba622b76ea04d15c9b62f642bf08"></a>
156<h2 class="memtitle"><span class="permalink"><a href="#a1f48ba622b76ea04d15c9b62f642bf08">&#9670;&nbsp;</a></span>Pass()</h2>
157
158<div class="memitem">
159<div class="memproto">
160<table class="mlabels">
161 <tr>
162 <td class="mlabels-left">
163 <table class="memname">
164 <tr>
165 <td class="memname">void Pass </td>
166 <td>(</td>
167 <td class="paramtype"><a class="el" href="classarmnn_1_1_graph.html">Graph</a> &amp;&#160;</td>
168 <td class="paramname"><em>graph</em>, </td>
169 </tr>
170 <tr>
171 <td class="paramkey"></td>
172 <td></td>
173 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optimizer.html#ad1794808004025d6e06c176507197b24">Optimizations</a> &amp;&#160;</td>
174 <td class="paramname"><em>optimizations</em>&#160;</td>
175 </tr>
176 <tr>
177 <td></td>
178 <td>)</td>
179 <td></td><td></td>
180 </tr>
181 </table>
182 </td>
183 <td class="mlabels-right">
184<span class="mlabels"><span class="mlabel">static</span></span> </td>
185 </tr>
186</table>
187</div><div class="memdoc">
188
189<p class="definition">Definition at line <a class="el" href="_optimizer_8cpp_source.html#l00016">16</a> of file <a class="el" href="_optimizer_8cpp_source.html">Optimizer.cpp</a>.</p>
190<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div>
191<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <a class="code" href="_profiling_8hpp.html#a5ccc65e2c464ac05ce311fdae7ede03a">ARMNN_SCOPED_PROFILING_EVENT</a>(<a class="code" href="namespacearmnn.html#ae2f04a162585c0a5222a537efd5456aeaec0fc0100c4fc1ce4eea230c3dc10360">Compute::Undefined</a>, <span class="stringliteral">&quot;Optimizer_Pass&quot;</span>);</div>
192<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="comment">// Create observables to observe changes to the graph</span></div>
193<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; AddedLayerObservable addedLayerObservable(graph);</div>
194<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; ErasedLayerNamesObservable erasedLayerNamesObservable(graph);</div>
195<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
196<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordtype">bool</span> graphNeedsSorting = <span class="keyword">false</span>;</div>
197<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">auto</span> it = graph.TopologicalSort().end();</div>
198<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
199<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="comment">// Calls TopologicalSort() for every iteration to re-order the list in case layers were added/removed.</span></div>
200<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">while</span> (it != graph.TopologicalSort().begin())</div>
201<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div>
202<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; --it;</div>
203<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp;&amp; optimization : optimizations)</div>
204<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {</div>
205<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">if</span> (!*it)</div>
206<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; {</div>
207<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_null_pointer_exception.html">armnn::NullPointerException</a>(<span class="stringliteral">&quot;Layer must not be null.&quot;</span>);</div>
208<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</div>
209<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
210<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; optimization-&gt;Run(graph, **it);</div>
211<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
212<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">if</span> ((*it)-&gt;IsOutputUnconnected())</div>
213<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; {</div>
214<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">auto</span> next = std::next(graph.GetPosInGraph(**it));</div>
215<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; graph.EraseLayer(it);</div>
216<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; it = next;</div>
217<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; graphNeedsSorting = <span class="keyword">true</span>;</div>
218<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div>
219<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
220<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="comment">// Add the names of erased layers as related layers to the new added layers</span></div>
221<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; erasedLayerName : erasedLayerNamesObservable)</div>
222<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; {</div>
223<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; addedLayer : addedLayerObservable)</div>
224<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; {</div>
225<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; addedLayer-&gt;AddRelatedLayerName(erasedLayerName);</div>
226<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div>
227<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div>
228<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
229<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; erasedLayerNamesObservable.Clear();</div>
230<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; addedLayerObservable.Clear();</div>
231<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
232<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">if</span> (graphNeedsSorting)</div>
233<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; {</div>
234<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; graphNeedsSorting = <span class="keyword">false</span>;</div>
235<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordflow">break</span>;</div>
236<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div>
237<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; }</div>
238<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; }</div>
239<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;}</div>
240</div><!-- fragment -->
241<p class="reference">References <a class="el" href="_profiling_8hpp_source.html#l00220">ARMNN_SCOPED_PROFILING_EVENT</a>, <a class="el" href="_graph_8hpp_source.html#l00176">Graph::begin()</a>, <a class="el" href="_observable_8hpp_source.html#l00026">GraphObservable&lt; ObservedType &gt;::Clear()</a>, <a class="el" href="_graph_8hpp_source.html#l00178">Graph::end()</a>, <a class="el" href="_graph_8hpp_source.html#l00517">Graph::EraseLayer()</a>, <a class="el" href="_graph_8hpp_source.html#l00455">Graph::GetPosInGraph()</a>, <a class="el" href="_graph_8hpp_source.html#l00191">Graph::TopologicalSort()</a>, and <a class="el" href="namespacearmnn.html#ae2f04a162585c0a5222a537efd5456aeaec0fc0100c4fc1ce4eea230c3dc10360">armnn::Undefined</a>.</p>
242
243<p class="reference">Referenced by <a class="el" href="_network_8cpp_source.html#l01320">armnn::ApplyBackendOptimizations()</a>.</p>
244
245</div>
246</div>
247<hr/>The documentation for this class was generated from the following files:<ul>
248<li>src/armnn/<a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a></li>
249<li>src/armnn/<a class="el" href="_optimizer_8cpp_source.html">Optimizer.cpp</a></li>
250</ul>
251</div><!-- contents -->
252</div><!-- doc-content -->
253<div class="ttc" id="anamespacearmnn_html_ae2f04a162585c0a5222a537efd5456aeaec0fc0100c4fc1ce4eea230c3dc10360"><div class="ttname"><a href="namespacearmnn.html#ae2f04a162585c0a5222a537efd5456aeaec0fc0100c4fc1ce4eea230c3dc10360">armnn::Compute::Undefined</a></div><div class="ttdeci">@ Undefined</div></div>
254<div class="ttc" id="a_profiling_8hpp_html_a5ccc65e2c464ac05ce311fdae7ede03a"><div class="ttname"><a href="_profiling_8hpp.html#a5ccc65e2c464ac05ce311fdae7ede03a">ARMNN_SCOPED_PROFILING_EVENT</a></div><div class="ttdeci">#define ARMNN_SCOPED_PROFILING_EVENT(backendId, name)</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8hpp_source.html#l00220">Profiling.hpp:220</a></div></div>
255<div class="ttc" id="aclassarmnn_1_1_null_pointer_exception_html"><div class="ttname"><a href="classarmnn_1_1_null_pointer_exception.html">armnn::NullPointerException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00146">Exceptions.hpp:146</a></div></div>
256<!-- start footer part -->
257<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
258 <ul>
259 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_optimizer.html">Optimizer</a></li>
260 <li class="footer">Generated on Thu May 16 2024 09:31:58 for Arm NN by
261 <a href="http://www.doxygen.org/index.html">
262 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
263 </ul>
264</div>
265</body>
266</html>