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

EnsembleByKey implements EnsembleByKey More...

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

Public Member Functions

 EnsembleByKey ()
 Creates a EnsembleByKey without any parameters. More...
 
 EnsembleByKey (string uid)
 Creates a EnsembleByKey with a UID that is used to give the EnsembleByKey a unique ID. More...
 
EnsembleByKey SetColNames (string[] value)
 Sets value for colNames More...
 
EnsembleByKey SetCollapseGroup (bool value)
 Sets value for collapseGroup More...
 
EnsembleByKey SetCols (string[] value)
 Sets value for cols More...
 
EnsembleByKey SetKeys (string[] value)
 Sets value for keys More...
 
EnsembleByKey SetStrategy (string value)
 Sets value for strategy More...
 
EnsembleByKey SetVectorDims (Dictionary< string, int > value)
 Sets value for vectorDims More...
 
string [] GetColNames ()
 Gets colNames value More...
 
bool GetCollapseGroup ()
 Gets collapseGroup value More...
 
string [] GetCols ()
 Gets cols value More...
 
string [] GetKeys ()
 Gets keys value More...
 
string GetStrategy ()
 Gets strategy value More...
 
Dictionary< string, int > GetVectorDims ()
 Gets vectorDims 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< EnsembleByKeyRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

EnsembleByKey implements EnsembleByKey

Constructor & Destructor Documentation

◆ EnsembleByKey() [1/2]

Synapse.ML.Stages.EnsembleByKey.EnsembleByKey ( )
inline

Creates a EnsembleByKey without any parameters.

◆ EnsembleByKey() [2/2]

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

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

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

Member Function Documentation

◆ GetCollapseGroup()

bool Synapse.ML.Stages.EnsembleByKey.GetCollapseGroup ( )

Gets collapseGroup value

Returns
collapseGroup: Whether to collapse all items in group to one entry

◆ GetColNames()

string [] Synapse.ML.Stages.EnsembleByKey.GetColNames ( )

Gets colNames value

Returns
colNames: Names of the result of each col

◆ GetCols()

string [] Synapse.ML.Stages.EnsembleByKey.GetCols ( )

Gets cols value

Returns
cols: Cols to ensemble

◆ GetKeys()

string [] Synapse.ML.Stages.EnsembleByKey.GetKeys ( )

Gets keys value

Returns
keys: Keys to group by

◆ GetStrategy()

string Synapse.ML.Stages.EnsembleByKey.GetStrategy ( )

Gets strategy value

Returns
strategy: How to ensemble the scores, ex: mean

◆ GetVectorDims()

Dictionary<string, int> Synapse.ML.Stages.EnsembleByKey.GetVectorDims ( )
inline

Gets vectorDims value

Returns
vectorDims: the dimensions of any vector columns, used to avoid materialization

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetCollapseGroup()

EnsembleByKey Synapse.ML.Stages.EnsembleByKey.SetCollapseGroup ( bool  value)

Sets value for collapseGroup

Parameters
valueWhether to collapse all items in group to one entry
Returns
New EnsembleByKey object

◆ SetColNames()

EnsembleByKey Synapse.ML.Stages.EnsembleByKey.SetColNames ( string []  value)

Sets value for colNames

Parameters
valueNames of the result of each col
Returns
New EnsembleByKey object

◆ SetCols()

EnsembleByKey Synapse.ML.Stages.EnsembleByKey.SetCols ( string []  value)

Sets value for cols

Parameters
valueCols to ensemble
Returns
New EnsembleByKey object

◆ SetKeys()

EnsembleByKey Synapse.ML.Stages.EnsembleByKey.SetKeys ( string []  value)

Sets value for keys

Parameters
valueKeys to group by
Returns
New EnsembleByKey object

◆ SetStrategy()

EnsembleByKey Synapse.ML.Stages.EnsembleByKey.SetStrategy ( string  value)

Sets value for strategy

Parameters
valueHow to ensemble the scores, ex: mean
Returns
New EnsembleByKey object

◆ SetVectorDims()

EnsembleByKey Synapse.ML.Stages.EnsembleByKey.SetVectorDims ( Dictionary< string, int >  value)

Sets value for vectorDims

Parameters
valuethe dimensions of any vector columns, used to avoid materialization
Returns
New EnsembleByKey object

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