-
Notifications
You must be signed in to change notification settings - Fork 1
/
tensor.html
415 lines (286 loc) · 16.9 KB
/
tensor.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
<!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>smaug.tensor — SMAUG: Simulating Machine Learning Applications Using gem5-Aladdin</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 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" />
<link rel="next" title="Internal modules" href="internals.html" />
<link rel="prev" title="smaug.math" href="math.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"> SMAUG
</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">Python API and tutorials</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="python_api.html">SMAUG Python APIs</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="smaug.html">smaug</a></li>
<li class="toctree-l2"><a class="reference internal" href="nn.html">smaug.nn</a></li>
<li class="toctree-l2"><a class="reference internal" href="math.html">smaug.math</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">smaug.tensor</a></li>
<li class="toctree-l2"><a class="reference internal" href="internals.html">Internal modules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="python_tutorials.html">Tutorials</a></li>
</ul>
<p class="caption"><span class="caption-text">C++ docs</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpp_docs.html">C++ API and Tutorials</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">SMAUG</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><a href="python_api.html">SMAUG Python APIs</a> »</li>
<li>smaug.tensor</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tensor.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="smaug-tensor">
<h1>smaug.tensor<a class="headerlink" href="#smaug-tensor" title="Permalink to this headline">¶</a></h1>
<dl class="py function">
<dt id="smaug.tensor.reorder">
<code class="sig-prename descclassname">smaug.tensor.</code><code class="sig-name descname">reorder</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_tensor</span></em>, <em class="sig-param"><span class="n">target_layout</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'reorder'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#smaug.tensor.reorder" title="Permalink to this definition">¶</a></dt>
<dd><p>Reorder the data of a given <cite>Tensor</cite> with the target layout.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input_tensor</strong> – A <cite>Tensor</cite>.</p></li>
<li><p><strong>target_layout</strong> – The target layout.</p></li>
<li><p><strong>name</strong> – Operator name (optional).</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A new <cite>Tensor</cite> with the layout as <cite>target_layout</cite>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="smaug.tensor.flatten">
<code class="sig-prename descclassname">smaug.tensor.</code><code class="sig-name descname">flatten</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_tensor</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'flatten'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#smaug.tensor.flatten" title="Permalink to this definition">¶</a></dt>
<dd><p>Flatten the data of a given <cite>Tensor</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input_tensor</strong> – A 4D <cite>Tensor</cite>.</p></li>
<li><p><strong>name</strong> – Operator name (optional).</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A 2D <cite>Tensor</cite> shaped as <cite>NC</cite>.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="smaug.tensor.concat">
<code class="sig-prename descclassname">smaug.tensor.</code><code class="sig-name descname">concat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_tensors</span></em>, <em class="sig-param"><span class="n">axis</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'concat'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#smaug.tensor.concat" title="Permalink to this definition">¶</a></dt>
<dd><p>Concatenate tensors into one.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input_tensors</strong> – Input tensor to be concatenated.</p></li>
<li><p><strong>axis</strong> – The dimension along which to concatenate.</p></li>
<li><p><strong>name</strong> – Name of the operator.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A concatenated tensor.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="smaug.tensor.split">
<code class="sig-prename descclassname">smaug.tensor.</code><code class="sig-name descname">split</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_tensor</span></em>, <em class="sig-param"><span class="n">num_or_size_splits</span></em>, <em class="sig-param"><span class="n">axis</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'split'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#smaug.tensor.split" title="Permalink to this definition">¶</a></dt>
<dd><p>Split a tensor into sub tensors.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input_tensor</strong> – Input tensor.</p></li>
<li><p><strong>num_or_size_splits</strong> – Either an integer indicating the number of splits along
axis or a 1D list containing the sizes of each output tensor along axis.
If an integer, then it must evenly divide input_tensor.shape.dims[axis];
otherwise the sum of sizes along the split axis must match that of the
value.</p></li>
<li><p><strong>axis</strong> – The dimension to split.</p></li>
<li><p><strong>name</strong> – Name of the operator.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of sub tensors.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="smaug.tensor.reshape">
<code class="sig-prename descclassname">smaug.tensor.</code><code class="sig-name descname">reshape</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_tensor</span></em>, <em class="sig-param"><span class="n">shape</span></em>, <em class="sig-param"><span class="n">layout</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'reshape'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#smaug.tensor.reshape" title="Permalink to this definition">¶</a></dt>
<dd><p>Reshape the given tensor in the same order.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input_tensor</strong> – Input tensor.</p></li>
<li><p><strong>shape</strong> – New shape.</p></li>
<li><p><strong>layout</strong> – New layout.</p></li>
<li><p><strong>name</strong> – Name of the operator.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Tensor with the new shape.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="smaug.tensor.expand_dims">
<code class="sig-prename descclassname">smaug.tensor.</code><code class="sig-name descname">expand_dims</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_tensor</span></em>, <em class="sig-param"><span class="n">axis</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'expand_dims'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#smaug.tensor.expand_dims" title="Permalink to this definition">¶</a></dt>
<dd><p>Expand a tensor with an additional dimension.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input_tensor</strong> – Input tensor.</p></li>
<li><p><strong>axis</strong> – Dimension to expand the shape of input tensor.</p></li>
<li><p><strong>name</strong> – Name used for naming the operator.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A tensor with an additional dimension inserted at index axis.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="smaug.tensor.squeeze">
<code class="sig-prename descclassname">smaug.tensor.</code><code class="sig-name descname">squeeze</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_tensor</span></em>, <em class="sig-param"><span class="n">axis</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'squeeze'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#smaug.tensor.squeeze" title="Permalink to this definition">¶</a></dt>
<dd><p>Eliminate a dimension of size 1 from a tensor.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input_tensor</strong> – Input tensor.</p></li>
<li><p><strong>axis</strong> – Dimension to be removed from the input tensor.</p></li>
<li><p><strong>name</strong> – Named used for naming the operator.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A tensor with a dimension removed at index axis.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="smaug.tensor.repeat">
<code class="sig-prename descclassname">smaug.tensor.</code><code class="sig-name descname">repeat</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_tensor</span></em>, <em class="sig-param"><span class="n">multiples</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'repeat'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#smaug.tensor.repeat" title="Permalink to this definition">¶</a></dt>
<dd><p>Construct a tensor by repeating a given tensor.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input_tensor</strong> – Input tensor.</p></li>
<li><p><strong>multiples</strong> – A list that represents the number of multiples in each dimension
of the input tensor.</p></li>
<li><p><strong>name</strong> – Name of the operator.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A repeated version of the input tensor.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="smaug.tensor.stack">
<code class="sig-prename descclassname">smaug.tensor.</code><code class="sig-name descname">stack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_tensor</span></em>, <em class="sig-param"><span class="n">multiple</span></em>, <em class="sig-param"><span class="n">axis</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'stack'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#smaug.tensor.stack" title="Permalink to this definition">¶</a></dt>
<dd><p>Expand and repeat the specified dimension of a tensor.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input_tensor</strong> – Input tensor.</p></li>
<li><p><strong>multiple</strong> – Number of repeats in the expanded dimension.</p></li>
<li><p><strong>axis</strong> – Dimension on which to batch.</p></li>
<li><p><strong>name</strong> – Name used for naming operators.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A tensor with a new dimension.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt id="smaug.tensor.unstack">
<code class="sig-prename descclassname">smaug.tensor.</code><code class="sig-name descname">unstack</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input_tensor</span></em>, <em class="sig-param"><span class="n">axis</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'unstack'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#smaug.tensor.unstack" title="Permalink to this definition">¶</a></dt>
<dd><p>Unpack the specified dimension of a tensor.</p>
<p>The size = 1 dimension gets squeezed out.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>input_tensor</strong> – Input tensor.</p></li>
<li><p><strong>axis</strong> – Dimension on which to unpack.</p></li>
<li><p><strong>name</strong> – Name used for naming operators.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A list of tensors with the given dimension unpacked.</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="internals.html" class="btn btn-neutral float-right" title="Internal modules" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="math.html" class="btn btn-neutral float-left" title="smaug.math" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, SMAUG Contributors
</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>