aboutsummaryrefslogtreecommitdiff
path: root/22.02/namespacetflite.xhtml
blob: 6f75745b8067dbd145f60783a64ef1e49ba78910 (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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<!-- 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.13"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: tflite Namespace 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">
  $(document).ready(initResizable);
</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" 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">22.02</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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">
$(document).ready(function(){initNavTree('namespacetflite.xhtml','');});
</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="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">tflite Namespace Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8e21a0acecdf21e909d9d7dc13acdcef"><td class="memItemLeft" align="right" valign="top">TfLiteDelegate *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacetflite.xhtml#a8e21a0acecdf21e909d9d7dc13acdcef">tflite_plugin_create_delegate</a> (char **options_keys, char **options_values, size_t num_options, void(*report_error)(const char *))</td></tr>
<tr class="memdesc:a8e21a0acecdf21e909d9d7dc13acdcef"><td class="mdescLeft">&#160;</td><td class="mdescRight">This file defines two symbols that need to be exported to use the TFLite external delegate provider.  <a href="#a8e21a0acecdf21e909d9d7dc13acdcef">More...</a><br /></td></tr>
<tr class="separator:a8e21a0acecdf21e909d9d7dc13acdcef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2501fc8679230dab265774a84264f19"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacetflite.xhtml#ae2501fc8679230dab265774a84264f19">tflite_plugin_destroy_delegate</a> (TfLiteDelegate *delegate)</td></tr>
<tr class="memdesc:ae2501fc8679230dab265774a84264f19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a given delegate plugin.  <a href="#ae2501fc8679230dab265774a84264f19">More...</a><br /></td></tr>
<tr class="separator:ae2501fc8679230dab265774a84264f19"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a8e21a0acecdf21e909d9d7dc13acdcef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e21a0acecdf21e909d9d7dc13acdcef">&#9670;&nbsp;</a></span>tflite_plugin_create_delegate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TfLiteDelegate* tflite::tflite_plugin_create_delegate </td>
          <td>(</td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>options_keys</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>options_values</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>num_options</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void(*)(const char *)&#160;</td>
          <td class="paramname"><em>report_error</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This file defines two symbols that need to be exported to use the TFLite external delegate provider. </p>
<p>This is a plugin that can be used for fast integration of delegates into benchmark tests and other tools. It allows loading of a dynamic delegate library at runtime.</p>
<p>The external delegate also has Tensorflow Lite Python bindings. Therefore the dynamic external delegate can be directly used with Tensorflow Lite Python APIs.</p>
<p>See tensorflow/lite/delegates/external for details or visit the tensorflow guide <a href="https://www.tensorflow.org/lite/performance/implementing_delegate#option_2_leverage_external_delegate">here</a> Implementation of the TfLite external delegate plugin</p>
<p>For details about what options_keys and option_values are supported please see: <a class="el" href="classarmnn_delegate_1_1_delegate_options.xhtml#a318c3a715a80b7288e39c7daa8ef8494">armnnDelegate::DelegateOptions::DelegateOptions</a>(char const* const*, char const* const*,size_t,void (*)(const char*)) </p>

<p class="definition">Definition at line <a class="el" href="armnn__external__delegate_8cpp_source.xhtml#l00036">36</a> of file <a class="el" href="armnn__external__delegate_8cpp_source.xhtml">armnn_external_delegate.cpp</a>.</p>

<p class="reference">References <a class="el" href="namespacearmnn_delegate.xhtml#aaab840e387d9a4e7de223fbc8c969eb3">armnnDelegate::TfLiteArmnnDelegateCreate()</a>.</p>
<div class="fragment"><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="comment">// Returning null indicates an error during delegate creation, we initialize with that</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    TfLiteDelegate* delegate = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="keywordflow">try</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    {</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;        <a class="code" href="classarmnn_delegate_1_1_delegate_options.xhtml">armnnDelegate::DelegateOptions</a> options (options_keys, options_values, num_options, (*report_error));</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;        delegate = <a class="code" href="namespacearmnn_delegate.xhtml#aaab840e387d9a4e7de223fbc8c969eb3">TfLiteArmnnDelegateCreate</a>(options);</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="keywordflow">catch</span> (<span class="keyword">const</span> std::exception&amp; ex)</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="keywordflow">if</span>(report_error)</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        {</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;            report_error(ex.what());</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="keywordflow">return</span> delegate;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;}</div><div class="ttc" id="namespacearmnn_delegate_xhtml_aaab840e387d9a4e7de223fbc8c969eb3"><div class="ttname"><a href="namespacearmnn_delegate.xhtml#aaab840e387d9a4e7de223fbc8c969eb3">armnnDelegate::TfLiteArmnnDelegateCreate</a></div><div class="ttdeci">TfLiteDelegate * TfLiteArmnnDelegateCreate(armnnDelegate::DelegateOptions options)</div></div>
<div class="ttc" id="classarmnn_delegate_1_1_delegate_options_xhtml"><div class="ttname"><a href="classarmnn_delegate_1_1_delegate_options.xhtml">armnnDelegate::DelegateOptions</a></div><div class="ttdef"><b>Definition:</b> <a href="_delegate_options_8hpp_source.xhtml#l00019">DelegateOptions.hpp:19</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ae2501fc8679230dab265774a84264f19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2501fc8679230dab265774a84264f19">&#9670;&nbsp;</a></span>tflite_plugin_destroy_delegate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void tflite::tflite_plugin_destroy_delegate </td>
          <td>(</td>
          <td class="paramtype">TfLiteDelegate *&#160;</td>
          <td class="paramname"><em>delegate</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroy a given delegate plugin. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">delegate</td><td>Delegate to destruct </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="armnn__external__delegate_8cpp_source.xhtml#l00062">62</a> of file <a class="el" href="armnn__external__delegate_8cpp_source.xhtml">armnn_external_delegate.cpp</a>.</p>

<p class="reference">References <a class="el" href="namespacearmnn_delegate.xhtml#a29bbb05765039d65532d61301b56749e">armnnDelegate::TfLiteArmnnDelegateDelete()</a>.</p>
<div class="fragment"><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;{</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <a class="code" href="namespacearmnn_delegate.xhtml#a29bbb05765039d65532d61301b56749e">armnnDelegate::TfLiteArmnnDelegateDelete</a>(delegate);</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;}</div><div class="ttc" id="namespacearmnn_delegate_xhtml_a29bbb05765039d65532d61301b56749e"><div class="ttname"><a href="namespacearmnn_delegate.xhtml#a29bbb05765039d65532d61301b56749e">armnnDelegate::TfLiteArmnnDelegateDelete</a></div><div class="ttdeci">void TfLiteArmnnDelegateDelete(TfLiteDelegate *tfLiteDelegate)</div></div>
</div><!-- fragment -->
</div>
</div>
</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="namespacetflite.xhtml">tflite</a></li>
    <li class="footer">Generated on Wed Mar 9 2022 12:01:31 for ArmNN by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>