Synapse.ML.Automl.BestModel Class Reference

BestModel implements BestModel More...

Inheritance diagram for Synapse.ML.Automl.BestModel:

Collaboration diagram for Synapse.ML.Automl.BestModel:

Public Member Functions
	BestModel ()
	Creates a BestModel without any parameters. More...
	BestModel (string uid)
	Creates a BestModel with a UID that is used to give the BestModel a unique ID. More...
BestModel	SetAllModelMetrics (DataFrame value)
	Sets value for allModelMetrics More...
BestModel	SetBestModel (JavaTransformer value)
	Sets value for bestModel More...
BestModel	SetBestModelMetrics (DataFrame value)
	Sets value for bestModelMetrics More...
BestModel	SetRocCurve (DataFrame value)
	Sets value for rocCurve More...
BestModel	SetScoredDataset (DataFrame value)
	Sets value for scoredDataset More...
DataFrame	GetAllModelMetrics ()
	Gets allModelMetrics value More...
JavaTransformer	GetBestModel ()
	Gets bestModel value More...
DataFrame	GetBestModelMetrics ()
	Gets bestModelMetrics value More...
DataFrame	GetRocCurve ()
	Gets rocCurve value More...
DataFrame	GetScoredDataset ()
	Gets scoredDataset 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< BestModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

BestModel implements BestModel

Constructor & Destructor Documentation

BestModel() [1/2]

Synapse.ML.Automl.BestModel.BestModel ( )

inline

Creates a BestModel without any parameters.

BestModel() [2/2]

Synapse.ML.Automl.BestModel.BestModel ( string  uid )

inline

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

Parameters

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

Member Function Documentation

GetAllModelMetrics()

DataFrame Synapse.ML.Automl.BestModel.GetAllModelMetrics

(

)

Gets allModelMetrics value

Returns

allModelMetrics: all model metrics

GetBestModel()

JavaTransformer Synapse.ML.Automl.BestModel.GetBestModel ( )

inline

Gets bestModel value

Returns

bestModel: the best model found

GetBestModelMetrics()

DataFrame Synapse.ML.Automl.BestModel.GetBestModelMetrics

(

)

Gets bestModelMetrics value

Returns

bestModelMetrics: the metrics from the best model

GetRocCurve()

DataFrame Synapse.ML.Automl.BestModel.GetRocCurve

(

)

Gets rocCurve value

Returns

rocCurve: the roc curve of the best model

GetScoredDataset()

DataFrame Synapse.ML.Automl.BestModel.GetScoredDataset

(

)

Gets scoredDataset value

Returns

scoredDataset: dataset scored by best model

Load()

static BestModel Synapse.ML.Automl.BestModel.Load ( string  path )

static

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

Parameters

path	The path the previous BestModel was saved to

Returns

New BestModel object, loaded from path.

Read()

JavaMLReader<BestModel> Synapse.ML.Automl.BestModel.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<BestModel> instance for this ML instance.

Save()

void Synapse.ML.Automl.BestModel.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

SetAllModelMetrics()

BestModel Synapse.ML.Automl.BestModel.SetAllModelMetrics

(

DataFrame

value

)

Sets value for allModelMetrics

Parameters

value

all model metrics

Returns

New BestModel object

SetBestModel()

BestModel Synapse.ML.Automl.BestModel.SetBestModel

(

JavaTransformer

value

)

Sets value for bestModel

Parameters

value

the best model found

Returns

New BestModel object

SetBestModelMetrics()

BestModel Synapse.ML.Automl.BestModel.SetBestModelMetrics

(

DataFrame

value

)

Sets value for bestModelMetrics

Parameters

value

the metrics from the best model

Returns

New BestModel object

SetRocCurve()

BestModel Synapse.ML.Automl.BestModel.SetRocCurve

(

DataFrame

value

)

Sets value for rocCurve

Parameters

value

the roc curve of the best model

Returns

New BestModel object

SetScoredDataset()

BestModel Synapse.ML.Automl.BestModel.SetScoredDataset

(

DataFrame

value

)

Sets value for scoredDataset

Parameters

value

dataset scored by best model

Returns

New BestModel object

---

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

• synapse/ml/automl/BestModel.cs