VowpalWabbitClassifier implements VowpalWabbitClassifier More...

Inheritance diagram for Synapse.ML.Vw.VowpalWabbitClassifier:

[legend]

Collaboration diagram for Synapse.ML.Vw.VowpalWabbitClassifier:

[legend]

Public Member Functions
	VowpalWabbitClassifier ()
	Creates a VowpalWabbitClassifier without any parameters. More...

	VowpalWabbitClassifier (string uid)
	Creates a VowpalWabbitClassifier with a UID that is used to give the VowpalWabbitClassifier a unique ID. More...

VowpalWabbitClassifier	SetAdditionalFeatures (string[] value)
	Sets value for additionalFeatures More...

VowpalWabbitClassifier	SetFeaturesCol (string value)
	Sets value for featuresCol More...

VowpalWabbitClassifier	SetHashSeed (int value)
	Sets value for hashSeed More...

VowpalWabbitClassifier	SetIgnoreNamespaces (string value)
	Sets value for ignoreNamespaces More...

VowpalWabbitClassifier	SetInitialModel (object value)
	Sets value for initialModel More...

VowpalWabbitClassifier	SetInteractions (string[] value)
	Sets value for interactions More...

VowpalWabbitClassifier	SetL1 (double value)
	Sets value for l1 More...

VowpalWabbitClassifier	SetL2 (double value)
	Sets value for l2 More...

VowpalWabbitClassifier	SetLabelCol (string value)
	Sets value for labelCol More...

VowpalWabbitClassifier	SetLabelConversion (bool value)
	Sets value for labelConversion More...

VowpalWabbitClassifier	SetLearningRate (double value)
	Sets value for learningRate More...

VowpalWabbitClassifier	SetNumBits (int value)
	Sets value for numBits More...

VowpalWabbitClassifier	SetNumClasses (int value)
	Sets value for numClasses More...

VowpalWabbitClassifier	SetNumPasses (int value)
	Sets value for numPasses More...

VowpalWabbitClassifier	SetNumSyncsPerPass (int value)
	Sets value for numSyncsPerPass More...

VowpalWabbitClassifier	SetPassThroughArgs (string value)
	Sets value for passThroughArgs More...

VowpalWabbitClassifier	SetPowerT (double value)
	Sets value for powerT More...

VowpalWabbitClassifier	SetPredictionCol (string value)
	Sets value for predictionCol More...

VowpalWabbitClassifier	SetPredictionIdCol (string value)
	Sets value for predictionIdCol More...

VowpalWabbitClassifier	SetProbabilityCol (string value)
	Sets value for probabilityCol More...

VowpalWabbitClassifier	SetRawPredictionCol (string value)
	Sets value for rawPredictionCol More...

VowpalWabbitClassifier	SetSplitCol (string value)
	Sets value for splitCol More...

VowpalWabbitClassifier	SetSplitColValues (string[] value)
	Sets value for splitColValues More...

VowpalWabbitClassifier	SetThresholds (double[] value)
	Sets value for thresholds More...

VowpalWabbitClassifier	SetUseBarrierExecutionMode (bool value)
	Sets value for useBarrierExecutionMode More...

VowpalWabbitClassifier	SetWeightCol (string value)
	Sets value for weightCol More...

string[]	GetAdditionalFeatures ()
	Gets additionalFeatures value More...

string	GetFeaturesCol ()
	Gets featuresCol value More...

int	GetHashSeed ()
	Gets hashSeed value More...

string	GetIgnoreNamespaces ()
	Gets ignoreNamespaces value More...

object	GetInitialModel ()
	Gets initialModel value More...

string[]	GetInteractions ()
	Gets interactions value More...

double	GetL1 ()
	Gets l1 value More...

double	GetL2 ()
	Gets l2 value More...

string	GetLabelCol ()
	Gets labelCol value More...

bool	GetLabelConversion ()
	Gets labelConversion value More...

double	GetLearningRate ()
	Gets learningRate value More...

