Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1dc83febfb76d6a770bdf3ba16c4034a970c2320 / . / 24.05 / classarmnn_1_1_cl_context_serializer.html
blob: cb8459a1ce4ab4c6fb9d7bea29ff16dc0194a58e [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100[diff] [blame^]1<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: ClContextSerializer 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<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.05</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('classarmnn_1_1_cl_context_serializer.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="classarmnn_1_1_cl_context_serializer-members.html">List of all members</a> </div>
98 <div class="headertitle">
99<div class="title">ClContextSerializer Class Reference</div> </div>
100</div><!--header-->
101<div class="contents">
102
103<p><code>#include &lt;<a class="el" href="_cl_context_serializer_8hpp_source.html">ClContextSerializer.hpp</a>&gt;</code></p>
104<table class="memberdecls">
105<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
106Public Member Functions</h2></td></tr>
107<tr class="memitem:a76667bc7f0bed0097cd2f44c6b28b7ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.html#a76667bc7f0bed0097cd2f44c6b28b7ab">ClContextSerializer</a> ()=default</td></tr>
108<tr class="separator:a76667bc7f0bed0097cd2f44c6b28b7ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
109<tr class="memitem:a98565c90862c879b731128512377efb6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.html#a98565c90862c879b731128512377efb6">~ClContextSerializer</a> ()=default</td></tr>
110<tr class="separator:a98565c90862c879b731128512377efb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
111<tr class="memitem:a4a280cb5af0dc71c4dd665e2d12c4c94"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.html#a4a280cb5af0dc71c4dd665e2d12c4c94">Serialize</a> (const arm_compute::CLCompileContext &amp;clCompileContext)</td></tr>
112<tr class="memdesc:a4a280cb5af0dc71c4dd665e2d12c4c94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes the CLCompileContext built-in programs. <a href="classarmnn_1_1_cl_context_serializer.html#a4a280cb5af0dc71c4dd665e2d12c4c94">More...</a><br /></td></tr>
113<tr class="separator:a4a280cb5af0dc71c4dd665e2d12c4c94"><td class="memSeparator" colspan="2">&#160;</td></tr>
114<tr class="memitem:a049d34980f9dd0a518f9781822a718c4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.html#a049d34980f9dd0a518f9781822a718c4">SaveSerializedToStream</a> (std::ostream &amp;stream)</td></tr>
115<tr class="memdesc:a049d34980f9dd0a518f9781822a718c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes the ClContext to the stream. <a href="classarmnn_1_1_cl_context_serializer.html#a049d34980f9dd0a518f9781822a718c4">More...</a><br /></td></tr>
116<tr class="separator:a049d34980f9dd0a518f9781822a718c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
117</table>
118<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
119<div class="textblock">
120<p class="definition">Definition at line <a class="el" href="_cl_context_serializer_8hpp_source.html#l00015">15</a> of file <a class="el" href="_cl_context_serializer_8hpp_source.html">ClContextSerializer.hpp</a>.</p>
121</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
122<a id="a76667bc7f0bed0097cd2f44c6b28b7ab"></a>
123<h2 class="memtitle"><span class="permalink"><a href="#a76667bc7f0bed0097cd2f44c6b28b7ab">&#9670;&nbsp;</a></span>ClContextSerializer()</h2>
124
125<div class="memitem">
126<div class="memproto">
127<table class="mlabels">
128 <tr>
129 <td class="mlabels-left">
130 <table class="memname">
131 <tr>
132 <td class="memname"><a class="el" href="classarmnn_1_1_cl_context_serializer.html">ClContextSerializer</a> </td>
133 <td>(</td>
134 <td class="paramname"></td><td>)</td>
135 <td></td>
136 </tr>
137 </table>
138 </td>
139 <td class="mlabels-right">
140<span class="mlabels"><span class="mlabel">default</span></span> </td>
141 </tr>
142</table>
143</div><div class="memdoc">
144
145</div>
146</div>
147<a id="a98565c90862c879b731128512377efb6"></a>
148<h2 class="memtitle"><span class="permalink"><a href="#a98565c90862c879b731128512377efb6">&#9670;&nbsp;</a></span>~ClContextSerializer()</h2>
149
150<div class="memitem">
151<div class="memproto">
152<table class="mlabels">
153 <tr>
154 <td class="mlabels-left">
155 <table class="memname">
156 <tr>
157 <td class="memname">~<a class="el" href="classarmnn_1_1_cl_context_serializer.html">ClContextSerializer</a> </td>
158 <td>(</td>
159 <td class="paramname"></td><td>)</td>
160 <td></td>
161 </tr>
162 </table>
163 </td>
164 <td class="mlabels-right">
165<span class="mlabels"><span class="mlabel">default</span></span> </td>
166 </tr>
167</table>
168</div><div class="memdoc">
169
170</div>
171</div>
172<h2 class="groupheader">Member Function Documentation</h2>
173<a id="a049d34980f9dd0a518f9781822a718c4"></a>
174<h2 class="memtitle"><span class="permalink"><a href="#a049d34980f9dd0a518f9781822a718c4">&#9670;&nbsp;</a></span>SaveSerializedToStream()</h2>
175
176<div class="memitem">
177<div class="memproto">
178 <table class="memname">
179 <tr>
180 <td class="memname">bool SaveSerializedToStream </td>
181 <td>(</td>
182 <td class="paramtype">std::ostream &amp;&#160;</td>
183 <td class="paramname"><em>stream</em></td><td>)</td>
184 <td></td>
185 </tr>
186 </table>
187</div><div class="memdoc">
188
189<p>Serializes the ClContext to the stream. </p>
190<dl class="params"><dt>Parameters</dt><dd>
191 <table class="params">
192 <tr><td class="paramname">[stream]</td><td>the stream to save to </td></tr>
193 </table>
194 </dd>
195</dl>
196<dl class="section return"><dt>Returns</dt><dd>true if ClContext is Serialized to the Stream, false otherwise </dd></dl>
197
198<p class="definition">Definition at line <a class="el" href="_cl_context_serializer_8cpp_source.html#l00049">49</a> of file <a class="el" href="_cl_context_serializer_8cpp_source.html">ClContextSerializer.cpp</a>.</p>
199<div class="fragment"><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;{</div>
200<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// Write to a stream</span></div>
201<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">auto</span> bytesToWrite = armnn::numeric_cast&lt;std::streamsize&gt;(m_FlatBufferBuilder.GetSize());</div>
202<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; stream.write(<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span><span class="keywordtype">char</span>*<span class="keyword">&gt;</span>(m_FlatBufferBuilder.GetBufferPointer()), bytesToWrite);</div>
203<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> !stream.bad();</div>
204<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}</div>
205</div><!-- fragment -->
206</div>
207</div>
208<a id="a4a280cb5af0dc71c4dd665e2d12c4c94"></a>
209<h2 class="memtitle"><span class="permalink"><a href="#a4a280cb5af0dc71c4dd665e2d12c4c94">&#9670;&nbsp;</a></span>Serialize()</h2>
210
211<div class="memitem">
212<div class="memproto">
213 <table class="memname">
214 <tr>
215 <td class="memname">void Serialize </td>
216 <td>(</td>
217 <td class="paramtype">const arm_compute::CLCompileContext &amp;&#160;</td>
218 <td class="paramname"><em>clCompileContext</em></td><td>)</td>
219 <td></td>
220 </tr>
221 </table>
222</div><div class="memdoc">
223
224<p>Serializes the CLCompileContext built-in programs. </p>
225<dl class="params"><dt>Parameters</dt><dd>
226 <table class="params">
227 <tr><td class="paramdir">[in]</td><td class="paramname">clCompileContext</td><td>The CLCompileContext to be serialized. </td></tr>
228 </table>
229 </dd>
230</dl>
231
232<p class="definition">Definition at line <a class="el" href="_cl_context_serializer_8cpp_source.html#l00023">23</a> of file <a class="el" href="_cl_context_serializer_8cpp_source.html">ClContextSerializer.cpp</a>.</p>
233<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
234<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// Get map of built programs from clCompileContext</span></div>
235<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; std::map&lt;std::string, cl::Program&gt; builtProgramsMap = clCompileContext.get_built_programs();</div>
236<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">if</span> (builtProgramsMap.empty())</div>
237<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div>
238<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="_logging_8hpp.html#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a>(warning) &lt;&lt; <span class="stringliteral">&quot;There are no built programs to be serialised.&quot;</span>;</div>
239<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">return</span>;</div>
240<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; }</div>
241<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
242<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// Create Flatbuffer CL Programs</span></div>
243<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; std::vector&lt;flatbuffers::Offset&lt;armnn::Program&gt;&gt; clPrograms;</div>
244<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span>&amp; program : builtProgramsMap)</div>
245<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {</div>
246<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; std::vector&lt;std::vector&lt;uint8_t&gt;&gt; binaries = program.second.getInfo&lt;CL_PROGRAM_BINARIES&gt;();</div>
247<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; clPrograms.push_back(<a class="code" href="namespacearmnn.html#a0f37510801ba4f2500e4e9558c81f93c">CreateProgram</a>(m_FlatBufferBuilder,</div>
248<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; m_FlatBufferBuilder.CreateString(program.first),</div>
249<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; m_FlatBufferBuilder.CreateVector(binaries[0])));</div>
250<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; }</div>
251<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
252<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// Create Flatbuffer CLContext</span></div>
253<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">auto</span> clContext = <a class="code" href="namespacearmnn.html#ac845f99ae84c2fcf016b676769da7c51">CreateClContext</a>(m_FlatBufferBuilder, m_FlatBufferBuilder.CreateVector(clPrograms));</div>
254<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
255<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; m_FlatBufferBuilder.Finish(clContext);</div>
256<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}</div>
257</div><!-- fragment -->
258<p class="reference">References <a class="el" href="_logging_8hpp_source.html#l00212">ARMNN_LOG</a>, <a class="el" href="_cl_context_schema__generated_8h_source.html#l00057">armnn::CreateClContext()</a>, <a class="el" href="_cl_context_schema__generated_8h_source.html#l00118">armnn::CreateProgram()</a>, and <a class="el" href="namespacearmnn.html#a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd">armnn::warning</a>.</p>
259
260</div>
261</div>
262<hr/>The documentation for this class was generated from the following files:<ul>
263<li>src/backends/cl/<a class="el" href="_cl_context_serializer_8hpp_source.html">ClContextSerializer.hpp</a></li>
264<li>src/backends/cl/<a class="el" href="_cl_context_serializer_8cpp_source.html">ClContextSerializer.cpp</a></li>
265</ul>
266</div><!-- contents -->
267</div><!-- doc-content -->
268<div class="ttc" id="anamespacearmnn_html_a0f37510801ba4f2500e4e9558c81f93c"><div class="ttname"><a href="namespacearmnn.html#a0f37510801ba4f2500e4e9558c81f93c">armnn::CreateProgram</a></div><div class="ttdeci">flatbuffers::Offset&lt; Program &gt; CreateProgram(flatbuffers::FlatBufferBuilder &amp;_fbb, flatbuffers::Offset&lt; flatbuffers::String &gt; name=0, flatbuffers::Offset&lt; flatbuffers::Vector&lt; uint8_t &gt;&gt; binary=0)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_schema__generated_8h_source.html#l00118">ClContextSchema_generated.h:118</a></div></div>
269<div class="ttc" id="anamespacearmnn_html_ac845f99ae84c2fcf016b676769da7c51"><div class="ttname"><a href="namespacearmnn.html#ac845f99ae84c2fcf016b676769da7c51">armnn::CreateClContext</a></div><div class="ttdeci">flatbuffers::Offset&lt; ClContext &gt; CreateClContext(flatbuffers::FlatBufferBuilder &amp;_fbb, flatbuffers::Offset&lt; flatbuffers::Vector&lt; flatbuffers::Offset&lt; armnn::Program &gt;&gt;&gt; programs=0)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_schema__generated_8h_source.html#l00057">ClContextSchema_generated.h:57</a></div></div>
270<div class="ttc" id="a_logging_8hpp_html_a7b6ad073975f437ec38ca7d20154727f"><div class="ttname"><a href="_logging_8hpp.html#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a></div><div class="ttdeci">#define ARMNN_LOG(severity)</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8hpp_source.html#l00212">Logging.hpp:212</a></div></div>
271<!-- start footer part -->
272<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
273 <ul>
274 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_cl_context_serializer.html">ClContextSerializer</a></li>
275 <li class="footer">Generated on Thu May 16 2024 09:31:55 for Arm NN by
276 <a href="http://www.doxygen.org/index.html">
277 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
278 </ul>
279</div>
280</body>
281</html>