Synapse.ML.Recommendation.RankingAdapterModel Class Reference

RankingAdapterModel implements RankingAdapterModel More...

Inheritance diagram for Synapse.ML.Recommendation.RankingAdapterModel:

Collaboration diagram for Synapse.ML.Recommendation.RankingAdapterModel:

Public Member Functions
	RankingAdapterModel ()
	Creates a RankingAdapterModel without any parameters. More...
	RankingAdapterModel (string uid)
	Creates a RankingAdapterModel with a UID that is used to give the RankingAdapterModel a unique ID. More...
RankingAdapterModel	SetItemCol (string value)
	Sets value for itemCol More...
RankingAdapterModel	SetK (int value)
	Sets value for k More...
RankingAdapterModel	SetLabelCol (string value)
	Sets value for labelCol More...
RankingAdapterModel	SetMinRatingsPerItem (int value)
	Sets value for minRatingsPerItem More...
RankingAdapterModel	SetMinRatingsPerUser (int value)
	Sets value for minRatingsPerUser More...
RankingAdapterModel	SetMode (string value)
	Sets value for mode More...
RankingAdapterModel	SetRatingCol (string value)
	Sets value for ratingCol More...
RankingAdapterModel	SetRecommender< M > (JavaEstimator< M > value)
	Sets value for recommender More...
RankingAdapterModel	SetRecommenderModel (JavaTransformer value)
	Sets value for recommenderModel More...
RankingAdapterModel	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...
JavaTransformer	GetRecommenderModel ()
	Gets recommenderModel value More...
string	GetUserCol ()
	Gets userCol 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< RankingAdapterModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

RankingAdapterModel implements RankingAdapterModel

Constructor & Destructor Documentation

RankingAdapterModel() [1/2]

Synapse.ML.Recommendation.RankingAdapterModel.RankingAdapterModel ( )

inline

Creates a RankingAdapterModel without any parameters.

RankingAdapterModel() [2/2]

Synapse.ML.Recommendation.RankingAdapterModel.RankingAdapterModel ( string  uid )

inline

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

Parameters

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

Member Function Documentation

GetItemCol()

string Synapse.ML.Recommendation.RankingAdapterModel.GetItemCol

(

)

Gets itemCol value

Returns

itemCol: Column of items

GetK()

int Synapse.ML.Recommendation.RankingAdapterModel.GetK

(

)

Gets k value

Returns

k: number of items

GetLabelCol()

string Synapse.ML.Recommendation.RankingAdapterModel.GetLabelCol

(

)

Gets labelCol value

Returns

labelCol: The name of the label column

GetMinRatingsPerItem()

int Synapse.ML.Recommendation.RankingAdapterModel.GetMinRatingsPerItem

(

)

Gets minRatingsPerItem value

Returns

minRatingsPerItem: min ratings for items > 0

GetMinRatingsPerUser()

int Synapse.ML.Recommendation.RankingAdapterModel.GetMinRatingsPerUser

(

)

Gets minRatingsPerUser value

Returns

minRatingsPerUser: min ratings for users > 0

GetMode()

string Synapse.ML.Recommendation.RankingAdapterModel.GetMode

(

)

Gets mode value

Returns

mode: recommendation mode

GetRatingCol()

string Synapse.ML.Recommendation.RankingAdapterModel.GetRatingCol

(

)

Gets ratingCol value

Returns

ratingCol: Column of ratings

GetRecommender()

IEstimator<object> Synapse.ML.Recommendation.RankingAdapterModel.GetRecommender ( )

inline

Gets recommender value

Returns

recommender: estimator for selection

GetRecommenderModel()

JavaTransformer Synapse.ML.Recommendation.RankingAdapterModel.GetRecommenderModel ( )

inline

Gets recommenderModel value

Returns

recommenderModel: recommenderModel

GetUserCol()

string Synapse.ML.Recommendation.RankingAdapterModel.GetUserCol

(

)

Gets userCol value

Returns

userCol: Column of users

Load()

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

static

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

Parameters

path	The path the previous RankingAdapterModel was saved to

Returns

New RankingAdapterModel object, loaded from path.

Read()

JavaMLReader<RankingAdapterModel> Synapse.ML.Recommendation.RankingAdapterModel.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<RankingAdapterModel> instance for this ML instance.

Save()

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

SetItemCol()

RankingAdapterModel Synapse.ML.Recommendation.RankingAdapterModel.SetItemCol

(

string

value

)

Sets value for itemCol

Parameters

value

Column of items

Returns

New RankingAdapterModel object

SetK()

RankingAdapterModel Synapse.ML.Recommendation.RankingAdapterModel.SetK

(

int

value

)

Sets value for k

Parameters

value

number of items

Returns

New RankingAdapterModel object

SetLabelCol()

RankingAdapterModel Synapse.ML.Recommendation.RankingAdapterModel.SetLabelCol

(

string

value

)

Sets value for labelCol

Parameters

value

The name of the label column

Returns

New RankingAdapterModel object

SetMinRatingsPerItem()

RankingAdapterModel Synapse.ML.Recommendation.RankingAdapterModel.SetMinRatingsPerItem

(

int

value

)

Sets value for minRatingsPerItem

Parameters

value

min ratings for items > 0

Returns

New RankingAdapterModel object

SetMinRatingsPerUser()

RankingAdapterModel Synapse.ML.Recommendation.RankingAdapterModel.SetMinRatingsPerUser

(

int

value

)

Sets value for minRatingsPerUser

Parameters

value

min ratings for users > 0

Returns

New RankingAdapterModel object

SetMode()

RankingAdapterModel Synapse.ML.Recommendation.RankingAdapterModel.SetMode

(

string

value

)

Sets value for mode

Parameters

value

recommendation mode

Returns

New RankingAdapterModel object

SetRatingCol()

RankingAdapterModel Synapse.ML.Recommendation.RankingAdapterModel.SetRatingCol

(

string

value

)

Sets value for ratingCol

Parameters

value

Column of ratings

Returns

New RankingAdapterModel object

SetRecommender< M >()

RankingAdapterModel Synapse.ML.Recommendation.RankingAdapterModel.SetRecommender< M >

(

JavaEstimator< M >

value

)

Sets value for recommender

Parameters

value

estimator for selection

Returns

New RankingAdapterModel object

Type Constraints

M	:	JavaModel<M>
M	:	WrapAsRankingAdapterModel
M	:	Reference.Invoke
M	:	setRecommender
M	:	object
M	:	value

SetRecommenderModel()

RankingAdapterModel Synapse.ML.Recommendation.RankingAdapterModel.SetRecommenderModel

(

JavaTransformer

value

)

Sets value for recommenderModel

Parameters

value

recommenderModel

Returns

New RankingAdapterModel object

SetUserCol()

RankingAdapterModel Synapse.ML.Recommendation.RankingAdapterModel.SetUserCol

(

string

value

)

Sets value for userCol

Parameters

value

Column of users

Returns

New RankingAdapterModel object

---

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

• synapse/ml/recommendation/RankingAdapterModel.cs