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

ValueIndexer implements ValueIndexer More...

Inheritance diagram for Synapse.ML.Featurize.ValueIndexer:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Featurize.ValueIndexer:
Collaboration graph
[legend]

Public Member Functions

 ValueIndexer ()
 Creates a ValueIndexer without any parameters. More...
 
 ValueIndexer (string uid)
 Creates a ValueIndexer with a UID that is used to give the ValueIndexer a unique ID. More...
 
ValueIndexer SetInputCol (string value)
 Sets value for inputCol More...
 
ValueIndexer SetOutputCol (string value)
 Sets value for outputCol More...
 
string GetInputCol ()
 Gets inputCol value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
override ValueIndexerModel 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< ValueIndexerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

ValueIndexer implements ValueIndexer

Constructor & Destructor Documentation

◆ ValueIndexer() [1/2]

Synapse.ML.Featurize.ValueIndexer.ValueIndexer ( )
inline

Creates a ValueIndexer without any parameters.

◆ ValueIndexer() [2/2]

Synapse.ML.Featurize.ValueIndexer.ValueIndexer ( string  uid)
inline

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

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

Member Function Documentation

◆ Fit()

override ValueIndexerModel Synapse.ML.Featurize.ValueIndexer.Fit ( DataFrame  dataset)

Fits a model to the input data.

Parameters
datasetThe DataFrame to fit the model to.
Returns
ValueIndexerModel

◆ GetInputCol()

string Synapse.ML.Featurize.ValueIndexer.GetInputCol ( )

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetOutputCol()

string Synapse.ML.Featurize.ValueIndexer.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ Load()

static ValueIndexer Synapse.ML.Featurize.ValueIndexer.Load ( string  path)
static

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

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

◆ Read()

JavaMLReader<ValueIndexer> Synapse.ML.Featurize.ValueIndexer.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Featurize.ValueIndexer.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()

ValueIndexer Synapse.ML.Featurize.ValueIndexer.SetInputCol ( string  value)

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New ValueIndexer object

◆ SetOutputCol()

ValueIndexer Synapse.ML.Featurize.ValueIndexer.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New ValueIndexer object

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