Synapse.ML.Recommendation.RankingTrainValidationSplitModel Class Reference

RankingTrainValidationSplitModel implements RankingTrainValidationSplitModel More...

Inheritance diagram for Synapse.ML.Recommendation.RankingTrainValidationSplitModel:

Collaboration diagram for Synapse.ML.Recommendation.RankingTrainValidationSplitModel:

Public Member Functions
	RankingTrainValidationSplitModel ()
	Creates a RankingTrainValidationSplitModel without any parameters. More...
	RankingTrainValidationSplitModel (string uid)
	Creates a RankingTrainValidationSplitModel with a UID that is used to give the RankingTrainValidationSplitModel a unique ID. More...
RankingTrainValidationSplitModel	SetBestModel< M > (JavaModel< M > value)
	Sets value for bestModel More...
RankingTrainValidationSplitModel	SetValidationMetrics (double[] value)
	Sets value for validationMetrics More...
IModel< object >	GetBestModel ()
	Gets bestModel value More...
double []	GetValidationMetrics ()
	Gets validationMetrics 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< RankingTrainValidationSplitModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

RankingTrainValidationSplitModel implements RankingTrainValidationSplitModel

Constructor & Destructor Documentation

RankingTrainValidationSplitModel() [1/2]

Synapse.ML.Recommendation.RankingTrainValidationSplitModel.RankingTrainValidationSplitModel ( )

inline

Creates a RankingTrainValidationSplitModel without any parameters.

RankingTrainValidationSplitModel() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

GetBestModel()

IModel<object> Synapse.ML.Recommendation.RankingTrainValidationSplitModel.GetBestModel ( )

inline

Gets bestModel value

Returns

bestModel: The internal ALS model used splitter

GetValidationMetrics()

double [] Synapse.ML.Recommendation.RankingTrainValidationSplitModel.GetValidationMetrics ( )

inline

Gets validationMetrics value

Returns

validationMetrics: Best Model

Load()

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

static

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

Parameters

path	The path the previous RankingTrainValidationSplitModel was saved to

Returns

New RankingTrainValidationSplitModel object, loaded from path.

Read()

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

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<RankingTrainValidationSplitModel> instance for this ML instance.

Save()

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

SetBestModel< M >()

RankingTrainValidationSplitModel Synapse.ML.Recommendation.RankingTrainValidationSplitModel.SetBestModel< M >

(

JavaModel< M >

value

)

Sets value for bestModel

Parameters

value

The internal ALS model used splitter

Returns

New RankingTrainValidationSplitModel object

Type Constraints

M	:	JavaModel<M>
M	:	WrapAsRankingTrainValidationSplitModel
M	:	Reference.Invoke
M	:	setBestModel
M	:	object
M	:	value

SetValidationMetrics()

RankingTrainValidationSplitModel Synapse.ML.Recommendation.RankingTrainValidationSplitModel.SetValidationMetrics

(

double []

value

)

Sets value for validationMetrics

Parameters

value

Best Model

Returns

New RankingTrainValidationSplitModel object

---

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

• synapse/ml/recommendation/RankingTrainValidationSplitModel.cs