Synapse.ML.Exploratory.FeatureBalanceMeasure Class Reference

FeatureBalanceMeasure implements FeatureBalanceMeasure More...

Inheritance diagram for Synapse.ML.Exploratory.FeatureBalanceMeasure:

Collaboration diagram for Synapse.ML.Exploratory.FeatureBalanceMeasure:

Public Member Functions
	FeatureBalanceMeasure ()
	Creates a FeatureBalanceMeasure without any parameters. More...
	FeatureBalanceMeasure (string uid)
	Creates a FeatureBalanceMeasure with a UID that is used to give the FeatureBalanceMeasure a unique ID. More...
FeatureBalanceMeasure	SetClassACol (string value)
	Sets value for classACol More...
FeatureBalanceMeasure	SetClassBCol (string value)
	Sets value for classBCol More...
FeatureBalanceMeasure	SetFeatureNameCol (string value)
	Sets value for featureNameCol More...
FeatureBalanceMeasure	SetLabelCol (string value)
	Sets value for labelCol More...
FeatureBalanceMeasure	SetOutputCol (string value)
	Sets value for outputCol More...
FeatureBalanceMeasure	SetSensitiveCols (string[] value)
	Sets value for sensitiveCols More...
FeatureBalanceMeasure	SetVerbose (bool value)
	Sets value for verbose More...
string	GetClassACol ()
	Gets classACol value More...
string	GetClassBCol ()
	Gets classBCol value More...
string	GetFeatureNameCol ()
	Gets featureNameCol value More...
string	GetLabelCol ()
	Gets labelCol 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< FeatureBalanceMeasure >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

FeatureBalanceMeasure implements FeatureBalanceMeasure

Constructor & Destructor Documentation

FeatureBalanceMeasure() [1/2]

Synapse.ML.Exploratory.FeatureBalanceMeasure.FeatureBalanceMeasure ( )

inline

Creates a FeatureBalanceMeasure without any parameters.

FeatureBalanceMeasure() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetClassACol()

string Synapse.ML.Exploratory.FeatureBalanceMeasure.GetClassACol

(

)

Gets classACol value

Returns

classACol: Output column name for the first feature value to compare.

GetClassBCol()

string Synapse.ML.Exploratory.FeatureBalanceMeasure.GetClassBCol

(

)

Gets classBCol value

Returns

classBCol: Output column name for the second feature value to compare.

GetFeatureNameCol()

string Synapse.ML.Exploratory.FeatureBalanceMeasure.GetFeatureNameCol

(

)

Gets featureNameCol value

Returns

featureNameCol: Output column name for feature names.

GetLabelCol()

string Synapse.ML.Exploratory.FeatureBalanceMeasure.GetLabelCol

(

)

Gets labelCol value

Returns

labelCol: label column name

GetOutputCol()

string Synapse.ML.Exploratory.FeatureBalanceMeasure.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: output column name

GetSensitiveCols()

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

(

)

Gets sensitiveCols value

Returns

sensitiveCols: Sensitive columns to use.

GetVerbose()

bool Synapse.ML.Exploratory.FeatureBalanceMeasure.GetVerbose

(

)

Gets verbose value

Returns

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

Load()

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

static

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

Parameters

path	The path the previous FeatureBalanceMeasure was saved to

Returns

New FeatureBalanceMeasure object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<FeatureBalanceMeasure> instance for this ML instance.

Save()

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

SetClassACol()

FeatureBalanceMeasure Synapse.ML.Exploratory.FeatureBalanceMeasure.SetClassACol

(

string

value

)

Sets value for classACol

Parameters

value

Output column name for the first feature value to compare.

Returns

New FeatureBalanceMeasure object

SetClassBCol()

FeatureBalanceMeasure Synapse.ML.Exploratory.FeatureBalanceMeasure.SetClassBCol

(

string

value

)

Sets value for classBCol

Parameters

value

Output column name for the second feature value to compare.

Returns

New FeatureBalanceMeasure object

SetFeatureNameCol()

FeatureBalanceMeasure Synapse.ML.Exploratory.FeatureBalanceMeasure.SetFeatureNameCol

(

string

value

)

Sets value for featureNameCol

Parameters

value

Output column name for feature names.

Returns

New FeatureBalanceMeasure object

SetLabelCol()

FeatureBalanceMeasure Synapse.ML.Exploratory.FeatureBalanceMeasure.SetLabelCol

(

string

value

)

Sets value for labelCol

Parameters

value

label column name

Returns

New FeatureBalanceMeasure object

SetOutputCol()

FeatureBalanceMeasure Synapse.ML.Exploratory.FeatureBalanceMeasure.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

output column name

Returns

New FeatureBalanceMeasure object

SetSensitiveCols()

FeatureBalanceMeasure Synapse.ML.Exploratory.FeatureBalanceMeasure.SetSensitiveCols

(

string []

value

)

Sets value for sensitiveCols

Parameters

value

Sensitive columns to use.

Returns

New FeatureBalanceMeasure object

SetVerbose()

FeatureBalanceMeasure Synapse.ML.Exploratory.FeatureBalanceMeasure.SetVerbose

(

bool

value

)

Sets value for verbose

Parameters

value

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

Returns

New FeatureBalanceMeasure object

---

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

• synapse/ml/exploratory/FeatureBalanceMeasure.cs