Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 59da369d2a66e49eb0f84d596ed7162621c32d06 / . / Documentation / classarmnn_1_1_optimizer.xhtml
blob: 0049e5758a8375cc1f6a78611e22c95e2ba24deb [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: Optimizer Class Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">20.02</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('classarmnn_1_1_optimizer.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-types">Public Types</a> &#124;
99<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
100<a href="classarmnn_1_1_optimizer-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">Optimizer Class Reference</div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p><code>#include &lt;<a class="el" href="_optimizer_8hpp_source.xhtml">Optimizer.hpp</a>&gt;</code></p>
107<table class="memberdecls">
108<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
109Public Types</h2></td></tr>
110<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.xhtml#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a> = std::unique_ptr&lt; <a class="el" href="classarmnn_1_1_optimization.xhtml">Optimization</a> &gt;</td></tr>
111<tr class="separator:a621bdb49c4a2f879b27d27e771693a46"><td class="memSeparator" colspan="2">&#160;</td></tr>
112<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.xhtml#ad1794808004025d6e06c176507197b24">Optimizations</a> = std::vector&lt; <a class="el" href="classarmnn_1_1_optimizer.xhtml#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a> &gt;</td></tr>
113<tr class="separator:ad1794808004025d6e06c176507197b24"><td class="memSeparator" colspan="2">&#160;</td></tr>
114</table><table class="memberdecls">
115<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
116Static Public Member Functions</h2></td></tr>
117<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.xhtml#a1f48ba622b76ea04d15c9b62f642bf08">Pass</a> (<a class="el" href="classarmnn_1_1_graph.xhtml">Graph</a> &amp;graph, const <a class="el" href="classarmnn_1_1_optimizer.xhtml#ad1794808004025d6e06c176507197b24">Optimizations</a> &amp;optimizations)</td></tr>
118<tr class="separator:a1f48ba622b76ea04d15c9b62f642bf08"><td class="memSeparator" colspan="2">&#160;</td></tr>
119</table>
120<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
121<div class="textblock">
122<p class="definition">Definition at line <a class="el" href="_optimizer_8hpp_source.xhtml#l00014">14</a> of file <a class="el" href="_optimizer_8hpp_source.xhtml">Optimizer.hpp</a>.</p>
123</div><h2 class="groupheader">Member Typedef Documentation</h2>
124<a id="a621bdb49c4a2f879b27d27e771693a46"></a>
125<h2 class="memtitle"><span class="permalink"><a href="#a621bdb49c4a2f879b27d27e771693a46">&#9670;&nbsp;</a></span>OptimizationPtr</h2>
126
127<div class="memitem">
128<div class="memproto">
129 <table class="memname">
130 <tr>
131 <td class="memname">using <a class="el" href="classarmnn_1_1_optimizer.xhtml#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a> = std::unique_ptr&lt;<a class="el" href="classarmnn_1_1_optimization.xhtml">Optimization</a>&gt;</td>
132 </tr>
133 </table>
134</div><div class="memdoc">
135
136<p class="definition">Definition at line <a class="el" href="_optimizer_8hpp_source.xhtml#l00017">17</a> of file <a class="el" href="_optimizer_8hpp_source.xhtml">Optimizer.hpp</a>.</p>
137
138</div>
139</div>
140<a id="ad1794808004025d6e06c176507197b24"></a>
141<h2 class="memtitle"><span class="permalink"><a href="#ad1794808004025d6e06c176507197b24">&#9670;&nbsp;</a></span>Optimizations</h2>
142
143<div class="memitem">
144<div class="memproto">
145 <table class="memname">
146 <tr>
147 <td class="memname">using <a class="el" href="classarmnn_1_1_optimizer.xhtml#ad1794808004025d6e06c176507197b24">Optimizations</a> = std::vector&lt;<a class="el" href="classarmnn_1_1_optimizer.xhtml#a621bdb49c4a2f879b27d27e771693a46">OptimizationPtr</a>&gt;</td>
148 </tr>
149 </table>
150</div><div class="memdoc">
151
152<p class="definition">Definition at line <a class="el" href="_optimizer_8hpp_source.xhtml#l00018">18</a> of file <a class="el" href="_optimizer_8hpp_source.xhtml">Optimizer.hpp</a>.</p>
153
154</div>
155</div>
156<h2 class="groupheader">Member Function Documentation</h2>
157<a id="a1f48ba622b76ea04d15c9b62f642bf08"></a>
158<h2 class="memtitle"><span class="permalink"><a href="#a1f48ba622b76ea04d15c9b62f642bf08">&#9670;&nbsp;</a></span>Pass()</h2>
159
160<div class="memitem">
161<div class="memproto">
162<table class="mlabels">
163 <tr>
164 <td class="mlabels-left">
165 <table class="memname">
166 <tr>
167 <td class="memname">void Pass </td>
168 <td>(</td>
169 <td class="paramtype"><a class="el" href="classarmnn_1_1_graph.xhtml">Graph</a> &amp;&#160;</td>
170 <td class="paramname"><em>graph</em>, </td>
171 </tr>
172 <tr>
173 <td class="paramkey"></td>
174 <td></td>
175 <td class="paramtype">const <a class="el" href="classarmnn_1_1_optimizer.xhtml#ad1794808004025d6e06c176507197b24">Optimizations</a> &amp;&#160;</td>
176 <td class="paramname"><em>optimizations</em>&#160;</td>
177 </tr>
178 <tr>
179 <td></td>
180 <td>)</td>
181 <td></td><td></td>
182 </tr>
183 </table>
184 </td>
185 <td class="mlabels-right">
186<span class="mlabels"><span class="mlabel">static</span></span> </td>
187 </tr>
188</table>
189</div><div class="memdoc">
190
191<p class="definition">Definition at line <a class="el" href="_optimizer_8cpp_source.xhtml#l00016">16</a> of file <a class="el" href="_optimizer_8cpp_source.xhtml">Optimizer.cpp</a>.</p>
192
193<p class="reference">References <a class="el" href="_graph_8hpp_source.xhtml#l00158">Graph::begin()</a>, <a class="el" href="_observable_8hpp_source.xhtml#l00026">GraphObservable&lt; ObservedType &gt;::Clear()</a>, <a class="el" href="_graph_8hpp_source.xhtml#l00160">Graph::end()</a>, <a class="el" href="_graph_8hpp_source.xhtml#l00442">Graph::EraseLayer()</a>, <a class="el" href="_graph_8hpp_source.xhtml#l00389">Graph::GetPosInGraph()</a>, and <a class="el" href="_graph_8hpp_source.xhtml#l00173">Graph::TopologicalSort()</a>.</p>
194
195<p class="reference">Referenced by <a class="el" href="_convert_constants_float_to_half_tests_8cpp_source.xhtml#l00018">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_network_8cpp_source.xhtml#l00890">armnn::Optimize()</a>.</p>
196<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 -->
197</div>
198</div>
199<hr/>The documentation for this class was generated from the following files:<ul>
200<li>src/armnn/<a class="el" href="_optimizer_8hpp_source.xhtml">Optimizer.hpp</a></li>
201<li>src/armnn/<a class="el" href="_optimizer_8cpp_source.xhtml">Optimizer.cpp</a></li>
202</ul>
203</div><!-- contents -->
204</div><!-- doc-content -->
205<!-- start footer part -->
206<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
207 <ul>
208 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_optimizer.xhtml">Optimizer</a></li>
209 <li class="footer">Generated on Fri Mar 13 2020 16:09:19 for ArmNN by
210 <a href="http://www.doxygen.org/index.html">
211 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
212 </ul>
213</div>
214</body>
215</html>