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

ComputeModelStatistics implements ComputeModelStatistics More...

Inheritance diagram for Synapse.ML.Train.ComputeModelStatistics:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Train.ComputeModelStatistics:
Collaboration graph
[legend]

Public Member Functions

 ComputeModelStatistics ()
 Creates a ComputeModelStatistics without any parameters. More...
 
 ComputeModelStatistics (string uid)
 Creates a ComputeModelStatistics with a UID that is used to give the ComputeModelStatistics a unique ID. More...
 
ComputeModelStatistics SetEvaluationMetric (string value)
 Sets value for evaluationMetric More...
 
ComputeModelStatistics SetLabelCol (string value)
 Sets value for labelCol More...
 
ComputeModelStatistics SetScoredLabelsCol (string value)
 Sets value for scoredLabelsCol More...
 
ComputeModelStatistics SetScoresCol (string value)
 Sets value for scoresCol More...
 
string GetEvaluationMetric ()
 Gets evaluationMetric value More...
 
string GetLabelCol ()
 Gets labelCol value More...
 
string GetScoredLabelsCol ()
 Gets scoredLabelsCol value More...
 
string GetScoresCol ()
 Gets scoresCol 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< ComputeModelStatisticsRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

ComputeModelStatistics implements ComputeModelStatistics

Constructor & Destructor Documentation

◆ ComputeModelStatistics() [1/2]

Synapse.ML.Train.ComputeModelStatistics.ComputeModelStatistics ( )
inline

Creates a ComputeModelStatistics without any parameters.

◆ ComputeModelStatistics() [2/2]

Synapse.ML.Train.ComputeModelStatistics.ComputeModelStatistics ( string  uid)
inline

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

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

Member Function Documentation

◆ GetEvaluationMetric()

string Synapse.ML.Train.ComputeModelStatistics.GetEvaluationMetric ( )

Gets evaluationMetric value

Returns
evaluationMetric: Metric to evaluate models with

◆ GetLabelCol()

string Synapse.ML.Train.ComputeModelStatistics.GetLabelCol ( )

Gets labelCol value

Returns
labelCol: The name of the label column

◆ GetScoredLabelsCol()

string Synapse.ML.Train.ComputeModelStatistics.GetScoredLabelsCol ( )

Gets scoredLabelsCol value

Returns
scoredLabelsCol: Scored labels column name, only required if using SparkML estimators

◆ GetScoresCol()

string Synapse.ML.Train.ComputeModelStatistics.GetScoresCol ( )

Gets scoresCol value

Returns
scoresCol: Scores or raw prediction column name, only required if using SparkML estimators

◆ Load()

static ComputeModelStatistics Synapse.ML.Train.ComputeModelStatistics.Load ( string  path)
static

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

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

◆ Read()

JavaMLReader<ComputeModelStatistics> Synapse.ML.Train.ComputeModelStatistics.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Train.ComputeModelStatistics.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()

ComputeModelStatistics Synapse.ML.Train.ComputeModelStatistics.SetEvaluationMetric ( string  value)

Sets value for evaluationMetric

Parameters
valueMetric to evaluate models with
Returns
New ComputeModelStatistics object

◆ SetLabelCol()

ComputeModelStatistics Synapse.ML.Train.ComputeModelStatistics.SetLabelCol ( string  value)

Sets value for labelCol

Parameters
valueThe name of the label column
Returns
New ComputeModelStatistics object

◆ SetScoredLabelsCol()

ComputeModelStatistics Synapse.ML.Train.ComputeModelStatistics.SetScoredLabelsCol ( string  value)

Sets value for scoredLabelsCol

Parameters
valueScored labels column name, only required if using SparkML estimators
Returns
New ComputeModelStatistics object

◆ SetScoresCol()

ComputeModelStatistics Synapse.ML.Train.ComputeModelStatistics.SetScoresCol ( string  value)

Sets value for scoresCol

Parameters
valueScores or raw prediction column name, only required if using SparkML estimators
Returns
New ComputeModelStatistics object

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