| <!-- 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: include/armnn/backends/IWorkload.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"> |
|  <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&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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('_i_workload_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">IWorkload.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="_i_workload_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> <span class="comment">//</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright © 2020-2023 Arm Ltd and Contributors. All rights reserved.</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <<a class="code" href="_types_8hpp.html">armnn/Types.hpp</a>></span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <<a class="code" href="_workload_info_8hpp.html">armnn/backends/WorkloadInfo.hpp</a>></span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> {</div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div> |
| <div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="namespacearmnn_1_1experimental.html"> 13</a></span> <span class="keyword">namespace </span>experimental</div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> {</div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">struct </span><a class="code" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a>;</div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> } <span class="comment">// end experimental namespace</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">using namespace </span><a class="code" href="namespacearmnn_1_1experimental.html">armnn::experimental</a>;</div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span> </div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/// Workload interface to enqueue a layer computation.</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_workload.html"> 23</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classarmnn_1_1_i_workload.html">IWorkload</a> {</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_workload.html#a69c83c02ae8de866bc7a46c49e69c1ba"> 25</a></span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_i_workload.html#a69c83c02ae8de866bc7a46c49e69c1ba">~IWorkload</a>() {}</div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment">// Note: do not call for async networks via ExecuteAsync or otherwise,</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">// as async networks memory is allocated outside the workload.</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> PostAllocationConfigure() = 0;</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Execute() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> ExecuteAsync(<a class="code" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a>& executionData) = 0;</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">virtual</span> arm::pipe::ProfilingGuid GetGuid() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// SupportsTensorHandleReplacement signals that a given workload is capable of</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// replacing any of its I/O tensors via ReplaceInput/OutputTensorHandle</span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SupportsTensorHandleReplacement() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// Replace input tensor handle with the given TensorHandle</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReplaceInputTensorHandle(<a class="code" href="classarmnn_1_1_i_tensor_handle.html">ITensorHandle</a>* <span class="comment">/*input*/</span>, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="comment">/*slot*/</span>) = 0;</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// Returns the name of the workload</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& GetName() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// Replace output tensor handle with the given TensorHandle</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReplaceOutputTensorHandle(<a class="code" href="classarmnn_1_1_i_tensor_handle.html">ITensorHandle</a>* <span class="comment">/*output*/</span>, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="comment">/*slot*/</span>) = 0;</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div> |
| <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_workload.html#ab81312bd5e64cbae2803de9f243bdb32"> 50</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_workload.html#ab81312bd5e64cbae2803de9f243bdb32">RegisterDebugCallback</a>(<span class="keyword">const</span> <a class="code" href="namespacearmnn.html#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a>& <span class="comment">/*func*/</span>) {}</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_workload.html#a2d2834d1029217934f504e3e59579081"> 52</a></span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_optional.html">armnn::Optional<armnn::MemoryRequirements></a> <a class="code" href="classarmnn_1_1_i_workload.html#a2d2834d1029217934f504e3e59579081">GetMemoryRequirements</a>()</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_empty_optional.html">armnn::EmptyOptional</a>();</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> } <span class="comment">//namespace armnn</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <div class="ttc" id="aclassarmnn_1_1_optional_html"><div class="ttname"><a href="classarmnn_1_1_optional.html">armnn::Optional</a></div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.html#l00270">Optional.hpp:270</a></div></div> |
| <div class="ttc" id="aclassarmnn_1_1_i_workload_html"><div class="ttname"><a href="classarmnn_1_1_i_workload.html">armnn::IWorkload</a></div><div class="ttdoc">Workload interface to enqueue a layer computation.</div><div class="ttdef"><b>Definition:</b> <a href="_i_workload_8hpp_source.html#l00023">IWorkload.hpp:23</a></div></div> |
| <div class="ttc" id="aclassarmnn_1_1_i_tensor_handle_html"><div class="ttname"><a href="classarmnn_1_1_i_tensor_handle.html">armnn::ITensorHandle</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_tensor_handle_8hpp_source.html#l00016">ITensorHandle.hpp:16</a></div></div> |
| <div class="ttc" id="aclassarmnn_1_1_i_workload_html_a2d2834d1029217934f504e3e59579081"><div class="ttname"><a href="classarmnn_1_1_i_workload.html#a2d2834d1029217934f504e3e59579081">armnn::IWorkload::GetMemoryRequirements</a></div><div class="ttdeci">virtual armnn::Optional< armnn::MemoryRequirements > GetMemoryRequirements()</div><div class="ttdef"><b>Definition:</b> <a href="_i_workload_8hpp_source.html#l00052">IWorkload.hpp:52</a></div></div> |
| <div class="ttc" id="astructarmnn_1_1_empty_optional_html"><div class="ttname"><a href="structarmnn_1_1_empty_optional.html">armnn::EmptyOptional</a></div><div class="ttdoc">EmptyOptional is used to initialize the Optional class in case we want to have default value for an O...</div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.html#l00032">Optional.hpp:32</a></div></div> |
| <div class="ttc" id="anamespacearmnn_1_1experimental_html"><div class="ttname"><a href="namespacearmnn_1_1experimental.html">armnn::experimental</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_workload_8hpp_source.html#l00013">IWorkload.hpp:13</a></div></div> |
| <div class="ttc" id="aclassarmnn_1_1_i_workload_html_a69c83c02ae8de866bc7a46c49e69c1ba"><div class="ttname"><a href="classarmnn_1_1_i_workload.html#a69c83c02ae8de866bc7a46c49e69c1ba">armnn::IWorkload::~IWorkload</a></div><div class="ttdeci">virtual ~IWorkload()</div><div class="ttdef"><b>Definition:</b> <a href="_i_workload_8hpp_source.html#l00025">IWorkload.hpp:25</a></div></div> |
| <div class="ttc" id="anamespacearmnn_html_a15f3ad9b5e4e3d46b0a6dda246a7bc28"><div class="ttname"><a href="namespacearmnn.html#a15f3ad9b5e4e3d46b0a6dda246a7bc28">armnn::DebugCallbackFunction</a></div><div class="ttdeci">std::function< void(LayerGuid guid, unsigned int slotIndex, ITensorHandle *tensorHandle)> DebugCallbackFunction</div><div class="ttdoc">Define the type of callback for the Debug layer to call.</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.html#l00398">Types.hpp:398</a></div></div> |
| <div class="ttc" id="anamespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors.</div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.html#l00006">01_00_quick_start.dox:6</a></div></div> |
| <div class="ttc" id="a_types_8hpp_html"><div class="ttname"><a href="_types_8hpp.html">Types.hpp</a></div></div> |
| <div class="ttc" id="aclassarmnn_1_1_i_workload_html_ab81312bd5e64cbae2803de9f243bdb32"><div class="ttname"><a href="classarmnn_1_1_i_workload.html#ab81312bd5e64cbae2803de9f243bdb32">armnn::IWorkload::RegisterDebugCallback</a></div><div class="ttdeci">virtual void RegisterDebugCallback(const DebugCallbackFunction &)</div><div class="ttdef"><b>Definition:</b> <a href="_i_workload_8hpp_source.html#l00050">IWorkload.hpp:50</a></div></div> |
| <div class="ttc" id="a_workload_info_8hpp_html"><div class="ttname"><a href="_workload_info_8hpp.html">WorkloadInfo.hpp</a></div></div> |
| <div class="ttc" id="astructarmnn_1_1experimental_1_1_execution_data_html"><div class="ttname"><a href="structarmnn_1_1experimental_1_1_execution_data.html">armnn::experimental::ExecutionData</a></div><div class="ttdef"><b>Definition:</b> <a href="_execution_data_8hpp_source.html#l00014">ExecutionData.hpp:14</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_2b72cc348e06937955e62ebdd8a13436.html">armnn</a></li><li class="navelem"><a class="el" href="dir_8946eb9d8f826e973720979438627a91.html">backends</a></li><li class="navelem"><a class="el" href="_i_workload_8hpp.html">IWorkload.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> |