int	GetNumBits ()
	Gets numBits value More...

int	GetNumClasses ()
	Gets numClasses value More...

int	GetNumPasses ()
	Gets numPasses value More...

int	GetNumSyncsPerPass ()
	Gets numSyncsPerPass value More...

string	GetPassThroughArgs ()
	Gets passThroughArgs value More...

double	GetPowerT ()
	Gets powerT value More...

string	GetPredictionCol ()
	Gets predictionCol value More...

string	GetPredictionIdCol ()
	Gets predictionIdCol value More...

string	GetProbabilityCol ()
	Gets probabilityCol value More...

string	GetRawPredictionCol ()
	Gets rawPredictionCol value More...

string	GetSplitCol ()
	Gets splitCol value More...

string[]	GetSplitColValues ()
	Gets splitColValues value More...

double[]	GetThresholds ()
	Gets thresholds value More...

bool	GetUseBarrierExecutionMode ()
	Gets useBarrierExecutionMode value More...

string	GetWeightCol ()
	Gets weightCol value More...

override VowpalWabbitClassificationModel	Fit (DataFrame dataset)
	Fits a model to the input data. 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< VowpalWabbitClassifier >	Read ()
	Get the corresponding JavaMLReader instance. More...

Static Public Member Functions
static VowpalWabbitClassifier	Load (string path)
	Loads the VowpalWabbitClassifier that was previously saved using Save(string). More...

Detailed Description

VowpalWabbitClassifier implements VowpalWabbitClassifier

Constructor & Destructor Documentation

◆ VowpalWabbitClassifier() [1/2]

Synapse.ML.Vw.VowpalWabbitClassifier.VowpalWabbitClassifier ( )

inline

Creates a VowpalWabbitClassifier without any parameters.

◆ VowpalWabbitClassifier() [2/2]

Synapse.ML.Vw.VowpalWabbitClassifier.VowpalWabbitClassifier ( string uid )

inline

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

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ Fit()

override VowpalWabbitClassificationModel Synapse.ML.Vw.VowpalWabbitClassifier.Fit ( DataFrame dataset )

Fits a model to the input data.

Parameters

dataset The DataFrame to fit the model to.

Returns: VowpalWabbitClassificationModel

◆ GetAdditionalFeatures()

string [] Synapse.ML.Vw.VowpalWabbitClassifier.GetAdditionalFeatures ( )

Gets additionalFeatures value

Returns: additionalFeatures: Additional feature columns

◆ GetFeaturesCol()

string Synapse.ML.Vw.VowpalWabbitClassifier.GetFeaturesCol ( )

Gets featuresCol value

Returns: featuresCol: features column name

◆ GetHashSeed()

int Synapse.ML.Vw.VowpalWabbitClassifier.GetHashSeed ( )

Gets hashSeed value

Returns: hashSeed: Seed used for hashing

◆ GetIgnoreNamespaces()

string Synapse.ML.Vw.VowpalWabbitClassifier.GetIgnoreNamespaces ( )

Gets ignoreNamespaces value

Returns: ignoreNamespaces: Namespaces to be ignored (first letter only)

◆ GetInitialModel()

object Synapse.ML.Vw.VowpalWabbitClassifier.GetInitialModel ( )

Gets initialModel value

Returns: initialModel: Initial model to start from

◆ GetInteractions()

string [] Synapse.ML.Vw.VowpalWabbitClassifier.GetInteractions ( )

Gets interactions value

Returns: interactions: Interaction terms as specified by -q

◆ GetL1()

double Synapse.ML.Vw.VowpalWabbitClassifier.GetL1 ( )

Gets l1 value

Returns: l1: l_1 lambda

◆ GetL2()

double Synapse.ML.Vw.VowpalWabbitClassifier.GetL2 ( )

Gets l2 value

Returns: l2: l_2 lambda

◆ GetLabelCol()

string Synapse.ML.Vw.VowpalWabbitClassifier.GetLabelCol ( )

