aboutsummaryrefslogtreecommitdiff
path: root/23.05/_cl_backend_model_context_8hpp_source.xhtml
blob: 5de37beae6921abafd68c4323dabf1a4afc0d0f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!-- Copyright (c) 2020 ARM Limited. -->
<!--                                 -->
<!-- SPDX-License-Identifier: MIT    -->
<!--                                 -->
<!-- HTML header for doxygen 1.8.13-->
<!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.17"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: src/backends/cl/ClBackendModelContext.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="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="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
  <td style="padding-left: 0.5em;">
   <div id="projectname">
   &#160;<span id="projectnumber">23.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('_cl_backend_model_context_8hpp_source.xhtml',''); 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">ClBackendModelContext.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_cl_backend_model_context_8hpp.xhtml">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 © 2020 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;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="include_2armnn_2backends_2_i_backend_context_8hpp.xhtml">armnn/backends/IBackendContext.hpp</a>&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#include&lt;string&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;{</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">/// The ClBackendModelContext is used to pass in CL specific backend ModelOptions. The supported backend ModelOptions</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">/// are:</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">///  - &quot;FastMathEnabled&quot;\n</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">///    Using the fast_math flag can lead to performance improvements in fp32 and fp16 layers but may result in\n</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">///    results with reduced or different precision. The fast_math flag will not have any effect on int8 performance.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">///  - &quot;SaveCachedNetwork&quot;\n</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">///    Using the save_cached_network flag enables saving the cached network\n</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">///    to a file given with the cached_network_file_path option.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">///  - &quot;CachedNetworkFilePath&quot;\n</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">///    If the cached_network_file_path is a valid file and the save_cached_network flag is present\n</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">///    then the cached network will be saved to the given file.\n</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">///    If the cached_network_file_path is a valid file and the save_cached_network flag is not present\n</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">///    then the cached network will be loaded from the given file.\n</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">///    This will remove the time taken for initial compilation of kernels and speed up the first execution.</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_backend_model_context.xhtml">   28</a></span>&#160;<span class="comment"></span><span class="keyword">class </span><a class="code" href="classarmnn_1_1_cl_backend_model_context.xhtml">ClBackendModelContext</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_i_backend_model_context.xhtml">IBackendModelContext</a></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;{</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <a class="code" href="classarmnn_1_1_cl_backend_model_context.xhtml#a337185fa5f1502a2e641b3aabdf24dcc">ClBackendModelContext</a>(<span class="keyword">const</span> <a class="code" href="namespacearmnn.xhtml#a5b6893cda5b69359a4244c06054da18f">ModelOptions</a>&amp; modelOptions);</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    std::string <a class="code" href="classarmnn_1_1_cl_backend_model_context.xhtml#af63da34dc5a594a3a3458fca1f83571e">GetCachedNetworkFilePath</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_cl_backend_model_context.xhtml#abfe9aa4fa74aca0f9a925752bbbb0f79">IsFastMathEnabled</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_cl_backend_model_context.xhtml#a9640684f215321d0d93f6f3cb14d5da1">SaveCachedNetwork</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="classarmnn_1_1_cl_backend_model_context.xhtml#abd2a5f8d869d14f1e962238c0579719f">GetCachedFileDescriptor</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    std::string m_CachedNetworkFilePath;</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="keywordtype">bool</span> m_IsFastMathEnabled;</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    <span class="keywordtype">bool</span> m_SaveCachedNetwork;</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keywordtype">int</span> m_CachedFileDescriptor;</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160; </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; </div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;} <span class="comment">// namespace armnn</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassarmnn_1_1_cl_backend_model_context_xhtml_af63da34dc5a594a3a3458fca1f83571e"><div class="ttname"><a href="classarmnn_1_1_cl_backend_model_context.xhtml#af63da34dc5a594a3a3458fca1f83571e">armnn::ClBackendModelContext::GetCachedNetworkFilePath</a></div><div class="ttdeci">std::string GetCachedNetworkFilePath() const</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_model_context_8cpp_source.xhtml#l00061">ClBackendModelContext.cpp:61</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_cl_backend_model_context_xhtml_a9640684f215321d0d93f6f3cb14d5da1"><div class="ttname"><a href="classarmnn_1_1_cl_backend_model_context.xhtml#a9640684f215321d0d93f6f3cb14d5da1">armnn::ClBackendModelContext::SaveCachedNetwork</a></div><div class="ttdeci">bool SaveCachedNetwork() const</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_model_context_8cpp_source.xhtml#l00071">ClBackendModelContext.cpp:71</a></div></div>
