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

MultiColumnAdapter implements MultiColumnAdapter More...

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

Public Member Functions

 MultiColumnAdapter ()
 Creates a MultiColumnAdapter without any parameters. More...
 
 MultiColumnAdapter (string uid)
 Creates a MultiColumnAdapter with a UID that is used to give the MultiColumnAdapter a unique ID. More...
 
MultiColumnAdapter SetBaseStage (JavaPipelineStage value)
 Sets value for baseStage More...
 
MultiColumnAdapter SetInputCols (string[] value)
 Sets value for inputCols More...
 
MultiColumnAdapter SetOutputCols (string[] value)
 Sets value for outputCols More...
 
JavaPipelineStage GetBaseStage ()
 Gets baseStage value More...
 
string[] GetInputCols ()
 Gets inputCols value More...
 
string[] GetOutputCols ()
 Gets outputCols value More...
 
override PipelineModel 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< MultiColumnAdapterRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

MultiColumnAdapter implements MultiColumnAdapter

Constructor & Destructor Documentation

◆ MultiColumnAdapter() [1/2]

Synapse.ML.Stages.MultiColumnAdapter.MultiColumnAdapter ( )
inline

Creates a MultiColumnAdapter without any parameters.

◆ MultiColumnAdapter() [2/2]

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

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

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

Member Function Documentation

◆ Fit()

override PipelineModel Synapse.ML.Stages.MultiColumnAdapter.Fit ( DataFrame  dataset)

Fits a model to the input data.

Parameters
datasetThe DataFrame to fit the model to.
Returns
PipelineModel

◆ GetBaseStage()

JavaPipelineStage Synapse.ML.Stages.MultiColumnAdapter.GetBaseStage ( )
inline

Gets baseStage value

Returns
baseStage: base pipeline stage to apply to every column

◆ GetInputCols()

string [] Synapse.ML.Stages.MultiColumnAdapter.GetInputCols ( )

Gets inputCols value

Returns
inputCols: list of column names encoded as a string

◆ GetOutputCols()

string [] Synapse.ML.Stages.MultiColumnAdapter.GetOutputCols ( )

Gets outputCols value

Returns
outputCols: list of column names encoded as a string

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetBaseStage()

MultiColumnAdapter Synapse.ML.Stages.MultiColumnAdapter.SetBaseStage ( JavaPipelineStage  value)

Sets value for baseStage

Parameters
valuebase pipeline stage to apply to every column
Returns
New MultiColumnAdapter object

◆ SetInputCols()

MultiColumnAdapter Synapse.ML.Stages.MultiColumnAdapter.SetInputCols ( string[]  value)

Sets value for inputCols

Parameters
valuelist of column names encoded as a string
Returns
New MultiColumnAdapter object

◆ SetOutputCols()

MultiColumnAdapter Synapse.ML.Stages.MultiColumnAdapter.SetOutputCols ( string[]  value)

Sets value for outputCols

Parameters
valuelist of column names encoded as a string
Returns
New MultiColumnAdapter object

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