Gets labelCol value

Returns: labelCol: label column name

◆ GetLabelConversion()

bool Synapse.ML.Vw.VowpalWabbitClassifier.GetLabelConversion ( )

Gets labelConversion value

Returns: labelConversion: Convert 0/1 Spark ML style labels to -1/1 VW style labels. Defaults to false.

◆ GetLearningRate()

double Synapse.ML.Vw.VowpalWabbitClassifier.GetLearningRate ( )

Gets learningRate value

Returns: learningRate: Learning rate

◆ GetNumBits()

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

Gets numBits value

Returns: numBits: Number of bits used

◆ GetNumClasses()

int Synapse.ML.Vw.VowpalWabbitClassifier.GetNumClasses ( )

Gets numClasses value

Returns: numClasses: Number of classes. Defaults to binary. Needs to match oaa/csoaa/multilabel_oaa/...

◆ GetNumPasses()

int Synapse.ML.Vw.VowpalWabbitClassifier.GetNumPasses ( )

Gets numPasses value

Returns: numPasses: Number of passes over the data

◆ GetNumSyncsPerPass()

int Synapse.ML.Vw.VowpalWabbitClassifier.GetNumSyncsPerPass ( )

Gets numSyncsPerPass value

Returns: numSyncsPerPass: Number of times weights should be synchronized within each pass. 0 disables inter-pass synchronization.

◆ GetPassThroughArgs()

string Synapse.ML.Vw.VowpalWabbitClassifier.GetPassThroughArgs ( )

Gets passThroughArgs value

Returns: passThroughArgs: VW command line arguments passed

◆ GetPowerT()

double Synapse.ML.Vw.VowpalWabbitClassifier.GetPowerT ( )

Gets powerT value

Returns: powerT: t power value

◆ GetPredictionCol()

string Synapse.ML.Vw.VowpalWabbitClassifier.GetPredictionCol ( )

Gets predictionCol value

Returns: predictionCol: prediction column name

◆ GetPredictionIdCol()

string Synapse.ML.Vw.VowpalWabbitClassifier.GetPredictionIdCol ( )

Gets predictionIdCol value

Returns: predictionIdCol: The ID column returned for predictions

◆ GetProbabilityCol()

string Synapse.ML.Vw.VowpalWabbitClassifier.GetProbabilityCol ( )

Gets probabilityCol value

Returns: probabilityCol: Column name for predicted class conditional probabilities. Note: Not all models output well-calibrated probability estimates! These probabilities should be treated as confidences, not precise probabilities

◆ GetRawPredictionCol()

string Synapse.ML.Vw.VowpalWabbitClassifier.GetRawPredictionCol ( )

Gets rawPredictionCol value

Returns: rawPredictionCol: raw prediction (a.k.a. confidence) column name

◆ GetSplitCol()

string Synapse.ML.Vw.VowpalWabbitClassifier.GetSplitCol ( )

Gets splitCol value

Returns: splitCol: The column to split on for inter-pass sync

◆ GetSplitColValues()

string [] Synapse.ML.Vw.VowpalWabbitClassifier.GetSplitColValues ( )

Gets splitColValues value

Returns: splitColValues: Sorted values to use to select each split to train on. If not specified, computed from data

◆ GetThresholds()

double [] Synapse.ML.Vw.VowpalWabbitClassifier.GetThresholds ( )

Gets thresholds value

Returns: thresholds: Thresholds in multi-class classification to adjust the probability of predicting each class. Array must have length equal to the number of classes, with values > 0 excepting that at most one value may be 0. The class with largest value p/t is predicted, where p is the original probability of that class and t is the class's threshold

◆ GetUseBarrierExecutionMode()

bool Synapse.ML.Vw.VowpalWabbitClassifier.GetUseBarrierExecutionMode ( )

Gets useBarrierExecutionMode value

Returns: useBarrierExecutionMode: Use barrier execution mode, on by default.

