Skip to content

Commit cd7fb8f

Browse files
committed
Doc updates + Remove an old helper method that is now part of the core
1 parent 4e60417 commit cd7fb8f

39 files changed

+77688
-38799
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ rebuild-docs: docs/template
55

66
# Used to fetch XML doc updates from the C# compiler into the ECMA docs
77
doc-update:
8-
mdoc update -i TensorFlowSharp/bin/Debug/TensorFlowSharp.xml -o ecmadocs/en TensorFlowSharp/bin/Debug/TensorFlowSharp.dll
8+
mdoc update -i TensorFlowSharp/bin/Debug/TensorFlowSharp.xml -o ecmadocs/en TensorFlowSharp/bin/Debug/net461/TensorFlowSharp.dll
99

1010
yaml:
1111
-rm ecmadocs/en/ns-.xml

TensorFlowSharp/OperationsExtras.cs

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -373,33 +373,6 @@ public TFOutput Dropout (TFOutput x, double keep_prob, TFShape noise_shape = nul
373373
}
374374

375375

376-
377-
/// <summary>
378-
/// Clips tensor values to a specified min and max.
379-
/// </summary>
380-
/// <remarks>
381-
/// Given a tensor <paramref name="x"/>, this operation returns a tensor of the same type and shape
382-
/// as <paramref name="x"/> with its values clipped to <paramref name="clip_value_min"/> and <paramref name="clip_value_max"/>.
383-
/// Any values less than <paramref name="clip_value_min"/> are set to <paramref name="clip_value_min"/>. Any values greater than
384-
/// <paramref name="clip_value_max"/> are set to <paramref name="clip_value_max"/>.
385-
/// </remarks>
386-
/// <param name="x">The tensor.</param>
387-
/// <param name="clip_value_min">The minimum value to clip by. A 0 - D(scalar) tensor, or a tensor with the same shape as <paramref name="x"/>.</param>
388-
/// <param name="clip_value_max">The minimum value to clip by. A 0 - D(scalar) tensor, or a tensor with the same shape as <paramref name="x"/>.</param>
389-
/// <param name="operName">Operation name, optional.</param>
390-
/// <returns>A clipped <see cref="TFOutput">tensor</see>.</returns>
391-
public TFOutput ClipByValue (TFOutput x, TFOutput clip_value_min, TFOutput clip_value_max, string operName = null)
392-
{
393-
// https://github.com/tensorflow/tensorflow/blob/r1.2/tensorflow/python/ops/clip_ops.py#L33
394-
var scopeName = MakeName ("ClipByValue", operName);
395-
using (var newScope = WithScope (scopeName)) {
396-
// Go through list of tensors, for each value in each tensor clip
397-
var t_min = Minimum (x, clip_value_max);
398-
var t_max = Maximum (t_min, clip_value_min, operName: operName);
399-
return t_max;
400-
}
401-
}
402-
403376
/// <summary>
404377
/// Clips tensor values to a maximum L2-norm.
405378
/// </summary>

TensorFlowSharp/TensorFlowSharp.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
<GenerateDocumentationFile Condition=" '$(Configuration)' == 'Release' ">true</GenerateDocumentationFile>
1111
<ReleaseVersion>0.2</ReleaseVersion>
1212
<TensorFlowRuntimeVersion>1.12.0</TensorFlowRuntimeVersion>
13+
<TargetFramework>net461</TargetFramework>
1314
</PropertyGroup>
1415

1516
<PropertyGroup>

docfx/api/TensorFlow.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ items:
33
- uid: TensorFlow
44
id: TensorFlow
55
children:
6+
- TensorFlow.DeviceAttributes
7+
- TensorFlow.DeviceType
68
- TensorFlow.MonoPInvokeCallbackAttribute
79
- TensorFlow.PaddingFIFOQueue
810
- TensorFlow.QueueBase
@@ -15,6 +17,7 @@ items:
1517
- TensorFlow.TFDataType
1618
- TensorFlow.TFDependencies
1719
- TensorFlow.TFDisposable
20+
- TensorFlow.TFDisposableThreadSafe
1821
- TensorFlow.TFException
1922
- TensorFlow.TFFunction
2023
- TensorFlow.TFGraph
@@ -47,6 +50,18 @@ items:
4750
This is the API documentation for the TensorFlowSharp project.
4851
</p>
4952
references:
53+
- uid: TensorFlow.DeviceAttributes
54+
parent: TensorFlow
55+
isExternal: false
56+
name: DeviceAttributes
57+
nameWithType: DeviceAttributes
58+
fullName: TensorFlow.DeviceAttributes
59+
- uid: TensorFlow.DeviceType
60+
parent: TensorFlow
61+
isExternal: false
62+
name: DeviceType
63+
nameWithType: DeviceType
64+
fullName: TensorFlow.DeviceType
5065
- uid: TensorFlow.MonoPInvokeCallbackAttribute
5166
parent: TensorFlow
5267
isExternal: false
@@ -119,6 +134,12 @@ references:
119134
name: TFDisposable
120135
nameWithType: TFDisposable
121136
fullName: TensorFlow.TFDisposable
137+
- uid: TensorFlow.TFDisposableThreadSafe
138+
parent: TensorFlow
139+
isExternal: false
140+
name: TFDisposableThreadSafe
141+
nameWithType: TFDisposableThreadSafe
142+
fullName: TensorFlow.TFDisposableThreadSafe
122143
- uid: TensorFlow.TFException
123144
parent: TensorFlow
124145
isExternal: false

