-
Notifications
You must be signed in to change notification settings - Fork 1
/
export_CPP.html
387 lines (269 loc) · 16.7 KB
/
export_CPP.html
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Export: C++ — N2D2 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Export: C++/STM32" href="export_CPP_STM32.html" />
<link rel="prev" title="[NEW] Quantization-Aware Training" href="quant_qat.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> N2D2
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Introduction:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About N2D2-IP</a></li>
<li class="toctree-l1"><a class="reference internal" href="simus.html">Performing simulations</a></li>
<li class="toctree-l1"><a class="reference internal" href="perfs_tools.html">Performance evaluation tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="tuto.html">Tutorials</a></li>
</ul>
<p class="caption"><span class="caption-text">ONNX Import:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="onnx_convert.html">Obtain ONNX models</a></li>
<li class="toctree-l1"><a class="reference internal" href="onnx_import.html">Import ONNX models</a></li>
<li class="toctree-l1"><a class="reference internal" href="onnx_transfer.html">Train from ONNX models</a></li>
</ul>
<p class="caption"><span class="caption-text">Quantization and Export:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quant_post.html">Post-training quantization</a></li>
<li class="toctree-l1"><a class="reference internal" href="quant_qat.html">[NEW] Quantization-Aware Training</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Export: C++</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#principle">Principle</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#graph-optimizations">Graph optimizations</a></li>
<li class="toctree-l3"><a class="reference internal" href="#memory-optimizations">Memory optimizations</a></li>
<li class="toctree-l3"><a class="reference internal" href="#export-parameters">Export parameters</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#example">Example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="export_CPP_STM32.html">Export: C++/STM32</a></li>
<li class="toctree-l1"><a class="reference internal" href="export_TensorRT.html">Export: TensorRT</a></li>
<li class="toctree-l1"><a class="reference internal" href="export_DNeuro.html">Export: DNeuro</a></li>
<li class="toctree-l1"><a class="reference internal" href="export_ONNX.html">Export: ONNX</a></li>
<li class="toctree-l1"><a class="reference internal" href="export_legacy.html">Export: other / legacy</a></li>
</ul>
<p class="caption"><span class="caption-text">INI File Interface:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="ini_intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="ini_databases.html">Databases</a></li>
<li class="toctree-l1"><a class="reference internal" href="ini_data_analysis.html">Stimuli data analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="ini_environment.html">Stimuli provider (Environment)</a></li>
<li class="toctree-l1"><a class="reference internal" href="ini_layers.html">Network Layers</a></li>
<li class="toctree-l1"><a class="reference internal" href="ini_target.html">Targets (outputs & losses)</a></li>
<li class="toctree-l1"><a class="reference internal" href="adversarial.html">Adversarial module</a></li>
</ul>
<p class="caption"><span class="caption-text">Python API:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="containers.html">Containers</a></li>
<li class="toctree-l1"><a class="reference internal" href="cells.html">Cells</a></li>
<li class="toctree-l1"><a class="reference internal" href="databases.html">Databases</a></li>
<li class="toctree-l1"><a class="reference internal" href="stimuliprovider.html">StimuliProvider</a></li>
<li class="toctree-l1"><a class="reference internal" href="deepnet.html">DeepNet</a></li>
</ul>
<p class="caption"><span class="caption-text">C++ API / Developer:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="dev_intro.html">Introduction</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">N2D2</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li>Export: C++</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/export_CPP.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="export-c">
<span id="export-cpp-label"></span><h1>Export: C++<a class="headerlink" href="#export-c" title="Permalink to this headline">¶</a></h1>
<dl class="simple">
<dt>Export type: <code class="docutils literal notranslate"><span class="pre">CPP</span></code></dt><dd><p>C++ export using OpenMP.</p>
</dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">n2d2</span> <span class="n">MobileNet_ONNX</span><span class="o">.</span><span class="n">ini</span> <span class="o">-</span><span class="n">seed</span> <span class="mi">1</span> <span class="o">-</span><span class="n">w</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="o">-</span><span class="n">export</span> <span class="n">CPP</span>
</pre></div>
</div>
<div class="section" id="principle">
<h2>Principle<a class="headerlink" href="#principle" title="Permalink to this headline">¶</a></h2>
<p>The C++ export is the reference N2D2 export, which implements all the export
features available in N2D2, like post-training quantization or quantization
aware training.</p>
<p>Summary of the main features of a C++ export:</p>
<ul class="simple">
<li><p>Standalone C++11 compliant project;</p>
<ul>
<li><p>No C++ exception (often disabled on embedded code);</p></li>
<li><p>No <stream> library (which is memory bloated).</p></li>
</ul>
</li>
<li><p>Fully templated compute kernels;</p></li>
<li><p>Fully inlined compute kernels;</p></li>
<li><p>No dynamic memory allocation;</p></li>
<li><p>Memory alignment support;</p></li>
<li><p>OpenMP parallelism.</p></li>
</ul>
<dl class="simple">
<dt>Data order</dt><dd><p>The input of a layer is ordered by Height-Width-Channels (HWC) and the weights
of the kernel for a convolution by Output-Height-Width-Channels (OHWC). This order allows
us to do read <em>kernel_width</em> × <em>nb_channels</em> inputs and weights sequentially in memory to do the
necessary MACs.</p>
</dd>
<dt>Templated layer parameters</dt><dd><p>The current export uses C++ templates heavily, most of the
parameters of the layers are passed as template parameters. This allows the compiler to better
optimize the code and make it easier to unroll the loops. It comes at the cost of a larger compiled
binary.</p>
</dd>
<dt>Force inline</dt><dd><p>Most of the methods are forced to be inlined. As previously this increases the binary
size to provide a faster inference.</p>
</dd>
<dt>Loop boundaries</dt><dd><p>The boundaries of the loops are fixed at compile time through the template
parameters. If some steps in a loop must be skipped an if and continue are used inside the loop. It
results in better results than having variable loop boundaries.</p>
</dd>
</dl>
<div class="section" id="graph-optimizations">
<h3>Graph optimizations<a class="headerlink" href="#graph-optimizations" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li><p>Weights are equalized between layers when possible;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">BatchNorm</span></code> is automatically fused with the preceding <code class="docutils literal notranslate"><span class="pre">Conv</span></code> or <code class="docutils literal notranslate"><span class="pre">Fc</span></code> when possible;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Padding</span></code> layers are fused with <code class="docutils literal notranslate"><span class="pre">Conv</span></code> when possible;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Dropout</span></code> layers are removed.</p></li>
</ul>
</div>
<div class="section" id="memory-optimizations">
<h3>Memory optimizations<a class="headerlink" href="#memory-optimizations" title="Permalink to this headline">¶</a></h3>
<p>In the C++ export, all the memory is allocated statically at compilation time.</p>
<p>The following memory optimization features are integrated in this export:</p>
<ul class="simple">
<li><p><strong>Strided buffers:</strong> concatenation can be done directly in memory, no memory copy is needed;</p></li>
<li><p><strong>Memory wrapping:</strong> memory buffers are re-used when possible (memory wrapping or in-place).</p></li>
</ul>
<p>For example, the memory mapping of each layer in a global memory space for
MobileNet v2 is shown below (generated automatically during an export):</p>
<div class="figure align-default">
<img alt="Example of memory mapping for MobileNet v2." src="_images/memory_mapping.png" />
</div>
<p>In this example, the largest layer memory buffer overlaps with the memory
buffer of the preceding layer thanks to the <code class="docutils literal notranslate"><span class="pre">OptimizeBufferMemory</span></code> option
(see the next section).</p>
</div>
<div class="section" id="export-parameters">
<h3>Export parameters<a class="headerlink" href="#export-parameters" title="Permalink to this headline">¶</a></h3>
<p>Extra parameters can be passed during export using the
<code class="docutils literal notranslate"><span class="pre">-export-parameters</span> <span class="pre">params.ini</span></code> command line argument. The parameters must be
saved in an INI-like file.</p>
<p>List of available parameters:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 35%" />
<col style="width: 65%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Argument [default value]</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">IncludeInputInBuffer</span></code> [1]</p></td>
<td><p>If true (1), include the input buffer in the memory mapping</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">OptimizeBufferMemory</span></code> [1]</p></td>
<td><p>If true (1), try to re-use memory spaces using wrapping and in-place</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">OptimizeNoBranchConcat</span></code> [1]</p></td>
<td><p>If true (1), concatenation is done directly in memory when possible</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">MemoryAlignment</span></code> [1]</p></td>
<td><p>Default memory alignment (in bytes)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">MemoryManagerStrategy</span></code> [<code class="docutils literal notranslate"><span class="pre">OptimizeMaxLifetimeMaxSizeFirst</span></code>]</p></td>
<td><p>Optimization strategy for static memory allocation</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">n2d2</span> <span class="n">MobileNet_ONNX</span><span class="o">.</span><span class="n">ini</span> <span class="o">-</span><span class="n">seed</span> <span class="mi">1</span> <span class="o">-</span><span class="n">w</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="o">-</span><span class="n">export</span> <span class="n">CPP</span> <span class="o">-</span><span class="n">fuse</span> <span class="o">-</span><span class="n">nbbits</span> <span class="mi">8</span> <span class="o">-</span><span class="n">calib</span> <span class="o">-</span><span class="mi">1</span> <span class="o">-</span><span class="n">db</span><span class="o">-</span><span class="n">export</span> <span class="mi">100</span> <span class="o">-</span><span class="n">test</span>
</pre></div>
</div>
<p>This command generates a C++ project in the sub-directory <code class="docutils literal notranslate"><span class="pre">export_CPP_int8</span></code>.
This project is ready to be compiled with a <code class="docutils literal notranslate"><span class="pre">Makefile</span></code>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code class="docutils literal notranslate"><span class="pre">Softmax</span></code> layer is not supported by the C++ export and must be removed
before export, as it is not compatible with low precision integer computing.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="export_CPP_STM32.html" class="btn btn-neutral float-right" title="Export: C++/STM32" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="quant_qat.html" class="btn btn-neutral float-left" title="[NEW] Quantization-Aware Training" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, CEA LIST
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>