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

UDFTransformer implements UDFTransformer More...

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

Public Member Functions

 UDFTransformer ()
 Creates a UDFTransformer without any parameters. More...
 
 UDFTransformer (string uid)
 Creates a UDFTransformer with a UID that is used to give the UDFTransformer a unique ID. More...
 
UDFTransformer SetInputCol (string value)
 Sets value for inputCol More...
 
UDFTransformer SetInputCols (string[] value)
 Sets value for inputCols More...
 
UDFTransformer SetOutputCol (string value)
 Sets value for outputCol More...
 
UDFTransformer SetUdf (object value)
 Sets value for udf More...
 
UDFTransformer SetUdfScala (object value)
 Sets value for udfScala More...
 
string GetInputCol ()
 Gets inputCol value More...
 
string [] GetInputCols ()
 Gets inputCols value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
object GetUdf ()
 Gets udf value More...
 
object GetUdfScala ()
 Gets udfScala 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< UDFTransformerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

UDFTransformer implements UDFTransformer

Constructor & Destructor Documentation

◆ UDFTransformer() [1/2]

Synapse.ML.Stages.UDFTransformer.UDFTransformer ( )
inline

Creates a UDFTransformer without any parameters.

◆ UDFTransformer() [2/2]

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

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

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

Member Function Documentation

◆ GetInputCol()

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

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetInputCols()

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

Gets inputCols value

Returns
inputCols: The names of the input columns

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetUdf()

object Synapse.ML.Stages.UDFTransformer.GetUdf ( )

Gets udf value

Returns
udf: User Defined Python Function to be applied to the DF input col

◆ GetUdfScala()

object Synapse.ML.Stages.UDFTransformer.GetUdfScala ( )

Gets udfScala value

Returns
udfScala: User Defined Function to be applied to the DF input col

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetInputCol()

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

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New UDFTransformer object

◆ SetInputCols()

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

Sets value for inputCols

Parameters
valueThe names of the input columns
Returns
New UDFTransformer object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New UDFTransformer object

◆ SetUdf()

UDFTransformer Synapse.ML.Stages.UDFTransformer.SetUdf ( object  value)

Sets value for udf

Parameters
valueUser Defined Python Function to be applied to the DF input col
Returns
New UDFTransformer object

◆ SetUdfScala()

UDFTransformer Synapse.ML.Stages.UDFTransformer.SetUdfScala ( object  value)

Sets value for udfScala

Parameters
valueUser Defined Function to be applied to the DF input col
Returns
New UDFTransformer object

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