docfx/api/TensorFlow/TensorFlow.TFCore.yml

Lines changed: 85 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ items:
44
id: TFCore
55
children:
66
- TensorFlow.TFCore.GetAllOpList
7+
- TensorFlow.TFCore.GetAllRegisteredKernels(TensorFlow.TFStatus)
8+
- TensorFlow.TFCore.GetAllRegisteredKernels(System.String,TensorFlow.TFStatus)
79
- TensorFlow.TFCore.GetDataTypeSize(TensorFlow.TFDataType)
810
- TensorFlow.TFCore.Version
911
langs:
@@ -45,6 +47,59 @@ items:
4547
description: The buffer contains a ProtocolBuffer encoded payload, you need a ProtocolBuffer reader to process the contents.
4648
overload: TensorFlow.TFCore.GetAllOpList*
4749
exceptions: []
50+
- uid: TensorFlow.TFCore.GetAllRegisteredKernels(TensorFlow.TFStatus)
51+
id: GetAllRegisteredKernels(TensorFlow.TFStatus)
52+
parent: TensorFlow.TFCore
53+
langs:
54+
- csharp
55+
name: GetAllRegisteredKernels(TFStatus)
56+
nameWithType: TFCore.GetAllRegisteredKernels(TFStatus)
57+
fullName: TFCore.GetAllRegisteredKernels(TFStatus)
58+
type: Method
59+
assemblies:
60+
- TensorFlowSharp
61+
namespace: TensorFlow
62+
summary: Returns a serialized KernelList protocol buffer containing KernelDefs for all registered kernels
63+
syntax:
64+
content: public static TensorFlow.TFBuffer GetAllRegisteredKernels (TensorFlow.TFStatus status = null);
65+
parameters:
66+
- id: status
67+
type: TensorFlow.TFStatus
68+
description: Status buffer, if specified a status code will be left here, if not specified, a <xref href="TensorFlow.TFException"></xref> exception is raised if there is an error.
69+
return:
70+
type: TensorFlow.TFBuffer
71+
description: The all registered kernels.
72+
overload: TensorFlow.TFCore.GetAllRegisteredKernels*
73+
exceptions: []
74+
- uid: TensorFlow.TFCore.GetAllRegisteredKernels(System.String,TensorFlow.TFStatus)
75+
id: GetAllRegisteredKernels(System.String,TensorFlow.TFStatus)
76+
parent: TensorFlow.TFCore
77+
langs:
78+
- csharp
79+
name: GetAllRegisteredKernels(String, TFStatus)
80+
nameWithType: TFCore.GetAllRegisteredKernels(String, TFStatus)
81+
fullName: TFCore.GetAllRegisteredKernels(String, TFStatus)
82+
type: Method
83+
assemblies:
84+
- TensorFlowSharp
85+
namespace: TensorFlow
86+
summary: >-
87+
Returns a serialized KernelList protocol buffer containing KernelDefs for all
88+
kernels registered for the operation specified.
89+
syntax:
90+
content: public static TensorFlow.TFBuffer GetAllRegisteredKernels (string name, TensorFlow.TFStatus status = null);
91+
parameters:
92+
- id: name
93+
type: System.String
94+
description: The operation to look up.
95+
- id: status
96+
type: TensorFlow.TFStatus
97+
description: Status buffer, if specified a status code will be left here, if not specified, a <xref href="TensorFlow.TFException"></xref> exception is raised if there is an error.
98+
return:
99+
type: TensorFlow.TFBuffer
100+
description: The registered kernels for the specified operation.
101+
overload: TensorFlow.TFCore.GetAllRegisteredKernels*
102+
exceptions: []
48103
- uid: TensorFlow.TFCore.GetDataTypeSize(TensorFlow.TFDataType)
49104
id: GetDataTypeSize(TensorFlow.TFDataType)
50105
parent: TensorFlow.TFCore
@@ -108,6 +163,30 @@ references:
108163
name: TFBuffer
109164
nameWithType: TFBuffer
110165
fullName: TensorFlow.TFBuffer
166+
- uid: TensorFlow.TFCore.GetAllRegisteredKernels(TensorFlow.TFStatus)
167+
parent: TensorFlow.TFCore
168+
isExternal: false
169+
name: GetAllRegisteredKernels(TFStatus)
170+
nameWithType: TFCore.GetAllRegisteredKernels(TFStatus)
171+
fullName: TFCore.GetAllRegisteredKernels(TFStatus)
172+
- uid: TensorFlow.TFStatus
173+
parent: TensorFlow
174+
isExternal: false
175+
name: TFStatus
176+
nameWithType: TFStatus
177+
fullName: TensorFlow.TFStatus
178+
- uid: TensorFlow.TFCore.GetAllRegisteredKernels(System.String,TensorFlow.TFStatus)
179+
parent: TensorFlow.TFCore
180+
isExternal: false
181+
name: GetAllRegisteredKernels(String, TFStatus)
182+
nameWithType: TFCore.GetAllRegisteredKernels(String, TFStatus)
183+
fullName: TFCore.GetAllRegisteredKernels(String, TFStatus)
184+
- uid: System.String
185+
parent: System
186+
isExternal: true
187+
name: String
188+
nameWithType: String
189+
fullName: System.String
111190
- uid: TensorFlow.TFCore.GetDataTypeSize(TensorFlow.TFDataType)
112191
parent: TensorFlow.TFCore
113192
isExternal: false
@@ -132,18 +211,18 @@ references:
132211
name: Version
133212
nameWithType: TFCore.Version
134213
fullName: TFCore.Version
135-
- uid: System.String
136-
parent: System
137-
isExternal: true
138-
name: String
139-
nameWithType: String
140-
fullName: System.String
141214
- uid: TensorFlow.TFCore.GetAllOpList*
142215
parent: TensorFlow.TFCore
143216
isExternal: false
144217
name: GetAllOpList
145218
nameWithType: TFCore.GetAllOpList
146219
fullName: TFCore.GetAllOpList
220+
- uid: TensorFlow.TFCore.GetAllRegisteredKernels*
221+
parent: TensorFlow.TFCore
222+
isExternal: false
223+
name: GetAllRegisteredKernels
224+
nameWithType: TFCore.GetAllRegisteredKernels
225+
fullName: TFCore.GetAllRegisteredKernels
147226
- uid: TensorFlow.TFCore.GetDataTypeSize*
148227
parent: TensorFlow.TFCore
149228
isExternal: false

