VowpalWabbitContextualBanditModel implements VowpalWabbitContextualBanditModel More...

Inheritance diagram for Synapse.ML.Vw.VowpalWabbitContextualBanditModel:

[legend]

Collaboration diagram for Synapse.ML.Vw.VowpalWabbitContextualBanditModel:

[legend]

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

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

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

VowpalWabbitContextualBanditModel	SetAdditionalSharedFeatures (string[] value)
	Sets value for additionalSharedFeatures More...

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

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

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

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

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

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

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

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

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

VowpalWabbitContextualBanditModel	SetModel (object value)
	Sets value for model More...

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

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

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

VowpalWabbitContextualBanditModel	SetOneStepAheadPredictions (DataFrame value)
	Sets value for oneStepAheadPredictions More...

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

VowpalWabbitContextualBanditModel	SetPerformanceStatistics (DataFrame value)
	Sets value for performanceStatistics More...

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

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

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

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

VowpalWabbitContextualBanditModel	SetSharedCol (string value)
	Sets value for sharedCol More...

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

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

VowpalWabbitContextualBanditModel	SetTestArgs (string value)
	Sets value for testArgs More...

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

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

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

string[]	GetAdditionalSharedFeatures ()
	Gets additionalSharedFeatures 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...

double	GetLearningRate ()
	Gets learningRate value More...

object	GetModel ()
	Gets model value More...

int	GetNumBits ()
	Gets numBits value More...

int	GetNumPasses ()
	Gets numPasses value More...

int	GetNumSyncsPerPass ()
	Gets numSyncsPerPass value More...

DataFrame	GetOneStepAheadPredictions ()
	Gets oneStepAheadPredictions value More...

string	GetPassThroughArgs ()
	Gets passThroughArgs value More...

DataFrame	GetPerformanceStatistics ()
	Gets performanceStatistics value More...

double	GetPowerT ()
	Gets powerT value More...

string	GetPredictionCol ()
	Gets predictionCol value More...

string	GetPredictionIdCol ()
	Gets predictionIdCol value More...

string	GetRawPredictionCol ()
	Gets rawPredictionCol value More...

string	GetSharedCol ()
	Gets sharedCol value More...

string	GetSplitCol ()
	Gets splitCol value More...

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

string	GetTestArgs ()
	Gets testArgs value More...

bool	GetUseBarrierExecutionMode ()
	Gets useBarrierExecutionMode value More...

string	GetWeightCol ()
	Gets weightCol 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< VowpalWabbitContextualBanditModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

VowpalWabbitContextualBanditModel implements VowpalWabbitContextualBanditModel

Constructor & Destructor Documentation

◆ VowpalWabbitContextualBanditModel() [1/2]

Synapse.ML.Vw.VowpalWabbitContextualBanditModel.VowpalWabbitContextualBanditModel ( )

inline

Creates a VowpalWabbitContextualBanditModel without any parameters.

◆ VowpalWabbitContextualBanditModel() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetAdditionalFeatures()

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

Gets additionalFeatures value

Returns: additionalFeatures: Additional feature columns

◆ GetAdditionalSharedFeatures()

string [] Synapse.ML.Vw.VowpalWabbitContextualBanditModel.GetAdditionalSharedFeatures ( )

Gets additionalSharedFeatures value

Returns: additionalSharedFeatures: Additional namespaces for the shared example

◆ GetFeaturesCol()

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

Gets featuresCol value

Returns: featuresCol: features column name

◆ GetHashSeed()

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

Gets hashSeed value

Returns: hashSeed: Seed used for hashing

◆ GetIgnoreNamespaces()

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

Gets ignoreNamespaces value

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

◆ GetInitialModel()

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

Gets initialModel value

Returns: initialModel: Initial model to start from

◆ GetInteractions()

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

Gets interactions value

Returns: interactions: Interaction terms as specified by -q

◆ GetL1()

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

Gets l1 value

Returns: l1: l_1 lambda

◆ GetL2()

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

Gets l2 value

Returns: l2: l_2 lambda

◆ GetLabelCol()

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

Gets labelCol value

Returns: labelCol: label column name

◆ GetLearningRate()

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

Gets learningRate value

Returns: learningRate: Learning rate

◆ GetModel()

object Synapse.ML.Vw.VowpalWabbitContextualBanditModel.GetModel ( )

Gets model value

Returns: model: The VW model....

◆ GetNumBits()

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

Gets numBits value

Returns: numBits: Number of bits used

◆ GetNumPasses()

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

Gets numPasses value

Returns: numPasses: Number of passes over the data

◆ GetNumSyncsPerPass()

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

Gets numSyncsPerPass value

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

◆ GetOneStepAheadPredictions()

DataFrame Synapse.ML.Vw.VowpalWabbitContextualBanditModel.GetOneStepAheadPredictions ( )

