Synapseml  0.11.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Stages.ClassBalancer Class Reference

ClassBalancer implements ClassBalancer More...

Inheritance diagram for Synapse.ML.Stages.ClassBalancer:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Stages.ClassBalancer:
Collaboration graph
[legend]

Public Member Functions

 ClassBalancer ()
 Creates a ClassBalancer without any parameters. More...
 
 ClassBalancer (string uid)
 Creates a ClassBalancer with a UID that is used to give the ClassBalancer a unique ID. More...
 
ClassBalancer SetBroadcastJoin (bool value)
 Sets value for broadcastJoin More...
 
ClassBalancer SetInputCol (string value)
 Sets value for inputCol More...
 
ClassBalancer SetOutputCol (string value)
 Sets value for outputCol More...
 
bool GetBroadcastJoin ()
 Gets broadcastJoin value More...
 
string GetInputCol ()
 Gets inputCol value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
override ClassBalancerModel Fit (DataFrame dataset)
 Fits a model to the input data. 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< ClassBalancerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

ClassBalancer implements ClassBalancer

Constructor & Destructor Documentation

◆ ClassBalancer() [1/2]

Synapse.ML.Stages.ClassBalancer.ClassBalancer ( )
inline

Creates a ClassBalancer without any parameters.

◆ ClassBalancer() [2/2]

Synapse.ML.Stages.ClassBalancer.ClassBalancer ( string  uid)
inline

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

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

Member Function Documentation

◆ Fit()

override ClassBalancerModel Synapse.ML.Stages.ClassBalancer.Fit ( DataFrame  dataset)

Fits a model to the input data.

Parameters
datasetThe DataFrame to fit the model to.
Returns
ClassBalancerModel

◆ GetBroadcastJoin()

bool Synapse.ML.Stages.ClassBalancer.GetBroadcastJoin ( )

Gets broadcastJoin value

Returns
broadcastJoin: Whether to broadcast the class to weight mapping to the worker

◆ GetInputCol()

string Synapse.ML.Stages.ClassBalancer.GetInputCol ( )

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetOutputCol()

string Synapse.ML.Stages.ClassBalancer.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ Load()

static ClassBalancer Synapse.ML.Stages.ClassBalancer.Load ( string  path)
static

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

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

◆ Read()

JavaMLReader<ClassBalancer> Synapse.ML.Stages.ClassBalancer.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Stages.ClassBalancer.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

◆ SetBroadcastJoin()

ClassBalancer Synapse.ML.Stages.ClassBalancer.SetBroadcastJoin ( bool  value)

Sets value for broadcastJoin

Parameters
valueWhether to broadcast the class to weight mapping to the worker
Returns
New ClassBalancer object

◆ SetInputCol()

ClassBalancer Synapse.ML.Stages.ClassBalancer.SetInputCol ( string  value)

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New ClassBalancer object

◆ SetOutputCol()

ClassBalancer Synapse.ML.Stages.ClassBalancer.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New ClassBalancer object

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