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

ValueIndexerModel implements ValueIndexerModel More...

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

Public Member Functions

 ValueIndexerModel ()
 Creates a ValueIndexerModel without any parameters. More...
 
 ValueIndexerModel (string uid)
 Creates a ValueIndexerModel with a UID that is used to give the ValueIndexerModel a unique ID. More...
 
ValueIndexerModel SetDataType (string value)
 Sets value for dataType More...
 
ValueIndexerModel SetInputCol (string value)
 Sets value for inputCol More...
 
ValueIndexerModel SetLevels (object[] value)
 Sets value for levels More...
 
ValueIndexerModel SetOutputCol (string value)
 Sets value for outputCol More...
 
string GetDataType ()
 Gets dataType value More...
 
string GetInputCol ()
 Gets inputCol value More...
 
object[] GetLevels ()
 Gets levels 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< ValueIndexerModelRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

ValueIndexerModel implements ValueIndexerModel

Constructor & Destructor Documentation

◆ ValueIndexerModel() [1/2]

Synapse.ML.Featurize.ValueIndexerModel.ValueIndexerModel ( )
inline

Creates a ValueIndexerModel without any parameters.

◆ ValueIndexerModel() [2/2]

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

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

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

Member Function Documentation

◆ GetDataType()

string Synapse.ML.Featurize.ValueIndexerModel.GetDataType ( )

Gets dataType value

Returns
dataType: The datatype of the levels as a Json string

◆ GetInputCol()

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

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetLevels()

object [] Synapse.ML.Featurize.ValueIndexerModel.GetLevels ( )
inline

Gets levels value

Returns
levels: Levels in categorical array

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Featurize.ValueIndexerModel.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

◆ SetDataType()

ValueIndexerModel Synapse.ML.Featurize.ValueIndexerModel.SetDataType ( string  value)

Sets value for dataType

Parameters
valueThe datatype of the levels as a Json string
Returns
New ValueIndexerModel object

◆ SetInputCol()

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

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New ValueIndexerModel object

◆ SetLevels()

ValueIndexerModel Synapse.ML.Featurize.ValueIndexerModel.SetLevels ( object[]  value)

Sets value for levels

Parameters
valueLevels in categorical array
Returns
New ValueIndexerModel object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New ValueIndexerModel object

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