Gets oneStepAheadPredictions value

Returns: oneStepAheadPredictions: 1-step ahead predictions collected during training

◆ GetPassThroughArgs()

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

Gets passThroughArgs value

Returns: passThroughArgs: VW command line arguments passed

◆ GetPerformanceStatistics()

DataFrame Synapse.ML.Vw.VowpalWabbitContextualBanditModel.GetPerformanceStatistics ( )

Gets performanceStatistics value

Returns: performanceStatistics: Performance statistics collected during training

◆ GetPowerT()

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

Gets powerT value

Returns: powerT: t power value

◆ GetPredictionCol()

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

Gets predictionCol value

Returns: predictionCol: prediction column name

◆ GetPredictionIdCol()

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

Gets predictionIdCol value

Returns: predictionIdCol: The ID column returned for predictions

◆ GetRawPredictionCol()

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

Gets rawPredictionCol value

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

◆ GetSharedCol()

string Synapse.ML.Vw.VowpalWabbitContextualBanditModel.GetSharedCol ( )

Gets sharedCol value

Returns: sharedCol: Column name of shared features

◆ GetSplitCol()

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

Gets splitCol value

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

◆ GetSplitColValues()

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

Gets splitColValues value

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

◆ GetTestArgs()

string Synapse.ML.Vw.VowpalWabbitContextualBanditModel.GetTestArgs ( )

Gets testArgs value

Returns: testArgs: Additional arguments passed to VW at test time

◆ GetUseBarrierExecutionMode()

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

Gets useBarrierExecutionMode value

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

◆ GetWeightCol()

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

Gets weightCol value

Returns: weightCol: The name of the weight column

◆ Load()

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

static

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

Parameters

path	The path the previous VowpalWabbitContextualBanditModel was saved to

Returns: New VowpalWabbitContextualBanditModel object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Vw.VowpalWabbitContextualBanditModel.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()

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

Sets value for additionalFeatures

Parameters

value Additional feature columns

Returns: New VowpalWabbitContextualBanditModel object

◆ SetAdditionalSharedFeatures()

VowpalWabbitContextualBanditModel Synapse.ML.Vw.VowpalWabbitContextualBanditModel.SetAdditionalSharedFeatures ( string[] value )

Sets value for additionalSharedFeatures

Parameters

value Additional namespaces for the shared example

Returns: New VowpalWabbitContextualBanditModel object

◆ SetFeaturesCol()

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

Sets value for featuresCol

Parameters

value features column name

Returns: New VowpalWabbitContextualBanditModel object

◆ SetHashSeed()

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

Sets value for hashSeed

Parameters

value Seed used for hashing

Returns: New VowpalWabbitContextualBanditModel object

◆ SetIgnoreNamespaces()

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

Sets value for ignoreNamespaces

Parameters

value Namespaces to be ignored (first letter only)

Returns: New VowpalWabbitContextualBanditModel object

◆ SetInitialModel()

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

Sets value for initialModel

Parameters

value Initial model to start from

Returns: New VowpalWabbitContextualBanditModel object

◆ SetInteractions()

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

Sets value for interactions

Parameters

value Interaction terms as specified by -q

Returns: New VowpalWabbitContextualBanditModel object

◆ SetL1()

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

Sets value for l1

Parameters

value l_1 lambda

Returns: New VowpalWabbitContextualBanditModel object

◆ SetL2()

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

Sets value for l2

Parameters

value l_2 lambda

Returns: New VowpalWabbitContextualBanditModel object

◆ SetLabelCol()

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

Sets value for labelCol

Parameters

value label column name

Returns: New VowpalWabbitContextualBanditModel object

◆ SetLearningRate()

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

Sets value for learningRate

Parameters

value Learning rate

Returns: New VowpalWabbitContextualBanditModel object

◆ SetModel()

VowpalWabbitContextualBanditModel Synapse.ML.Vw.VowpalWabbitContextualBanditModel.SetModel ( object value )

Sets value for model

Parameters

value The VW model....

Returns: New VowpalWabbitContextualBanditModel object

◆ SetNumBits()

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

Sets value for numBits

Parameters

value Number of bits used

Returns: New VowpalWabbitContextualBanditModel object

◆ SetNumPasses()

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

Sets value for numPasses

Parameters

value Number of passes over the data

Returns: New VowpalWabbitContextualBanditModel object

◆ SetNumSyncsPerPass()

VowpalWabbitContextualBanditModel Synapse.ML.Vw.VowpalWabbitContextualBanditModel.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 VowpalWabbitContextualBanditModel object

◆ SetOneStepAheadPredictions()

VowpalWabbitContextualBanditModel Synapse.ML.Vw.VowpalWabbitContextualBanditModel.SetOneStepAheadPredictions ( DataFrame value )

