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

StratifiedRepartition implements StratifiedRepartition More...

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

Public Member Functions

 StratifiedRepartition ()
 Creates a StratifiedRepartition without any parameters. More...
 
 StratifiedRepartition (string uid)
 Creates a StratifiedRepartition with a UID that is used to give the StratifiedRepartition a unique ID. More...
 
StratifiedRepartition SetLabelCol (string value)
 Sets value for labelCol More...
 
StratifiedRepartition SetMode (string value)
 Sets value for mode More...
 
StratifiedRepartition SetSeed (long value)
 Sets value for seed More...
 
string GetLabelCol ()
 Gets labelCol value More...
 
string GetMode ()
 Gets mode value More...
 
long GetSeed ()
 Gets seed 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< StratifiedRepartitionRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

StratifiedRepartition implements StratifiedRepartition

Constructor & Destructor Documentation

◆ StratifiedRepartition() [1/2]

Synapse.ML.Stages.StratifiedRepartition.StratifiedRepartition ( )
inline

Creates a StratifiedRepartition without any parameters.

◆ StratifiedRepartition() [2/2]

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

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

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

Member Function Documentation

◆ GetLabelCol()

string Synapse.ML.Stages.StratifiedRepartition.GetLabelCol ( )

Gets labelCol value

Returns
labelCol: The name of the label column

◆ GetMode()

string Synapse.ML.Stages.StratifiedRepartition.GetMode ( )

Gets mode value

Returns
mode: Specify equal to repartition with replacement across all labels, specify original to keep the ratios in the original dataset, or specify mixed to use a heuristic

◆ GetSeed()

long Synapse.ML.Stages.StratifiedRepartition.GetSeed ( )

Gets seed value

Returns
seed: random seed

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetLabelCol()

StratifiedRepartition Synapse.ML.Stages.StratifiedRepartition.SetLabelCol ( string  value)

Sets value for labelCol

Parameters
valueThe name of the label column
Returns
New StratifiedRepartition object

◆ SetMode()

StratifiedRepartition Synapse.ML.Stages.StratifiedRepartition.SetMode ( string  value)

Sets value for mode

Parameters
valueSpecify equal to repartition with replacement across all labels, specify original to keep the ratios in the original dataset, or specify mixed to use a heuristic
Returns
New StratifiedRepartition object

◆ SetSeed()

StratifiedRepartition Synapse.ML.Stages.StratifiedRepartition.SetSeed ( long  value)

Sets value for seed

Parameters
valuerandom seed
Returns
New StratifiedRepartition object

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