Synapseml  1.0.2
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Train.TrainedClassifierModel Class Reference

TrainedClassifierModel implements TrainedClassifierModel More...

Inheritance diagram for Synapse.ML.Train.TrainedClassifierModel:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Train.TrainedClassifierModel:
Collaboration graph
[legend]

Public Member Functions

 TrainedClassifierModel ()
 Creates a TrainedClassifierModel without any parameters. More...
 
 TrainedClassifierModel (string uid)
 Creates a TrainedClassifierModel with a UID that is used to give the TrainedClassifierModel a unique ID. More...
 
TrainedClassifierModel SetFeaturesCol (string value)
 Sets value for featuresCol More...
 
TrainedClassifierModel SetLabelCol (string value)
 Sets value for labelCol More...
 
TrainedClassifierModel SetLevels (object[] value)
 Sets value for levels More...
 
TrainedClassifierModel SetModel (JavaTransformer value)
 Sets value for model More...
 
string GetFeaturesCol ()
 Gets featuresCol value More...
 
string GetLabelCol ()
 Gets labelCol value More...
 
object[] GetLevels ()
 Gets levels value More...
 
JavaTransformer GetModel ()
 Gets model 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< TrainedClassifierModelRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

TrainedClassifierModel implements TrainedClassifierModel

Constructor & Destructor Documentation

◆ TrainedClassifierModel() [1/2]

Synapse.ML.Train.TrainedClassifierModel.TrainedClassifierModel ( )
inline

Creates a TrainedClassifierModel without any parameters.

◆ TrainedClassifierModel() [2/2]

Synapse.ML.Train.TrainedClassifierModel.TrainedClassifierModel ( string  uid)
inline

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

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

Member Function Documentation

◆ GetFeaturesCol()

string Synapse.ML.Train.TrainedClassifierModel.GetFeaturesCol ( )

Gets featuresCol value

Returns
featuresCol: The name of the features column

◆ GetLabelCol()

string Synapse.ML.Train.TrainedClassifierModel.GetLabelCol ( )

Gets labelCol value

Returns
labelCol: The name of the label column

◆ GetLevels()

object [] Synapse.ML.Train.TrainedClassifierModel.GetLevels ( )
inline

Gets levels value

Returns
levels: the levels

◆ GetModel()

JavaTransformer Synapse.ML.Train.TrainedClassifierModel.GetModel ( )
inline

Gets model value

Returns
model: model produced by training

◆ Load()

static TrainedClassifierModel Synapse.ML.Train.TrainedClassifierModel.Load ( string  path)
static

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

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

◆ Read()

JavaMLReader<TrainedClassifierModel> Synapse.ML.Train.TrainedClassifierModel.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Train.TrainedClassifierModel.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

◆ SetFeaturesCol()

TrainedClassifierModel Synapse.ML.Train.TrainedClassifierModel.SetFeaturesCol ( string  value)

Sets value for featuresCol

Parameters
valueThe name of the features column
Returns
New TrainedClassifierModel object

◆ SetLabelCol()

TrainedClassifierModel Synapse.ML.Train.TrainedClassifierModel.SetLabelCol ( string  value)

Sets value for labelCol

Parameters
valueThe name of the label column
Returns
New TrainedClassifierModel object

◆ SetLevels()

TrainedClassifierModel Synapse.ML.Train.TrainedClassifierModel.SetLevels ( object[]  value)

Sets value for levels

Parameters
valuethe levels
Returns
New TrainedClassifierModel object

◆ SetModel()

TrainedClassifierModel Synapse.ML.Train.TrainedClassifierModel.SetModel ( JavaTransformer  value)

Sets value for model

Parameters
valuemodel produced by training
Returns
New TrainedClassifierModel object

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