Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Vw.VowpalWabbitFeaturizer Class Reference

VowpalWabbitFeaturizer implements VowpalWabbitFeaturizer More...

Inheritance diagram for Synapse.ML.Vw.VowpalWabbitFeaturizer:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Vw.VowpalWabbitFeaturizer:
Collaboration graph
[legend]

Public Member Functions

 VowpalWabbitFeaturizer ()
 Creates a VowpalWabbitFeaturizer without any parameters. More...
 
 VowpalWabbitFeaturizer (string uid)
 Creates a VowpalWabbitFeaturizer with a UID that is used to give the VowpalWabbitFeaturizer a unique ID. More...
 
VowpalWabbitFeaturizer SetInputCols (string[] value)
 Sets value for inputCols More...
 
VowpalWabbitFeaturizer SetNumBits (int value)
 Sets value for numBits More...
 
VowpalWabbitFeaturizer SetOutputCol (string value)
 Sets value for outputCol More...
 
VowpalWabbitFeaturizer SetPrefixStringsWithColumnName (bool value)
 Sets value for prefixStringsWithColumnName More...
 
VowpalWabbitFeaturizer SetPreserveOrderNumBits (int value)
 Sets value for preserveOrderNumBits More...
 
VowpalWabbitFeaturizer SetSeed (int value)
 Sets value for seed More...
 
VowpalWabbitFeaturizer SetStringSplitInputCols (string[] value)
 Sets value for stringSplitInputCols More...
 
VowpalWabbitFeaturizer SetSumCollisions (bool value)
 Sets value for sumCollisions More...
 
string [] GetInputCols ()
 Gets inputCols value More...
 
int GetNumBits ()
 Gets numBits value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
bool GetPrefixStringsWithColumnName ()
 Gets prefixStringsWithColumnName value More...
 
int GetPreserveOrderNumBits ()
 Gets preserveOrderNumBits value More...
 
int GetSeed ()
 Gets seed value More...
 
string [] GetStringSplitInputCols ()
 Gets stringSplitInputCols value More...
 
bool GetSumCollisions ()
 Gets sumCollisions value More...
 
void Save (string path)
 Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...
 
JavaMLWriter Write ()
 
Returns
a JavaMLWriter instance for this ML instance.

 
JavaMLReader< VowpalWabbitFeaturizerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

static VowpalWabbitFeaturizer Load (string path)
 Loads the VowpalWabbitFeaturizer that was previously saved using Save(string). More...
 

Detailed Description

VowpalWabbitFeaturizer implements VowpalWabbitFeaturizer

Constructor & Destructor Documentation

◆ VowpalWabbitFeaturizer() [1/2]

Synapse.ML.Vw.VowpalWabbitFeaturizer.VowpalWabbitFeaturizer ( )
inline

Creates a VowpalWabbitFeaturizer without any parameters.

◆ VowpalWabbitFeaturizer() [2/2]

Synapse.ML.Vw.VowpalWabbitFeaturizer.VowpalWabbitFeaturizer ( string  uid)
inline

Creates a VowpalWabbitFeaturizer with a UID that is used to give the VowpalWabbitFeaturizer a unique ID.

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetInputCols()

string [] Synapse.ML.Vw.VowpalWabbitFeaturizer.GetInputCols ( )

Gets inputCols value

Returns
inputCols: The names of the input columns

◆ GetNumBits()

int Synapse.ML.Vw.VowpalWabbitFeaturizer.GetNumBits ( )

Gets numBits value

Returns
numBits: Number of bits used to mask

◆ GetOutputCol()

string Synapse.ML.Vw.VowpalWabbitFeaturizer.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPrefixStringsWithColumnName()

bool Synapse.ML.Vw.VowpalWabbitFeaturizer.GetPrefixStringsWithColumnName ( )

Gets prefixStringsWithColumnName value

Returns
prefixStringsWithColumnName: Prefix string features with column name

◆ GetPreserveOrderNumBits()

int Synapse.ML.Vw.VowpalWabbitFeaturizer.GetPreserveOrderNumBits ( )

Gets preserveOrderNumBits value

