Synapse.ML.Exploratory.DistributionBalanceMeasure Class Reference

DistributionBalanceMeasure implements DistributionBalanceMeasure More...

Inheritance diagram for Synapse.ML.Exploratory.DistributionBalanceMeasure:

Collaboration diagram for Synapse.ML.Exploratory.DistributionBalanceMeasure:

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

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

Detailed Description

DistributionBalanceMeasure implements DistributionBalanceMeasure

Constructor & Destructor Documentation

DistributionBalanceMeasure() [1/2]

Synapse.ML.Exploratory.DistributionBalanceMeasure.DistributionBalanceMeasure ( )

inline

Creates a DistributionBalanceMeasure without any parameters.

DistributionBalanceMeasure() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetFeatureNameCol()

string Synapse.ML.Exploratory.DistributionBalanceMeasure.GetFeatureNameCol

(

)

Gets featureNameCol value

Returns

featureNameCol: Output column name for feature names.

GetOutputCol()

string Synapse.ML.Exploratory.DistributionBalanceMeasure.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: output column name

GetSensitiveCols()

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

(

)

Gets sensitiveCols value

Returns

sensitiveCols: Sensitive columns to use.

GetVerbose()

bool Synapse.ML.Exploratory.DistributionBalanceMeasure.GetVerbose

(

)

Gets verbose value

Returns

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

Load()

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

static

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

Parameters

path	The path the previous DistributionBalanceMeasure was saved to

Returns

New DistributionBalanceMeasure object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<DistributionBalanceMeasure> instance for this ML instance.

Save()

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

SetFeatureNameCol()

DistributionBalanceMeasure Synapse.ML.Exploratory.DistributionBalanceMeasure.SetFeatureNameCol

(

string

value

)

Sets value for featureNameCol

Parameters

value

Output column name for feature names.

Returns

New DistributionBalanceMeasure object

SetOutputCol()

DistributionBalanceMeasure Synapse.ML.Exploratory.DistributionBalanceMeasure.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

output column name

Returns

New DistributionBalanceMeasure object

SetSensitiveCols()

DistributionBalanceMeasure Synapse.ML.Exploratory.DistributionBalanceMeasure.SetSensitiveCols

(

string []

value

)

Sets value for sensitiveCols

Parameters

value

Sensitive columns to use.

Returns

New DistributionBalanceMeasure object

SetVerbose()

DistributionBalanceMeasure Synapse.ML.Exploratory.DistributionBalanceMeasure.SetVerbose

(

bool

value

)

Sets value for verbose

Parameters

value

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

Returns

New DistributionBalanceMeasure object

---

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

• synapse/ml/exploratory/DistributionBalanceMeasure.cs