-
Notifications
You must be signed in to change notification settings - Fork 1
/
ini_intro.html
456 lines (333 loc) · 22.5 KB
/
ini_intro.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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
<!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>Introduction — 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="Databases" href="ini_databases.html" />
<link rel="prev" title="Export: other / legacy" href="export_legacy.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>
<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"><a class="reference internal" href="export_CPP.html">Export: C++</a></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 class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#syntax">Syntax</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="#sections">Sections</a></li>
<li class="toctree-l3"><a class="reference internal" href="#case-sensitivity">Case sensitivity</a></li>
<li class="toctree-l3"><a class="reference internal" href="#comments">Comments</a></li>
<li class="toctree-l3"><a class="reference internal" href="#quoted-values">Quoted values</a></li>
<li class="toctree-l3"><a class="reference internal" href="#whitespace">Whitespace</a></li>
<li class="toctree-l3"><a class="reference internal" href="#escape-characters">Escape characters</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#template-inclusion-syntax">Template inclusion syntax</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#variable-substitution">Variable substitution</a></li>
<li class="toctree-l3"><a class="reference internal" href="#control-statements">Control statements</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#block">block</a></li>
<li class="toctree-l4"><a class="reference internal" href="#for">for</a></li>
<li class="toctree-l4"><a class="reference internal" href="#if">if</a></li>
<li class="toctree-l4"><a class="reference internal" href="#include">include</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#global-parameters">Global parameters</a></li>
</ul>
</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>Introduction</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/ini_intro.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="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
<p>The INI file interface is the primary way of using N2D2. It is a simple,
lightweight and user-friendly format for specifying a complete DNN-based
application, including dataset instanciation, data pre-processing,
neural network layers instanciation and post-processing, with all its
hyperparameters.</p>
<div class="section" id="syntax">
<h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<p>INI files are simple text files with a basic structure composed of
sections, properties and values.</p>
<div class="section" id="properties">
<h3>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h3>
<p>The basic element contained in an INI file is the property. Every
property has a name and a value, delimited by an equals sign (=). The
name appears to the left of the equals sign.</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="na">name</span><span class="o">=</span><span class="s">value</span>
</pre></div>
</div>
</div>
<div class="section" id="sections">
<h3>Sections<a class="headerlink" href="#sections" title="Permalink to this headline">¶</a></h3>
<p>Properties may be grouped into arbitrarily named sections. The section
name appears on a line by itself, in square brackets ([ and ]). All
properties after the section declaration are associated with that
section. There is no explicit “end of section” delimiter; sections end
at the next section declaration, or the end of the file. Sections may
not be nested.</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[section]</span>
<span class="na">a</span><span class="o">=</span><span class="s">a</span>
<span class="na">b</span><span class="o">=</span><span class="s">b</span>
</pre></div>
</div>
</div>
<div class="section" id="case-sensitivity">
<h3>Case sensitivity<a class="headerlink" href="#case-sensitivity" title="Permalink to this headline">¶</a></h3>
<p>Section and property names are case sensitive.</p>
</div>
<div class="section" id="comments">
<h3>Comments<a class="headerlink" href="#comments" title="Permalink to this headline">¶</a></h3>
<p>Semicolons (<code class="docutils literal notranslate"><span class="pre">;</span></code>) or number sign (<code class="docutils literal notranslate"><span class="pre">#</span></code>) at the beginning or in the
middle of the line indicate a comment. Comments are ignored.</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="c1">; comment text</span>
<span class="na">a</span><span class="o">=</span><span class="s">a # comment text</span>
<span class="na">a</span><span class="o">=</span><span class="s">"a ; not a comment" ; comment text</span>
</pre></div>
</div>
</div>
<div class="section" id="quoted-values">
<h3>Quoted values<a class="headerlink" href="#quoted-values" title="Permalink to this headline">¶</a></h3>
<p>Values can be quoted, using double quotes. This allows for explicit
declaration of whitespace, and/or for quoting of special characters
(equals, semicolon, etc.).</p>
</div>
<div class="section" id="whitespace">
<h3>Whitespace<a class="headerlink" href="#whitespace" title="Permalink to this headline">¶</a></h3>
<p>Leading and trailing whitespace on a line are ignored.</p>
</div>
<div class="section" id="escape-characters">
<h3>Escape characters<a class="headerlink" href="#escape-characters" title="Permalink to this headline">¶</a></h3>
<p>A backslash (<code class="docutils literal notranslate"><span class="pre">\</span></code>) followed immediately by EOL (end-of-line) causes the
line break to be ignored.</p>
</div>
</div>
<div class="section" id="template-inclusion-syntax">
<h2>Template inclusion syntax<a class="headerlink" href="#template-inclusion-syntax" title="Permalink to this headline">¶</a></h2>
<p>Is is possible to recursively include templated INI files. For example,
the main INI file can include a templated file like the following:</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[inception@inception_model.ini.tpl]</span>
<span class="na">INPUT</span><span class="o">=</span><span class="s">layer_x</span>
<span class="na">SIZE</span><span class="o">=</span><span class="s">32</span>
<span class="na">ARRAY</span><span class="o">=</span><span class="s">2 ; Must be the number of elements in the array</span>
<span class="na">ARRAY[0].P1</span><span class="o">=</span><span class="s">Conv</span>
<span class="na">ARRAY[0].P2</span><span class="o">=</span><span class="s">32</span>
<span class="na">ARRAY[1].P1</span><span class="o">=</span><span class="s">Pool</span>
<span class="na">ARRAY[1].P2</span><span class="o">=</span><span class="s">64</span>
</pre></div>
</div>
<p>If the <code class="docutils literal notranslate"><span class="pre">inception_model.ini.tpl</span></code> template file content is:</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[{{SECTION_NAME}}_layer1]</span>
<span class="na">Input</span><span class="o">=</span><span class="s">{{INPUT}}</span>
<span class="na">Type</span><span class="o">=</span><span class="s">Conv</span>
<span class="na">NbOutputs</span><span class="o">=</span><span class="s">{{SIZE}}</span>
<span class="k">[{{SECTION_NAME}}_layer2]</span>
<span class="na">Input</span><span class="o">=</span><span class="s">{{SECTION_NAME}}_layer1</span>
<span class="na">Type</span><span class="o">=</span><span class="s">Fc</span>
<span class="na">NbOutputs</span><span class="o">=</span><span class="s">{{SIZE}}</span>
<span class="na">{% block ARRAY %}</span>
<span class="k">[{{SECTION_NAME}}_array{{#}}]</span>
<span class="na">Prop1</span><span class="o">=</span><span class="s">Config{{.P1}}</span>
<span class="na">Prop2</span><span class="o">=</span><span class="s">{{.P2}}</span>
<span class="na">{% endblock %}</span>
</pre></div>
</div>
<p>The resulting equivalent content for the main INI file will be:</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[inception_layer1]</span>
<span class="na">Input</span><span class="o">=</span><span class="s">layer_x</span>
<span class="na">Type</span><span class="o">=</span><span class="s">Conv</span>
<span class="na">NbOutputs</span><span class="o">=</span><span class="s">32</span>
<span class="k">[inception_layer2]</span>
<span class="na">Input</span><span class="o">=</span><span class="s">inception_layer1</span>
<span class="na">Type</span><span class="o">=</span><span class="s">Fc</span>
<span class="na">NbOutputs</span><span class="o">=</span><span class="s">32</span>
<span class="k">[inception_array0]</span>
<span class="na">Prop1</span><span class="o">=</span><span class="s">ConfigConv</span>
<span class="na">Prop2</span><span class="o">=</span><span class="s">32</span>
<span class="k">[inception_array1]</span>
<span class="na">Prop1</span><span class="o">=</span><span class="s">ConfigPool</span>
<span class="na">Prop2</span><span class="o">=</span><span class="s">64</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">SECTION_NAME</span></code> template parameter is automatically generated from
the name of the including section (before <code class="docutils literal notranslate"><span class="pre">@</span></code>).</p>
<div class="section" id="variable-substitution">
<h3>Variable substitution<a class="headerlink" href="#variable-substitution" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">{{VAR}}</span></code> is replaced by the value of the <code class="docutils literal notranslate"><span class="pre">VAR</span></code> template parameter.</p>
</div>
<div class="section" id="control-statements">
<h3>Control statements<a class="headerlink" href="#control-statements" title="Permalink to this headline">¶</a></h3>
<p>Control statements are between <code class="docutils literal notranslate"><span class="pre">{%</span></code> and <code class="docutils literal notranslate"><span class="pre">%}</span></code> delimiters.</p>
<div class="section" id="block">
<h4>block<a class="headerlink" href="#block" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">block</span> <span class="pre">ARRAY</span> <span class="pre">%}</span></code> … <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">endblock</span> <span class="pre">%}</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">#</span></code> template parameter is automatically generated from the
<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">block</span> <span class="pre">...</span> <span class="pre">%}</span></code> template control statement and corresponds to the
current item position, starting from 0.</p>
</div>
<div class="section" id="for">
<h4>for<a class="headerlink" href="#for" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">for</span> <span class="pre">VAR</span> <span class="pre">in</span> <span class="pre">range([START,</span> <span class="pre">]END])</span> <span class="pre">%}</span></code> … <code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">endfor</span> <span class="pre">%}</span></code></p>
<p>If <code class="docutils literal notranslate"><span class="pre">START</span></code> is not specified, the loop begins at 0 (first value of
<code class="docutils literal notranslate"><span class="pre">VAR</span></code>). The last value of <code class="docutils literal notranslate"><span class="pre">VAR</span></code> is <code class="docutils literal notranslate"><span class="pre">END</span></code>-1.</p>
</div>
<div class="section" id="if">
<h4>if<a class="headerlink" href="#if" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">if</span> <span class="pre">VAR</span> <span class="pre">OP</span> <span class="pre">[VALUE]</span> <span class="pre">%}</span></code> … <code class="docutils literal notranslate"><span class="pre">[{%</span> <span class="pre">else</span> <span class="pre">%}]</span></code> …
<code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">endif</span> <span class="pre">%}</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">OP</span></code> may be <code class="docutils literal notranslate"><span class="pre">==</span></code>, <code class="docutils literal notranslate"><span class="pre">!=</span></code>, <code class="docutils literal notranslate"><span class="pre">exists</span></code> or <code class="docutils literal notranslate"><span class="pre">not_exists</span></code>.</p>
</div>
<div class="section" id="include">
<h4>include<a class="headerlink" href="#include" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">{%</span> <span class="pre">include</span> <span class="pre">FILENAME</span> <span class="pre">%}</span></code></p>
</div>
</div>
</div>
<div class="section" id="global-parameters">
<h2>Global parameters<a class="headerlink" href="#global-parameters" title="Permalink to this headline">¶</a></h2>
<table class="docutils align-default">
<colgroup>
<col style="width: 32%" />
<col style="width: 68%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Option [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">DefaultModel</span></code> [<code class="docutils literal notranslate"><span class="pre">Transcode</span></code>]</p></td>
<td><p>Default layers model. Can be <code class="docutils literal notranslate"><span class="pre">Frame</span></code>, <code class="docutils literal notranslate"><span class="pre">Frame_CUDA</span></code>, <code class="docutils literal notranslate"><span class="pre">Transcode</span></code> or <code class="docutils literal notranslate"><span class="pre">Spike</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">DefaultDataType</span></code> [<code class="docutils literal notranslate"><span class="pre">Float32</span></code>]</p></td>
<td><p>Default layers data type. Can be <code class="docutils literal notranslate"><span class="pre">Float16</span></code>, <code class="docutils literal notranslate"><span class="pre">Float32</span></code> or <code class="docutils literal notranslate"><span class="pre">Float64</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">InsertBatchNormAfterConv</span></code> [0]</p></td>
<td><p>If true (1), batch normalization is automatically inserted after each convolution
when not already present</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="ini_databases.html" class="btn btn-neutral float-right" title="Databases" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="export_legacy.html" class="btn btn-neutral float-left" title="Export: other / legacy" 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>