docfx/api/TensorFlow/TensorFlow.TFDataType.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ items:
2323
- TensorFlow.TFDataType.Resource
2424
- TensorFlow.TFDataType.String
2525
- TensorFlow.TFDataType.UInt16
26+
- TensorFlow.TFDataType.UInt32
27+
- TensorFlow.TFDataType.UInt64
2628
- TensorFlow.TFDataType.UInt8
2729
- TensorFlow.TFDataType.Unknown
2830
- TensorFlow.TFDataType.Variant
@@ -423,6 +425,44 @@ items:
423425
type: TensorFlow.TFDataType
424426
description: To be added.
425427
exceptions: []
428+
- uid: TensorFlow.TFDataType.UInt32
429+
id: UInt32
430+
parent: TensorFlow.TFDataType
431+
langs:
432+
- csharp
433+
name: UInt32
434+
nameWithType: TFDataType.UInt32
435+
fullName: TFDataType.UInt32
436+
type: Field
437+
assemblies:
438+
- TensorFlowSharp
439+
namespace: TensorFlow
440+
summary: 32-bit unsigned integers
441+
syntax:
442+
content: UInt32
443+
return:
444+
type: TensorFlow.TFDataType
445+
description: To be added.
446+
exceptions: []
447+
- uid: TensorFlow.TFDataType.UInt64
448+
id: UInt64
449+
parent: TensorFlow.TFDataType
450+
langs:
451+
- csharp
452+
name: UInt64
453+
nameWithType: TFDataType.UInt64
454+
fullName: TFDataType.UInt64
455+
type: Field
456+
assemblies:
457+
- TensorFlowSharp
458+
namespace: TensorFlow
459+
summary: 64-bit unsigned integers
460+
syntax:
461+
content: UInt64
462+
return:
463+
type: TensorFlow.TFDataType
464+
description: To be added.
465+
exceptions: []
426466
- uid: TensorFlow.TFDataType.UInt8
427467
id: UInt8
428468
parent: TensorFlow.TFDataType
@@ -613,6 +653,18 @@ references:
613653
name: UInt16
614654
nameWithType: TFDataType.UInt16
615655
fullName: TFDataType.UInt16
656+
- uid: TensorFlow.TFDataType.UInt32
657+
parent: TensorFlow.TFDataType
658+
isExternal: false
659+
name: UInt32
660+
nameWithType: TFDataType.UInt32
661+
fullName: TFDataType.UInt32
662+
- uid: TensorFlow.TFDataType.UInt64
663+
parent: TensorFlow.TFDataType
664+
isExternal: false
665+
name: UInt64
666+
nameWithType: TFDataType.UInt64
667+
fullName: TFDataType.UInt64
616668
- uid: TensorFlow.TFDataType.UInt8
617669
parent: TensorFlow.TFDataType
618670
isExternal: false

