Skip to content

Commit 6055d79

Browse files
migueldeicazamigueldeicaza
committed
Updated github docs
1 parent 583318e commit 6055d79

22 files changed

+276
-146
lines changed

‎docs/TensorFlow/TFDataType.html‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ <h2 class="Section">Members</h2>
299299
<b>BFloat16</b>
300300
</td>
301301
<td>
302-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
302+
Float32 truncated to 16 bits. Only for cast operations.
303303
</td>
304304
</tr>
305305
<tr valign="top">
@@ -315,39 +315,39 @@ <h2 class="Section">Members</h2>
315315
<b>Complex</b>
316316
</td>
317317
<td>
318-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
318+
32-bit float based complex numbers
319319
</td>
320320
</tr>
321321
<tr valign="top">
322322
<td id="F:TensorFlow.TFDataType.Complex128">
323323
<b>Complex128</b>
324324
</td>
325325
<td>
326-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
326+
Double precission complex numbers (32-bit floats)
327327
</td>
328328
</tr>
329329
<tr valign="top">
330330
<td id="F:TensorFlow.TFDataType.Complex64">
331331
<b>Complex64</b>
332332
</td>
333333
<td>
334-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
334+
Single precission complex numbers (32-bit floats)
335335
</td>
336336
</tr>
337337
<tr valign="top">
338338
<td id="F:TensorFlow.TFDataType.Double">
339339
<b>Double</b>
340340
</td>
341341
<td>
342-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
342+
Double precission floatint point, 64-bits (C# double)
343343
</td>
344344
</tr>
345345
<tr valign="top">
346346
<td id="F:TensorFlow.TFDataType.Float">
347347
<b>Float</b>
348348
</td>
349349
<td>
350-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
350+
Single precission floatint point, 32-bits (C# float)
351351
</td>
352352
</tr>
353353
<tr valign="top">
@@ -363,71 +363,71 @@ <h2 class="Section">Members</h2>
363363
<b>Int16</b>
364364
</td>
365365
<td>
366-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
366+
16-bit signed integers (C# short)
367367
</td>
368368
</tr>
369369
<tr valign="top">
370370
<td id="F:TensorFlow.TFDataType.Int32">
371371
<b>Int32</b>
372372
</td>
373373
<td>
374-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
374+
32-bit signed integers (C# int)
375375
</td>
376376
</tr>
377377
<tr valign="top">
378378
<td id="F:TensorFlow.TFDataType.Int64">
379379
<b>Int64</b>
380380
</td>
381381
<td>
382-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
382+
64-bit signed integers (C# long)
383383
</td>
384384
</tr>
385385
<tr valign="top">
386386
<td id="F:TensorFlow.TFDataType.Int8">
387387
<b>Int8</b>
388388
</td>
389389
<td>
390-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
390+
8-bit signed integers (C# sbyte)
391391
</td>
392392
</tr>
393393
<tr valign="top">
394394
<td id="F:TensorFlow.TFDataType.QInt16">
395395
<b>QInt16</b>
396396
</td>
397397
<td>
398-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
398+
Quantized 16-bit signed integer
399399
</td>
400400
</tr>
401401
<tr valign="top">
402402
<td id="F:TensorFlow.TFDataType.QInt32">
403403
<b>QInt32</b>
404404
</td>
405405
<td>
406-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
406+
Quantized 32-bit signed integer
407407
</td>
408408
</tr>
409409
<tr valign="top">
410410
<td id="F:TensorFlow.TFDataType.QInt8">
411411
<b>QInt8</b>
412412
</td>
413413
<td>
414-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
414+
Quantized 8-bit signed integer
415415
</td>
416416
</tr>
417417
<tr valign="top">
418418
<td id="F:TensorFlow.TFDataType.QUInt16">
419419
<b>QUInt16</b>
420420
</td>
421421
<td>
422-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
422+
Quantized 16-bit unsigned integer
423423
</td>
424424
</tr>
425425
<tr valign="top">
426426
<td id="F:TensorFlow.TFDataType.QUInt8">
427427
<b>QUInt8</b>
428428
</td>
429429
<td>
430-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
430+
Quantized 8-bit unsigned integer
431431
</td>
432432
</tr>
433433
<tr valign="top">
@@ -443,23 +443,23 @@ <h2 class="Section">Members</h2>
443443
<b>String</b>
444444
</td>
445445
<td>
446-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
446+
Binary blob
447447
</td>
448448
</tr>
449449
<tr valign="top">
450450
<td id="F:TensorFlow.TFDataType.UInt16">
451451
<b>UInt16</b>
452452
</td>
453453
<td>
454-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
454+
16-bit unsigned integers (C# long)
455455
</td>
456456
</tr>
457457
<tr valign="top">
458458
<td id="F:TensorFlow.TFDataType.UInt8">
459459
<b>UInt8</b>
460460
</td>
461461
<td>
462-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
462+
8 bit unsigned integers (C# byte)
463463
</td>
464464
</tr>
465465
</table>

‎docs/TensorFlow/TFException.html‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -311,8 +311,8 @@ <h2 class="Section">Public Constructors</h2>
311311
</b>(<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a>)</div>
312312
</td>
313313
<td>
314-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
315-
</td>
314+
Initializes a new instance of the <a href="../TensorFlow/TFException.html">TensorFlow.TFException</a> class with a message.
315+
</td>
316316
</tr>
317317
</table>
318318
</div>
@@ -325,8 +325,8 @@ <h2 class="Section" id="MemberDetails">Member Details</h2>
325325
<h3 id="C:TensorFlow.TFException(System.String)">TFException Constructor</h3>
326326
<blockquote id="C:TensorFlow.TFException(System.String):member">
327327
<div class="msummary">
328-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
329-
</div>
328+
Initializes a new instance of the <a href="../TensorFlow/TFException.html">TensorFlow.TFException</a> class with a message.
329+
</div>
330330
<h2>Syntax</h2>
331331
<div class="Signature">public <b>TFException</b> (<a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.String">string</a> message)</div>
332332
<h4 class="Subsection">Parameters</h4>
@@ -335,9 +335,7 @@ <h4 class="Subsection">Parameters</h4>
335335
<dt>
336336
<i>message</i>
337337
</dt>
338-
<dd>
339-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
340-
</dd>
338+
<dd>Message.</dd>
341339
</dl>
342340
</blockquote>
343341
<h2 class="Section">Remarks</h2>

‎docs/TensorFlow/TFImportGraphDefOptions.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,7 @@ <h4 class="Subsection">Parameters</h4>
603603
<h2 class="Section">Remarks</h2>
604604
<div class="SectionBox" id="M:TensorFlow.TFImportGraphDefOptions.RemapControlDependency(System.String,TensorFlow.TFOperation):Remarks">
605605
Set any imported nodes with control input <i>srcName</i> to have that input
606-
replaced with <i>dst</i>.
606+
replaced with <i>destination</i>.
607607
</div>
608608
<h2 class="Section">Requirements</h2>
609609
<div class="SectionBox" id="M:TensorFlow.TFImportGraphDefOptions.RemapControlDependency(System.String,TensorFlow.TFOperation):Version Information">

‎docs/TensorFlow/TFOperationDesc.html‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,8 @@ <h2 class="Section">Remarks</h2>
293293
nodes.
294294

295295
You create instances bound to a graph, add inputs, attributes and so on, and when you are done
296-
you can call the FinishOperation method that will turn this TFOperationDesc into a <a href="../TensorFlow/TFOperation.html">TensorFlow.TFOperation</a>.
296+
you can call the <a href="../TensorFlow/TFOperationDesc.html#M:TensorFlow.TFOperationDesc.FinishOperation(TensorFlow.TFStatus)">TFOperationDesc.FinishOperation(TFStatus)</a> method that will turn this TFOperationDesc
297+
into a <a href="../TensorFlow/TFOperation.html">TensorFlow.TFOperation</a>.
297298
</div>
298299
<h2 class="Section">Requirements</h2>
299300
<div class="SectionBox" id="T:TensorFlow.TFOperationDesc:Docs:Version Information">
@@ -439,7 +440,9 @@ <h2 class="Section">Public Methods</h2>
439440
<td colspan="2">
440441
<b>
441442
<a href="#M:TensorFlow.TFOperationDesc.FinishOperation(TensorFlow.TFStatus)">FinishOperation</a>
442-
</b>(<a href="../TensorFlow/TFStatus.html">TFStatus</a>)<nobr> : <a href="../TensorFlow/TFOperation.html">TFOperation</a></nobr><blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
443+
</b>(<a href="../TensorFlow/TFStatus.html">TFStatus</a>)<nobr> : <a href="../TensorFlow/TFOperation.html">TFOperation</a></nobr><blockquote>
444+
Turns the operation description into an actual operation in the graph.
445+
</blockquote></td>
443446
</tr>
444447
<tr valign="top">
445448
<td>
@@ -772,8 +775,8 @@ <h2 class="Section">Requirements</h2>
772775
<h3 id="M:TensorFlow.TFOperationDesc.FinishOperation(TensorFlow.TFStatus)">FinishOperation Method</h3>
773776
<blockquote id="M:TensorFlow.TFOperationDesc.FinishOperation(TensorFlow.TFStatus):member">
774777
<div class="msummary">
775-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
776-
</div>
778+
Turns the operation description into an actual operation in the graph.
779+
</div>
777780
<h2>Syntax</h2>
778781
<div class="Signature">public <a href="../TensorFlow/TFOperation.html">TFOperation</a> <b>FinishOperation</b> (<a href="../TensorFlow/TFStatus.html">TFStatus</a> status)</div>
779782
<h4 class="Subsection">Parameters</h4>
@@ -782,15 +785,11 @@ <h4 class="Subsection">Parameters</h4>
782785
<dt>
783786
<i>status</i>
784787
</dt>
785-
<dd>
786-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
787-
</dd>
788+
<dd>Optional status, on failure the operation is not added to the graph. If you pass null (the default), this operation throws on error conditions.</dd>
788789
</dl>
789790
</blockquote>
790791
<h4 class="Subsection">Returns</h4>
791-
<blockquote class="SubsectionBox" id="M:TensorFlow.TFOperationDesc.FinishOperation(TensorFlow.TFStatus):Returns">
792-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
793-
</blockquote>
792+
<blockquote class="SubsectionBox" id="M:TensorFlow.TFOperationDesc.FinishOperation(TensorFlow.TFStatus):Returns">The operation on success, or null on error.</blockquote>
794793
<h2 class="Section">Remarks</h2>
795794
<div class="SectionBox" id="M:TensorFlow.TFOperationDesc.FinishOperation(TensorFlow.TFStatus):Remarks">
796795
<span class="NotEntered">Documentation for this section has not yet been entered.</span>

‎docs/TensorFlow/TFScope.html‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,9 @@ <h2 class="Section">Public Methods</h2>
308308
<td colspan="2">
309309
<b>
310310
<a href="#M:TensorFlow.TFScope.Dispose()">Dispose</a>
311-
</b>()<blockquote><span class="NotEntered">Documentation for this section has not yet been entered.</span></blockquote></td>
311+
</b>()<blockquote>
312+
Pops the name space to the previous namescope in use.
313+
</blockquote></td>
312314
</tr>
313315
</table>
314316
</div>
@@ -321,14 +323,14 @@ <h2 class="Section" id="MemberDetails">Member Details</h2>
321323
<h3 id="M:TensorFlow.TFScope.Dispose()">Dispose Method</h3>
322324
<blockquote id="M:TensorFlow.TFScope.Dispose():member">
323325
<div class="msummary">
324-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
325-
</div>
326+
Pops the name space to the previous namescope in use.
327+
</div>
326328
<h2>Syntax</h2>
327329
<div class="Signature">public <a href="http://www.go-mono.com/docs/monodoc.ashx?link=T:System.Void">void</a> <b>Dispose</b> ()</div>
328330
<h2 class="Section">Remarks</h2>
329-
<div class="SectionBox" id="M:TensorFlow.TFScope.Dispose():Remarks">
330-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
331-
</div>
331+
<div class="SectionBox" id="M:TensorFlow.TFScope.Dispose():Remarks">Call <a href="../TensorFlow/TFScope.html#M:TensorFlow.TFScope.Dispose">TFScope.Dispose</a> when you are finished using the <a href="../TensorFlow/TFScope.html">TensorFlow.TFScope</a>
332+
to restore the previous name scope in use in the <a href="../TensorFlow/TFGraph.html">TensorFlow.TFGraph</a>.
333+
</div>
332334
<h2 class="Section">Requirements</h2>
333335
<div class="SectionBox" id="M:TensorFlow.TFScope.Dispose():Version Information">
334336
<b>Namespace: </b>TensorFlow<br /><b>Assembly: </b>TensorFlowSharp (in TensorFlowSharp.dll)<br /><b>Assembly Versions: </b>1.0.0.0</div>

‎docs/TensorFlow/TFSession+Runner.html‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -669,9 +669,7 @@ <h4 class="Subsection">Parameters</h4>
669669
<dt>
670670
<i>outputs</i>
671671
</dt>
672-
<dd>
673-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
674-
</dd>
672+
<dd>The output sreferencing a specified tensor.</dd>
675673
</dl>
676674
</blockquote>
677675
<h4 class="Subsection">Returns</h4>
@@ -725,9 +723,7 @@ <h4 class="Subsection">Parameters</h4>
725723
<dt>
726724
<i>outputs</i>
727725
</dt>
728-
<dd>
729-
<span class="NotEntered">Documentation for this section has not yet been entered.</span>
730-
</dd>
726+
<dd>The outputs referencing a specified tensor.</dd>
731727
</dl>
732728
</blockquote>
733729
<h4 class="Subsection">Returns</h4>

0 commit comments

Comments
 (0)