<div class="ttc" id="ainclude_2armnn_2backends_2_i_backend_context_8hpp_xhtml"><div class="ttname"><a href="include_2armnn_2backends_2_i_backend_context_8hpp.xhtml">IBackendContext.hpp</a></div></div>
<div class="ttc" id="anamespacearmnn_xhtml_a5b6893cda5b69359a4244c06054da18f"><div class="ttname"><a href="namespacearmnn.xhtml#a5b6893cda5b69359a4244c06054da18f">armnn::ModelOptions</a></div><div class="ttdeci">std::vector&lt; BackendOptions &gt; ModelOptions</div><div class="ttdef"><b>Definition:</b> <a href="_backend_options_8hpp_source.xhtml#l00018">BackendOptions.hpp:18</a></div></div>
<div class="ttc" id="anamespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">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.xhtml#l00006">01_00_quick_start.dox:6</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_cl_backend_model_context_xhtml"><div class="ttname"><a href="classarmnn_1_1_cl_backend_model_context.xhtml">armnn::ClBackendModelContext</a></div><div class="ttdoc">The ClBackendModelContext is used to pass in CL specific backend ModelOptions.</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_model_context_8hpp_source.xhtml#l00028">ClBackendModelContext.hpp:28</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_cl_backend_model_context_xhtml_abd2a5f8d869d14f1e962238c0579719f"><div class="ttname"><a href="classarmnn_1_1_cl_backend_model_context.xhtml#abd2a5f8d869d14f1e962238c0579719f">armnn::ClBackendModelContext::GetCachedFileDescriptor</a></div><div class="ttdeci">int GetCachedFileDescriptor() const</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_model_context_8cpp_source.xhtml#l00076">ClBackendModelContext.cpp:76</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_cl_backend_model_context_xhtml_a337185fa5f1502a2e641b3aabdf24dcc"><div class="ttname"><a href="classarmnn_1_1_cl_backend_model_context.xhtml#a337185fa5f1502a2e641b3aabdf24dcc">armnn::ClBackendModelContext::ClBackendModelContext</a></div><div class="ttdeci">ClBackendModelContext(const ModelOptions &amp;modelOptions)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_model_context_8cpp_source.xhtml#l00034">ClBackendModelContext.cpp:34</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_cl_backend_model_context_xhtml_abfe9aa4fa74aca0f9a925752bbbb0f79"><div class="ttname"><a href="classarmnn_1_1_cl_backend_model_context.xhtml#abfe9aa4fa74aca0f9a925752bbbb0f79">armnn::ClBackendModelContext::IsFastMathEnabled</a></div><div class="ttdeci">bool IsFastMathEnabled() const</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_model_context_8cpp_source.xhtml#l00066">ClBackendModelContext.cpp:66</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_i_backend_model_context_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_backend_model_context.xhtml">armnn::IBackendModelContext</a></div><div class="ttdef"><b>Definition:</b> <a href="include_2armnn_2backends_2_i_backend_context_8hpp_source.xhtml#l00036">IBackendContext.hpp:36</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_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.xhtml">backends</a></li><li class="navelem"><a class="el" href="dir_1ad86c6d39ab715a831555571b9e98a5.xhtml">cl</a></li><li class="navelem"><a class="el" href="_cl_backend_model_context_8hpp.xhtml">ClBackendModelContext.hpp</a></li>
    <li class="footer">Generated on Thu May 18 2023 10:35:41 for ArmNN 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>