docfx/api/TensorFlow/TensorFlow.TFDisposable.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,13 @@ items:
3535
- System.Object
3636
derivedClasses:
3737
- TensorFlow.TFBuffer
38+
- TensorFlow.TFDisposableThreadSafe
3839
- TensorFlow.TFFunction
39-
- TensorFlow.TFGraph
4040
- TensorFlow.TFImportGraphDefOptions
4141
- TensorFlow.TFLibrary
4242
- TensorFlow.TFOperationDesc
43-
- TensorFlow.TFSession
4443
- TensorFlow.TFSessionOptions
4544
- TensorFlow.TFStatus
46-
- TensorFlow.TFTensor
4745
implements:
4846
- System.IDisposable
4947
inheritedMembers: []

docfx/api/TensorFlow/TensorFlow.TFFunction.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ items:
44
id: TFFunction
55
children:
66
- TensorFlow.TFFunction.ImportFunctionDef(System.Byte[],TensorFlow.TFStatus)
7+
- TensorFlow.TFFunction.Name
78
- TensorFlow.TFFunction.ToFunctionDef(TensorFlow.TFBuffer,TensorFlow.TFStatus)
89
langs:
910
- csharp
@@ -57,6 +58,25 @@ items:
5758
description: The function definition, or null on failure.
5859
overload: TensorFlow.TFFunction.ImportFunctionDef*
5960
exceptions: []
61+
- uid: TensorFlow.TFFunction.Name
62+
id: Name
63+
parent: TensorFlow.TFFunction
64+
langs:
65+
- csharp
66+
name: Name
67+
nameWithType: TFFunction.Name
68+
fullName: TFFunction.Name
69+
type: Property
70+
assemblies:
71+
- TensorFlowSharp
72+
namespace: TensorFlow
73+
syntax:
74+
content: public string Name { get; }
75+
return:
76+
type: System.String
77+
description: To be added.
78+
overload: TensorFlow.TFFunction.Name*
79+
exceptions: []
6080
- uid: TensorFlow.TFFunction.ToFunctionDef(TensorFlow.TFBuffer,TensorFlow.TFStatus)
6181
id: ToFunctionDef(TensorFlow.TFBuffer,TensorFlow.TFStatus)
6282
parent: TensorFlow.TFFunction
@@ -124,6 +144,18 @@ references:
124144
name: TFStatus
125145
nameWithType: TFStatus
126146
fullName: TensorFlow.TFStatus
147+
- uid: TensorFlow.TFFunction.Name
148+
parent: TensorFlow.TFFunction
149+
isExternal: false
150+
name: Name
151+
nameWithType: TFFunction.Name
152+
fullName: TFFunction.Name
153+
- uid: System.String
154+
parent: System
155+
isExternal: true
156+
name: String
157+
nameWithType: String
158+
fullName: System.String
127159
- uid: TensorFlow.TFFunction.ToFunctionDef(TensorFlow.TFBuffer,TensorFlow.TFStatus)
128160
parent: TensorFlow.TFFunction
129161
isExternal: false
@@ -142,6 +174,12 @@ references:
142174
name: ImportFunctionDef
143175
nameWithType: TFFunction.ImportFunctionDef
144176
fullName: TFFunction.ImportFunctionDef
177+
- uid: TensorFlow.TFFunction.Name*
178+
parent: TensorFlow.TFFunction
179+
isExternal: false
180+
name: Name
181+
nameWithType: TFFunction.Name
182+
fullName: TFFunction.Name
145183
- uid: TensorFlow.TFFunction.ToFunctionDef*
146184
parent: TensorFlow.TFFunction
147185
isExternal: false

0 commit comments

Comments
 (0)