Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / refs/heads/gh-pages / . / latest / _armnn_driver_impl_8hpp_source.html
blob: 1a1a7deca057df1b383c09ea6d0dcf2db2542847 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.17-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Arm NN: shim/sl/canonical/ArmnnDriverImpl.hpp Source File</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>
<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="customdoxygen.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="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
<td id="projectalign" style="padding-left: 0.9em;">
<div id="projectname">
&#160;<span id="projectnumber">24.05</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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('_armnn_driver_impl_8hpp_source.html',''); initResizable(); });
/* @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="headertitle">
<div class="title">ArmnnDriverImpl.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_armnn_driver_impl_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2022, 2024 Arm Ltd and Contributors. All rights reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_driver_options_8hpp.html">DriverOptions.hpp</a>&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_arm_n_n_8hpp.html">armnn/ArmNN.hpp</a>&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;nnapi/IPreparedModel.h&gt;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;nnapi/Result.h&gt;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;nnapi/TypeUtils.h&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;nnapi/Types.h&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;nnapi/Validation.h&gt;</span></div>
<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="keyword">using namespace </span><a class="code" href="namespaceandroid_1_1nn.html">android::nn</a>;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn__driver.html">armnn_driver</a></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; </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn__driver_1_1_armnn_driver_impl.html"> 23</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn__driver_1_1_armnn_driver_impl.html">ArmnnDriverImpl</a></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="keyword">public</span>:</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="_deprecated_8hpp.html#af16119336bd0dfbfbc83fc283151067e">ARMNN_DEPRECATED_MSG_REMOVAL_DATE</a>(<span class="stringliteral">&quot;The Shim and support library will be removed from Arm NN in 24.08&quot;</span>, <span class="stringliteral">&quot;24.08&quot;</span>)</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">static</span> GeneralResult&lt;SharedPreparedModel&gt; PrepareArmnnModel(</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacearmnn.html#a150468a02bd7b2d2d061c4aaaee939f0">armnn::IRuntimePtr</a>&amp; runtime,</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacearmnn.html#a2d3a708a26ac6d77bf8f15506e89a25a">armnn::IGpuAccTunedParametersPtr</a>&amp; clTunedParameters,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn__driver_1_1_driver_options.html">DriverOptions</a>&amp; options,</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacearmnn__driver.html#a923b39ec5f83672f50289cbaf5de6798">Model</a>&amp; model,</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">const</span> std::vector&lt;SharedHandle&gt;&amp; modelCacheHandle,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">const</span> std::vector&lt;SharedHandle&gt;&amp; dataCacheHandle,</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">const</span> CacheToken&amp; token,</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">bool</span> float32ToFloat16 = <span class="keyword">false</span>,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; Priority priority = Priority::MEDIUM);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="_deprecated_8hpp.html#af16119336bd0dfbfbc83fc283151067e">ARMNN_DEPRECATED_MSG_REMOVAL_DATE</a>(<span class="stringliteral">&quot;The Shim and support library will be removed from Arm NN in 24.08&quot;</span>, <span class="stringliteral">&quot;24.08&quot;</span>)</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">static</span> GeneralResult&lt;SharedPreparedModel&gt; PrepareArmnnModelFromCache(</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacearmnn.html#a150468a02bd7b2d2d061c4aaaee939f0">armnn::IRuntimePtr</a>&amp; runtime,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">const</span> <a class="code" href="namespacearmnn.html#a2d3a708a26ac6d77bf8f15506e89a25a">armnn::IGpuAccTunedParametersPtr</a>&amp; clTunedParameters,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn__driver_1_1_driver_options.html">DriverOptions</a>&amp; options,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">const</span> std::vector&lt;SharedHandle&gt;&amp; modelCacheHandle,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> std::vector&lt;SharedHandle&gt;&amp; dataCacheHandle,</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">const</span> CacheToken&amp; token,</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">bool</span> float32ToFloat16 = <span class="keyword">false</span>);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> Capabilities&amp; GetCapabilities(<span class="keyword">const</span> <a class="code" href="namespacearmnn.html#a150468a02bd7b2d2d061c4aaaee939f0">armnn::IRuntimePtr</a>&amp; runtime);</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;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> ValidateSharedHandle(<span class="keyword">const</span> SharedHandle&amp; sharedHandle);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">static</span> <span class="keywordtype">bool</span> ValidateDataCacheHandle(<span class="keyword">const</span> std::vector&lt;SharedHandle&gt;&amp; dataCacheHandle, <span class="keyword">const</span> <span class="keywordtype">size_t</span> dataSize);</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; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;} <span class="comment">// namespace armnn_driver</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassarmnn__driver_1_1_armnn_driver_impl_html"><div class="ttname"><a href="classarmnn__driver_1_1_armnn_driver_impl.html">armnn_driver::ArmnnDriverImpl</a></div><div class="ttdef"><b>Definition:</b> <a href="_armnn_driver_impl_8hpp_source.html#l00023">ArmnnDriverImpl.hpp:23</a></div></div>
<div class="ttc" id="anamespacearmnn__driver_html"><div class="ttname"><a href="namespacearmnn__driver.html">armnn_driver</a></div><div class="ttdoc">Helper classes.</div><div class="ttdef"><b>Definition:</b> <a href="_armnn_device_8cpp_source.html#l00037">ArmnnDevice.cpp:37</a></div></div>
<div class="ttc" id="anamespacearmnn_html_a150468a02bd7b2d2d061c4aaaee939f0"><div class="ttname"><a href="namespacearmnn.html#a150468a02bd7b2d2d061c4aaaee939f0">armnn::IRuntimePtr</a></div><div class="ttdeci">std::unique_ptr&lt; IRuntime, void(*)(IRuntime *runtime)&gt; IRuntimePtr</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.html#l00041">IRuntime.hpp:41</a></div></div>
<div class="ttc" id="anamespacearmnn__driver_html_a923b39ec5f83672f50289cbaf5de6798"><div class="ttname"><a href="namespacearmnn__driver.html#a923b39ec5f83672f50289cbaf5de6798">armnn_driver::Model</a></div><div class="ttdeci">::android::nn::Model Model</div><div class="ttdoc">Helper classes.</div><div class="ttdef"><b>Definition:</b> <a href="_conversion_utils_8hpp_source.html#l00045">ConversionUtils.hpp:45</a></div></div>
<div class="ttc" id="aclassarmnn__driver_1_1_driver_options_html"><div class="ttname"><a href="classarmnn__driver_1_1_driver_options.html">armnn_driver::DriverOptions</a></div><div class="ttdef"><b>Definition:</b> <a href="_driver_options_8hpp_source.html#l00017">DriverOptions.hpp:17</a></div></div>
<div class="ttc" id="a_deprecated_8hpp_html_af16119336bd0dfbfbc83fc283151067e"><div class="ttname"><a href="_deprecated_8hpp.html#af16119336bd0dfbfbc83fc283151067e">ARMNN_DEPRECATED_MSG_REMOVAL_DATE</a></div><div class="ttdeci">#define ARMNN_DEPRECATED_MSG_REMOVAL_DATE(message, removed_in_release)</div><div class="ttdef"><b>Definition:</b> <a href="_deprecated_8hpp_source.html#l00044">Deprecated.hpp:44</a></div></div>
<div class="ttc" id="anamespaceandroid_1_1nn_html"><div class="ttname"><a href="namespaceandroid_1_1nn.html">android::nn</a></div><div class="ttdef"><b>Definition:</b> <a href="support__library__service_8cpp_source.html#l00010">support_library_service.cpp:10</a></div></div>
<div class="ttc" id="a_arm_n_n_8hpp_html"><div class="ttname"><a href="_arm_n_n_8hpp.html">ArmNN.hpp</a></div></div>
<div class="ttc" id="anamespacearmnn_html_a2d3a708a26ac6d77bf8f15506e89a25a"><div class="ttname"><a href="namespacearmnn.html#a2d3a708a26ac6d77bf8f15506e89a25a">armnn::IGpuAccTunedParametersPtr</a></div><div class="ttdeci">std::shared_ptr&lt; IGpuAccTunedParameters &gt; IGpuAccTunedParametersPtr</div><div class="ttdoc">The following API is replaced by the backend options API.</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.html#l00301">IRuntime.hpp:301</a></div></div>
<div class="ttc" id="a_driver_options_8hpp_html"><div class="ttname"><a href="_driver_options_8hpp.html">DriverOptions.hpp</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_b4dbf96392bc72a402a7206cbda88a03.html">shim</a></li><li class="navelem"><a class="el" href="dir_09eea26cf0279feb9fcfb9b796a3e57e.html">sl</a></li><li class="navelem"><a class="el" href="dir_6de13b49022bb7cfc6557e28050d5cbe.html">canonical</a></li><li class="navelem"><a class="el" href="_armnn_driver_impl_8hpp.html">ArmnnDriverImpl.hpp</a></li>
<li class="footer">Generated on Thu May 16 2024 09:31:44 for Arm NN by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>