Synapse.ML.Vw.VowpalWabbitContextualBandit Class Reference

VowpalWabbitContextualBandit implements VowpalWabbitContextualBandit More...

Inheritance diagram for Synapse.ML.Vw.VowpalWabbitContextualBandit:

Collaboration diagram for Synapse.ML.Vw.VowpalWabbitContextualBandit:

Public Member Functions
	VowpalWabbitContextualBandit ()
	Creates a VowpalWabbitContextualBandit without any parameters. More...
	VowpalWabbitContextualBandit (string uid)
	Creates a VowpalWabbitContextualBandit with a UID that is used to give the VowpalWabbitContextualBandit a unique ID. More...
VowpalWabbitContextualBandit	SetAdditionalFeatures (string[] value)
	Sets value for additionalFeatures More...
VowpalWabbitContextualBandit	SetAdditionalSharedFeatures (string[] value)
	Sets value for additionalSharedFeatures More...
VowpalWabbitContextualBandit	SetChosenActionCol (string value)
	Sets value for chosenActionCol More...
VowpalWabbitContextualBandit	SetEpsilon (double value)
	Sets value for epsilon More...
VowpalWabbitContextualBandit	SetFeaturesCol (string value)
	Sets value for featuresCol More...
VowpalWabbitContextualBandit	SetHashSeed (int value)
	Sets value for hashSeed More...
VowpalWabbitContextualBandit	SetIgnoreNamespaces (string value)
	Sets value for ignoreNamespaces More...
VowpalWabbitContextualBandit	SetInitialModel (object value)
	Sets value for initialModel More...
VowpalWabbitContextualBandit	SetInteractions (string[] value)
	Sets value for interactions More...
VowpalWabbitContextualBandit	SetL1 (double value)
	Sets value for l1 More...
VowpalWabbitContextualBandit	SetL2 (double value)
	Sets value for l2 More...
VowpalWabbitContextualBandit	SetLabelCol (string value)
	Sets value for labelCol More...
VowpalWabbitContextualBandit	SetLearningRate (double value)
	Sets value for learningRate More...
VowpalWabbitContextualBandit	SetNumBits (int value)
	Sets value for numBits More...
VowpalWabbitContextualBandit	SetNumPasses (int value)
	Sets value for numPasses More...
VowpalWabbitContextualBandit	SetNumSyncsPerPass (int value)
	Sets value for numSyncsPerPass More...
VowpalWabbitContextualBandit	SetParallelism (int value)
	Sets value for parallelism More...
VowpalWabbitContextualBandit	SetPassThroughArgs (string value)
	Sets value for passThroughArgs More...
VowpalWabbitContextualBandit	SetPowerT (double value)
	Sets value for powerT More...
VowpalWabbitContextualBandit	SetPredictionCol (string value)
	Sets value for predictionCol More...
VowpalWabbitContextualBandit	SetPredictionIdCol (string value)
	Sets value for predictionIdCol More...
VowpalWabbitContextualBandit	SetProbabilityCol (string value)
	Sets value for probabilityCol More...
VowpalWabbitContextualBandit	SetSharedCol (string value)
	Sets value for sharedCol More...
VowpalWabbitContextualBandit	SetSplitCol (string value)
	Sets value for splitCol More...
VowpalWabbitContextualBandit	SetSplitColValues (string[] value)
	Sets value for splitColValues More...
VowpalWabbitContextualBandit	SetUseBarrierExecutionMode (bool value)
	Sets value for useBarrierExecutionMode More...
VowpalWabbitContextualBandit	SetWeightCol (string value)
	Sets value for weightCol More...
string[]	GetAdditionalFeatures ()
	Gets additionalFeatures value More...
string[]	GetAdditionalSharedFeatures ()
	Gets additionalSharedFeatures value More...
string	GetChosenActionCol ()
	Gets chosenActionCol value More...
double	GetEpsilon ()
	Gets epsilon 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...
int	GetNumBits ()
	Gets numBits value More...
int	GetNumPasses ()
	Gets numPasses value More...
int	GetNumSyncsPerPass ()
	Gets numSyncsPerPass value More...
int	GetParallelism ()
	Gets parallelism 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	GetSharedCol ()
	Gets sharedCol value More...
string	GetSplitCol ()
	Gets splitCol value More...
string[]	GetSplitColValues ()
	Gets splitColValues value More...
bool	GetUseBarrierExecutionMode ()
	Gets useBarrierExecutionMode value More...
string	GetWeightCol ()
	Gets weightCol value More...
override VowpalWabbitContextualBanditModel	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< VowpalWabbitContextualBandit >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

VowpalWabbitContextualBandit implements VowpalWabbitContextualBandit

Constructor & Destructor Documentation

VowpalWabbitContextualBandit() [1/2]

Synapse.ML.Vw.VowpalWabbitContextualBandit.VowpalWabbitContextualBandit ( )

inline

Creates a VowpalWabbitContextualBandit without any parameters.

VowpalWabbitContextualBandit() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

Fit()

override VowpalWabbitContextualBanditModel Synapse.ML.Vw.VowpalWabbitContextualBandit.Fit

