Synapse.ML.Train.ComputePerInstanceStatistics Class Reference

ComputePerInstanceStatistics implements ComputePerInstanceStatistics More...

Inheritance diagram for Synapse.ML.Train.ComputePerInstanceStatistics:

Collaboration diagram for Synapse.ML.Train.ComputePerInstanceStatistics:

Public Member Functions
	ComputePerInstanceStatistics ()
	Creates a ComputePerInstanceStatistics without any parameters. More...
	ComputePerInstanceStatistics (string uid)
	Creates a ComputePerInstanceStatistics with a UID that is used to give the ComputePerInstanceStatistics a unique ID. More...
ComputePerInstanceStatistics	SetEvaluationMetric (string value)
	Sets value for evaluationMetric More...
ComputePerInstanceStatistics	SetLabelCol (string value)
	Sets value for labelCol More...
ComputePerInstanceStatistics	SetScoredLabelsCol (string value)
	Sets value for scoredLabelsCol More...
ComputePerInstanceStatistics	SetScoredProbabilitiesCol (string value)
	Sets value for scoredProbabilitiesCol More...
ComputePerInstanceStatistics	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	GetScoredProbabilitiesCol ()
	Gets scoredProbabilitiesCol 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< ComputePerInstanceStatistics >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

ComputePerInstanceStatistics implements ComputePerInstanceStatistics

Constructor & Destructor Documentation

ComputePerInstanceStatistics() [1/2]

Synapse.ML.Train.ComputePerInstanceStatistics.ComputePerInstanceStatistics ( )

inline

Creates a ComputePerInstanceStatistics without any parameters.

ComputePerInstanceStatistics() [2/2]

Synapse.ML.Train.ComputePerInstanceStatistics.ComputePerInstanceStatistics ( string  uid )

inline

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

Parameters

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

Member Function Documentation

GetEvaluationMetric()

string Synapse.ML.Train.ComputePerInstanceStatistics.GetEvaluationMetric

(

)

Gets evaluationMetric value

Returns

evaluationMetric: Metric to evaluate models with

GetLabelCol()

string Synapse.ML.Train.ComputePerInstanceStatistics.GetLabelCol

(

)

Gets labelCol value

Returns

labelCol: The name of the label column

GetScoredLabelsCol()

string Synapse.ML.Train.ComputePerInstanceStatistics.GetScoredLabelsCol

(

)

Gets scoredLabelsCol value

Returns

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

GetScoredProbabilitiesCol()

string Synapse.ML.Train.ComputePerInstanceStatistics.GetScoredProbabilitiesCol

(

)

Gets scoredProbabilitiesCol value

Returns

scoredProbabilitiesCol: Scored probabilities, usually calibrated from raw scores, only required if using SparkML estimators

GetScoresCol()

string Synapse.ML.Train.ComputePerInstanceStatistics.GetScoresCol

(

)

Gets scoresCol value

Returns

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

Load()

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

static

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

Parameters

path	The path the previous ComputePerInstanceStatistics was saved to

Returns

New ComputePerInstanceStatistics object, loaded from path.

Read()

JavaMLReader<ComputePerInstanceStatistics> Synapse.ML.Train.ComputePerInstanceStatistics.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<ComputePerInstanceStatistics> instance for this ML instance.

Save()

void Synapse.ML.Train.ComputePerInstanceStatistics.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

SetEvaluationMetric()

ComputePerInstanceStatistics Synapse.ML.Train.ComputePerInstanceStatistics.SetEvaluationMetric

(

string

value

)

Sets value for evaluationMetric

Parameters

value

Metric to evaluate models with

Returns

New ComputePerInstanceStatistics object

SetLabelCol()

ComputePerInstanceStatistics Synapse.ML.Train.ComputePerInstanceStatistics.SetLabelCol

(

string

value

)

Sets value for labelCol

Parameters

value

The name of the label column

Returns

New ComputePerInstanceStatistics object

SetScoredLabelsCol()

ComputePerInstanceStatistics Synapse.ML.Train.ComputePerInstanceStatistics.SetScoredLabelsCol

(

string

value

)

Sets value for scoredLabelsCol

Parameters

value

Scored labels column name, only required if using SparkML estimators

Returns

New ComputePerInstanceStatistics object

SetScoredProbabilitiesCol()

ComputePerInstanceStatistics Synapse.ML.Train.ComputePerInstanceStatistics.SetScoredProbabilitiesCol

(

string

value

)

Sets value for scoredProbabilitiesCol

Parameters

value

Scored probabilities, usually calibrated from raw scores, only required if using SparkML estimators

Returns

New ComputePerInstanceStatistics object

SetScoresCol()

ComputePerInstanceStatistics Synapse.ML.Train.ComputePerInstanceStatistics.SetScoresCol

(

string

value

)

Sets value for scoresCol

Parameters

value

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

Returns

New ComputePerInstanceStatistics object

---

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

• synapse/ml/train/ComputePerInstanceStatistics.cs