Returns
preserveOrderNumBits: Number of bits used to preserve the feature order. This will reduce the hash size. Needs to be large enough to fit count the maximum number of words

◆ GetSeed()

int Synapse.ML.Vw.VowpalWabbitFeaturizer.GetSeed ( )

Gets seed value

Returns
seed: Hash seed

◆ GetStringSplitInputCols()

string [] Synapse.ML.Vw.VowpalWabbitFeaturizer.GetStringSplitInputCols ( )

Gets stringSplitInputCols value

Returns
stringSplitInputCols: Input cols that should be split at word boundaries

◆ GetSumCollisions()

bool Synapse.ML.Vw.VowpalWabbitFeaturizer.GetSumCollisions ( )

Gets sumCollisions value

Returns
sumCollisions: Sums collisions if true, otherwise removes them

◆ Load()

static VowpalWabbitFeaturizer Synapse.ML.Vw.VowpalWabbitFeaturizer.Load ( string  path)
static

Loads the VowpalWabbitFeaturizer that was previously saved using Save(string).

Parameters
pathThe path the previous VowpalWabbitFeaturizer was saved to
Returns
New VowpalWabbitFeaturizer object, loaded from path.

◆ Read()

JavaMLReader<VowpalWabbitFeaturizer> Synapse.ML.Vw.VowpalWabbitFeaturizer.Read ( )

Get the corresponding JavaMLReader instance.

Returns
an JavaMLReader<VowpalWabbitFeaturizer> instance for this ML instance.

◆ Save()

void Synapse.ML.Vw.VowpalWabbitFeaturizer.Save ( string  path)

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters
pathThe path to save the object to

◆ SetInputCols()

VowpalWabbitFeaturizer Synapse.ML.Vw.VowpalWabbitFeaturizer.SetInputCols ( string []  value)

Sets value for inputCols

Parameters
valueThe names of the input columns
Returns
New VowpalWabbitFeaturizer object

◆ SetNumBits()

VowpalWabbitFeaturizer Synapse.ML.Vw.VowpalWabbitFeaturizer.SetNumBits ( int  value)

Sets value for numBits

Parameters
valueNumber of bits used to mask
Returns
New VowpalWabbitFeaturizer object

◆ SetOutputCol()

VowpalWabbitFeaturizer Synapse.ML.Vw.VowpalWabbitFeaturizer.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New VowpalWabbitFeaturizer object

◆ SetPrefixStringsWithColumnName()

VowpalWabbitFeaturizer Synapse.ML.Vw.VowpalWabbitFeaturizer.SetPrefixStringsWithColumnName ( bool  value)

Sets value for prefixStringsWithColumnName

Parameters
valuePrefix string features with column name
Returns
New VowpalWabbitFeaturizer object

◆ SetPreserveOrderNumBits()

VowpalWabbitFeaturizer Synapse.ML.Vw.VowpalWabbitFeaturizer.SetPreserveOrderNumBits ( int  value)

Sets value for preserveOrderNumBits

Parameters
valueNumber of bits used to preserve the feature order. This will reduce the hash size. Needs to be large enough to fit count the maximum number of words
Returns
New VowpalWabbitFeaturizer object

◆ SetSeed()

VowpalWabbitFeaturizer Synapse.ML.Vw.VowpalWabbitFeaturizer.SetSeed ( int  value)

Sets value for seed

Parameters
valueHash seed
Returns
New VowpalWabbitFeaturizer object

◆ SetStringSplitInputCols()

VowpalWabbitFeaturizer Synapse.ML.Vw.VowpalWabbitFeaturizer.SetStringSplitInputCols ( string []  value)

Sets value for stringSplitInputCols

Parameters
valueInput cols that should be split at word boundaries
Returns
New VowpalWabbitFeaturizer object

◆ SetSumCollisions()

VowpalWabbitFeaturizer Synapse.ML.Vw.VowpalWabbitFeaturizer.SetSumCollisions ( bool  value)

Sets value for sumCollisions

Parameters
valueSums collisions if true, otherwise removes them
Returns
New VowpalWabbitFeaturizer object

The documentation for this class was generated from the following file: