Synapse.ML.Exploratory.AggregateBalanceMeasure Class Reference

AggregateBalanceMeasure implements AggregateBalanceMeasure More...

Inheritance diagram for Synapse.ML.Exploratory.AggregateBalanceMeasure:

Collaboration diagram for Synapse.ML.Exploratory.AggregateBalanceMeasure:

Public Member Functions
	AggregateBalanceMeasure ()
	Creates a AggregateBalanceMeasure without any parameters. More...
	AggregateBalanceMeasure (string uid)
	Creates a AggregateBalanceMeasure with a UID that is used to give the AggregateBalanceMeasure a unique ID. More...
AggregateBalanceMeasure	SetEpsilon (double value)
	Sets value for epsilon More...
AggregateBalanceMeasure	SetErrorTolerance (double value)
	Sets value for errorTolerance More...
AggregateBalanceMeasure	SetOutputCol (string value)
	Sets value for outputCol More...
AggregateBalanceMeasure	SetSensitiveCols (string[] value)
	Sets value for sensitiveCols More...
AggregateBalanceMeasure	SetVerbose (bool value)
	Sets value for verbose More...
double	GetEpsilon ()
	Gets epsilon value More...
double	GetErrorTolerance ()
	Gets errorTolerance value More...
string	GetOutputCol ()
	Gets outputCol value More...
string []	GetSensitiveCols ()
	Gets sensitiveCols value More...
bool	GetVerbose ()
	Gets verbose 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< AggregateBalanceMeasure >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

AggregateBalanceMeasure implements AggregateBalanceMeasure

Constructor & Destructor Documentation

AggregateBalanceMeasure() [1/2]

Synapse.ML.Exploratory.AggregateBalanceMeasure.AggregateBalanceMeasure ( )

inline

Creates a AggregateBalanceMeasure without any parameters.

AggregateBalanceMeasure() [2/2]

Synapse.ML.Exploratory.AggregateBalanceMeasure.AggregateBalanceMeasure ( string  uid )

inline

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

Parameters

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

Member Function Documentation

GetEpsilon()

double Synapse.ML.Exploratory.AggregateBalanceMeasure.GetEpsilon

(

)

Gets epsilon value

Returns

epsilon: Epsilon value for Atkinson Index. Inverse of alpha (1 - alpha).

GetErrorTolerance()

double Synapse.ML.Exploratory.AggregateBalanceMeasure.GetErrorTolerance

(

)

Gets errorTolerance value

Returns

errorTolerance: Error tolerance value for Atkinson Index.

GetOutputCol()

string Synapse.ML.Exploratory.AggregateBalanceMeasure.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: output column name

GetSensitiveCols()

string [] Synapse.ML.Exploratory.AggregateBalanceMeasure.GetSensitiveCols

(

)

Gets sensitiveCols value

Returns

sensitiveCols: Sensitive columns to use.

GetVerbose()

bool Synapse.ML.Exploratory.AggregateBalanceMeasure.GetVerbose

(

)

Gets verbose value

Returns

verbose: Whether to show intermediate measures and calculations, such as Positive Rate.

Load()

static AggregateBalanceMeasure Synapse.ML.Exploratory.AggregateBalanceMeasure.Load ( string  path )

static

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

Parameters

path	The path the previous AggregateBalanceMeasure was saved to

Returns

New AggregateBalanceMeasure object, loaded from path.

Read()

JavaMLReader<AggregateBalanceMeasure> Synapse.ML.Exploratory.AggregateBalanceMeasure.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<AggregateBalanceMeasure> instance for this ML instance.

Save()

void Synapse.ML.Exploratory.AggregateBalanceMeasure.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

SetEpsilon()

AggregateBalanceMeasure Synapse.ML.Exploratory.AggregateBalanceMeasure.SetEpsilon

(

double

value

)

Sets value for epsilon

Parameters

value

Epsilon value for Atkinson Index. Inverse of alpha (1 - alpha).

Returns

New AggregateBalanceMeasure object

SetErrorTolerance()

AggregateBalanceMeasure Synapse.ML.Exploratory.AggregateBalanceMeasure.SetErrorTolerance

(

double

value

)

Sets value for errorTolerance

Parameters

value

Error tolerance value for Atkinson Index.

Returns

New AggregateBalanceMeasure object

SetOutputCol()

AggregateBalanceMeasure Synapse.ML.Exploratory.AggregateBalanceMeasure.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

output column name

Returns

New AggregateBalanceMeasure object

SetSensitiveCols()

AggregateBalanceMeasure Synapse.ML.Exploratory.AggregateBalanceMeasure.SetSensitiveCols

(

string []

value

)

Sets value for sensitiveCols

Parameters

value

Sensitive columns to use.

Returns

New AggregateBalanceMeasure object

SetVerbose()

AggregateBalanceMeasure Synapse.ML.Exploratory.AggregateBalanceMeasure.SetVerbose

(

bool

value

)

Sets value for verbose

Parameters

value

Whether to show intermediate measures and calculations, such as Positive Rate.

Returns

New AggregateBalanceMeasure object

---

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

• synapse/ml/exploratory/AggregateBalanceMeasure.cs