Synapse.ML.Recommendation.RankingEvaluator Class Reference

RankingEvaluator implements RankingEvaluator More...

Inheritance diagram for Synapse.ML.Recommendation.RankingEvaluator:

Collaboration diagram for Synapse.ML.Recommendation.RankingEvaluator:

Public Member Functions
	RankingEvaluator ()
	Creates a RankingEvaluator without any parameters. More...
	RankingEvaluator (string uid)
	Creates a RankingEvaluator with a UID that is used to give the RankingEvaluator a unique ID. More...
RankingEvaluator	SetItemCol (string value)
	Sets value for itemCol More...
RankingEvaluator	SetK (int value)
	Sets value for k More...
RankingEvaluator	SetLabelCol (string value)
	Sets value for labelCol More...
RankingEvaluator	SetMetricName (string value)
	Sets value for metricName More...
RankingEvaluator	SetNItems (long value)
	Sets value for nItems More...
RankingEvaluator	SetPredictionCol (string value)
	Sets value for predictionCol More...
RankingEvaluator	SetRatingCol (string value)
	Sets value for ratingCol More...
RankingEvaluator	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...
string	GetMetricName ()
	Gets metricName value More...
long	GetNItems ()
	Gets nItems value More...
string	GetPredictionCol ()
	Gets predictionCol value More...
string	GetRatingCol ()
	Gets ratingCol 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< RankingEvaluator >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

RankingEvaluator implements RankingEvaluator

Constructor & Destructor Documentation

RankingEvaluator() [1/2]

Synapse.ML.Recommendation.RankingEvaluator.RankingEvaluator ( )

inline

Creates a RankingEvaluator without any parameters.

RankingEvaluator() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetItemCol()

string Synapse.ML.Recommendation.RankingEvaluator.GetItemCol

(

)

Gets itemCol value

Returns

itemCol: Column of items

GetK()

int Synapse.ML.Recommendation.RankingEvaluator.GetK

(

)

Gets k value

Returns

k: number of items

GetLabelCol()

string Synapse.ML.Recommendation.RankingEvaluator.GetLabelCol

(

)

Gets labelCol value

Returns

labelCol: label column name

GetMetricName()

string Synapse.ML.Recommendation.RankingEvaluator.GetMetricName

(

)

Gets metricName value

Returns

metricName: metric name in evaluation (ndcgAt|map|precisionAtk|recallAtK|diversityAtK|maxDiversity|mrr|fcp)

GetNItems()

long Synapse.ML.Recommendation.RankingEvaluator.GetNItems

(

)

Gets nItems value

Returns

nItems: number of items

GetPredictionCol()

string Synapse.ML.Recommendation.RankingEvaluator.GetPredictionCol

(

)

Gets predictionCol value

Returns

predictionCol: prediction column name

GetRatingCol()

string Synapse.ML.Recommendation.RankingEvaluator.GetRatingCol

(

)

Gets ratingCol value

Returns

ratingCol: Column of ratings

GetUserCol()

string Synapse.ML.Recommendation.RankingEvaluator.GetUserCol

(

)

Gets userCol value

Returns

userCol: Column of users

Load()

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

static

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

Parameters

path	The path the previous RankingEvaluator was saved to

Returns

New RankingEvaluator object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<RankingEvaluator> instance for this ML instance.

Save()

void Synapse.ML.Recommendation.RankingEvaluator.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()

RankingEvaluator Synapse.ML.Recommendation.RankingEvaluator.SetItemCol

(

string

value

)

Sets value for itemCol

Parameters

value

Column of items

Returns

New RankingEvaluator object

SetK()

RankingEvaluator Synapse.ML.Recommendation.RankingEvaluator.SetK

(

int

value

)

Sets value for k

Parameters

value

number of items

Returns

New RankingEvaluator object

SetLabelCol()

RankingEvaluator Synapse.ML.Recommendation.RankingEvaluator.SetLabelCol

(

string

value

)

Sets value for labelCol

Parameters

value

label column name

Returns

New RankingEvaluator object

SetMetricName()

RankingEvaluator Synapse.ML.Recommendation.RankingEvaluator.SetMetricName

(

string

value

)

Sets value for metricName

Parameters

value

metric name in evaluation (ndcgAt|map|precisionAtk|recallAtK|diversityAtK|maxDiversity|mrr|fcp)

Returns

New RankingEvaluator object

SetNItems()

RankingEvaluator Synapse.ML.Recommendation.RankingEvaluator.SetNItems

(

long

value

)

Sets value for nItems

Parameters

value

number of items

Returns

New RankingEvaluator object

SetPredictionCol()

RankingEvaluator Synapse.ML.Recommendation.RankingEvaluator.SetPredictionCol

(

string

value

)

Sets value for predictionCol

Parameters

value

prediction column name

Returns

New RankingEvaluator object

SetRatingCol()

RankingEvaluator Synapse.ML.Recommendation.RankingEvaluator.SetRatingCol

(

string

value

)

Sets value for ratingCol

Parameters

value

Column of ratings

Returns

New RankingEvaluator object

SetUserCol()

RankingEvaluator Synapse.ML.Recommendation.RankingEvaluator.SetUserCol

(

string

value

)

Sets value for userCol

Parameters

value

Column of users

Returns

New RankingEvaluator object

---

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

• synapse/ml/recommendation/RankingEvaluator.cs