blob: 832d92e0a8ab3ae4d9ae7ea5763219f1a9085d3b [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: BifrostTuner Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">19.08</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classarm__compute_1_1tuners_1_1_bifrost_tuner.xhtml','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">BifrostTuner Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Bifrost based OpenCL tuner implementation.
<a href="classarm__compute_1_1tuners_1_1_bifrost_tuner.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_bifrost_tuner_8h_source.xhtml">BifrostTuner.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for BifrostTuner:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1tuners_1_1_bifrost_tuner__coll__graph.svg" width="108" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a52f755d664bbdcb9346cdf5cc4a7e958"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1tuners_1_1_bifrost_tuner.xhtml#a52f755d664bbdcb9346cdf5cc4a7e958">tune_kernel_static</a> (<a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;kernel) override</td></tr>
<tr class="memdesc:a52f755d664bbdcb9346cdf5cc4a7e958"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tune OpenCL kernel statically. <a href="#a52f755d664bbdcb9346cdf5cc4a7e958">More...</a><br /></td></tr>
<tr class="separator:a52f755d664bbdcb9346cdf5cc4a7e958"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af073b532560e2105dd22d381f5888ce7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1tuners_1_1_bifrost_tuner.xhtml#af073b532560e2105dd22d381f5888ce7">tune_kernel_dynamic</a> (<a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;kernel) override</td></tr>
<tr class="memdesc:af073b532560e2105dd22d381f5888ce7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tune OpenCL kernel dynamically. <a href="#af073b532560e2105dd22d381f5888ce7">More...</a><br /></td></tr>
<tr class="separator:af073b532560e2105dd22d381f5888ce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_tuner"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_tuner')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml">ICLTuner</a></td></tr>
<tr class="memitem:a7103799fdecd6abca8fc84efebb3653f inherit pub_methods_classarm__compute_1_1_i_c_l_tuner"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml#a7103799fdecd6abca8fc84efebb3653f">~ICLTuner</a> ()=default</td></tr>
<tr class="memdesc:a7103799fdecd6abca8fc84efebb3653f inherit pub_methods_classarm__compute_1_1_i_c_l_tuner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <a href="classarm__compute_1_1_i_c_l_tuner.xhtml#a7103799fdecd6abca8fc84efebb3653f">More...</a><br /></td></tr>
<tr class="separator:a7103799fdecd6abca8fc84efebb3653f inherit pub_methods_classarm__compute_1_1_i_c_l_tuner"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Bifrost based OpenCL tuner implementation. </p>
<p class="definition">Definition at line <a class="el" href="_bifrost_tuner_8h_source.xhtml#l00034">34</a> of file <a class="el" href="_bifrost_tuner_8h_source.xhtml">BifrostTuner.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af073b532560e2105dd22d381f5888ce7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af073b532560e2105dd22d381f5888ce7">&#9670;&nbsp;</a></span>tune_kernel_dynamic()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void tune_kernel_dynamic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;&#160;</td>
<td class="paramname"><em>kernel</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tune OpenCL kernel dynamically. </p>
<dl class="section note"><dt>Note</dt><dd>Tuning requires memory to be available on all kernel tensors and objects in order to be performed</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">kernel</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class.">Kernel</a> to tune </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml#ae12d76ff3471c1f73c62b7c65addc1ec">ICLTuner</a>.</p>
<p class="definition">Definition at line <a class="el" href="_bifrost_tuner_8cpp_source.xhtml#l00336">336</a> of file <a class="el" href="_bifrost_tuner_8cpp_source.xhtml">BifrostTuner.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160;{</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160; <a class="code" href="_error_8h.xhtml#a6dc630a6ae9cc063b3924bcea8dee9d6">ARM_COMPUTE_UNUSED</a>(kernel);</div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160;}</div><div class="ttc" id="_error_8h_xhtml_a6dc630a6ae9cc063b3924bcea8dee9d6"><div class="ttname"><a href="_error_8h.xhtml#a6dc630a6ae9cc063b3924bcea8dee9d6">ARM_COMPUTE_UNUSED</a></div><div class="ttdeci">#define ARM_COMPUTE_UNUSED(...)</div><div class="ttdoc">To avoid unused variables warnings.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00160">Error.h:160</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00160">ARM_COMPUTE_UNUSED</a>.</p>
</div>
</div>
<a id="a52f755d664bbdcb9346cdf5cc4a7e958"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52f755d664bbdcb9346cdf5cc4a7e958">&#9670;&nbsp;</a></span>tune_kernel_static()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void tune_kernel_static </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;&#160;</td>
<td class="paramname"><em>kernel</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tune OpenCL kernel statically. </p>
<dl class="section note"><dt>Note</dt><dd>Tuning is performed using only kernel and tensor metadata, thus can be performed when memory is not available</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">kernel</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class.">Kernel</a> to tune </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml#a384fdc1bc38a4fc6e79af675cc4aa8e3">ICLTuner</a>.</p>
<p class="definition">Definition at line <a class="el" href="_bifrost_tuner_8cpp_source.xhtml#l00300">300</a> of file <a class="el" href="_bifrost_tuner_8cpp_source.xhtml">BifrostTuner.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160;{</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160; <span class="keywordflow">if</span>(dynamic_cast&lt;CLDirectConvolutionLayerKernel *&gt;(&amp;kernel) != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160; {</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160; tune_direct_convolution_kernel(*utils::cast::polymorphic_downcast&lt;CLDirectConvolutionLayerKernel *&gt;(&amp;kernel));</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160; }</div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span>(dynamic_cast&lt;CLCol2ImKernel *&gt;(&amp;kernel) != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160; {</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160; tune_col2im_kernel(*utils::cast::polymorphic_downcast&lt;CLCol2ImKernel *&gt;(&amp;kernel));</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160; }</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span>(dynamic_cast&lt;CLIm2ColKernel *&gt;(&amp;kernel) != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160; {</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160; tune_im2col_kernel(*utils::cast::polymorphic_downcast&lt;CLIm2ColKernel *&gt;(&amp;kernel));</div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160; }</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span>(dynamic_cast&lt;CLDepthwiseIm2ColKernel *&gt;(&amp;kernel) != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; {</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160; tune_depthwise_im2col_kernel(*utils::cast::polymorphic_downcast&lt;CLDepthwiseIm2ColKernel *&gt;(&amp;kernel));</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160; }</div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span>(dynamic_cast&lt;CLGEMMMatrixVectorMultiplyKernel *&gt;(&amp;kernel) != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160; {</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160; tune_gemv_kernel(*utils::cast::polymorphic_downcast&lt;CLGEMMMatrixVectorMultiplyKernel *&gt;(&amp;kernel));</div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160; }</div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span>(dynamic_cast&lt;CLGEMMMatrixMultiplyKernel *&gt;(&amp;kernel) != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160; {</div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160; tune_gemm_kernel(*utils::cast::polymorphic_downcast&lt;CLGEMMMatrixMultiplyKernel *&gt;(&amp;kernel));</div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; }</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span>(dynamic_cast&lt;CLPoolingLayerKernel *&gt;(&amp;kernel) != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; {</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; tune_pooling_kernel(*utils::cast::polymorphic_downcast&lt;CLPoolingLayerKernel *&gt;(&amp;kernel));</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; <span class="keywordflow">else</span> <span class="keywordflow">if</span>(dynamic_cast&lt;CLScaleKernel *&gt;(&amp;kernel) != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; {</div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; tune_scale_kernel(*utils::cast::polymorphic_downcast&lt;CLScaleKernel *&gt;(&amp;kernel));</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;}</div></div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="_tuner_8cpp_source.xhtml#l00044">arm_compute::test::validation::TEST_CASE()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>arm_compute/runtime/CL/tuners/<a class="el" href="_bifrost_tuner_8h_source.xhtml">BifrostTuner.h</a></li>
<li>src/runtime/CL/tuners/<a class="el" href="_bifrost_tuner_8cpp_source.xhtml">BifrostTuner.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1tuners.xhtml">tuners</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1tuners_1_1_bifrost_tuner.xhtml">BifrostTuner</a></li>
<li class="footer">Generated on Mon Sep 2 2019 11:47:42 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>