Synapseml  0.11.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Automl.FindBestModel Class Reference

FindBestModel implements FindBestModel More...

Inheritance diagram for Synapse.ML.Automl.FindBestModel:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Automl.FindBestModel:
Collaboration graph
[legend]

Public Member Functions

 FindBestModel ()
 Creates a FindBestModel without any parameters. More...
 
 FindBestModel (string uid)
 Creates a FindBestModel with a UID that is used to give the FindBestModel a unique ID. More...
 
FindBestModel SetEvaluationMetric (string value)
 Sets value for evaluationMetric More...
 
FindBestModel SetModels (JavaTransformer[] value)
 Sets value for models More...
 
string GetEvaluationMetric ()
 Gets evaluationMetric value More...
 
JavaTransformer[] GetModels ()
 Gets models value More...
 
override BestModel 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< FindBestModelRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

FindBestModel implements FindBestModel

Constructor & Destructor Documentation

◆ FindBestModel() [1/2]

Synapse.ML.Automl.FindBestModel.FindBestModel ( )
inline

Creates a FindBestModel without any parameters.

◆ FindBestModel() [2/2]

Synapse.ML.Automl.FindBestModel.FindBestModel ( string  uid)
inline

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

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

Member Function Documentation

◆ Fit()

override BestModel Synapse.ML.Automl.FindBestModel.Fit ( DataFrame  dataset)

Fits a model to the input data.

Parameters
datasetThe DataFrame to fit the model to.
Returns
BestModel

◆ GetEvaluationMetric()

string Synapse.ML.Automl.FindBestModel.GetEvaluationMetric ( )

Gets evaluationMetric value

Returns
evaluationMetric: Metric to evaluate models with

◆ GetModels()

JavaTransformer [] Synapse.ML.Automl.FindBestModel.GetModels ( )
inline

Gets models value

Returns
models: List of models to be evaluated

◆ Load()

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

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

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

◆ Read()

JavaMLReader<FindBestModel> Synapse.ML.Automl.FindBestModel.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetEvaluationMetric()

FindBestModel Synapse.ML.Automl.FindBestModel.SetEvaluationMetric ( string  value)

Sets value for evaluationMetric

Parameters
valueMetric to evaluate models with
Returns
New FindBestModel object

◆ SetModels()

FindBestModel Synapse.ML.Automl.FindBestModel.SetModels ( JavaTransformer[]  value)

Sets value for models

Parameters
valueList of models to be evaluated
Returns
New FindBestModel object

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