ConditionalKNNModel implements ConditionalKNNModel More...

Inheritance diagram for Synapse.ML.Nn.ConditionalKNNModel:

[legend]

Collaboration diagram for Synapse.ML.Nn.ConditionalKNNModel:

[legend]

Public Member Functions
	ConditionalKNNModel ()
	Creates a ConditionalKNNModel without any parameters. More...

	ConditionalKNNModel (string uid)
	Creates a ConditionalKNNModel with a UID that is used to give the ConditionalKNNModel a unique ID. More...

ConditionalKNNModel	SetBallTree (object value)
	Sets value for ballTree More...

ConditionalKNNModel	SetConditionerCol (string value)
	Sets value for conditionerCol More...

ConditionalKNNModel	SetFeaturesCol (string value)
	Sets value for featuresCol More...

ConditionalKNNModel	SetK (int value)
	Sets value for k More...

ConditionalKNNModel	SetLabelCol (string value)
	Sets value for labelCol More...

ConditionalKNNModel	SetLeafSize (int value)
	Sets value for leafSize More...

ConditionalKNNModel	SetOutputCol (string value)
	Sets value for outputCol More...

ConditionalKNNModel	SetValuesCol (string value)
	Sets value for valuesCol More...

object	GetBallTree ()
	Gets ballTree value 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...

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< ConditionalKNNModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

ConditionalKNNModel implements ConditionalKNNModel

Constructor & Destructor Documentation

◆ ConditionalKNNModel() [1/2]

Synapse.ML.Nn.ConditionalKNNModel.ConditionalKNNModel ( )

inline

Creates a ConditionalKNNModel without any parameters.

◆ ConditionalKNNModel() [2/2]

Synapse.ML.Nn.ConditionalKNNModel.ConditionalKNNModel ( string uid )

inline

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

Parameters

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

Member Function Documentation

◆ GetBallTree()

object Synapse.ML.Nn.ConditionalKNNModel.GetBallTree ( )

Gets ballTree value

Returns: ballTree: the ballTree model used for perfoming queries

◆ GetConditionerCol()

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

Gets conditionerCol value

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

◆ GetFeaturesCol()

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

Gets featuresCol value

Returns: featuresCol: The name of the features column

◆ GetK()

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

Gets k value

Returns: k: number of matches to return

◆ GetLabelCol()

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

Gets labelCol value

Returns: labelCol: The name of the label column

◆ GetLeafSize()

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

Gets leafSize value

Returns: leafSize: max size of the leaves of the tree

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetValuesCol()

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

Gets valuesCol value

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

◆ Load()

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

static

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

Parameters

path	The path the previous ConditionalKNNModel was saved to

Returns: New ConditionalKNNModel object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<ConditionalKNNModel> instance for this ML instance.

◆ Save()

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

◆ SetBallTree()

ConditionalKNNModel Synapse.ML.Nn.ConditionalKNNModel.SetBallTree ( object value )

Sets value for ballTree

Parameters

value the ballTree model used for perfoming queries

Returns: New ConditionalKNNModel object

◆ SetConditionerCol()

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

Sets value for conditionerCol

Parameters

value column holding identifiers for features that will be returned when queried

Returns: New ConditionalKNNModel object

◆ SetFeaturesCol()

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

Sets value for featuresCol

Parameters

value The name of the features column

Returns: New ConditionalKNNModel object

◆ SetK()

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

Sets value for k

Parameters

value number of matches to return

Returns: New ConditionalKNNModel object

◆ SetLabelCol()

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

Sets value for labelCol

Parameters

value The name of the label column

Returns: New ConditionalKNNModel object

◆ SetLeafSize()

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

Sets value for leafSize

Parameters

value max size of the leaves of the tree

Returns: New ConditionalKNNModel object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value The name of the output column

Returns: New ConditionalKNNModel object

◆ SetValuesCol()

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

Sets value for valuesCol

Parameters

value column holding values for each feature (key) that will be returned when queried

Returns: New ConditionalKNNModel object

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

synapse/ml/nn/ConditionalKNNModel.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ConditionalKNNModel() [1/2]

◆ ConditionalKNNModel() [2/2]

Member Function Documentation

◆ GetBallTree()

◆ GetConditionerCol()

◆ GetFeaturesCol()

◆ GetK()

◆ GetLabelCol()

◆ GetLeafSize()

◆ GetOutputCol()

◆ GetValuesCol()

◆ Load()

◆ Read()

◆ Save()

◆ SetBallTree()

◆ SetConditionerCol()

◆ SetFeaturesCol()

◆ SetK()

◆ SetLabelCol()

◆ SetLeafSize()

◆ SetOutputCol()

◆ SetValuesCol()