Synapse.ML.Vw.VowpalWabbitGenericModel Class Reference

VowpalWabbitGenericModel implements VowpalWabbitGenericModel More...

Inheritance diagram for Synapse.ML.Vw.VowpalWabbitGenericModel:

Collaboration diagram for Synapse.ML.Vw.VowpalWabbitGenericModel:

Public Member Functions
	VowpalWabbitGenericModel ()
	Creates a VowpalWabbitGenericModel without any parameters. More...
	VowpalWabbitGenericModel (string uid)
	Creates a VowpalWabbitGenericModel with a UID that is used to give the VowpalWabbitGenericModel a unique ID. More...
VowpalWabbitGenericModel	SetInputCol (string value)
	Sets value for inputCol More...
VowpalWabbitGenericModel	SetModel (object value)
	Sets value for model More...
VowpalWabbitGenericModel	SetOneStepAheadPredictions (DataFrame value)
	Sets value for oneStepAheadPredictions More...
VowpalWabbitGenericModel	SetPerformanceStatistics (DataFrame value)
	Sets value for performanceStatistics More...
VowpalWabbitGenericModel	SetTestArgs (string value)
	Sets value for testArgs More...
string	GetInputCol ()
	Gets inputCol value More...
object	GetModel ()
	Gets model value More...
DataFrame	GetOneStepAheadPredictions ()
	Gets oneStepAheadPredictions value More...
DataFrame	GetPerformanceStatistics ()
	Gets performanceStatistics value More...
string	GetTestArgs ()
	Gets testArgs 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< VowpalWabbitGenericModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

VowpalWabbitGenericModel implements VowpalWabbitGenericModel

Constructor & Destructor Documentation

VowpalWabbitGenericModel() [1/2]

Synapse.ML.Vw.VowpalWabbitGenericModel.VowpalWabbitGenericModel ( )

inline

Creates a VowpalWabbitGenericModel without any parameters.

VowpalWabbitGenericModel() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetInputCol()

string Synapse.ML.Vw.VowpalWabbitGenericModel.GetInputCol

(

)

Gets inputCol value

Returns

inputCol: The name of the input column

GetModel()

object Synapse.ML.Vw.VowpalWabbitGenericModel.GetModel

(

)

Gets model value

Returns

model: The VW model....

GetOneStepAheadPredictions()

DataFrame Synapse.ML.Vw.VowpalWabbitGenericModel.GetOneStepAheadPredictions

(

)

Gets oneStepAheadPredictions value

Returns

oneStepAheadPredictions: 1-step ahead predictions collected during training

GetPerformanceStatistics()

DataFrame Synapse.ML.Vw.VowpalWabbitGenericModel.GetPerformanceStatistics

(

)

Gets performanceStatistics value

Returns

performanceStatistics: Performance statistics collected during training

GetTestArgs()

string Synapse.ML.Vw.VowpalWabbitGenericModel.GetTestArgs

(

)

Gets testArgs value

Returns

testArgs: Additional arguments passed to VW at test time

Load()

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

static

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

Parameters

path	The path the previous VowpalWabbitGenericModel was saved to

Returns

New VowpalWabbitGenericModel object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<VowpalWabbitGenericModel> instance for this ML instance.

Save()

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

SetInputCol()

VowpalWabbitGenericModel Synapse.ML.Vw.VowpalWabbitGenericModel.SetInputCol

(

string

value

)

Sets value for inputCol

Parameters

value

The name of the input column

Returns

New VowpalWabbitGenericModel object

SetModel()

VowpalWabbitGenericModel Synapse.ML.Vw.VowpalWabbitGenericModel.SetModel

(

object

value

)

Sets value for model

Parameters

value

The VW model....

Returns

New VowpalWabbitGenericModel object

SetOneStepAheadPredictions()

VowpalWabbitGenericModel Synapse.ML.Vw.VowpalWabbitGenericModel.SetOneStepAheadPredictions

(

DataFrame

value

)

Sets value for oneStepAheadPredictions

Parameters

value

1-step ahead predictions collected during training

Returns

New VowpalWabbitGenericModel object

SetPerformanceStatistics()

VowpalWabbitGenericModel Synapse.ML.Vw.VowpalWabbitGenericModel.SetPerformanceStatistics

(

DataFrame

value

)

Sets value for performanceStatistics

Parameters

value

Performance statistics collected during training

Returns

New VowpalWabbitGenericModel object

SetTestArgs()

VowpalWabbitGenericModel Synapse.ML.Vw.VowpalWabbitGenericModel.SetTestArgs

(

string

value

)

Sets value for testArgs

Parameters

value

Additional arguments passed to VW at test time

Returns

New VowpalWabbitGenericModel object

---

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

• synapse/ml/vw/VowpalWabbitGenericModel.cs