forked from Xilinx/brevitas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbrevitas.core.bit_width.html
397 lines (271 loc) · 17.4 KB
/
brevitas.core.bit_width.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
<!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.bit_width 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.bit_width package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-brevitas.core.bit_width.const">brevitas.core.bit_width.const module</a></li>
<li><a class="reference internal" href="#module-brevitas.core.bit_width.parameter">brevitas.core.bit_width.parameter module</a></li>
<li><a class="reference internal" href="#module-brevitas.core.bit_width">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.bit_width package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/brevitas.core.bit_width.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-bit-width-package">
<h1>brevitas.core.bit_width package<a class="headerlink" href="#brevitas-core-bit-width-package" title="Permalink to this headline">¶</a></h1>
<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.bit_width.const">
<span id="brevitas-core-bit-width-const-module"></span><h2>brevitas.core.bit_width.const module<a class="headerlink" href="#module-brevitas.core.bit_width.const" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="brevitas.core.bit_width.const.BitWidthConst">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.bit_width.const.</code><code class="sig-name descname">BitWidthConst</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bit_width</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.bit_width.const.BitWidthConst" 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>
<p>ScriptModule that returns a constant bit-width wrapped in a float torch.tensor.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>bit_width</strong> (<em>int</em>) – bit-width value.</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">bit_width</span> <span class="o">=</span> <span class="n">BitWidthConst</span><span class="p">(</span><span class="mi">8</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">bit_width</span><span class="p">()</span>
<span class="go">tensor(8.)</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The bit-width is not part of the Module’s state, meaning that it won’t be saved as part of
a checkpoint.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Maps to bit_width_impl_type == BitWidthImplType.CONST == ‘CONST’ == ‘const’ in higher-level APIs.</p>
</div>
<dl class="py method">
<dt id="brevitas.core.bit_width.const.BitWidthConst.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.bit_width.const.BitWidthConst.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.bit_width.const.BitWidthConst.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.bit_width.const.BitWidthConst.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="brevitas.core.bit_width.const.MsbClampBitWidth">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.bit_width.const.</code><code class="sig-name descname">MsbClampBitWidth</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bit_width_to_remove_impl</span></em>, <em class="sig-param"><span class="n">min_overall_bit_width</span></em>, <em class="sig-param"><span class="n">max_overall_bit_width</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.bit_width.const.MsbClampBitWidth" 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.bit_width.const.MsbClampBitWidth.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_bit_width</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.bit_width.const.MsbClampBitWidth.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.bit_width.const.MsbClampBitWidth.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.bit_width.const.MsbClampBitWidth.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-brevitas.core.bit_width.parameter">
<span id="brevitas-core-bit-width-parameter-module"></span><h2>brevitas.core.bit_width.parameter module<a class="headerlink" href="#module-brevitas.core.bit_width.parameter" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="brevitas.core.bit_width.parameter.BitWidthParameter">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.bit_width.parameter.</code><code class="sig-name descname">BitWidthParameter</code><span class="sig-paren">(</span><em class="sig-param">bit_width</em>, <em class="sig-param">min_bit_width=2</em>, <em class="sig-param">restrict_bit_width_impl=IntRestrictValue( (float_to_int_impl): RoundSte() )</em>, <em class="sig-param">override_pretrained_bit_width=False</em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.bit_width.parameter.BitWidthParameter" 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>
<p>ScriptModule that returns a learnable bit-width wrapped in a float torch.Tensor.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bit_width</strong> (<em>int</em>) – value to initialize the output learned bit-width.</p></li>
<li><p><strong>min_bit_width</strong> (<em>int</em>) – lower bound for the output learned bit-width. Default: 2.</p></li>
<li><p><strong>restrict_bit_width_impl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Module</span></code>) – restrict the learned bit-width to a subset of values. Default: IntRestrictValue(RoundSte()).</p></li>
<li><p><strong>override_pretrained_bit_width</strong> (<em>bool</em>) – ignore pretrained bit-width loaded from a state dict. Default: False.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>bit-width wrapped in a float torch.tensor and backend by a learnable torch.nn.Parameter.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>Tensor</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>RuntimeError</strong> – if bit_width < min_bit_width.</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">bit_width_parameter</span> <span class="o">=</span> <span class="n">BitWidthParameter</span><span class="p">(</span><span class="mi">8</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">bit_width_parameter</span><span class="p">()</span>
<span class="go">tensor(8., grad_fn=<RoundSteFnBackward>)</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Set env variable BREVITAS_IGNORE_MISSING_KEYS=1 to avoid errors when retraining
from a floating point state dict.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Maps to bit_width_impl_type == BitWidthImplType.PARAMETER == ‘PARAMETER’ == ‘parameter’ in higher-level APIs.</p>
</div>
<dl class="py method">
<dt id="brevitas.core.bit_width.parameter.BitWidthParameter.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.bit_width.parameter.BitWidthParameter.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.bit_width.parameter.BitWidthParameter.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.bit_width.parameter.BitWidthParameter.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="brevitas.core.bit_width.parameter.RemoveBitwidthParameter">
<em class="property">class </em><code class="sig-prename descclassname">brevitas.core.bit_width.parameter.</code><code class="sig-name descname">RemoveBitwidthParameter</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">bit_width_to_remove</span></em>, <em class="sig-param"><span class="n">override_pretrained_bit_width</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">non_zero_epsilon</span><span class="o">=</span><span class="default_value">1e-06</span></em>, <em class="sig-param"><span class="n">remove_zero_bit_width</span><span class="o">=</span><span class="default_value">0.1</span></em><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.bit_width.parameter.RemoveBitwidthParameter" 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.bit_width.parameter.RemoveBitwidthParameter.forward">
<code class="sig-name descname">forward</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.core.bit_width.parameter.RemoveBitwidthParameter.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.bit_width.parameter.RemoveBitwidthParameter.training">
<code class="sig-name descname">training</code><em class="property">: bool</em><a class="headerlink" href="#brevitas.core.bit_width.parameter.RemoveBitwidthParameter.training" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-brevitas.core.bit_width">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-brevitas.core.bit_width" 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>