◆ GetWeightCol()

string Synapse.ML.Vw.VowpalWabbitClassifier.GetWeightCol ( )

Gets weightCol value

Returns: weightCol: The name of the weight column

◆ Load()

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

static

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

Parameters

path	The path the previous VowpalWabbitClassifier was saved to

Returns: New VowpalWabbitClassifier object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<VowpalWabbitClassifier> instance for this ML instance.

◆ Save()

void Synapse.ML.Vw.VowpalWabbitClassifier.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

path	The path to save the object to

◆ SetAdditionalFeatures()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetAdditionalFeatures ( string[] value )

Sets value for additionalFeatures

Parameters

value Additional feature columns

Returns: New VowpalWabbitClassifier object

◆ SetFeaturesCol()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetFeaturesCol ( string value )

Sets value for featuresCol

Parameters

value features column name

Returns: New VowpalWabbitClassifier object

◆ SetHashSeed()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetHashSeed ( int value )

Sets value for hashSeed

Parameters

value Seed used for hashing

Returns: New VowpalWabbitClassifier object

◆ SetIgnoreNamespaces()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetIgnoreNamespaces ( string value )

Sets value for ignoreNamespaces

Parameters

value Namespaces to be ignored (first letter only)

Returns: New VowpalWabbitClassifier object

◆ SetInitialModel()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetInitialModel ( object value )

Sets value for initialModel

Parameters

value Initial model to start from

Returns: New VowpalWabbitClassifier object

◆ SetInteractions()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetInteractions ( string[] value )

Sets value for interactions

Parameters

value Interaction terms as specified by -q

Returns: New VowpalWabbitClassifier object

◆ SetL1()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetL1 ( double value )

Sets value for l1

Parameters

value l_1 lambda

Returns: New VowpalWabbitClassifier object

◆ SetL2()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetL2 ( double value )

Sets value for l2

Parameters

value l_2 lambda

Returns: New VowpalWabbitClassifier object

◆ SetLabelCol()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetLabelCol ( string value )

Sets value for labelCol

Parameters

value label column name

Returns: New VowpalWabbitClassifier object

◆ SetLabelConversion()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetLabelConversion ( bool value )

Sets value for labelConversion

Parameters

value Convert 0/1 Spark ML style labels to -1/1 VW style labels. Defaults to false.

Returns: New VowpalWabbitClassifier object

◆ SetLearningRate()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetLearningRate ( double value )

Sets value for learningRate

Parameters

value Learning rate

Returns: New VowpalWabbitClassifier object

◆ SetNumBits()

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

Sets value for numBits

Parameters

value Number of bits used

Returns: New VowpalWabbitClassifier object

◆ SetNumClasses()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetNumClasses ( int value )

Sets value for numClasses

Parameters

value Number of classes. Defaults to binary. Needs to match oaa/csoaa/multilabel_oaa/...

Returns: New VowpalWabbitClassifier object

◆ SetNumPasses()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetNumPasses ( int value )

Sets value for numPasses

Parameters

value Number of passes over the data

Returns: New VowpalWabbitClassifier object

◆ SetNumSyncsPerPass()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetNumSyncsPerPass ( int value )

Sets value for numSyncsPerPass

Parameters

value Number of times weights should be synchronized within each pass. 0 disables inter-pass synchronization.

Returns: New VowpalWabbitClassifier object

◆ SetPassThroughArgs()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetPassThroughArgs ( string value )

Sets value for passThroughArgs

Parameters

value VW command line arguments passed

Returns: New VowpalWabbitClassifier object

◆ SetPowerT()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetPowerT ( double value )

Sets value for powerT

Parameters

value t power value

Returns: New VowpalWabbitClassifier object

◆ SetPredictionCol()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetPredictionCol ( string value )

Sets value for predictionCol

Parameters

value prediction column name

Returns: New VowpalWabbitClassifier object

◆ SetPredictionIdCol()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetPredictionIdCol ( string value )

