Synapse.ML.Train.TrainClassifier Class Reference

TrainClassifier implements TrainClassifier More...

Inheritance diagram for Synapse.ML.Train.TrainClassifier:

Collaboration diagram for Synapse.ML.Train.TrainClassifier:

Public Member Functions
	TrainClassifier ()
	Creates a TrainClassifier without any parameters. More...
	TrainClassifier (string uid)
	Creates a TrainClassifier with a UID that is used to give the TrainClassifier a unique ID. More...
TrainClassifier	SetFeaturesCol (string value)
	Sets value for featuresCol More...
TrainClassifier	SetLabelCol (string value)
	Sets value for labelCol More...
TrainClassifier	SetLabels (string[] value)
	Sets value for labels More...
TrainClassifier	SetModel< M > (JavaEstimator< M > value)
	Sets value for model More...
TrainClassifier	SetNumFeatures (int value)
	Sets value for numFeatures More...
TrainClassifier	SetReindexLabel (bool value)
	Sets value for reindexLabel More...
string	GetFeaturesCol ()
	Gets featuresCol value More...
string	GetLabelCol ()
	Gets labelCol value More...
string []	GetLabels ()
	Gets labels value More...
IEstimator< object >	GetModel ()
	Gets model value More...
int	GetNumFeatures ()
	Gets numFeatures value More...
bool	GetReindexLabel ()
	Gets reindexLabel value More...
override TrainedClassifierModel	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< TrainClassifier >	Read ()
	Get the corresponding JavaMLReader instance. More...

Static Public Member Functions
static TrainClassifier	Load (string path)
	Loads the TrainClassifier that was previously saved using Save(string). More...

Detailed Description

TrainClassifier implements TrainClassifier

Constructor & Destructor Documentation

TrainClassifier() [1/2]

Synapse.ML.Train.TrainClassifier.TrainClassifier ( )

inline

Creates a TrainClassifier without any parameters.

TrainClassifier() [2/2]

Synapse.ML.Train.TrainClassifier.TrainClassifier ( string  uid )

inline

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

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

Fit()

override TrainedClassifierModel Synapse.ML.Train.TrainClassifier.Fit

(

DataFrame

dataset

)

Fits a model to the input data.

Parameters

dataset

The DataFrame to fit the model to.

Returns

TrainedClassifierModel

GetFeaturesCol()

string Synapse.ML.Train.TrainClassifier.GetFeaturesCol

(

)

Gets featuresCol value

Returns

featuresCol: The name of the features column

GetLabelCol()

string Synapse.ML.Train.TrainClassifier.GetLabelCol

(

)

Gets labelCol value

Returns

labelCol: The name of the label column

GetLabels()

string [] Synapse.ML.Train.TrainClassifier.GetLabels

(

)

Gets labels value

Returns

labels: Sorted label values on the labels column

GetModel()

IEstimator<object> Synapse.ML.Train.TrainClassifier.GetModel ( )

inline

Gets model value

Returns

model: Classifier to run

GetNumFeatures()

int Synapse.ML.Train.TrainClassifier.GetNumFeatures

(

)

Gets numFeatures value

Returns

numFeatures: Number of features to hash to

GetReindexLabel()

bool Synapse.ML.Train.TrainClassifier.GetReindexLabel

(

)

Gets reindexLabel value

Returns

reindexLabel: Re-index the label column

Load()

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

static

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

Parameters

path	The path the previous TrainClassifier was saved to

Returns

New TrainClassifier object, loaded from path.

Read()

JavaMLReader<TrainClassifier> Synapse.ML.Train.TrainClassifier.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<TrainClassifier> instance for this ML instance.

Save()

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

path	The path to save the object to

SetFeaturesCol()

TrainClassifier Synapse.ML.Train.TrainClassifier.SetFeaturesCol

(

string

value

)

Sets value for featuresCol

Parameters

value

The name of the features column

Returns

New TrainClassifier object

SetLabelCol()

TrainClassifier Synapse.ML.Train.TrainClassifier.SetLabelCol

(

string

value

)

Sets value for labelCol

Parameters

value

The name of the label column

Returns

New TrainClassifier object

SetLabels()

TrainClassifier Synapse.ML.Train.TrainClassifier.SetLabels

(

string []

value

)

Sets value for labels

Parameters

value

Sorted label values on the labels column

Returns

New TrainClassifier object

SetModel< M >()

TrainClassifier Synapse.ML.Train.TrainClassifier.SetModel< M >

(

JavaEstimator< M >

value

)

Sets value for model

Parameters

value

Classifier to run

Returns

New TrainClassifier object

Type Constraints

M	:	JavaModel<M>
M	:	WrapAsTrainClassifier
M	:	Reference.Invoke
M	:	setModel
M	:	object
M	:	value

SetNumFeatures()

TrainClassifier Synapse.ML.Train.TrainClassifier.SetNumFeatures

(

int

value

)

Sets value for numFeatures

Parameters

value

Number of features to hash to

Returns

New TrainClassifier object

SetReindexLabel()

TrainClassifier Synapse.ML.Train.TrainClassifier.SetReindexLabel

(

bool

value

)

Sets value for reindexLabel

Parameters

value

Re-index the label column

Returns

New TrainClassifier object

---

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

• synapse/ml/train/TrainClassifier.cs