Synapse.ML.Vw.VowpalWabbitGeneric Class Reference

VowpalWabbitGeneric implements VowpalWabbitGeneric More...

Inheritance diagram for Synapse.ML.Vw.VowpalWabbitGeneric:

Collaboration diagram for Synapse.ML.Vw.VowpalWabbitGeneric:

Public Member Functions
	VowpalWabbitGeneric ()
	Creates a VowpalWabbitGeneric without any parameters. More...
	VowpalWabbitGeneric (string uid)
	Creates a VowpalWabbitGeneric with a UID that is used to give the VowpalWabbitGeneric a unique ID. More...
VowpalWabbitGeneric	SetHashSeed (int value)
	Sets value for hashSeed More...
VowpalWabbitGeneric	SetIgnoreNamespaces (string value)
	Sets value for ignoreNamespaces More...
VowpalWabbitGeneric	SetInitialModel (object value)
	Sets value for initialModel More...
VowpalWabbitGeneric	SetInputCol (string value)
	Sets value for inputCol More...
VowpalWabbitGeneric	SetInteractions (string[] value)
	Sets value for interactions More...
VowpalWabbitGeneric	SetL1 (double value)
	Sets value for l1 More...
VowpalWabbitGeneric	SetL2 (double value)
	Sets value for l2 More...
VowpalWabbitGeneric	SetLearningRate (double value)
	Sets value for learningRate More...
VowpalWabbitGeneric	SetNumBits (int value)
	Sets value for numBits More...
VowpalWabbitGeneric	SetNumPasses (int value)
	Sets value for numPasses More...
VowpalWabbitGeneric	SetNumSyncsPerPass (int value)
	Sets value for numSyncsPerPass More...
VowpalWabbitGeneric	SetPassThroughArgs (string value)
	Sets value for passThroughArgs More...
VowpalWabbitGeneric	SetPowerT (double value)
	Sets value for powerT More...
VowpalWabbitGeneric	SetPredictionIdCol (string value)
	Sets value for predictionIdCol More...
VowpalWabbitGeneric	SetSplitCol (string value)
	Sets value for splitCol More...
VowpalWabbitGeneric	SetSplitColValues (string[] value)
	Sets value for splitColValues More...
VowpalWabbitGeneric	SetUseBarrierExecutionMode (bool value)
	Sets value for useBarrierExecutionMode More...
int	GetHashSeed ()
	Gets hashSeed value More...
string	GetIgnoreNamespaces ()
	Gets ignoreNamespaces value More...
object	GetInitialModel ()
	Gets initialModel value More...
string	GetInputCol ()
	Gets inputCol value More...
string[]	GetInteractions ()
	Gets interactions value More...
double	GetL1 ()
	Gets l1 value More...
double	GetL2 ()
	Gets l2 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...
string	GetPassThroughArgs ()
	Gets passThroughArgs value More...
double	GetPowerT ()
	Gets powerT value More...
string	GetPredictionIdCol ()
	Gets predictionIdCol value More...
string	GetSplitCol ()
	Gets splitCol value More...
string[]	GetSplitColValues ()
	Gets splitColValues value More...
bool	GetUseBarrierExecutionMode ()
	Gets useBarrierExecutionMode value More...
override VowpalWabbitGenericModel	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< VowpalWabbitGeneric >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

VowpalWabbitGeneric implements VowpalWabbitGeneric

Constructor & Destructor Documentation

VowpalWabbitGeneric() [1/2]

Synapse.ML.Vw.VowpalWabbitGeneric.VowpalWabbitGeneric ( )

inline

Creates a VowpalWabbitGeneric without any parameters.

VowpalWabbitGeneric() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

Fit()

override VowpalWabbitGenericModel Synapse.ML.Vw.VowpalWabbitGeneric.Fit

(

DataFrame

dataset

)

Fits a model to the input data.

Parameters

dataset

The DataFrame to fit the model to.

Returns

VowpalWabbitGenericModel

GetHashSeed()

int Synapse.ML.Vw.VowpalWabbitGeneric.GetHashSeed

(

)

Gets hashSeed value

Returns

hashSeed: Seed used for hashing

GetIgnoreNamespaces()

string Synapse.ML.Vw.VowpalWabbitGeneric.GetIgnoreNamespaces

(

)

Gets ignoreNamespaces value

Returns

ignoreNamespaces: Namespaces to be ignored (first letter only)

GetInitialModel()

object Synapse.ML.Vw.VowpalWabbitGeneric.GetInitialModel

(

)

Gets initialModel value

Returns

initialModel: Initial model to start from

GetInputCol()

string Synapse.ML.Vw.VowpalWabbitGeneric.GetInputCol

(

)

Gets inputCol value

Returns

inputCol: The name of the input column

GetInteractions()

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

(

)

Gets interactions value

Returns

interactions: Interaction terms as specified by -q

GetL1()

double Synapse.ML.Vw.VowpalWabbitGeneric.GetL1

(

)

Gets l1 value

Returns

