HashingEstimator.ColumnOptions Constructor

Definition

Namespace:

Microsoft.ML.Transforms

Assembly:

Microsoft.ML.Data.dll

Package:

Microsoft.ML v3.0.1

Describes how the transformer handles one column pair.

public ColumnOptions (string name, string inputColumnName = default, int numberOfBits = 31, uint seed = 314489979, bool useOrderedHashing = false, int maximumNumberOfInverts = 0, bool combine = false);

new Microsoft.ML.Transforms.HashingEstimator.ColumnOptions : string * string * int * uint32 * bool * int * bool -> Microsoft.ML.Transforms.HashingEstimator.ColumnOptions

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)

Parameters

name

String

Name of the column resulting from the transformation of inputColumnName.

inputColumnName

String

Name of column to transform. If set to null, the value of the name will be used as source.

numberOfBits

Int32

Number of bits to hash into. Must be between 1 and 31, inclusive.

seed

UInt32

Hashing seed.

useOrderedHashing

Boolean

Whether the position of each term should be included in the hash, only applies to inputs of vector type.

maximumNumberOfInverts

Int32

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. maximumNumberOfInverts specifies the upper bound of the number of distinct input values mapping to a hash that should be retained. 0 does not retain any input values. -1 retains all input values mapping to each hash.

combine

Boolean

Whether the slots of a vector column should be hashed into a single value.