Sets value for oneStepAheadPredictions

Parameters

value 1-step ahead predictions collected during training

Returns: New VowpalWabbitContextualBanditModel object

◆ SetPassThroughArgs()

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

Sets value for passThroughArgs

Parameters

value VW command line arguments passed

Returns: New VowpalWabbitContextualBanditModel object

◆ SetPerformanceStatistics()

VowpalWabbitContextualBanditModel Synapse.ML.Vw.VowpalWabbitContextualBanditModel.SetPerformanceStatistics ( DataFrame value )

Sets value for performanceStatistics

Parameters

value Performance statistics collected during training

Returns: New VowpalWabbitContextualBanditModel object

◆ SetPowerT()

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

Sets value for powerT

Parameters

value t power value

Returns: New VowpalWabbitContextualBanditModel object

◆ SetPredictionCol()

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

Sets value for predictionCol

Parameters

value prediction column name

Returns: New VowpalWabbitContextualBanditModel object

◆ SetPredictionIdCol()

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

Sets value for predictionIdCol

Parameters

value The ID column returned for predictions

Returns: New VowpalWabbitContextualBanditModel object

◆ SetRawPredictionCol()

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

Sets value for rawPredictionCol

Parameters

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

Returns: New VowpalWabbitContextualBanditModel object

◆ SetSharedCol()

VowpalWabbitContextualBanditModel Synapse.ML.Vw.VowpalWabbitContextualBanditModel.SetSharedCol ( string value )

Sets value for sharedCol

Parameters

value Column name of shared features

Returns: New VowpalWabbitContextualBanditModel object

◆ SetSplitCol()

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

Sets value for splitCol

Parameters

value The column to split on for inter-pass sync

Returns: New VowpalWabbitContextualBanditModel object

◆ SetSplitColValues()

VowpalWabbitContextualBanditModel Synapse.ML.Vw.VowpalWabbitContextualBanditModel.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 VowpalWabbitContextualBanditModel object

◆ SetTestArgs()

VowpalWabbitContextualBanditModel Synapse.ML.Vw.VowpalWabbitContextualBanditModel.SetTestArgs ( string value )

Sets value for testArgs

Parameters

value Additional arguments passed to VW at test time

Returns: New VowpalWabbitContextualBanditModel object

◆ SetUseBarrierExecutionMode()

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

Sets value for useBarrierExecutionMode

Parameters

value Use barrier execution mode, on by default.

Returns: New VowpalWabbitContextualBanditModel object

◆ SetWeightCol()

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

Sets value for weightCol

Parameters

value The name of the weight column

Returns: New VowpalWabbitContextualBanditModel object

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

synapse/ml/vw/VowpalWabbitContextualBanditModel.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VowpalWabbitContextualBanditModel() [1/2]

◆ VowpalWabbitContextualBanditModel() [2/2]

Member Function Documentation

◆ GetAdditionalFeatures()

◆ GetAdditionalSharedFeatures()

◆ GetFeaturesCol()

◆ GetHashSeed()

◆ GetIgnoreNamespaces()

◆ GetInitialModel()

◆ GetInteractions()

◆ GetL1()

◆ GetL2()

◆ GetLabelCol()

◆ GetLearningRate()

◆ GetModel()

◆ GetNumBits()

◆ GetNumPasses()

◆ GetNumSyncsPerPass()

◆ GetOneStepAheadPredictions()

◆ GetPassThroughArgs()

◆ GetPerformanceStatistics()

◆ GetPowerT()

◆ GetPredictionCol()

◆ GetPredictionIdCol()

◆ GetRawPredictionCol()

◆ GetSharedCol()

◆ GetSplitCol()

◆ GetSplitColValues()

◆ GetTestArgs()

◆ GetUseBarrierExecutionMode()

◆ GetWeightCol()

◆ Load()

◆ Read()

◆ Save()

◆ SetAdditionalFeatures()

◆ SetAdditionalSharedFeatures()

◆ SetFeaturesCol()

◆ SetHashSeed()

◆ SetIgnoreNamespaces()

◆ SetInitialModel()

◆ SetInteractions()

◆ SetL1()

◆ SetL2()

◆ SetLabelCol()

◆ SetLearningRate()

◆ SetModel()

◆ SetNumBits()

◆ SetNumPasses()

◆ SetNumSyncsPerPass()

◆ SetOneStepAheadPredictions()

◆ SetPassThroughArgs()

◆ SetPerformanceStatistics()

◆ SetPowerT()

◆ SetPredictionCol()

◆ SetPredictionIdCol()

◆ SetRawPredictionCol()

◆ SetSharedCol()

◆ SetSplitCol()

◆ SetSplitColValues()

◆ SetTestArgs()

◆ SetUseBarrierExecutionMode()

◆ SetWeightCol()