(

DataFrame

dataset

)

Fits a model to the input data.

Parameters

dataset

The DataFrame to fit the model to.

Returns

VowpalWabbitContextualBanditModel

GetAdditionalFeatures()

string [] Synapse.ML.Vw.VowpalWabbitContextualBandit.GetAdditionalFeatures

(

)

Gets additionalFeatures value

Returns

additionalFeatures: Additional feature columns

GetAdditionalSharedFeatures()

string [] Synapse.ML.Vw.VowpalWabbitContextualBandit.GetAdditionalSharedFeatures

(

)

Gets additionalSharedFeatures value

Returns

additionalSharedFeatures: Additional namespaces for the shared example

GetChosenActionCol()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetChosenActionCol

(

)

Gets chosenActionCol value

Returns

chosenActionCol: Column name of chosen action

GetEpsilon()

double Synapse.ML.Vw.VowpalWabbitContextualBandit.GetEpsilon

(

)

Gets epsilon value

Returns

epsilon: epsilon used for exploration

GetFeaturesCol()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetFeaturesCol

(

)

Gets featuresCol value

Returns

featuresCol: features column name

GetHashSeed()

int Synapse.ML.Vw.VowpalWabbitContextualBandit.GetHashSeed

(

)

Gets hashSeed value

Returns

hashSeed: Seed used for hashing

GetIgnoreNamespaces()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetIgnoreNamespaces

(

)

Gets ignoreNamespaces value

Returns

ignoreNamespaces: Namespaces to be ignored (first letter only)

GetInitialModel()

object Synapse.ML.Vw.VowpalWabbitContextualBandit.GetInitialModel

(

)

Gets initialModel value

Returns

initialModel: Initial model to start from

GetInteractions()

string [] Synapse.ML.Vw.VowpalWabbitContextualBandit.GetInteractions

(

)

Gets interactions value

Returns

interactions: Interaction terms as specified by -q

GetL1()

double Synapse.ML.Vw.VowpalWabbitContextualBandit.GetL1

(

)

Gets l1 value

Returns

l1: l_1 lambda

GetL2()

double Synapse.ML.Vw.VowpalWabbitContextualBandit.GetL2

(

)

Gets l2 value

Returns

l2: l_2 lambda

GetLabelCol()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetLabelCol

(

)

Gets labelCol value

Returns

labelCol: label column name

GetLearningRate()

double Synapse.ML.Vw.VowpalWabbitContextualBandit.GetLearningRate

(

)

Gets learningRate value

Returns

learningRate: Learning rate

GetNumBits()

int Synapse.ML.Vw.VowpalWabbitContextualBandit.GetNumBits

(

)

Gets numBits value

Returns

numBits: Number of bits used

GetNumPasses()

int Synapse.ML.Vw.VowpalWabbitContextualBandit.GetNumPasses

(

)

Gets numPasses value

Returns

numPasses: Number of passes over the data

GetNumSyncsPerPass()

int Synapse.ML.Vw.VowpalWabbitContextualBandit.GetNumSyncsPerPass

(

)

Gets numSyncsPerPass value

Returns

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

GetParallelism()

int Synapse.ML.Vw.VowpalWabbitContextualBandit.GetParallelism

(

)

Gets parallelism value

Returns

parallelism: the number of threads to use when running parallel algorithms

GetPassThroughArgs()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetPassThroughArgs

(

)

Gets passThroughArgs value

Returns

passThroughArgs: VW command line arguments passed

GetPowerT()

double Synapse.ML.Vw.VowpalWabbitContextualBandit.GetPowerT

(

)

Gets powerT value

Returns

powerT: t power value

GetPredictionCol()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetPredictionCol

(

)

Gets predictionCol value

Returns

predictionCol: prediction column name

GetPredictionIdCol()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetPredictionIdCol

(

)

Gets predictionIdCol value

Returns

predictionIdCol: The ID column returned for predictions

GetProbabilityCol()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetProbabilityCol

(

)

Gets probabilityCol value

Returns

probabilityCol: Column name of probability of chosen action

GetSharedCol()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetSharedCol

(

)

Gets sharedCol value

Returns

sharedCol: Column name of shared features

GetSplitCol()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetSplitCol

(

)

Gets splitCol value

Returns

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

GetSplitColValues()

string [] Synapse.ML.Vw.VowpalWabbitContextualBandit.GetSplitColValues

(

)

Gets splitColValues value

Returns

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

GetUseBarrierExecutionMode()

bool Synapse.ML.Vw.VowpalWabbitContextualBandit.GetUseBarrierExecutionMode

(

)

Gets useBarrierExecutionMode value

Returns

useBarrierExecutionMode: Use barrier execution mode, on by default.

GetWeightCol()

string Synapse.ML.Vw.VowpalWabbitContextualBandit.GetWeightCol

(

)

Gets weightCol value

Returns

weightCol: The name of the weight column

Load()

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

static

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

Parameters

path	The path the previous VowpalWabbitContextualBandit was saved to

Returns

New VowpalWabbitContextualBandit object, loaded from path.

Read()