Sets value for predictionIdCol

Parameters

value The ID column returned for predictions

Returns: New VowpalWabbitClassifier object

◆ SetProbabilityCol()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetProbabilityCol ( string value )

Sets value for probabilityCol

Parameters

value Column name for predicted class conditional probabilities. Note: Not all models output well-calibrated probability estimates! These probabilities should be treated as confidences, not precise probabilities

Returns: New VowpalWabbitClassifier object

◆ SetRawPredictionCol()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetRawPredictionCol ( string value )

Sets value for rawPredictionCol

Parameters

value raw prediction (a.k.a. confidence) column name

Returns: New VowpalWabbitClassifier object

◆ SetSplitCol()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetSplitCol ( string value )

Sets value for splitCol

Parameters

value The column to split on for inter-pass sync

Returns: New VowpalWabbitClassifier object

◆ SetSplitColValues()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetSplitColValues ( string[] value )

Sets value for splitColValues

Parameters

value Sorted values to use to select each split to train on. If not specified, computed from data

Returns: New VowpalWabbitClassifier object

◆ SetThresholds()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetThresholds ( double[] value )

Sets value for thresholds

Parameters

value Thresholds in multi-class classification to adjust the probability of predicting each class. Array must have length equal to the number of classes, with values > 0 excepting that at most one value may be 0. The class with largest value p/t is predicted, where p is the original probability of that class and t is the class's threshold

Returns: New VowpalWabbitClassifier object

◆ SetUseBarrierExecutionMode()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetUseBarrierExecutionMode ( bool value )

Sets value for useBarrierExecutionMode

Parameters

value Use barrier execution mode, on by default.

Returns: New VowpalWabbitClassifier object

◆ SetWeightCol()

VowpalWabbitClassifier Synapse.ML.Vw.VowpalWabbitClassifier.SetWeightCol ( string value )

Sets value for weightCol

Parameters

value The name of the weight column

Returns: New VowpalWabbitClassifier object

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

synapse/ml/vw/VowpalWabbitClassifier.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VowpalWabbitClassifier() [1/2]

◆ VowpalWabbitClassifier() [2/2]

Member Function Documentation

◆ Fit()

◆ GetAdditionalFeatures()

◆ GetFeaturesCol()

◆ GetHashSeed()

◆ GetIgnoreNamespaces()

◆ GetInitialModel()

◆ GetInteractions()

◆ GetL1()

◆ GetL2()

◆ GetLabelCol()

◆ GetLabelConversion()

◆ GetLearningRate()

◆ GetNumBits()

◆ GetNumClasses()

◆ GetNumPasses()

◆ GetNumSyncsPerPass()

◆ GetPassThroughArgs()

◆ GetPowerT()

◆ GetPredictionCol()

◆ GetPredictionIdCol()

◆ GetProbabilityCol()

◆ GetRawPredictionCol()

◆ GetSplitCol()

◆ GetSplitColValues()

◆ GetThresholds()

◆ GetUseBarrierExecutionMode()

◆ GetWeightCol()

◆ Load()

◆ Read()

◆ Save()

◆ SetAdditionalFeatures()

◆ SetFeaturesCol()

◆ SetHashSeed()

◆ SetIgnoreNamespaces()

◆ SetInitialModel()

◆ SetInteractions()

◆ SetL1()

◆ SetL2()

◆ SetLabelCol()

◆ SetLabelConversion()

◆ SetLearningRate()

◆ SetNumBits()

◆ SetNumClasses()

◆ SetNumPasses()

◆ SetNumSyncsPerPass()

◆ SetPassThroughArgs()

◆ SetPowerT()

◆ SetPredictionCol()

◆ SetPredictionIdCol()

◆ SetProbabilityCol()

◆ SetRawPredictionCol()

◆ SetSplitCol()

◆ SetSplitColValues()

◆ SetThresholds()

◆ SetUseBarrierExecutionMode()

◆ SetWeightCol()