arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: NEConvertFullyConnectedWeights 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 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">Compute Library
43    &#160;<span id="projectnumber">18.05</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
86     </ul>
87   </div>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml','');});
101 </script>
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105      onmouseover="return searchBox.OnSearchSelectShow()"
106      onmouseout="return searchBox.OnSearchSelectHide()"
107      onkeydown="return searchBox.OnSearchSelectKey(event)">
108 </div>
109
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0" 
113         name="MSearchResults" id="MSearchResults">
114 </iframe>
115 </div>
116
117 <div class="header">
118   <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> &#124;
120 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
121   <div class="headertitle">
122 <div class="title">NEConvertFullyConnectedWeights Class Reference</div>  </div>
123 </div><!--header-->
124 <div class="contents">
125
126 <p>Basic function to run <a class="el" href="classarm__compute_1_1_n_e_convert_fully_connected_weights_kernel.xhtml">NEConvertFullyConnectedWeightsKernel</a>.  
127  <a href="classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml#details">More...</a></p>
128
129 <p><code>#include &lt;<a class="el" href="_n_e_convert_fully_connected_weights_8h_source.xhtml">NEConvertFullyConnectedWeights.h</a>&gt;</code></p>
130 <div class="dynheader">
131 Collaboration diagram for NEConvertFullyConnectedWeights:</div>
132 <div class="dyncontent">
133 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_convert_fully_connected_weights__coll__graph.svg" width="246" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
134 </div>
135 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
136 <table class="memberdecls">
137 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
138 Public Member Functions</h2></td></tr>
139 <tr class="memitem:aecbf55e0f00cef5c1378eb47099f336d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml#aecbf55e0f00cef5c1378eb47099f336d">NEConvertFullyConnectedWeights</a> ()</td></tr>
140 <tr class="memdesc:aecbf55e0f00cef5c1378eb47099f336d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#aecbf55e0f00cef5c1378eb47099f336d">More...</a><br /></td></tr>
141 <tr class="separator:aecbf55e0f00cef5c1378eb47099f336d"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:ac0cfd5b64b24f3dfae04ee3d0f258624"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml#ac0cfd5b64b24f3dfae04ee3d0f258624">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;original_input_shape, <a class="el" href="namespacearm__compute.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a> data_layout)</td></tr>
143 <tr class="memdesc:ac0cfd5b64b24f3dfae04ee3d0f258624"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the function.  <a href="#ac0cfd5b64b24f3dfae04ee3d0f258624">More...</a><br /></td></tr>
144 <tr class="separator:ac0cfd5b64b24f3dfae04ee3d0f258624"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memitem:ad1717410afd0be936c6213a63c8005fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
146 <tr class="memdesc:ad1717410afd0be936c6213a63c8005fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the kernels contained in the function.  <a href="#ad1717410afd0be936c6213a63c8005fb">More...</a><br /></td></tr>
147 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_function')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr>
149 <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr>
150 <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br /></td></tr>
151 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#a820f7291c24155a2980512fae45aac26">prepare</a> ()</td></tr>
153 <tr class="memdesc:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare the function for executing.  <a href="#a820f7291c24155a2980512fae45aac26">More...</a><br /></td></tr>
154 <tr class="separator:a820f7291c24155a2980512fae45aac26 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 </table><table class="memberdecls">
156 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
157 Static Public Member Functions</h2></td></tr>
158 <tr class="memitem:a0ee2875b1f3cf5b6bc2361e85b7e53ef"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml#a0ee2875b1f3cf5b6bc2361e85b7e53ef">validate</a> (const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *input, const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *output, const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;original_input_shape, <a class="el" href="namespacearm__compute.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a> data_layout)</td></tr>
159 <tr class="memdesc:a0ee2875b1f3cf5b6bc2361e85b7e53ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml">NEConvertFullyConnectedWeights</a>.  <a href="#a0ee2875b1f3cf5b6bc2361e85b7e53ef">More...</a><br /></td></tr>
160 <tr class="separator:a0ee2875b1f3cf5b6bc2361e85b7e53ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 </table>
162 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
163 <div class="textblock"><p>Basic function to run <a class="el" href="classarm__compute_1_1_n_e_convert_fully_connected_weights_kernel.xhtml">NEConvertFullyConnectedWeightsKernel</a>. </p>
164
165 <p>Definition at line <a class="el" href="_n_e_convert_fully_connected_weights_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_n_e_convert_fully_connected_weights_8h_source.xhtml">NEConvertFullyConnectedWeights.h</a>.</p>
166 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
167 <a class="anchor" id="aecbf55e0f00cef5c1378eb47099f336d"></a>
168 <div class="memitem">
169 <div class="memproto">
170       <table class="memname">
171         <tr>
172           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml">NEConvertFullyConnectedWeights</a> </td>
173           <td>(</td>
174           <td class="paramname"></td><td>)</td>
175           <td></td>
176         </tr>
177       </table>
178 </div><div class="memdoc">
179
180 <p>Default constructor. </p>
181
182 </div>
183 </div>
184 <h2 class="groupheader">Member Function Documentation</h2>
185 <a class="anchor" id="ac0cfd5b64b24f3dfae04ee3d0f258624"></a>
186 <div class="memitem">
187 <div class="memproto">
188       <table class="memname">
189         <tr>
190           <td class="memname">void configure </td>
191           <td>(</td>
192           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
193           <td class="paramname"><em>input</em>, </td>
194         </tr>
195         <tr>
196           <td class="paramkey"></td>
197           <td></td>
198           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
199           <td class="paramname"><em>output</em>, </td>
200         </tr>
201         <tr>
202           <td class="paramkey"></td>
203           <td></td>
204           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td>
205           <td class="paramname"><em>original_input_shape</em>, </td>
206         </tr>
207         <tr>
208           <td class="paramkey"></td>
209           <td></td>
210           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a>&#160;</td>
211           <td class="paramname"><em>data_layout</em>&#160;</td>
212         </tr>
213         <tr>
214           <td></td>
215           <td>)</td>
216           <td></td><td></td>
217         </tr>
218       </table>
219 </div><div class="memdoc">
220
221 <p>Initialize the function. </p>
222 <dl class="params"><dt>Parameters</dt><dd>
223   <table class="params">
224     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source weights tensor to convert. Must be 2 dimensional. Data types supported: U8/S8/QS8/QASYMM8/U16/S16/QS16/U32/S32/QS32/F16/F32. </td></tr>
225     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>The converted weights tensor. Shape and Data Type: Same as <code>input</code>. </td></tr>
226     <tr><td class="paramdir">[in]</td><td class="paramname">original_input_shape</td><td>Shape of the original input tensor (the one entering fully connected layer). Must be in NCHW format. </td></tr>
227     <tr><td class="paramdir">[in]</td><td class="paramname">data_layout</td><td>The data layout the weights have been trained in. </td></tr>
228   </table>
229   </dd>
230 </dl>
231
232 </div>
233 </div>
234 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
235 <div class="memitem">
236 <div class="memproto">
237 <table class="mlabels">
238   <tr>
239   <td class="mlabels-left">
240       <table class="memname">
241         <tr>
242           <td class="memname">void run </td>
243           <td>(</td>
244           <td class="paramname"></td><td>)</td>
245           <td></td>
246         </tr>
247       </table>
248   </td>
249   <td class="mlabels-right">
250 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
251   </tr>
252 </table>
253 </div><div class="memdoc">
254
255 <p>Run the kernels contained in the function. </p>
256 <p>For NEON kernels:</p><ul>
257 <li>Multi-threading is used for the kernels which are parallelisable.</li>
258 <li>By default std::thread::hardware_concurrency() threads are used.</li>
259 </ul>
260 <dl class="section note"><dt>Note</dt><dd><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae64eebaa07f4d2da6cc2ba538c3cb095">CPPScheduler::set_num_threads()</a> can be used to manually set the number of threads</dd></dl>
261 <p>For OpenCL kernels:</p><ul>
262 <li>All the kernels are enqueued on the queue associated with <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml" title="Provides global access to a CL context and command queue. ">CLScheduler</a>.</li>
263 <li>The queue is then flushed.</li>
264 </ul>
265 <dl class="section note"><dt>Note</dt><dd>The function will not block until the kernels are executed. It is the user's responsibility to wait. </dd>
266 <dd>
267 Will call <a class="el" href="classarm__compute_1_1_i_function.xhtml#a820f7291c24155a2980512fae45aac26" title="Prepare the function for executing. ">prepare()</a> on first run if hasn't been done </dd></dl>
268
269 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
270
271 </div>
272 </div>
273 <a class="anchor" id="a0ee2875b1f3cf5b6bc2361e85b7e53ef"></a>
274 <div class="memitem">
275 <div class="memproto">
276 <table class="mlabels">
277   <tr>
278   <td class="mlabels-left">
279       <table class="memname">
280         <tr>
281           <td class="memname">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a> validate </td>
282           <td>(</td>
283           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
284           <td class="paramname"><em>input</em>, </td>
285         </tr>
286         <tr>
287           <td class="paramkey"></td>
288           <td></td>
289           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
290           <td class="paramname"><em>output</em>, </td>
291         </tr>
292         <tr>
293           <td class="paramkey"></td>
294           <td></td>
295           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_tensor_shape.xhtml">TensorShape</a> &amp;&#160;</td>
296           <td class="paramname"><em>original_input_shape</em>, </td>
297         </tr>
298         <tr>
299           <td class="paramkey"></td>
300           <td></td>
301           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ad1d5cce2d9e9a5d61c243e5c989112e0">DataLayout</a>&#160;</td>
302           <td class="paramname"><em>data_layout</em>&#160;</td>
303         </tr>
304         <tr>
305           <td></td>
306           <td>)</td>
307           <td></td><td></td>
308         </tr>
309       </table>
310   </td>
311   <td class="mlabels-right">
312 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
313   </tr>
314 </table>
315 </div><div class="memdoc">
316
317 <p>Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml">NEConvertFullyConnectedWeights</a>. </p>
318 <dl class="params"><dt>Parameters</dt><dd>
319   <table class="params">
320     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source weights tensor info to convert. Must be 2 dimensional. Data types supported: U8/S8/QS8/QASYMM8/U16/S16/QS16/U32/S32/QS32/F16/F32. </td></tr>
321     <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>The converted weights tensor info. Shape and Data Type: Same as <code>input</code>. </td></tr>
322     <tr><td class="paramdir">[in]</td><td class="paramname">original_input_shape</td><td>Shape of the original input tensor (the one entering fully connected layer). Must be in NCHW format. </td></tr>
323     <tr><td class="paramdir">[in]</td><td class="paramname">data_layout</td><td>The data layout the weights have been trained in. </td></tr>
324   </table>
325   </dd>
326 </dl>
327
328 </div>
329 </div>
330 <hr/>The documentation for this class was generated from the following file:<ul>
331 <li>arm_compute/runtime/NEON/functions/<a class="el" href="_n_e_convert_fully_connected_weights_8h_source.xhtml">NEConvertFullyConnectedWeights.h</a></li>
332 </ul>
333 </div><!-- contents -->
334 </div><!-- doc-content -->
335 <!-- start footer part -->
336 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
337   <ul>
338     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_n_e_convert_fully_connected_weights.xhtml">NEConvertFullyConnectedWeights</a></li>
339     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
340     <a href="http://www.doxygen.org/index.html">
341     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
342   </ul>
343 </div>
344 </body>
345 </html>