Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / ae42f01cb7f75fd5f7681f142f073f6f51e2e57f / . / Documentation / namespacearmnn_caffe_parser.html
blob: 65d523c255794ba971aaca7231bff501c68fdf88 [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: armnnCaffeParser Namespace 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('namespacearmnn_caffe_parser.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="#nested-classes">Classes</a> &#124;
85<a href="#typedef-members">Typedefs</a> &#124;
86<a href="#func-members">Functions</a> </div>
87 <div class="headertitle">
88<div class="title">armnnCaffeParser Namespace Reference</div> </div>
89</div><!--header-->
90<div class="contents">
91<table class="memberdecls">
92<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
93Classes</h2></td></tr>
94<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_caffe_parser_1_1_caffe_parser.html">CaffeParser</a></td></tr>
95<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
96<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_caffe_parser_1_1_caffe_parser_base.html">CaffeParserBase</a></td></tr>
97<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
98<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_caffe_parser_1_1_i_caffe_parser.html">ICaffeParser</a></td></tr>
99<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
100<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_caffe_parser_1_1_record_by_record_caffe_parser.html">RecordByRecordCaffeParser</a></td></tr>
101<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
102</table><table class="memberdecls">
103<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
104Typedefs</h2></td></tr>
105<tr class="memitem:a9084adbf804022c874039ad40d1939e9"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn_caffe_parser.html#a9084adbf804022c874039ad40d1939e9">BindingPointInfo</a> = <a class="el" href="namespacearmnn.html#a280670a263dc4fd40491f6d0a2737f44">armnn::BindingPointInfo</a></td></tr>
106<tr class="separator:a9084adbf804022c874039ad40d1939e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
107<tr class="memitem:a33c76910f1980ffaa41c22e0151cce2a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn_caffe_parser.html#a33c76910f1980ffaa41c22e0151cce2a">ICaffeParserPtr</a> = std::unique_ptr&lt; <a class="el" href="classarmnn_caffe_parser_1_1_i_caffe_parser.html">ICaffeParser</a>, void(*)(<a class="el" href="classarmnn_caffe_parser_1_1_i_caffe_parser.html">ICaffeParser</a> *parser)&gt;</td></tr>
108<tr class="separator:a33c76910f1980ffaa41c22e0151cce2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
109</table><table class="memberdecls">
110<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
111Functions</h2></td></tr>
112<tr class="memitem:af3fde7630e7c9df35cae9ed2b435dbed"><td class="memItemLeft" align="right" valign="top">BlobShape&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn_caffe_parser.html#af3fde7630e7c9df35cae9ed2b435dbed">TensorDescToBlobShape</a> (const <a class="el" href="classarmnn_1_1_tensor_info.html">TensorInfo</a> &amp;desc)</td></tr>
113<tr class="separator:af3fde7630e7c9df35cae9ed2b435dbed"><td class="memSeparator" colspan="2">&#160;</td></tr>
114</table>
115<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
116<div class="textblock"><p>Caffe networks are loaded from protobuf files (binary or text) using the protobuf library and the generated code from caffe.pb.h. This gives us a caffe::NetParameter which is an in-memory version of the file. This contains a flat list of Caffe 'layers' (e.g. convolution, pooling etc.). Each layer has inputs (called "bottoms") and outputs (called "tops"). Data flows from bottom to top. The bottoms of a layer refer to the tops of other layers, not their names. The names of layers seem to be arbitrary (you could rename a layer and the network wouldn't need any other changes).</p>
117<p>Some layers (e.g. Relu) can be configured so that their top and bottom are both the same. This is called an "in-place" layer and is a Caffe runtime feature used to reduce memory usage by modifying tensors in-place. This isn't relevant to the parser and so we preprocess these layers to convert them to regular layers, to result in a consistent graph structure. </p>
118</div><h2 class="groupheader">Typedef Documentation</h2>
119<a id="a9084adbf804022c874039ad40d1939e9"></a>
120<h2 class="memtitle"><span class="permalink"><a href="#a9084adbf804022c874039ad40d1939e9">&#9670;&nbsp;</a></span>BindingPointInfo</h2>
121
122<div class="memitem">
123<div class="memproto">
124 <table class="memname">
125 <tr>
126 <td class="memname">using <a class="el" href="namespacearmnn.html#a280670a263dc4fd40491f6d0a2737f44">BindingPointInfo</a> = <a class="el" href="namespacearmnn.html#a280670a263dc4fd40491f6d0a2737f44">armnn::BindingPointInfo</a></td>
127 </tr>
128 </table>
129</div><div class="memdoc">
130
131<p class="definition">Definition at line <a class="el" href="_i_caffe_parser_8hpp_source.html#l00019">19</a> of file <a class="el" href="_i_caffe_parser_8hpp_source.html">ICaffeParser.hpp</a>.</p>
132
133</div>
134</div>
135<a id="a33c76910f1980ffaa41c22e0151cce2a"></a>
136<h2 class="memtitle"><span class="permalink"><a href="#a33c76910f1980ffaa41c22e0151cce2a">&#9670;&nbsp;</a></span>ICaffeParserPtr</h2>
137
138<div class="memitem">
139<div class="memproto">
140 <table class="memname">
141 <tr>
142 <td class="memname">using <a class="el" href="namespacearmnn_caffe_parser.html#a33c76910f1980ffaa41c22e0151cce2a">ICaffeParserPtr</a> = std::unique_ptr&lt;<a class="el" href="classarmnn_caffe_parser_1_1_i_caffe_parser.html">ICaffeParser</a>, void(*)(<a class="el" href="classarmnn_caffe_parser_1_1_i_caffe_parser.html">ICaffeParser</a>* parser)&gt;</td>
143 </tr>
144 </table>
145</div><div class="memdoc">
146
147<p class="definition">Definition at line <a class="el" href="_i_caffe_parser_8hpp_source.html#l00022">22</a> of file <a class="el" href="_i_caffe_parser_8hpp_source.html">ICaffeParser.hpp</a>.</p>
148
149</div>
150</div>
151<h2 class="groupheader">Function Documentation</h2>
152<a id="af3fde7630e7c9df35cae9ed2b435dbed"></a>
153<h2 class="memtitle"><span class="permalink"><a href="#af3fde7630e7c9df35cae9ed2b435dbed">&#9670;&nbsp;</a></span>TensorDescToBlobShape()</h2>
154
155<div class="memitem">
156<div class="memproto">
157 <table class="memname">
158 <tr>
159 <td class="memname">BlobShape armnnCaffeParser::TensorDescToBlobShape </td>
160 <td>(</td>
161 <td class="paramtype">const <a class="el" href="classarmnn_1_1_tensor_info.html">TensorInfo</a> &amp;&#160;</td>
162 <td class="paramname"><em>desc</em></td><td>)</td>
163 <td></td>
164 </tr>
165 </table>
166</div><div class="memdoc">
167
168<p class="definition">Definition at line <a class="el" href="_caffe_parser_8cpp_source.html#l00325">325</a> of file <a class="el" href="_caffe_parser_8cpp_source.html">CaffeParser.cpp</a>.</p>
169
170<p class="reference">References <a class="el" href="_tensor_8hpp_source.html#l00092">TensorInfo::GetNumDimensions()</a>, and <a class="el" href="_tensor_8hpp_source.html#l00088">TensorInfo::GetShape()</a>.</p>
171
172<p class="reference">Referenced by <a class="el" href="_caffe_parser_8cpp_source.html#l00611">CaffeParserBase::AddConvLayerWithDepthwiseConv()</a>, <a class="el" href="_caffe_parser_8cpp_source.html#l00419">CaffeParserBase::AddConvLayerWithSplits()</a>, and <a class="el" href="_caffe_parser_8cpp_source.html#l00701">CaffeParserBase::ParseConvLayer()</a>.</p>
173<div class="fragment"><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160;{</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; BlobShape ret;</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; desc.<a class="code" href="classarmnn_1_1_tensor_info.html#a157e27d41e9f6b21f0d3c025fa47dc24">GetNumDimensions</a>(); ++i)</div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160; {</div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160; ret.add_dim(i);</div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; ret.set_dim(boost::numeric_cast&lt;int&gt;(i), desc.<a class="code" href="classarmnn_1_1_tensor_info.html#a8b5d0f8a24e9d9238f412260a552acf8">GetShape</a>()[i]);</div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; }</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160;</div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160; <span class="keywordflow">return</span> ret;</div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160;}</div><div class="ttc" id="classarmnn_1_1_tensor_info_html_a157e27d41e9f6b21f0d3c025fa47dc24"><div class="ttname"><a href="classarmnn_1_1_tensor_info.html#a157e27d41e9f6b21f0d3c025fa47dc24">armnn::TensorInfo::GetNumDimensions</a></div><div class="ttdeci">unsigned int GetNumDimensions() const</div><div class="ttdef"><b>Definition:</b> <a href="_tensor_8hpp_source.html#l00092">Tensor.hpp:92</a></div></div>
174<div class="ttc" id="classarmnn_1_1_tensor_info_html_a8b5d0f8a24e9d9238f412260a552acf8"><div class="ttname"><a href="classarmnn_1_1_tensor_info.html#a8b5d0f8a24e9d9238f412260a552acf8">armnn::TensorInfo::GetShape</a></div><div class="ttdeci">const TensorShape &amp; GetShape() const</div><div class="ttdef"><b>Definition:</b> <a href="_tensor_8hpp_source.html#l00088">Tensor.hpp:88</a></div></div>
175</div><!-- fragment -->
176</div>
177</div>
178</div><!-- contents -->
179</div><!-- doc-content -->
180<!-- start footer part -->
181<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
182 <ul>
183 <li class="navelem"><a class="el" href="namespacearmnn_caffe_parser.html">armnnCaffeParser</a></li>
184 <li class="footer">Generated on Fri Mar 13 2020 16:07:06 for ArmNN by
185 <a href="http://www.doxygen.org/index.html">
186 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
187 </ul>
188</div>
189</body>
190</html>