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

TextPreprocessor implements TextPreprocessor More...

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

Public Member Functions

 TextPreprocessor ()
 Creates a TextPreprocessor without any parameters. More...
 
 TextPreprocessor (string uid)
 Creates a TextPreprocessor with a UID that is used to give the TextPreprocessor a unique ID. More...
 
TextPreprocessor SetInputCol (string value)
 Sets value for inputCol More...
 
TextPreprocessor SetMap (Dictionary< string, string > value)
 Sets value for map More...
 
TextPreprocessor SetNormFunc (string value)
 Sets value for normFunc More...
 
TextPreprocessor SetOutputCol (string value)
 Sets value for outputCol More...
 
string GetInputCol ()
 Gets inputCol value More...
 
Dictionary< string, string > GetMap ()
 Gets map value More...
 
string GetNormFunc ()
 Gets normFunc value More...
 
string GetOutputCol ()
 Gets outputCol 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< TextPreprocessorRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

TextPreprocessor implements TextPreprocessor

Constructor & Destructor Documentation

◆ TextPreprocessor() [1/2]

Synapse.ML.Stages.TextPreprocessor.TextPreprocessor ( )
inline

Creates a TextPreprocessor without any parameters.

◆ TextPreprocessor() [2/2]

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

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

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

Member Function Documentation

◆ GetInputCol()

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

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetMap()

Dictionary<string, string> Synapse.ML.Stages.TextPreprocessor.GetMap ( )
inline

Gets map value

Returns
map: Map of substring match to replacement

◆ GetNormFunc()

string Synapse.ML.Stages.TextPreprocessor.GetNormFunc ( )

Gets normFunc value

Returns
normFunc: Name of normalization function to apply

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Stages.TextPreprocessor.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()

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

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New TextPreprocessor object

◆ SetMap()

TextPreprocessor Synapse.ML.Stages.TextPreprocessor.SetMap ( Dictionary< string, string >  value)

Sets value for map

Parameters
valueMap of substring match to replacement
Returns
New TextPreprocessor object

◆ SetNormFunc()

TextPreprocessor Synapse.ML.Stages.TextPreprocessor.SetNormFunc ( string  value)

Sets value for normFunc

Parameters
valueName of normalization function to apply
Returns
New TextPreprocessor object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New TextPreprocessor object

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