forked from migueldeicaza/TensorFlowSharp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTensorFlow.QueueBase.html
More file actions
364 lines (340 loc) · 14.3 KB
/
TensorFlow.QueueBase.html
File metadata and controls
364 lines (340 loc) · 14.3 KB
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
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class QueueBase
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class QueueBase
">
<meta name="generator" content="docfx 2.18.2.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="TensorFlow.QueueBase">
<h1 id="TensorFlow_QueueBase" data-uid="TensorFlow.QueueBase">Class QueueBase
</h1>
<div class="markdown level0 summary"><p>Base class for queue implementations.
Port of Python implementation <a href="https://github.com/tensorflow/tensorflow/blob/r1.3/tensorflow/python/ops/data_flow_ops.py">https://github.com/tensorflow/tensorflow/blob/r1.3/tensorflow/python/ops/data_flow_ops.py</a></p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">QueueBase</span></div>
</div>
<div class="level2"><a class="xref" href="TensorFlow.PaddingFIFOQueue.html">PaddingFIFOQueue</a></div>
<h6><strong>Namespace</strong>: <a class="xref" href="../TensorFlow.html">TensorFlow</a></h6>
<h6><strong>Assembly</strong>: TensorFlowSharp.dll</h6>
<h5 id="TensorFlow_QueueBase_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class QueueBase</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="TensorFlow_QueueBase__ctor_" data-uid="TensorFlow.QueueBase.#ctor*"></a>
<h4 id="TensorFlow_QueueBase__ctor_TensorFlow_TFSession_" data-uid="TensorFlow.QueueBase.#ctor(TensorFlow.TFSession)">QueueBase(TFSession)</h4>
<div class="markdown level1 summary"><p>A queue is a TensorFlow data structure that stores tensors across
multiple steps, and exposes operations that enqueue and dequeue
tensors.
Each queue element is a tuple of one or more tensors, where each
tuple component has a static dtype, and may have a static shape.The
queue implementations support versions of enqueue and dequeue that
handle single elements, versions that support enqueuing and
dequeuing a batch of elements at once.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public QueueBase (TensorFlow.TFSession session);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="TensorFlow.TFSession.html">TFSession</a></td>
<td><span class="parametername">session</span></td>
<td><p>Session instance</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="TensorFlow_QueueBase_Session_" data-uid="TensorFlow.QueueBase.Session*"></a>
<h4 id="TensorFlow_QueueBase_Session" data-uid="TensorFlow.QueueBase.Session">Session</h4>
<div class="markdown level1 summary"><p>The session that this QueueBased was created for.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected TensorFlow.TFSession Session { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="TensorFlow.TFSession.html">TFSession</a></td>
<td><p>The session.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="TensorFlow_QueueBase_Dequeue_" data-uid="TensorFlow.QueueBase.Dequeue*"></a>
<h4 id="TensorFlow_QueueBase_Dequeue_System_Nullable_System_Int64__System_String_" data-uid="TensorFlow.QueueBase.Dequeue(System.Nullable{System.Int64},System.String)">Dequeue(Nullable<Int64>, String)</h4>
<div class="markdown level1 summary"><p>Dequeues a tuple of one or more tensors from this queue.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract TensorFlow.TFOutput[] Dequeue (Nullable<long> timeout_ms = null, string operationName = null);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int64</span>></td>
<td><span class="parametername">timeout_ms</span></td>
<td><p>Optional argument
If the queue is empty, this operation will block for up to
timeout_ms milliseconds.
Note: This option is not supported yet.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">operationName</span></td>
<td><p>If specified, the created operation in the graph will be this one, otherwise it will be named 'QueueDequeueV2'.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="TensorFlow.TFOutput.html">TFOutput</a>[]</td>
<td><p>One or more tensors that were dequeued as a tuple.
The TFOperation can be fetched from the resulting TFOutput, by fethching the Operation property from the result.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="TensorFlow_QueueBase_Dequeue_System_Nullable_System_Int64__System_String__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This operation has k outputs, where k is the number of components
in the tuples stored in the given queue, and output i is the ith
component of the dequeued tuple.</p>
</div>
<a id="TensorFlow_QueueBase_Enqueue_" data-uid="TensorFlow.QueueBase.Enqueue*"></a>
<h4 id="TensorFlow_QueueBase_Enqueue_TensorFlow_TFOutput___System_Nullable_System_Int64__System_String_" data-uid="TensorFlow.QueueBase.Enqueue(TensorFlow.TFOutput[],System.Nullable{System.Int64},System.String)">Enqueue(TFOutput[], Nullable<Int64>, String)</h4>
<div class="markdown level1 summary"><p>Enqueues a tuple of one or more tensors in this queue.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract TensorFlow.TFOperation Enqueue (TensorFlow.TFOutput[] components, Nullable<long> timeout_ms = null, string operationName = null);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="TensorFlow.TFOutput.html">TFOutput</a>[]</td>
<td><span class="parametername">components</span></td>
<td><p>One or more tensors from which the enqueued tensors should be taken.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int64</span>></td>
<td><span class="parametername">timeout_ms</span></td>
<td><p>Optional argument
If the queue is full, this operation will block for up to
timeout_ms milliseconds.
Note: This option is not supported yet.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">operationName</span></td>
<td><p>If specified, the created operation in the graph will be this one, otherwise it will be named 'QueueEnqueueV2'.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="TensorFlow.TFOperation.html">TFOperation</a></td>
<td><p>Returns the description of the operation</p>
</td>
</tr>
</tbody>
</table>
<h5 id="TensorFlow_QueueBase_Enqueue_TensorFlow_TFOutput___System_Nullable_System_Int64__System_String__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>The components input has k elements, which correspond to the components of
tuples stored in the given queue.</p>
</div>
<a id="TensorFlow_QueueBase_GetSize_" data-uid="TensorFlow.QueueBase.GetSize*"></a>
<h4 id="TensorFlow_QueueBase_GetSize_System_String_" data-uid="TensorFlow.QueueBase.GetSize(System.String)">GetSize(String)</h4>
<div class="markdown level1 summary"><p>Gets the size of this queue.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract TensorFlow.TFOutput GetSize (string operationName = null);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">operationName</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="TensorFlow.TFOutput.html">TFOutput</a></td>
<td><p>queue size</p>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>