forked from migueldeicaza/TensorFlowSharp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTensorFlow.TFStatus.html
More file actions
388 lines (356 loc) · 15.3 KB
/
TensorFlow.TFStatus.html
File metadata and controls
388 lines (356 loc) · 15.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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class TFStatus
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class TFStatus
">
<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.TFStatus">
<h1 id="TensorFlow_TFStatus" data-uid="TensorFlow.TFStatus">Class TFStatus
</h1>
<div class="markdown level0 summary"><p>Used to track the result of TensorFlow operations.</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"><a class="xref" href="TensorFlow.TFDisposable.html">TFDisposable</a></div>
<div class="level2"><span class="xref">TFStatus</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="TensorFlow.TFDisposable.html#TensorFlow_TFDisposable_Dispose">TFDisposable.Dispose()</a>
</div>
<div>
<a class="xref" href="TensorFlow.TFDisposable.html#TensorFlow_TFDisposable_Dispose_System_Boolean_">TFDisposable.Dispose(Boolean)</a>
</div>
<div>
<a class="xref" href="TensorFlow.TFDisposable.html#TensorFlow_TFDisposable_Handle">TFDisposable.Handle</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="../TensorFlow.html">TensorFlow</a></h6>
<h6><strong>Assembly</strong>: TensorFlowSharp.dll</h6>
<h5 id="TensorFlow_TFStatus_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class TFStatus : TensorFlow.TFDisposable</code></pre>
</div>
<h5 id="TensorFlow_TFStatus_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>
TFStatus is used to track the status of a call to some TensorFlow
operations. Instances of this object are passed to various
TensorFlow operations and you can use the <a class="xref" href="TensorFlow.TFStatus.html#TensorFlow_TFStatus_Ok">Ok</a>
to quickly check if the operation succeeded, or get more detail from the
<a class="xref" href="TensorFlow.TFStatus.html#TensorFlow_TFStatus_StatusCode">StatusCode</a> and a human-readable text
using the <a class="xref" href="TensorFlow.TFStatus.html#TensorFlow_TFStatus_StatusMessage">StatusMessage</a> property.
</p>
<p>
The convenience <a class="xref" href="TensorFlow.TFStatus.html#TensorFlow_TFStatus_Raise">Raise()</a> can be used
to raise a <a class="xref" href="TensorFlow.TFException.html">TFException</a> if the status of the
operation did not succeed.
</p></div>
<h3 id="constructors">Constructors
</h3>
<a id="TensorFlow_TFStatus__ctor_" data-uid="TensorFlow.TFStatus.#ctor*"></a>
<h4 id="TensorFlow_TFStatus__ctor" data-uid="TensorFlow.TFStatus.#ctor">TFStatus()</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="TensorFlow.TFStatus.html">TFStatus</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TFStatus ();</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<h4 id="TensorFlow_TFStatus_Default" data-uid="TensorFlow.TFStatus.Default">Default</h4>
<div class="markdown level1 summary"><p>Per-thread global status that you can use if you do not need to create a new instance of this object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[System.ThreadStatic]
public static TensorFlow.TFStatus Default;</code></pre>
</div>
<h5 class="fieldValue">Field 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.TFStatus.html">TFStatus</a></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="TensorFlow_TFStatus_Default_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This is provided as a convenience for APIs that take a TFStatus. While the TFStatus is usually an
optional parameter, when it is made optional, API calls that fail raise an exception. Use this
property to pass a TFStatus without having to allocate a new one. The problem with this of course
is that you risk having multiple parts of your code override this thread-global variable.</p>
</div>
<h3 id="properties">Properties
</h3>
<a id="TensorFlow_TFStatus_Error_" data-uid="TensorFlow.TFStatus.Error*"></a>
<h4 id="TensorFlow_TFStatus_Error" data-uid="TensorFlow.TFStatus.Error">Error</h4>
<div class="markdown level1 summary"><p>Gets a value indicating whether this <a class="xref" href="TensorFlow.TFStatus.html">TFStatus</a> state has been set to an error.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Error { 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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if error; otherwise, <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
<a id="TensorFlow_TFStatus_Ok_" data-uid="TensorFlow.TFStatus.Ok*"></a>
<h4 id="TensorFlow_TFStatus_Ok" data-uid="TensorFlow.TFStatus.Ok">Ok</h4>
<div class="markdown level1 summary"><p>Gets a value indicating whether this <a class="xref" href="TensorFlow.TFStatus.html">TFStatus</a> state has been set to ok.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Ok { 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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if ok; otherwise, <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
<a id="TensorFlow_TFStatus_StatusCode_" data-uid="TensorFlow.TFStatus.StatusCode*"></a>
<h4 id="TensorFlow_TFStatus_StatusCode" data-uid="TensorFlow.TFStatus.StatusCode">StatusCode</h4>
<div class="markdown level1 summary"><p>Gets the status code for the status code.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TensorFlow.TFCode StatusCode { 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.TFCode.html">TFCode</a></td>
<td><p>The status code as an enumeration.</p>
</td>
</tr>
</tbody>
</table>
<a id="TensorFlow_TFStatus_StatusMessage_" data-uid="TensorFlow.TFStatus.StatusMessage*"></a>
<h4 id="TensorFlow_TFStatus_StatusMessage" data-uid="TensorFlow.TFStatus.StatusMessage">StatusMessage</h4>
<div class="markdown level1 summary"><p>Gets a human-readable status message.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string StatusMessage { 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><span class="xref">System.String</span></td>
<td><p>The status message.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="TensorFlow_TFStatus_Raise_" data-uid="TensorFlow.TFStatus.Raise*"></a>
<h4 id="TensorFlow_TFStatus_Raise" data-uid="TensorFlow.TFStatus.Raise">Raise()</h4>
<div class="markdown level1 summary"><p>Convenience method that raises an exception if the current status is an error.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Raise ();</code></pre>
</div>
<h5 id="TensorFlow_TFStatus_Raise_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>You can use this method as a convenience to raise an exception after you
invoke an operation if the operation did not succeed.</p>
</div>
<a id="TensorFlow_TFStatus_SetStatusCode_" data-uid="TensorFlow.TFStatus.SetStatusCode*"></a>
<h4 id="TensorFlow_TFStatus_SetStatusCode_TensorFlow_TFCode_System_String_" data-uid="TensorFlow.TFStatus.SetStatusCode(TensorFlow.TFCode,System.String)">SetStatusCode(TFCode, String)</h4>
<div class="markdown level1 summary"><p>Sets the status code on this TFStatus.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void SetStatusCode (TensorFlow.TFCode code, string msg);</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.TFCode.html">TFCode</a></td>
<td><span class="parametername">code</span></td>
<td><p>Code.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">msg</span></td>
<td><p>Message.</p>
</td>
</tr>
</tbody>
</table>
<a id="TensorFlow_TFStatus_ToString_" data-uid="TensorFlow.TFStatus.ToString*"></a>
<h4 id="TensorFlow_TFStatus_ToString" data-uid="TensorFlow.TFStatus.ToString">ToString()</h4>
<div class="markdown level1 summary"><p>Returns a <span class="xref">System.String</span> that represents the current <a class="xref" href="TensorFlow.TFStatus.html">TFStatus</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString ();</code></pre>
</div>
<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><span class="xref">System.String</span></td>
<td><p>A <span class="xref">System.String</span> that represents the current <a class="xref" href="TensorFlow.TFStatus.html">TFStatus</a>.</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>