l1: l_1 lambda

GetL2()

double Synapse.ML.Vw.VowpalWabbitGeneric.GetL2

(

)

Gets l2 value

Returns

l2: l_2 lambda

GetLearningRate()

double Synapse.ML.Vw.VowpalWabbitGeneric.GetLearningRate

(

)

Gets learningRate value

Returns

learningRate: Learning rate

GetNumBits()

int Synapse.ML.Vw.VowpalWabbitGeneric.GetNumBits

(

)

Gets numBits value

Returns

numBits: Number of bits used

GetNumPasses()

int Synapse.ML.Vw.VowpalWabbitGeneric.GetNumPasses

(

)

Gets numPasses value

Returns

numPasses: Number of passes over the data

GetNumSyncsPerPass()

int Synapse.ML.Vw.VowpalWabbitGeneric.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.VowpalWabbitGeneric.GetPassThroughArgs

(

)

Gets passThroughArgs value

Returns

passThroughArgs: VW command line arguments passed

GetPowerT()

double Synapse.ML.Vw.VowpalWabbitGeneric.GetPowerT

(

)

Gets powerT value

Returns

powerT: t power value

GetPredictionIdCol()

string Synapse.ML.Vw.VowpalWabbitGeneric.GetPredictionIdCol

(

)

Gets predictionIdCol value

Returns

predictionIdCol: The ID column returned for predictions

GetSplitCol()

string Synapse.ML.Vw.VowpalWabbitGeneric.GetSplitCol

(

)

Gets splitCol value

Returns

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

GetSplitColValues()

string [] Synapse.ML.Vw.VowpalWabbitGeneric.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.VowpalWabbitGeneric.GetUseBarrierExecutionMode

(

)

Gets useBarrierExecutionMode value

Returns

useBarrierExecutionMode: Use barrier execution mode, on by default.

Load()

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

static

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

Parameters

path	The path the previous VowpalWabbitGeneric was saved to

Returns

New VowpalWabbitGeneric object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<VowpalWabbitGeneric> instance for this ML instance.

Save()

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

SetHashSeed()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetHashSeed

(

int

value

)

Sets value for hashSeed

Parameters

value

Seed used for hashing

Returns

New VowpalWabbitGeneric object

SetIgnoreNamespaces()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetIgnoreNamespaces

(

string

value

)

Sets value for ignoreNamespaces

Parameters

value

Namespaces to be ignored (first letter only)

Returns

New VowpalWabbitGeneric object

SetInitialModel()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetInitialModel

(

object

value

)

Sets value for initialModel

Parameters

value

Initial model to start from

Returns

New VowpalWabbitGeneric object

SetInputCol()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetInputCol

(

string

value

)

Sets value for inputCol

Parameters

value

The name of the input column

Returns

New VowpalWabbitGeneric object

SetInteractions()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetInteractions

(

string[]

value

)

Sets value for interactions

Parameters

value

Interaction terms as specified by -q

Returns

New VowpalWabbitGeneric object

SetL1()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetL1

(

double

value

)

Sets value for l1

Parameters

value

l_1 lambda

Returns

New VowpalWabbitGeneric object

SetL2()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetL2

(

double

value

)

Sets value for l2

Parameters

value

l_2 lambda

Returns

New VowpalWabbitGeneric object

SetLearningRate()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetLearningRate

(

double

value

)

Sets value for learningRate

Parameters

value

Learning rate

Returns

New VowpalWabbitGeneric object

SetNumBits()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetNumBits

(

int

value

)

Sets value for numBits

Parameters

value

Number of bits used

Returns

New VowpalWabbitGeneric object

SetNumPasses()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetNumPasses

(

int

value

)

Sets value for numPasses

Parameters

value

Number of passes over the data

Returns

New VowpalWabbitGeneric object

SetNumSyncsPerPass()

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

SetPassThroughArgs()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetPassThroughArgs

(

string

value

)

Sets value for passThroughArgs

Parameters

value

VW command line arguments passed

Returns

New VowpalWabbitGeneric object

SetPowerT()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetPowerT

(

double

value

)

Sets value for powerT

Parameters

value

t power value

Returns

New VowpalWabbitGeneric object

SetPredictionIdCol()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetPredictionIdCol

(

string

value

)

Sets value for predictionIdCol

Parameters

value

The ID column returned for predictions

Returns

New VowpalWabbitGeneric object

SetSplitCol()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetSplitCol

(

string

value

)

Sets value for splitCol

Parameters

value

The column to split on for inter-pass sync

Returns

New VowpalWabbitGeneric object

SetSplitColValues()

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

SetUseBarrierExecutionMode()

VowpalWabbitGeneric Synapse.ML.Vw.VowpalWabbitGeneric.SetUseBarrierExecutionMode

(

bool

value

)

Sets value for useBarrierExecutionMode

Parameters

value

Use barrier execution mode, on by default.

Returns

New VowpalWabbitGeneric object

---

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

• synapse/ml/vw/VowpalWabbitGeneric.cs