JavaMLReader<VowpalWabbitContextualBandit> Synapse.ML.Vw.VowpalWabbitContextualBandit.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<VowpalWabbitContextualBandit> instance for this ML instance.

Save()

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

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetAdditionalFeatures

(

string[]

value

)

Sets value for additionalFeatures

Parameters

value

Additional feature columns

Returns

New VowpalWabbitContextualBandit object

SetAdditionalSharedFeatures()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetAdditionalSharedFeatures

(

string[]

value

)

Sets value for additionalSharedFeatures

Parameters

value

Additional namespaces for the shared example

Returns

New VowpalWabbitContextualBandit object

SetChosenActionCol()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetChosenActionCol

(

string

value

)

Sets value for chosenActionCol

Parameters

value

Column name of chosen action

Returns

New VowpalWabbitContextualBandit object

SetEpsilon()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetEpsilon

(

double

value

)

Sets value for epsilon

Parameters

value

epsilon used for exploration

Returns

New VowpalWabbitContextualBandit object

SetFeaturesCol()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetFeaturesCol

(

string

value

)

Sets value for featuresCol

Parameters

value

features column name

Returns

New VowpalWabbitContextualBandit object

SetHashSeed()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetHashSeed

(

int

value

)

Sets value for hashSeed

Parameters

value

Seed used for hashing

Returns

New VowpalWabbitContextualBandit object

SetIgnoreNamespaces()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetIgnoreNamespaces

(

string

value

)

Sets value for ignoreNamespaces

Parameters

value

Namespaces to be ignored (first letter only)

Returns

New VowpalWabbitContextualBandit object

SetInitialModel()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetInitialModel

(

object

value

)

Sets value for initialModel

Parameters

value

Initial model to start from

Returns

New VowpalWabbitContextualBandit object

SetInteractions()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetInteractions

(

string[]

value

)

Sets value for interactions

Parameters

value

Interaction terms as specified by -q

Returns

New VowpalWabbitContextualBandit object

SetL1()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetL1

(

double

value

)

Sets value for l1

Parameters

value

l_1 lambda

Returns

New VowpalWabbitContextualBandit object

SetL2()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetL2

(

double

value

)

Sets value for l2

Parameters

value

l_2 lambda

Returns

New VowpalWabbitContextualBandit object

SetLabelCol()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetLabelCol

(

string

value

)

Sets value for labelCol

Parameters

value

label column name

Returns

New VowpalWabbitContextualBandit object

SetLearningRate()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetLearningRate

(

double

value

)

Sets value for learningRate

Parameters

value

Learning rate

Returns

New VowpalWabbitContextualBandit object

SetNumBits()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetNumBits

(

int

value

)

Sets value for numBits

Parameters

value

Number of bits used

Returns

New VowpalWabbitContextualBandit object

SetNumPasses()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetNumPasses

(

int

value

)

Sets value for numPasses

Parameters

value

Number of passes over the data

Returns

New VowpalWabbitContextualBandit object

SetNumSyncsPerPass()

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

SetParallelism()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetParallelism

(

int

value

)

Sets value for parallelism

Parameters

value

the number of threads to use when running parallel algorithms

Returns

New VowpalWabbitContextualBandit object

SetPassThroughArgs()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetPassThroughArgs

(

string

value

)

Sets value for passThroughArgs

Parameters

value

VW command line arguments passed

Returns

New VowpalWabbitContextualBandit object

SetPowerT()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetPowerT

(

double

value

)

Sets value for powerT

Parameters

value

t power value

Returns

New VowpalWabbitContextualBandit object

SetPredictionCol()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetPredictionCol

(

string

value

)

Sets value for predictionCol

Parameters

value

prediction column name

Returns

New VowpalWabbitContextualBandit object

SetPredictionIdCol()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetPredictionIdCol

(

string

value

)

Sets value for predictionIdCol

Parameters

value

The ID column returned for predictions

Returns

New VowpalWabbitContextualBandit object

SetProbabilityCol()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetProbabilityCol

(

string

value

)

Sets value for probabilityCol

Parameters

value

Column name of probability of chosen action

Returns

New VowpalWabbitContextualBandit object

SetSharedCol()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetSharedCol

(

string

value

)

Sets value for sharedCol

Parameters

value

Column name of shared features

Returns

New VowpalWabbitContextualBandit object

SetSplitCol()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetSplitCol

(

string

value

)

Sets value for splitCol

Parameters

value

The column to split on for inter-pass sync

Returns

New VowpalWabbitContextualBandit object

SetSplitColValues()

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

SetUseBarrierExecutionMode()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetUseBarrierExecutionMode

(

bool

value

)

Sets value for useBarrierExecutionMode

Parameters

value

Use barrier execution mode, on by default.

Returns

New VowpalWabbitContextualBandit object

SetWeightCol()

VowpalWabbitContextualBandit Synapse.ML.Vw.VowpalWabbitContextualBandit.SetWeightCol

(

string

value

)

Sets value for weightCol

Parameters

value

The name of the weight column

Returns

New VowpalWabbitContextualBandit object

---

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

• synapse/ml/vw/VowpalWabbitContextualBandit.cs