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

RankingAdapter implements RankingAdapter More...

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

Public Member Functions

 RankingAdapter ()
 Creates a RankingAdapter without any parameters. More...
 
 RankingAdapter (string uid)
 Creates a RankingAdapter with a UID that is used to give the RankingAdapter a unique ID. More...
 
RankingAdapter SetItemCol (string value)
 Sets value for itemCol More...
 
RankingAdapter SetK (int value)
 Sets value for k More...
 
RankingAdapter SetLabelCol (string value)
 Sets value for labelCol More...
 
RankingAdapter SetMinRatingsPerItem (int value)
 Sets value for minRatingsPerItem More...
 
RankingAdapter SetMinRatingsPerUser (int value)
 Sets value for minRatingsPerUser More...
 
RankingAdapter SetMode (string value)
 Sets value for mode More...
 
RankingAdapter SetRatingCol (string value)
 Sets value for ratingCol More...
 
RankingAdapter SetRecommender< M > (JavaEstimator< M > value)
 Sets value for recommender More...
 
RankingAdapter SetUserCol (string value)
 Sets value for userCol More...
 
string GetItemCol ()
 Gets itemCol value More...
 
int GetK ()
 Gets k value More...
 
string GetLabelCol ()
 Gets labelCol value More...
 
int GetMinRatingsPerItem ()
 Gets minRatingsPerItem value More...
 
int GetMinRatingsPerUser ()
 Gets minRatingsPerUser value More...
 
string GetMode ()
 Gets mode value More...
 
string GetRatingCol ()
 Gets ratingCol value More...
 
IEstimator< object > GetRecommender ()
 Gets recommender value More...
 
string GetUserCol ()
 Gets userCol value More...
 
override RankingAdapterModel 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< RankingAdapterRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

RankingAdapter implements RankingAdapter

Constructor & Destructor Documentation

◆ RankingAdapter() [1/2]

Synapse.ML.Recommendation.RankingAdapter.RankingAdapter ( )
inline

Creates a RankingAdapter without any parameters.

◆ RankingAdapter() [2/2]

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

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

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

Member Function Documentation

◆ Fit()

override RankingAdapterModel Synapse.ML.Recommendation.RankingAdapter.Fit ( DataFrame  dataset)

Fits a model to the input data.

Parameters
datasetThe DataFrame to fit the model to.
Returns
RankingAdapterModel

◆ GetItemCol()

string Synapse.ML.Recommendation.RankingAdapter.GetItemCol ( )

Gets itemCol value

Returns
itemCol: Column of items

◆ GetK()

int Synapse.ML.Recommendation.RankingAdapter.GetK ( )

Gets k value

Returns
k: number of items

◆ GetLabelCol()

string Synapse.ML.Recommendation.RankingAdapter.GetLabelCol ( )

Gets labelCol value

Returns
labelCol: The name of the label column

◆ GetMinRatingsPerItem()

int Synapse.ML.Recommendation.RankingAdapter.GetMinRatingsPerItem ( )

Gets minRatingsPerItem value

Returns
minRatingsPerItem: min ratings for items > 0

◆ GetMinRatingsPerUser()

int Synapse.ML.Recommendation.RankingAdapter.GetMinRatingsPerUser ( )

Gets minRatingsPerUser value

Returns
minRatingsPerUser: min ratings for users > 0

◆ GetMode()

string Synapse.ML.Recommendation.RankingAdapter.GetMode ( )

Gets mode value

Returns
mode: recommendation mode

◆ GetRatingCol()

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

Gets ratingCol value

Returns
ratingCol: Column of ratings

◆ GetRecommender()

IEstimator<object> Synapse.ML.Recommendation.RankingAdapter.GetRecommender ( )
inline

Gets recommender value

Returns
recommender: estimator for selection

◆ GetUserCol()

string Synapse.ML.Recommendation.RankingAdapter.GetUserCol ( )

Gets userCol value

Returns
userCol: Column of users

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetItemCol()

RankingAdapter Synapse.ML.Recommendation.RankingAdapter.SetItemCol ( string  value)

Sets value for itemCol

Parameters
valueColumn of items
Returns
New RankingAdapter object

◆ SetK()

RankingAdapter Synapse.ML.Recommendation.RankingAdapter.SetK ( int  value)

Sets value for k

Parameters
valuenumber of items
Returns
New RankingAdapter object

◆ SetLabelCol()

RankingAdapter Synapse.ML.Recommendation.RankingAdapter.SetLabelCol ( string  value)

Sets value for labelCol

Parameters
valueThe name of the label column
Returns
New RankingAdapter object

◆ SetMinRatingsPerItem()

RankingAdapter Synapse.ML.Recommendation.RankingAdapter.SetMinRatingsPerItem ( int  value)

Sets value for minRatingsPerItem

Parameters
valuemin ratings for items > 0
Returns
New RankingAdapter object

◆ SetMinRatingsPerUser()

RankingAdapter Synapse.ML.Recommendation.RankingAdapter.SetMinRatingsPerUser ( int  value)

Sets value for minRatingsPerUser

Parameters
valuemin ratings for users > 0
Returns
New RankingAdapter object

◆ SetMode()

RankingAdapter Synapse.ML.Recommendation.RankingAdapter.SetMode ( string  value)

Sets value for mode

Parameters
valuerecommendation mode
Returns
New RankingAdapter object

◆ SetRatingCol()

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

Sets value for ratingCol

Parameters
valueColumn of ratings
Returns
New RankingAdapter object

◆ SetRecommender< M >()

RankingAdapter Synapse.ML.Recommendation.RankingAdapter.SetRecommender< M > ( JavaEstimator< M >  value)

Sets value for recommender

Parameters
valueestimator for selection
Returns
New RankingAdapter object
Type Constraints
M :JavaModel<M> 
M :WrapAsRankingAdapter 
M :Reference.Invoke 
M :setRecommender 
M :object 
M :value 

◆ SetUserCol()

RankingAdapter Synapse.ML.Recommendation.RankingAdapter.SetUserCol ( string  value)

Sets value for userCol

Parameters
valueColumn of users
Returns
New RankingAdapter object

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