-
Notifications
You must be signed in to change notification settings - Fork 31
/
HashingEstimator+ColumnOptions.xml
209 lines (209 loc) · 12.7 KB
/
HashingEstimator+ColumnOptions.xml
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
<Type Name="HashingEstimator+ColumnOptions" FullName="Microsoft.ML.Transforms.HashingEstimator+ColumnOptions">
<TypeSignature Language="C#" Value="public sealed class HashingEstimator.ColumnOptions" />
<TypeSignature Language="ILAsm" Value=".class nested public auto ansi sealed beforefieldinit HashingEstimator/ColumnOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class HashingEstimator.ColumnOptions" />
<TypeSignature Language="F#" Value="type HashingEstimator.ColumnOptions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Describes how the transformer handles one column pair.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ColumnOptions (string name, string inputColumnName = default, int numberOfBits = 31, uint seed = 314489979, bool useOrderedHashing = false, int maximumNumberOfInverts = 0, bool combine = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, string inputColumnName, int32 numberOfBits, unsigned int32 seed, bool useOrderedHashing, int32 maximumNumberOfInverts, bool combine) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.#ctor(System.String,System.String,System.Int32,System.UInt32,System.Boolean,System.Int32,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, Optional inputColumnName As String = Nothing, Optional numberOfBits As Integer = 31, Optional seed As UInteger = 314489979, Optional useOrderedHashing As Boolean = false, Optional maximumNumberOfInverts As Integer = 0, Optional combine As Boolean = false)" />
<MemberSignature Language="F#" Value="new Microsoft.ML.Transforms.HashingEstimator.ColumnOptions : string * string * int * uint32 * bool * int * bool -> Microsoft.ML.Transforms.HashingEstimator.ColumnOptions" Usage="new Microsoft.ML.Transforms.HashingEstimator.ColumnOptions (name, inputColumnName, numberOfBits, seed, useOrderedHashing, maximumNumberOfInverts, combine)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="inputColumnName" Type="System.String" />
<Parameter Name="numberOfBits" Type="System.Int32" />
<Parameter Name="seed" Type="System.UInt32" />
<Parameter Name="useOrderedHashing" Type="System.Boolean" />
<Parameter Name="maximumNumberOfInverts" Type="System.Int32" />
<Parameter Name="combine" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="name">Name of the column resulting from the transformation of <paramref name="inputColumnName" />.</param>
<param name="inputColumnName">Name of column to transform. If set to <see langword="null" />, the value of the <paramref name="name" /> will be used as source.</param>
<param name="numberOfBits">Number of bits to hash into. Must be between 1 and 31, inclusive.</param>
<param name="seed">Hashing seed.</param>
<param name="useOrderedHashing">Whether the position of each term should be included in the hash, only applies to inputs of vector type.</param>
<param name="maximumNumberOfInverts">During hashing we construct mappings between original values and the produced hash values.
Text representation of original values are stored in the slot names of the annotations for the new column.Hashing, as such, can map many initial values to one.
<paramref name="maximumNumberOfInverts" /> specifies the upper bound of the number of distinct input values mapping to a hash that should be retained.
<value>0</value> does not retain any input values. <value>-1</value> retains all input values mapping to each hash.</param>
<param name="combine">Whether the slots of a vector column should be hashed into a single value.</param>
<summary>
Describes how the transformer handles one column pair.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Combine">
<MemberSignature Language="C#" Value="public bool Combine { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Combine" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.Combine" />
<MemberSignature Language="VB.NET" Value="Public Property Combine As Boolean" />
<MemberSignature Language="F#" Value="member this.Combine : bool with get, set" Usage="Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.Combine" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Whether the slots of a vector column should be hashed into a single value.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InputColumnName">
<MemberSignature Language="C#" Value="public string InputColumnName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string InputColumnName" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.InputColumnName" />
<MemberSignature Language="VB.NET" Value="Public Property InputColumnName As String" />
<MemberSignature Language="F#" Value="member this.InputColumnName : string with get, set" Usage="Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.InputColumnName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> Name of column to transform.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaximumNumberOfInverts">
<MemberSignature Language="C#" Value="public int MaximumNumberOfInverts { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaximumNumberOfInverts" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.MaximumNumberOfInverts" />
<MemberSignature Language="VB.NET" Value="Public Property MaximumNumberOfInverts As Integer" />
<MemberSignature Language="F#" Value="member this.MaximumNumberOfInverts : int with get, set" Usage="Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.MaximumNumberOfInverts" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
During hashing we constuct mappings between original values and the produced hash values.
Text representation of original values are stored in the key names of the annotations for the new column. Hashing, as such, can map many initial values to one.
<see cref="P:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.MaximumNumberOfInverts" /> specifies the upper bound of the number of distinct input values mapping to a hash that should be retained.
<value>0</value> does not retain any input values. <value>-1</value> retains all input values mapping to each hash.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Name of the column resulting from the transformation of <see cref="P:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.InputColumnName" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NumberOfBits">
<MemberSignature Language="C#" Value="public int NumberOfBits { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 NumberOfBits" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.NumberOfBits" />
<MemberSignature Language="VB.NET" Value="Public Property NumberOfBits As Integer" />
<MemberSignature Language="F#" Value="member this.NumberOfBits : int with get, set" Usage="Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.NumberOfBits" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary> Number of bits to hash into. Must be between 1 and 31, inclusive.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Seed">
<MemberSignature Language="C#" Value="public uint Seed { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int32 Seed" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.Seed" />
<MemberSignature Language="VB.NET" Value="Public Property Seed As UInteger" />
<MemberSignature Language="F#" Value="member this.Seed : uint32 with get, set" Usage="Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.Seed" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary> Hashing seed.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UseOrderedHashing">
<MemberSignature Language="C#" Value="public bool UseOrderedHashing { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseOrderedHashing" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.UseOrderedHashing" />
<MemberSignature Language="VB.NET" Value="Public Property UseOrderedHashing As Boolean" />
<MemberSignature Language="F#" Value="member this.UseOrderedHashing : bool with get, set" Usage="Microsoft.ML.Transforms.HashingEstimator.ColumnOptions.UseOrderedHashing" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Data</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary> Whether the position of each term should be included in the hash, only applies to inputs of vector type.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>