arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_fully_connected_layer_reshape_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: NEFullyConnectedLayerReshapeWeights 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_fully_connected_layer_reshape_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">NEFullyConnectedLayerReshapeWeights Class Reference</div>  </div>
123 </div><!--header-->
124 <div class="contents">
125
126 <p>Basic function to reshape the weights of Fully Connected layer with NEON.  
127  <a href="classarm__compute_1_1_n_e_fully_connected_layer_reshape_weights.xhtml#details">More...</a></p>
128
129 <p><code>#include &lt;<a class="el" href="_n_e_fully_connected_layer_8h_source.xhtml">NEFullyConnectedLayer.h</a>&gt;</code></p>
130 <div class="dynheader">
131 Collaboration diagram for NEFullyConnectedLayerReshapeWeights:</div>
132 <div class="dyncontent">
133 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_fully_connected_layer_reshape_weights__coll__graph.svg" width="236" height="127"><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:af20812ea72913d388a9a70f9d28e7c36"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_fully_connected_layer_reshape_weights.xhtml#af20812ea72913d388a9a70f9d28e7c36">NEFullyConnectedLayerReshapeWeights</a> (std::shared_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> &gt; memory_manager=nullptr)</td></tr>
140 <tr class="memdesc:af20812ea72913d388a9a70f9d28e7c36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#af20812ea72913d388a9a70f9d28e7c36">More...</a><br /></td></tr>
141 <tr class="separator:af20812ea72913d388a9a70f9d28e7c36"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:a510f09c40e20d367e4506bc9b4e8b36e"><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_fully_connected_layer_reshape_weights.xhtml#a510f09c40e20d367e4506bc9b4e8b36e">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, bool transpose_weights, bool is_batched_fc_layer)</td></tr>
143 <tr class="memdesc:a510f09c40e20d367e4506bc9b4e8b36e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the input and output tensors.  <a href="#a510f09c40e20d367e4506bc9b4e8b36e">More...</a><br /></td></tr>
144 <tr class="separator:a510f09c40e20d367e4506bc9b4e8b36e"><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_fully_connected_layer_reshape_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:a70b636ca822d48228a8c1f6a4d0666b2"><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_fully_connected_layer_reshape_weights.xhtml#a70b636ca822d48228a8c1f6a4d0666b2">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, bool transpose_weights, bool is_batched_fc_layer)</td></tr>
159 <tr class="memdesc:a70b636ca822d48228a8c1f6a4d0666b2"><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_c_l_fully_connected_layer_reshape_weights.xhtml">CLFullyConnectedLayerReshapeWeights</a>.  <a href="#a70b636ca822d48228a8c1f6a4d0666b2">More...</a><br /></td></tr>
160 <tr class="separator:a70b636ca822d48228a8c1f6a4d0666b2"><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 reshape the weights of Fully Connected layer with NEON. </p>
164 <p>This function calls the following kernels:</p>
165 <ol type="1">
166 <li><a class="el" href="classarm__compute_1_1_n_e_transpose_kernel.xhtml">NETransposeKernel</a> (if <code>transpose_weights</code> is set to true)</li>
167 <li><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_transpose1x_w_kernel.xhtml">NEGEMMTranspose1xWKernel</a> (if <code>is_batched_fc_layer</code> is set to true)</li>
168 </ol>
169 <dl class="section note"><dt>Note</dt><dd>The fully connected layer accepts "weights" tensors only with 2 dimensions. </dd></dl>
170
171 <p>Definition at line <a class="el" href="_n_e_fully_connected_layer_8h_source.xhtml#l00047">47</a> of file <a class="el" href="_n_e_fully_connected_layer_8h_source.xhtml">NEFullyConnectedLayer.h</a>.</p>
172 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
173 <a class="anchor" id="af20812ea72913d388a9a70f9d28e7c36"></a>
174 <div class="memitem">
175 <div class="memproto">
176       <table class="memname">
177         <tr>
178           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_fully_connected_layer_reshape_weights.xhtml">NEFullyConnectedLayerReshapeWeights</a> </td>
179           <td>(</td>
180           <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> &gt;&#160;</td>
181           <td class="paramname"><em>memory_manager</em> = <code>nullptr</code></td><td>)</td>
182           <td></td>
183         </tr>
184       </table>
185 </div><div class="memdoc">
186
187 <p>Constructor. </p>
188
189 </div>
190 </div>
191 <h2 class="groupheader">Member Function Documentation</h2>
192 <a class="anchor" id="a510f09c40e20d367e4506bc9b4e8b36e"></a>
193 <div class="memitem">
194 <div class="memproto">
195       <table class="memname">
196         <tr>
197           <td class="memname">void configure </td>
198           <td>(</td>
199           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
200           <td class="paramname"><em>input</em>, </td>
201         </tr>
202         <tr>
203           <td class="paramkey"></td>
204           <td></td>
205           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
206           <td class="paramname"><em>output</em>, </td>
207         </tr>
208         <tr>
209           <td class="paramkey"></td>
210           <td></td>
211           <td class="paramtype">bool&#160;</td>
212           <td class="paramname"><em>transpose_weights</em>, </td>
213         </tr>
214         <tr>
215           <td class="paramkey"></td>
216           <td></td>
217           <td class="paramtype">bool&#160;</td>
218           <td class="paramname"><em>is_batched_fc_layer</em>&#160;</td>
219         </tr>
220         <tr>
221           <td></td>
222           <td>)</td>
223           <td></td><td></td>
224         </tr>
225       </table>
226 </div><div class="memdoc">
227
228 <p>Set the input and output tensors. </p>
229 <dl class="params"><dt>Parameters</dt><dd>
230   <table class="params">
231     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Weights tensor. The weights must be 2 dimensional. Data types supported: QS8/QS16/F32. </td></tr>
232     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor. Data type supported: Same as <code>input</code>. </td></tr>
233     <tr><td class="paramdir">[in]</td><td class="paramname">transpose_weights</td><td>True if the weights must be transposed. Data types supported: Same as <code>weights</code>. </td></tr>
234     <tr><td class="paramdir">[in]</td><td class="paramname">is_batched_fc_layer</td><td>True if it is a batched fully connected layer </td></tr>
235   </table>
236   </dd>
237 </dl>
238
239 </div>
240 </div>
241 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
242 <div class="memitem">
243 <div class="memproto">
244 <table class="mlabels">
245   <tr>
246   <td class="mlabels-left">
247       <table class="memname">
248         <tr>
249           <td class="memname">void run </td>
250           <td>(</td>
251           <td class="paramname"></td><td>)</td>
252           <td></td>
253         </tr>
254       </table>
255   </td>
256   <td class="mlabels-right">
257 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
258   </tr>
259 </table>
260 </div><div class="memdoc">
261
262 <p>Run the kernels contained in the function. </p>
263 <p>For NEON kernels:</p><ul>
264 <li>Multi-threading is used for the kernels which are parallelisable.</li>
265 <li>By default std::thread::hardware_concurrency() threads are used.</li>
266 </ul>
267 <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>
268 <p>For OpenCL kernels:</p><ul>
269 <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>
270 <li>The queue is then flushed.</li>
271 </ul>
272 <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>
273 <dd>
274 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>
275
276 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
277
278 </div>
279 </div>
280 <a class="anchor" id="a70b636ca822d48228a8c1f6a4d0666b2"></a>
281 <div class="memitem">
282 <div class="memproto">
283 <table class="mlabels">
284   <tr>
285   <td class="mlabels-left">
286       <table class="memname">
287         <tr>
288           <td class="memname">static <a class="el" href="classarm__compute_1_1_status.xhtml">Status</a> validate </td>
289           <td>(</td>
290           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
291           <td class="paramname"><em>input</em>, </td>
292         </tr>
293         <tr>
294           <td class="paramkey"></td>
295           <td></td>
296           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor_info.xhtml">ITensorInfo</a> *&#160;</td>
297           <td class="paramname"><em>output</em>, </td>
298         </tr>
299         <tr>
300           <td class="paramkey"></td>
301           <td></td>
302           <td class="paramtype">bool&#160;</td>
303           <td class="paramname"><em>transpose_weights</em>, </td>
304         </tr>
305         <tr>
306           <td class="paramkey"></td>
307           <td></td>
308           <td class="paramtype">bool&#160;</td>
309           <td class="paramname"><em>is_batched_fc_layer</em>&#160;</td>
310         </tr>
311         <tr>
312           <td></td>
313           <td>)</td>
314           <td></td><td></td>
315         </tr>
316       </table>
317   </td>
318   <td class="mlabels-right">
319 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
320   </tr>
321 </table>
322 </div><div class="memdoc">
323
324 <p>Static function to check if given info will lead to a valid configuration of <a class="el" href="classarm__compute_1_1_c_l_fully_connected_layer_reshape_weights.xhtml">CLFullyConnectedLayerReshapeWeights</a>. </p>
325 <dl class="params"><dt>Parameters</dt><dd>
326   <table class="params">
327     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Weights tensor info. The weights must be 2 dimensional. Data types supported: QS8/QS16/F32. </td></tr>
328     <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>Destination tensor info. Data type supported: Same as <code>input</code>. </td></tr>
329     <tr><td class="paramdir">[in]</td><td class="paramname">transpose_weights</td><td>True if the weights must be transposed. Data types supported: Same as <code>weights</code>. </td></tr>
330     <tr><td class="paramdir">[in]</td><td class="paramname">is_batched_fc_layer</td><td>True if it is a batched fully connected layer</td></tr>
331   </table>
332   </dd>
333 </dl>
334 <dl class="section return"><dt>Returns</dt><dd>a status </dd></dl>
335
336 </div>
337 </div>
338 <hr/>The documentation for this class was generated from the following file:<ul>
339 <li>arm_compute/runtime/NEON/functions/<a class="el" href="_n_e_fully_connected_layer_8h_source.xhtml">NEFullyConnectedLayer.h</a></li>
340 </ul>
341 </div><!-- contents -->
342 </div><!-- doc-content -->
343 <!-- start footer part -->
344 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
345   <ul>
346     <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_fully_connected_layer_reshape_weights.xhtml">NEFullyConnectedLayerReshapeWeights</a></li>
347     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
348     <a href="http://www.doxygen.org/index.html">
349     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
350   </ul>
351 </div>
352 </body>
353 </html>