Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Vw.VowpalWabbitRegressionModel Class Reference

VowpalWabbitRegressionModel implements VowpalWabbitRegressionModel More...

Inheritance diagram for Synapse.ML.Vw.VowpalWabbitRegressionModel:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Vw.VowpalWabbitRegressionModel:
Collaboration graph
[legend]

Public Member Functions

 VowpalWabbitRegressionModel ()
 Creates a VowpalWabbitRegressionModel without any parameters. More...
 
 VowpalWabbitRegressionModel (string uid)
 Creates a VowpalWabbitRegressionModel with a UID that is used to give the VowpalWabbitRegressionModel a unique ID. More...
 
VowpalWabbitRegressionModel SetAdditionalFeatures (string[] value)
 Sets value for additionalFeatures More...
 
VowpalWabbitRegressionModel SetFeaturesCol (string value)
 Sets value for featuresCol More...
 
VowpalWabbitRegressionModel SetLabelCol (string value)
 Sets value for labelCol More...
 
VowpalWabbitRegressionModel SetModel (object value)
 Sets value for model More...
 
VowpalWabbitRegressionModel SetPerformanceStatistics (DataFrame value)
 Sets value for performanceStatistics More...
 
VowpalWabbitRegressionModel SetPredictionCol (string value)
 Sets value for predictionCol More...
 
VowpalWabbitRegressionModel SetRawPredictionCol (string value)
 Sets value for rawPredictionCol More...
 
VowpalWabbitRegressionModel SetTestArgs (string value)
 Sets value for testArgs More...
 
string [] GetAdditionalFeatures ()
 Gets additionalFeatures value More...
 
string GetFeaturesCol ()
 Gets featuresCol value More...
 
string GetLabelCol ()
 Gets labelCol value More...
 
object GetModel ()
 Gets model value More...
 
DataFrame GetPerformanceStatistics ()
 Gets performanceStatistics value More...
 
string GetPredictionCol ()
 Gets predictionCol value More...
 
string GetRawPredictionCol ()
 Gets rawPredictionCol 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< VowpalWabbitRegressionModelRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

static VowpalWabbitRegressionModel Load (string path)
 Loads the VowpalWabbitRegressionModel that was previously saved using Save(string). More...
 

Detailed Description

VowpalWabbitRegressionModel implements VowpalWabbitRegressionModel

Constructor & Destructor Documentation

◆ VowpalWabbitRegressionModel() [1/2]

Synapse.ML.Vw.VowpalWabbitRegressionModel.VowpalWabbitRegressionModel ( )
inline

Creates a VowpalWabbitRegressionModel without any parameters.

◆ VowpalWabbitRegressionModel() [2/2]

Synapse.ML.Vw.VowpalWabbitRegressionModel.VowpalWabbitRegressionModel ( string  uid)
inline

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

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetAdditionalFeatures()

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

Gets additionalFeatures value

Returns
additionalFeatures: Additional feature columns

◆ GetFeaturesCol()

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

Gets featuresCol value

Returns
featuresCol: features column name

◆ GetLabelCol()

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

Gets labelCol value

Returns
labelCol: label column name

◆ GetModel()

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

Gets model value

Returns
model: The VW model....

◆ GetPerformanceStatistics()

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

Gets performanceStatistics value

Returns
performanceStatistics: Performance statistics collected during training

◆ GetPredictionCol()

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

Gets predictionCol value

Returns
predictionCol: prediction column name

◆ GetRawPredictionCol()

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

Gets rawPredictionCol value

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

◆ GetTestArgs()

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

Gets testArgs value

Returns
testArgs: Additional arguments passed to VW at test time

◆ Load()

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

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

Parameters
pathThe path the previous VowpalWabbitRegressionModel was saved to
Returns
New VowpalWabbitRegressionModel object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

Returns
an JavaMLReader<VowpalWabbitRegressionModel> instance for this ML instance.

◆ Save()

void Synapse.ML.Vw.VowpalWabbitRegressionModel.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
pathThe path to save the object to

◆ SetAdditionalFeatures()

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

Sets value for additionalFeatures

Parameters
valueAdditional feature columns
Returns
New VowpalWabbitRegressionModel object

◆ SetFeaturesCol()

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

Sets value for featuresCol

Parameters
valuefeatures column name
Returns
New VowpalWabbitRegressionModel object

◆ SetLabelCol()

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

Sets value for labelCol

Parameters
valuelabel column name
Returns
New VowpalWabbitRegressionModel object

◆ SetModel()

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

Sets value for model

Parameters
valueThe VW model....
Returns
New VowpalWabbitRegressionModel object

◆ SetPerformanceStatistics()

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

Sets value for performanceStatistics

Parameters
valuePerformance statistics collected during training
Returns
New VowpalWabbitRegressionModel object

◆ SetPredictionCol()

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

Sets value for predictionCol

Parameters
valueprediction column name
Returns
New VowpalWabbitRegressionModel object

◆ SetRawPredictionCol()

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

Sets value for rawPredictionCol

Parameters
valueraw prediction (a.k.a. confidence) column name
Returns
New VowpalWabbitRegressionModel object

◆ SetTestArgs()

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

Sets value for testArgs

Parameters
valueAdditional arguments passed to VW at test time
Returns
New VowpalWabbitRegressionModel object

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