forked from Xilinx/brevitas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbrevitas.graph.tracer.backport.html
281 lines (163 loc) · 10.3 KB
/
brevitas.graph.tracer.backport.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
<!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.graph.tracer.backport 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.graph.tracer.backport package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-brevitas.graph.tracer.backport.signatures">brevitas.graph.tracer.backport.signatures module</a></li>
<li><a class="reference internal" href="#module-brevitas.graph.tracer.backport">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.graph.tracer.backport package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/brevitas.graph.tracer.backport.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-graph-tracer-backport-package">
<h1>brevitas.graph.tracer.backport package<a class="headerlink" href="#brevitas-graph-tracer-backport-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.graph.tracer.backport.signatures">
<span id="brevitas-graph-tracer-backport-signatures-module"></span><h2>brevitas.graph.tracer.backport.signatures module<a class="headerlink" href="#module-brevitas.graph.tracer.backport.signatures" title="Permalink to this headline">¶</a></h2>
<p>Python implementation of __torch_function__</p>
<p>While most of the torch API and handling for __torch_function__ happens
at the C++ level, some of the torch API is written in Python so we need
python-level handling for __torch_function__ overrides as well. The main
developer-facing functionality in this file are handle_torch_function and
has_torch_function. See torch/functional.py and test/test_overrides.py
for usage examples.</p>
<p>NOTE: heavily inspired by NumPy’s <code class="docutils literal notranslate"><span class="pre">__array_function__</span></code> (see:
<a class="reference external" href="https://github.com/pytorch/pytorch/issues/24015">https://github.com/pytorch/pytorch/issues/24015</a> and
<a class="reference external" href="https://www.numpy.org/neps/nep-0018-array-function-protocol.html">https://www.numpy.org/neps/nep-0018-array-function-protocol.html</a>
)</p>
<p>If changing this file in a way that can affect <code class="docutils literal notranslate"><span class="pre">__torch_function__</span></code> overhead,
please report the benchmarks in <code class="docutils literal notranslate"><span class="pre">benchmarks/overrides_benchmark</span></code>. See the
instructions in the <code class="docutils literal notranslate"><span class="pre">README.md</span></code> in that directory.</p>
<dl class="py function">
<dt id="brevitas.graph.tracer.backport.signatures.get_nn_functional_overrides">
<code class="sig-prename descclassname">brevitas.graph.tracer.backport.signatures.</code><code class="sig-name descname">get_nn_functional_overrides</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.graph.tracer.backport.signatures.get_nn_functional_overrides" 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">Dict</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="brevitas.graph.tracer.backport.signatures.get_tensor_overrides">
<code class="sig-prename descclassname">brevitas.graph.tracer.backport.signatures.</code><code class="sig-name descname">get_tensor_overrides</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.graph.tracer.backport.signatures.get_tensor_overrides" 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">Dict</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="brevitas.graph.tracer.backport.signatures.get_testing_overrides">
<code class="sig-prename descclassname">brevitas.graph.tracer.backport.signatures.</code><code class="sig-name descname">get_testing_overrides</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.graph.tracer.backport.signatures.get_testing_overrides" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dict containing dummy overrides for all overridable functions</p>
<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">Dict</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code>]</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><em>A dictionary that maps overridable functions in the PyTorch API to</em></p></li>
<li><p><em>lambda functions that have the same signature as the real function</em></p></li>
<li><p><em>and unconditionally return -1. These lambda functions are useful</em></p></li>
<li><p><em>for testing API coverage for a type that defines __torch_function__.</em></p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="brevitas.graph.tracer.backport.signatures.get_torch_overrides">
<code class="sig-prename descclassname">brevitas.graph.tracer.backport.signatures.</code><code class="sig-name descname">get_torch_overrides</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#brevitas.graph.tracer.backport.signatures.get_torch_overrides" 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">Dict</span></code>[<code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code>, <code class="xref py py-data docutils literal notranslate"><span class="pre">Callable</span></code>]</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-brevitas.graph.tracer.backport">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-brevitas.graph.tracer.backport" 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>