Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 753560b55dbf6656389b95efc8d4df07ac43cc9a / . / Documentation / classarmnn_1_1_optimizer.html
blob: 10b11f0f19f34b4b889a03fb7e40af58f8cd7a34 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: Optimizer Class Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('classarmnn_1_1_optimizer.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="summary">
84<a href="#pub-types">Public Types</a> &#124;
85<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
86<a href="classarmnn_1_1_optimizer-members.html">List of all members</a> </div>
87 <div class="headertitle">
88<div class="title">Optimizer Class Reference</div> </div>
89</div><!--header-->
90<div class="contents">
91
92<p><code>#include &lt;<a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a>&gt;</code></p>
93<table class="memberdecls">
94<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
95Public Types</h2></td></tr>
96<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>
97<tr class="separator:a621bdb49c4a2f879b27d27e771693a46"><td class="memSeparator" colspan="2">&#160;</td></tr>
98<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>
99<tr class="separator:ad1794808004025d6e06c176507197b24"><td class="memSeparator" colspan="2">&#160;</td></tr>
100</table><table class="memberdecls">
101<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
102Static Public Member Functions</h2></td></tr>
103<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>
104<tr class="separator:a1f48ba622b76ea04d15c9b62f642bf08"><td class="memSeparator" colspan="2">&#160;</td></tr>
105</table>
106<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
107<div class="textblock">
108<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>
109</div><h2 class="groupheader">Member Typedef Documentation</h2>
110<a id="a621bdb49c4a2f879b27d27e771693a46"></a>
111<h2 class="memtitle"><span class="permalink"><a href="#a621bdb49c4a2f879b27d27e771693a46">&#9670;&nbsp;</a></span>OptimizationPtr</h2>
112
113<div class="memitem">
114<div class="memproto">
115 <table class="memname">
116 <tr>
117 <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>
118 </tr>
119 </table>
120</div><div class="memdoc">
121
122<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>
123
124</div>
125</div>
126<a id="ad1794808004025d6e06c176507197b24"></a>
127<h2 class="memtitle"><span class="permalink"><a href="#ad1794808004025d6e06c176507197b24">&#9670;&nbsp;</a></span>Optimizations</h2>
128
129<div class="memitem">
130<div class="memproto">
131 <table class="memname">
132 <tr>
133 <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>
134 </tr>
135 </table>
136</div><div class="memdoc">
137
138<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>
139
140</div>
141</div>
142<h2 class="groupheader">Member Function Documentation</h2>
143<a id="a1f48ba622b76ea04d15c9b62f642bf08"></a>
144<h2 class="memtitle"><span class="permalink"><a href="#a1f48ba622b76ea04d15c9b62f642bf08">&#9670;&nbsp;</a></span>Pass()</h2>
145
146<div class="memitem">
147<div class="memproto">
148<table class="mlabels">
149 <tr>
150 <td class="mlabels-left">
151 <table class="memname">
152 <tr>
153 <td class="memname">void Pass </td>
154 <td>(</td>
155 <td class="paramtype"><a class="el" href="classarmnn_1_1_graph.html">Graph</a> &amp;&#160;</td>
156 <td class="paramname"><em>graph</em>, </td>
157 </tr>
158 <tr>
159 <td class="paramkey"></td>
160 <td></td>
161 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optimizer.html#ad1794808004025d6e06c176507197b24">Optimizations</a> &amp;&#160;</td>
162 <td class="paramname"><em>optimizations</em>&#160;</td>
163 </tr>
164 <tr>
165 <td></td>
166 <td>)</td>
167 <td></td><td></td>
168 </tr>
169 </table>
170 </td>
171 <td class="mlabels-right">
172<span class="mlabels"><span class="mlabel">static</span></span> </td>
173 </tr>
174</table>
175</div><div class="memdoc">
176
177<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>
178
179<p class="reference">References <a class="el" href="_graph_8hpp_source.html#l00158">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#l00160">Graph::end()</a>, <a class="el" href="_graph_8hpp_source.html#l00442">Graph::EraseLayer()</a>, <a class="el" href="_graph_8hpp_source.html#l00389">Graph::GetPosInGraph()</a>, and <a class="el" href="_graph_8hpp_source.html#l00173">Graph::TopologicalSort()</a>.</p>
180
181<p class="reference">Referenced by <a class="el" href="_convert_constants_float_to_half_tests_8cpp_source.html#l00018">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_network_8cpp_source.html#l00807">armnn::Optimize()</a>.</p>
182<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">// Create observables to observe changes to the graph</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; AddedLayerObservable addedLayerObservable(graph);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; ErasedLayerNamesObservable erasedLayerNamesObservable(graph);</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordtype">bool</span> graphNeedsSorting = <span class="keyword">false</span>;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">auto</span> it = graph.TopologicalSort().end();</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// Calls TopologicalSort() for every iteration to re-order the list in case layers were added/removed.</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">while</span> (it != graph.TopologicalSort().begin())</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; --it;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp;&amp; optimization : optimizations)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; BOOST_ASSERT(*it);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; optimization-&gt;Run(graph, **it);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">if</span> ((*it)-&gt;IsOutputUnconnected())</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">auto</span> next = std::next(graph.GetPosInGraph(**it));</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; graph.EraseLayer(it);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; it = next;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; graphNeedsSorting = <span class="keyword">true</span>;</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;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="comment">// Add the names of erased layers as related layers to the new added layers</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; erasedLayerName : erasedLayerNamesObservable)</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">for</span> (<span class="keyword">auto</span>&amp; addedLayer : addedLayerObservable)</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; addedLayer-&gt;AddRelatedLayerName(erasedLayerName);</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; }</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; erasedLayerNamesObservable.Clear();</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; addedLayerObservable.Clear();</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; <span class="keywordflow">if</span> (graphNeedsSorting)</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; graphNeedsSorting = <span class="keyword">false</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">break</span>;</div><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; }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div></div><!-- fragment -->
183</div>
184</div>
185<hr/>The documentation for this class was generated from the following files:<ul>
186<li>src/armnn/<a class="el" href="_optimizer_8hpp_source.html">Optimizer.hpp</a></li>
187<li>src/armnn/<a class="el" href="_optimizer_8cpp_source.html">Optimizer.cpp</a></li>
188</ul>
189</div><!-- contents -->
190</div><!-- doc-content -->
191<!-- start footer part -->
192<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
193 <ul>
194 <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>
195 <li class="footer">Generated on Fri Mar 13 2020 16:07:04 for ArmNN by
196 <a href="http://www.doxygen.org/index.html">
197 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
198 </ul>
199</div>
200</body>
201</html>