forked from Xilinx/brevitas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbrevitas.core.html
636 lines (478 loc) · 37.8 KB
/
brevitas.core.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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
<!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>brevitas.core package — Brevitas 0.2.0b1.dev0+gc32fb31.d20210127 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 type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.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"> Brevitas
</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">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">brevitas.core package</a><ul>
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-brevitas.core.restrict_val">brevitas.core.restrict_val module</a></li>
<li><a class="reference internal" href="#module-brevitas.core.utils">brevitas.core.utils module</a></li>
<li><a class="reference internal" href="#module-brevitas.core.zero_point">brevitas.core.zero_point module</a></li>
<li><a class="reference internal" href="#module-brevitas.core">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</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">Brevitas</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>brevitas.core package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/brevitas.core.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="brevitas-core-package">
<h1>brevitas.core package<a class="headerlink" href="#brevitas-core-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="brevitas.core.bit_width.html">brevitas.core.bit_width package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.bit_width.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.bit_width.html#module-brevitas.core.bit_width.const">brevitas.core.bit_width.const module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.bit_width.html#module-brevitas.core.bit_width.parameter">brevitas.core.bit_width.parameter module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.bit_width.html#module-brevitas.core.bit_width">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="brevitas.core.function_wrapper.html">brevitas.core.function_wrapper package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.function_wrapper.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.function_wrapper.html#module-brevitas.core.function_wrapper.clamp">brevitas.core.function_wrapper.clamp module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.function_wrapper.html#module-brevitas.core.function_wrapper.misc">brevitas.core.function_wrapper.misc module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.function_wrapper.html#module-brevitas.core.function_wrapper.ops_ste">brevitas.core.function_wrapper.ops_ste module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.function_wrapper.html#module-brevitas.core.function_wrapper.shape">brevitas.core.function_wrapper.shape module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.function_wrapper.html#module-brevitas.core.function_wrapper">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="brevitas.core.quant.html">brevitas.core.quant package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.quant.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.quant.html#module-brevitas.core.quant.binary">brevitas.core.quant.binary module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.quant.html#module-brevitas.core.quant.delay">brevitas.core.quant.delay module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.quant.html#module-brevitas.core.quant.int">brevitas.core.quant.int module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.quant.html#module-brevitas.core.quant.int_base">brevitas.core.quant.int_base module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.quant.html#module-brevitas.core.quant.ternary">brevitas.core.quant.ternary module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.quant.html#module-brevitas.core.quant">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="brevitas.core.scaling.html">brevitas.core.scaling package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.scaling.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.scaling.html#module-brevitas.core.scaling.int_scaling">brevitas.core.scaling.int_scaling module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.scaling.html#module-brevitas.core.scaling.runtime">brevitas.core.scaling.runtime module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.scaling.html#module-brevitas.core.scaling.standalone">brevitas.core.scaling.standalone module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.scaling.html#module-brevitas.core.scaling">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="brevitas.core.stats.html">brevitas.core.stats package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.stats.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.stats.html#module-brevitas.core.stats.stats_op">brevitas.core.stats.stats_op module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.stats.html#module-brevitas.core.stats.stats_wrapper">brevitas.core.stats.stats_wrapper module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.stats.html#module-brevitas.core.stats.view_wrapper">brevitas.core.stats.view_wrapper module</a></li>
<li class="toctree-l2"><a class="reference internal" href="brevitas.core.stats.html#module-brevitas.core.stats">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-brevitas.core.restrict_val">
<span id="brevitas-core-restrict-val-module"></span><h2>brevitas.core.restrict_val module<a class="headerlink" href="#module-brevitas.core.restrict_val" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="brevitas.core.restrict_val.FloatRestrictValue">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.restrict_val.</code><code class="sig-name descname">FloatRestrictValue</code><a class="headerlink" href="#brevitas.core.restrict_val.FloatRestrictValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.modules.module.Module</span></code></p>
<dl class="py method">
<dt id="brevitas.core.restrict_val.FloatRestrictValue.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.FloatRestrictValue.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the computation performed at every call.</p>
<p>Should be overridden by all subclasses.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although the recipe for forward pass needs to be defined within
this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
instead of this since the former takes care of running the
registered hooks while the latter silently ignores them.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.FloatRestrictValue.restrict_init_float">
<code class="sig-name descname">restrict_init_float</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.FloatRestrictValue.restrict_init_float" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.FloatRestrictValue.restrict_init_inplace_module">
<code class="sig-name descname">restrict_init_inplace_module</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.FloatRestrictValue.restrict_init_inplace_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.FloatRestrictValue.restrict_init_module">
<code class="sig-name descname">restrict_init_module</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.FloatRestrictValue.restrict_init_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.FloatRestrictValue.restrict_init_tensor">
<code class="sig-name descname">restrict_init_tensor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.FloatRestrictValue.restrict_init_tensor" title="Permalink to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="brevitas.core.restrict_val.FloatRestrictValue.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.restrict_val.FloatRestrictValue.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="brevitas.core.restrict_val.IntRestrictValue">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.restrict_val.</code><code class="sig-name descname">IntRestrictValue</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">restrict_value_float_to_int_impl</span><span class="o">=</span><span class="default_value">RoundSte()</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.IntRestrictValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.modules.module.Module</span></code></p>
<dl class="py method">
<dt id="brevitas.core.restrict_val.IntRestrictValue.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.IntRestrictValue.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the computation performed at every call.</p>
<p>Should be overridden by all subclasses.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although the recipe for forward pass needs to be defined within
this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
instead of this since the former takes care of running the
registered hooks while the latter silently ignores them.</p>
</div>
</dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.IntRestrictValue.restrict_init_float">
<code class="sig-name descname">restrict_init_float</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.IntRestrictValue.restrict_init_float" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.IntRestrictValue.restrict_init_inplace_module">
<code class="sig-name descname">restrict_init_inplace_module</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.IntRestrictValue.restrict_init_inplace_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.IntRestrictValue.restrict_init_module">
<code class="sig-name descname">restrict_init_module</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.IntRestrictValue.restrict_init_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.IntRestrictValue.restrict_init_tensor">
<code class="sig-name descname">restrict_init_tensor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.IntRestrictValue.restrict_init_tensor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="brevitas.core.restrict_val.IntRestrictValue.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.restrict_val.IntRestrictValue.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="brevitas.core.restrict_val.LogFloatRestrictValue">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.restrict_val.</code><code class="sig-name descname">LogFloatRestrictValue</code><a class="headerlink" href="#brevitas.core.restrict_val.LogFloatRestrictValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.modules.module.Module</span></code></p>
<dl class="py method">
<dt id="brevitas.core.restrict_val.LogFloatRestrictValue.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.LogFloatRestrictValue.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the computation performed at every call.</p>
<p>Should be overridden by all subclasses.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although the recipe for forward pass needs to be defined within
this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
instead of this since the former takes care of running the
registered hooks while the latter silently ignores them.</p>
</div>
</dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.LogFloatRestrictValue.restrict_init_float">
<code class="sig-name descname">restrict_init_float</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.LogFloatRestrictValue.restrict_init_float" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.LogFloatRestrictValue.restrict_init_inplace_module">
<code class="sig-name descname">restrict_init_inplace_module</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.LogFloatRestrictValue.restrict_init_inplace_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.LogFloatRestrictValue.restrict_init_module">
<code class="sig-name descname">restrict_init_module</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.LogFloatRestrictValue.restrict_init_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.LogFloatRestrictValue.restrict_init_tensor">
<code class="sig-name descname">restrict_init_tensor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.LogFloatRestrictValue.restrict_init_tensor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="brevitas.core.restrict_val.LogFloatRestrictValue.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.restrict_val.LogFloatRestrictValue.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="brevitas.core.restrict_val.PowerOfTwoRestrictValue">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.restrict_val.</code><code class="sig-name descname">PowerOfTwoRestrictValue</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">restrict_value_float_to_int_impl</span><span class="o">=</span><span class="default_value">RoundSte()</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.PowerOfTwoRestrictValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.modules.module.Module</span></code></p>
<dl class="py method">
<dt id="brevitas.core.restrict_val.PowerOfTwoRestrictValue.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.PowerOfTwoRestrictValue.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the computation performed at every call.</p>
<p>Should be overridden by all subclasses.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although the recipe for forward pass needs to be defined within
this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
instead of this since the former takes care of running the
registered hooks while the latter silently ignores them.</p>
</div>
</dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.PowerOfTwoRestrictValue.restrict_init_float">
<code class="sig-name descname">restrict_init_float</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.PowerOfTwoRestrictValue.restrict_init_float" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.PowerOfTwoRestrictValue.restrict_init_inplace_module">
<code class="sig-name descname">restrict_init_inplace_module</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.PowerOfTwoRestrictValue.restrict_init_inplace_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.PowerOfTwoRestrictValue.restrict_init_module">
<code class="sig-name descname">restrict_init_module</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.PowerOfTwoRestrictValue.restrict_init_module" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="brevitas.core.restrict_val.PowerOfTwoRestrictValue.restrict_init_tensor">
<code class="sig-name descname">restrict_init_tensor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.restrict_val.PowerOfTwoRestrictValue.restrict_init_tensor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="brevitas.core.restrict_val.PowerOfTwoRestrictValue.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.restrict_val.PowerOfTwoRestrictValue.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-brevitas.core.utils">
<span id="brevitas-core-utils-module"></span><h2>brevitas.core.utils module<a class="headerlink" href="#module-brevitas.core.utils" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="brevitas.core.utils.StatelessBuffer">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.utils.</code><code class="sig-name descname">StatelessBuffer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.utils.StatelessBuffer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.modules.module.Module</span></code></p>
<dl class="py method">
<dt id="brevitas.core.utils.StatelessBuffer.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.utils.StatelessBuffer.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the computation performed at every call.</p>
<p>Should be overridden by all subclasses.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although the recipe for forward pass needs to be defined within
this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
instead of this since the former takes care of running the
registered hooks while the latter silently ignores them.</p>
</div>
</dd></dl>
<dl class="py method">
<dt id="brevitas.core.utils.StatelessBuffer.state_dict">
<code class="sig-name descname">state_dict</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">destination</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">prefix</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">keep_vars</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.utils.StatelessBuffer.state_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a dictionary containing a whole state of the module.</p>
<p>Both parameters and persistent buffers (e.g. running averages) are
included. Keys are corresponding parameter and buffer names.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>a dictionary containing a whole state of the module</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">module</span><span class="o">.</span><span class="n">state_dict</span><span class="p">()</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
<span class="go">['bias', 'weight']</span>
</pre></div>
</div>
</dd></dl>
<dl class="py attribute">
<dt id="brevitas.core.utils.StatelessBuffer.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.utils.StatelessBuffer.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-brevitas.core.zero_point">
<span id="brevitas-core-zero-point-module"></span><h2>brevitas.core.zero_point module<a class="headerlink" href="#module-brevitas.core.zero_point" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="brevitas.core.zero_point.MinUintZeroPoint">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.zero_point.</code><code class="sig-name descname">MinUintZeroPoint</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">float_to_int_impl</span></em>, <em class="sig-param"><span class="n">stats_reduce_dim</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.zero_point.MinUintZeroPoint" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.modules.module.Module</span></code></p>
<dl class="py method">
<dt id="brevitas.core.zero_point.MinUintZeroPoint.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">scale</span></em>, <em class="sig-param"><span class="n">min_int</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.zero_point.MinUintZeroPoint.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the computation performed at every call.</p>
<p>Should be overridden by all subclasses.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although the recipe for forward pass needs to be defined within
this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
instead of this since the former takes care of running the
registered hooks while the latter silently ignores them.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="brevitas.core.zero_point.MinUintZeroPoint.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.zero_point.MinUintZeroPoint.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="brevitas.core.zero_point.ParameterFromRuntimeMinZeroPoint">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.zero_point.</code><code class="sig-name descname">ParameterFromRuntimeMinZeroPoint</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">collect_stats_steps</span></em>, <em class="sig-param"><span class="n">float_to_int_impl</span></em>, <em class="sig-param"><span class="n">stats_reduce_dim</span></em>, <em class="sig-param"><span class="n">zero_point_shape</span></em>, <em class="sig-param"><span class="n">zero_point_stats_input_view_shape_impl</span></em>, <em class="sig-param"><span class="n">zero_point_stats_permute_dims</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">zero_point_stats_momentum</span><span class="o">=</span><span class="default_value">0.1</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.zero_point.ParameterFromRuntimeMinZeroPoint" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.modules.module.Module</span></code></p>
<dl class="py method">
<dt id="brevitas.core.zero_point.ParameterFromRuntimeMinZeroPoint.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">scale</span></em>, <em class="sig-param"><span class="n">min_int</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.zero_point.ParameterFromRuntimeMinZeroPoint.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the computation performed at every call.</p>
<p>Should be overridden by all subclasses.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although the recipe for forward pass needs to be defined within
this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
instead of this since the former takes care of running the
registered hooks while the latter silently ignores them.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="brevitas.core.zero_point.ParameterFromRuntimeMinZeroPoint.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.zero_point.ParameterFromRuntimeMinZeroPoint.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="brevitas.core.zero_point.ParameterZeroPoint">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.zero_point.</code><code class="sig-name descname">ParameterZeroPoint</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">zero_point_init</span></em>, <em class="sig-param"><span class="n">float_to_int_impl</span><span class="o">=</span><span class="default_value">RoundSte()</span></em>, <em class="sig-param"><span class="n">zero_point_shape</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.zero_point.ParameterZeroPoint" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.modules.module.Module</span></code></p>
<dl class="py method">
<dt id="brevitas.core.zero_point.ParameterZeroPoint.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">scale</span></em>, <em class="sig-param"><span class="n">min_int</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.zero_point.ParameterZeroPoint.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the computation performed at every call.</p>
<p>Should be overridden by all subclasses.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although the recipe for forward pass needs to be defined within
this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
instead of this since the former takes care of running the
registered hooks while the latter silently ignores them.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="brevitas.core.zero_point.ParameterZeroPoint.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.zero_point.ParameterZeroPoint.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="brevitas.core.zero_point.ZeroZeroPoint">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.zero_point.</code><code class="sig-name descname">ZeroZeroPoint</code><a class="headerlink" href="#brevitas.core.zero_point.ZeroZeroPoint" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">torch.nn.modules.module.Module</span></code></p>
<dl class="py method">
<dt id="brevitas.core.zero_point.ZeroZeroPoint.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em>, <em class="sig-param"><span class="n">scale</span></em>, <em class="sig-param"><span class="n">min_int</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.zero_point.ZeroZeroPoint.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the computation performed at every call.</p>
<p>Should be overridden by all subclasses.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Although the recipe for forward pass needs to be defined within
this function, one should call the <code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code> instance afterwards
instead of this since the former takes care of running the
registered hooks while the latter silently ignores them.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Tensor</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="brevitas.core.zero_point.ZeroZeroPoint.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.zero_point.ZeroZeroPoint.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-brevitas.core">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-brevitas.core" title="Permalink to this headline">¶</a></h2>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2021 - Xilinx, Inc.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/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>