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

ConditionalKNN implements ConditionalKNN More...

Inheritance diagram for Synapse.ML.Nn.ConditionalKNN:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Nn.ConditionalKNN:
Collaboration graph
[legend]

Public Member Functions

 ConditionalKNN ()
 Creates a ConditionalKNN without any parameters. More...
 
 ConditionalKNN (string uid)
 Creates a ConditionalKNN with a UID that is used to give the ConditionalKNN a unique ID. More...
 
ConditionalKNN SetConditionerCol (string value)
 Sets value for conditionerCol More...
 
ConditionalKNN SetFeaturesCol (string value)
 Sets value for featuresCol More...
 
ConditionalKNN SetK (int value)
 Sets value for k More...
 
ConditionalKNN SetLabelCol (string value)
 Sets value for labelCol More...
 
ConditionalKNN SetLeafSize (int value)
 Sets value for leafSize More...
 
ConditionalKNN SetOutputCol (string value)
 Sets value for outputCol More...
 
ConditionalKNN SetValuesCol (string value)
 Sets value for valuesCol More...
 
string GetConditionerCol ()
 Gets conditionerCol value More...
 
string GetFeaturesCol ()
 Gets featuresCol value More...
 
int GetK ()
 Gets k value More...
 
string GetLabelCol ()
 Gets labelCol value More...
 
int GetLeafSize ()
 Gets leafSize value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
string GetValuesCol ()
 Gets valuesCol value More...
 
override ConditionalKNNModel 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< ConditionalKNNRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

ConditionalKNN implements ConditionalKNN

Constructor & Destructor Documentation

◆ ConditionalKNN() [1/2]

Synapse.ML.Nn.ConditionalKNN.ConditionalKNN ( )
inline

Creates a ConditionalKNN without any parameters.

◆ ConditionalKNN() [2/2]

Synapse.ML.Nn.ConditionalKNN.ConditionalKNN ( string  uid)
inline

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

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

Member Function Documentation

◆ Fit()

override ConditionalKNNModel Synapse.ML.Nn.ConditionalKNN.Fit ( DataFrame  dataset)

Fits a model to the input data.

Parameters
datasetThe DataFrame to fit the model to.
Returns
ConditionalKNNModel

◆ GetConditionerCol()

string Synapse.ML.Nn.ConditionalKNN.GetConditionerCol ( )

Gets conditionerCol value

Returns
conditionerCol: column holding identifiers for features that will be returned when queried

◆ GetFeaturesCol()

string Synapse.ML.Nn.ConditionalKNN.GetFeaturesCol ( )

Gets featuresCol value

Returns
featuresCol: The name of the features column

◆ GetK()

int Synapse.ML.Nn.ConditionalKNN.GetK ( )

Gets k value

Returns
k: number of matches to return

◆ GetLabelCol()

string Synapse.ML.Nn.ConditionalKNN.GetLabelCol ( )

Gets labelCol value

Returns
labelCol: The name of the label column

◆ GetLeafSize()

int Synapse.ML.Nn.ConditionalKNN.GetLeafSize ( )

Gets leafSize value

Returns
leafSize: max size of the leaves of the tree

◆ GetOutputCol()

string Synapse.ML.Nn.ConditionalKNN.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetValuesCol()

string Synapse.ML.Nn.ConditionalKNN.GetValuesCol ( )

Gets valuesCol value

Returns
valuesCol: column holding values for each feature (key) that will be returned when queried

◆ Load()

static ConditionalKNN Synapse.ML.Nn.ConditionalKNN.Load ( string  path)
static

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

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

◆ Read()

JavaMLReader<ConditionalKNN> Synapse.ML.Nn.ConditionalKNN.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Nn.ConditionalKNN.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

◆ SetConditionerCol()

ConditionalKNN Synapse.ML.Nn.ConditionalKNN.SetConditionerCol ( string  value)

Sets value for conditionerCol

Parameters
valuecolumn holding identifiers for features that will be returned when queried
Returns
New ConditionalKNN object

◆ SetFeaturesCol()

ConditionalKNN Synapse.ML.Nn.ConditionalKNN.SetFeaturesCol ( string  value)

Sets value for featuresCol

Parameters
valueThe name of the features column
Returns
New ConditionalKNN object

◆ SetK()

ConditionalKNN Synapse.ML.Nn.ConditionalKNN.SetK ( int  value)

Sets value for k

Parameters
valuenumber of matches to return
Returns
New ConditionalKNN object

◆ SetLabelCol()

ConditionalKNN Synapse.ML.Nn.ConditionalKNN.SetLabelCol ( string  value)

Sets value for labelCol

Parameters
valueThe name of the label column
Returns
New ConditionalKNN object

◆ SetLeafSize()

ConditionalKNN Synapse.ML.Nn.ConditionalKNN.SetLeafSize ( int  value)

Sets value for leafSize

Parameters
valuemax size of the leaves of the tree
Returns
New ConditionalKNN object

◆ SetOutputCol()

ConditionalKNN Synapse.ML.Nn.ConditionalKNN.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New ConditionalKNN object

◆ SetValuesCol()

ConditionalKNN Synapse.ML.Nn.ConditionalKNN.SetValuesCol ( string  value)

Sets value for valuesCol

Parameters
valuecolumn holding values for each feature (key) that will be returned when queried
Returns
New ConditionalKNN object

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