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

RecommendationIndexer implements RecommendationIndexer More...

Inheritance diagram for Synapse.ML.Recommendation.RecommendationIndexer:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Recommendation.RecommendationIndexer:
Collaboration graph
[legend]

Public Member Functions

 RecommendationIndexer ()
 Creates a RecommendationIndexer without any parameters. More...
 
 RecommendationIndexer (string uid)
 Creates a RecommendationIndexer with a UID that is used to give the RecommendationIndexer a unique ID. More...
 
RecommendationIndexer SetItemInputCol (string value)
 Sets value for itemInputCol More...
 
RecommendationIndexer SetItemOutputCol (string value)
 Sets value for itemOutputCol More...
 
RecommendationIndexer SetRatingCol (string value)
 Sets value for ratingCol More...
 
RecommendationIndexer SetUserInputCol (string value)
 Sets value for userInputCol More...
 
RecommendationIndexer SetUserOutputCol (string value)
 Sets value for userOutputCol More...
 
string GetItemInputCol ()
 Gets itemInputCol value More...
 
string GetItemOutputCol ()
 Gets itemOutputCol value More...
 
string GetRatingCol ()
 Gets ratingCol value More...
 
string GetUserInputCol ()
 Gets userInputCol value More...
 
string GetUserOutputCol ()
 Gets userOutputCol value More...
 
override RecommendationIndexerModel 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< RecommendationIndexerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

RecommendationIndexer implements RecommendationIndexer

Constructor & Destructor Documentation

◆ RecommendationIndexer() [1/2]

Synapse.ML.Recommendation.RecommendationIndexer.RecommendationIndexer ( )
inline

Creates a RecommendationIndexer without any parameters.

◆ RecommendationIndexer() [2/2]

Synapse.ML.Recommendation.RecommendationIndexer.RecommendationIndexer ( string  uid)
inline

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

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

Member Function Documentation

◆ Fit()

override RecommendationIndexerModel Synapse.ML.Recommendation.RecommendationIndexer.Fit ( DataFrame  dataset)

Fits a model to the input data.

Parameters
datasetThe DataFrame to fit the model to.
Returns
RecommendationIndexerModel

◆ GetItemInputCol()

string Synapse.ML.Recommendation.RecommendationIndexer.GetItemInputCol ( )

Gets itemInputCol value

Returns
itemInputCol: Item Input Col

◆ GetItemOutputCol()

string Synapse.ML.Recommendation.RecommendationIndexer.GetItemOutputCol ( )

Gets itemOutputCol value

Returns
itemOutputCol: Item Output Col

◆ GetRatingCol()

string Synapse.ML.Recommendation.RecommendationIndexer.GetRatingCol ( )

Gets ratingCol value

Returns
ratingCol: Rating Col

◆ GetUserInputCol()

string Synapse.ML.Recommendation.RecommendationIndexer.GetUserInputCol ( )

Gets userInputCol value

Returns
userInputCol: User Input Col

◆ GetUserOutputCol()

string Synapse.ML.Recommendation.RecommendationIndexer.GetUserOutputCol ( )

Gets userOutputCol value

Returns
userOutputCol: User Output Col

◆ Load()

static RecommendationIndexer Synapse.ML.Recommendation.RecommendationIndexer.Load ( string  path)
static

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

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

◆ Read()

JavaMLReader<RecommendationIndexer> Synapse.ML.Recommendation.RecommendationIndexer.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Recommendation.RecommendationIndexer.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

◆ SetItemInputCol()

RecommendationIndexer Synapse.ML.Recommendation.RecommendationIndexer.SetItemInputCol ( string  value)

Sets value for itemInputCol

Parameters
valueItem Input Col
Returns
New RecommendationIndexer object

◆ SetItemOutputCol()

RecommendationIndexer Synapse.ML.Recommendation.RecommendationIndexer.SetItemOutputCol ( string  value)

Sets value for itemOutputCol

Parameters
valueItem Output Col
Returns
New RecommendationIndexer object

◆ SetRatingCol()

RecommendationIndexer Synapse.ML.Recommendation.RecommendationIndexer.SetRatingCol ( string  value)

Sets value for ratingCol

Parameters
valueRating Col
Returns
New RecommendationIndexer object

◆ SetUserInputCol()

RecommendationIndexer Synapse.ML.Recommendation.RecommendationIndexer.SetUserInputCol ( string  value)

Sets value for userInputCol

Parameters
valueUser Input Col
Returns
New RecommendationIndexer object

◆ SetUserOutputCol()

RecommendationIndexer Synapse.ML.Recommendation.RecommendationIndexer.SetUserOutputCol ( string  value)

Sets value for userOutputCol

Parameters
valueUser Output Col
Returns
New RecommendationIndexer object

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