Inheritance diagram for Synapse.ML.Recommendation.SARModel:

[legend]

Collaboration diagram for Synapse.ML.Recommendation.SARModel:

[legend]

Public Member Functions
	SARModel ()
	Creates a SARModel without any parameters. More...

	SARModel (string uid)
	Creates a SARModel with a UID that is used to give the SARModel a unique ID. More...

SARModel	SetActivityTimeFormat (string value)
	Sets value for activityTimeFormat More...

SARModel	SetAlpha (double value)
	Sets value for alpha More...

SARModel	SetBlockSize (int value)
	Sets value for blockSize More...

SARModel	SetCheckpointInterval (int value)
	Sets value for checkpointInterval More...

SARModel	SetColdStartStrategy (string value)
	Sets value for coldStartStrategy More...

SARModel	SetFinalStorageLevel (string value)
	Sets value for finalStorageLevel More...

SARModel	SetImplicitPrefs (bool value)
	Sets value for implicitPrefs More...

SARModel	SetIntermediateStorageLevel (string value)
	Sets value for intermediateStorageLevel More...

SARModel	SetItemCol (string value)
	Sets value for itemCol More...

SARModel	SetItemDataFrame (DataFrame value)
	Sets value for itemDataFrame More...

SARModel	SetMaxIter (int value)
	Sets value for maxIter More...

SARModel	SetNonnegative (bool value)
	Sets value for nonnegative More...

SARModel	SetNumItemBlocks (int value)
	Sets value for numItemBlocks More...

SARModel	SetNumUserBlocks (int value)
	Sets value for numUserBlocks More...

SARModel	SetPredictionCol (string value)
	Sets value for predictionCol More...

SARModel	SetRank (int value)
	Sets value for rank More...

SARModel	SetRatingCol (string value)
	Sets value for ratingCol More...

SARModel	SetRegParam (double value)
	Sets value for regParam More...

SARModel	SetSeed (long value)
	Sets value for seed More...

SARModel	SetSimilarityFunction (string value)
	Sets value for similarityFunction More...

SARModel	SetStartTime (string value)
	Sets value for startTime More...

SARModel	SetStartTimeFormat (string value)
	Sets value for startTimeFormat More...

SARModel	SetSupportThreshold (int value)
	Sets value for supportThreshold More...

SARModel	SetTimeCol (string value)
	Sets value for timeCol More...

SARModel	SetTimeDecayCoeff (int value)
	Sets value for timeDecayCoeff More...

SARModel	SetUserCol (string value)
	Sets value for userCol More...

SARModel	SetUserDataFrame (DataFrame value)
	Sets value for userDataFrame More...

string	GetActivityTimeFormat ()
	Gets activityTimeFormat value More...

double	GetAlpha ()
	Gets alpha value More...

int	GetBlockSize ()
	Gets blockSize value More...

int	GetCheckpointInterval ()
	Gets checkpointInterval value More...

string	GetColdStartStrategy ()
	Gets coldStartStrategy value More...

string	GetFinalStorageLevel ()
	Gets finalStorageLevel value More...

bool	GetImplicitPrefs ()
	Gets implicitPrefs value More...

string	GetIntermediateStorageLevel ()
	Gets intermediateStorageLevel value More...

string	GetItemCol ()
	Gets itemCol value More...

DataFrame	GetItemDataFrame ()
	Gets itemDataFrame value More...

int	GetMaxIter ()
	Gets maxIter value More...

bool	GetNonnegative ()
	Gets nonnegative value More...

int	GetNumItemBlocks ()
	Gets numItemBlocks value More...

int	GetNumUserBlocks ()
	Gets numUserBlocks value More...

string	GetPredictionCol ()
	Gets predictionCol value More...

int	GetRank ()
	Gets rank value More...

string	GetRatingCol ()
	Gets ratingCol value More...

double	GetRegParam ()
	Gets regParam value More...

long	GetSeed ()
	Gets seed value More...

string	GetSimilarityFunction ()
	Gets similarityFunction value More...

string	GetStartTime ()
	Gets startTime value More...

string	GetStartTimeFormat ()
	Gets startTimeFormat value More...

int	GetSupportThreshold ()
	Gets supportThreshold value More...

string	GetTimeCol ()
	Gets timeCol value More...

int	GetTimeDecayCoeff ()
	Gets timeDecayCoeff value More...

string	GetUserCol ()
	Gets userCol value More...

DataFrame	GetUserDataFrame ()
	Gets userDataFrame 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< SARModel >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

SARModel implements SARModel

Constructor & Destructor Documentation

◆ SARModel() [1/2]

Synapse.ML.Recommendation.SARModel.SARModel ( )

inline

Creates a SARModel without any parameters.

◆ SARModel() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetActivityTimeFormat()

string Synapse.ML.Recommendation.SARModel.GetActivityTimeFormat ( )

Gets activityTimeFormat value

Returns: activityTimeFormat: Time format for events, default: yyyy/MM/dd'T'h:mm:ss

◆ GetAlpha()

double Synapse.ML.Recommendation.SARModel.GetAlpha ( )

Gets alpha value

Returns: alpha: alpha for implicit preference

◆ GetBlockSize()

int Synapse.ML.Recommendation.SARModel.GetBlockSize ( )

Gets blockSize value

Returns: blockSize: block size for stacking input data in matrices. Data is stacked within partitions. If block size is more than remaining data in a partition then it is adjusted to the size of this data.

◆ GetCheckpointInterval()

int Synapse.ML.Recommendation.SARModel.GetCheckpointInterval ( )

Gets checkpointInterval value

Returns: checkpointInterval: set checkpoint interval (>= 1) or disable checkpoint (-1). E.g. 10 means that the cache will get checkpointed every 10 iterations. Note: this setting will be ignored if the checkpoint directory is not set in the SparkContext

◆ GetColdStartStrategy()

string Synapse.ML.Recommendation.SARModel.GetColdStartStrategy ( )

Gets coldStartStrategy value

Returns: coldStartStrategy: strategy for dealing with unknown or new users/items at prediction time. This may be useful in cross-validation or production scenarios, for handling user/item ids the model has not seen in the training data. Supported values: nan,drop.

◆ GetFinalStorageLevel()

string Synapse.ML.Recommendation.SARModel.GetFinalStorageLevel ( )

Gets finalStorageLevel value

Returns: finalStorageLevel: StorageLevel for ALS model factors.

◆ GetImplicitPrefs()

bool Synapse.ML.Recommendation.SARModel.GetImplicitPrefs ( )

Gets implicitPrefs value

Returns: implicitPrefs: whether to use implicit preference

◆ GetIntermediateStorageLevel()

string Synapse.ML.Recommendation.SARModel.GetIntermediateStorageLevel ( )

Gets intermediateStorageLevel value

Returns: intermediateStorageLevel: StorageLevel for intermediate datasets. Cannot be 'NONE'.

◆ GetItemCol()

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

Gets itemCol value

Returns: itemCol: column name for item ids. Ids must be within the integer value range.

◆ GetItemDataFrame()

DataFrame Synapse.ML.Recommendation.SARModel.GetItemDataFrame ( )

Gets itemDataFrame value

Returns: itemDataFrame: Time of activity

◆ GetMaxIter()

int Synapse.ML.Recommendation.SARModel.GetMaxIter ( )

Gets maxIter value

Returns: maxIter: maximum number of iterations (>= 0)

◆ GetNonnegative()

bool Synapse.ML.Recommendation.SARModel.GetNonnegative ( )

Gets nonnegative value

Returns: nonnegative: whether to use nonnegative constraint for least squares

◆ GetNumItemBlocks()

int Synapse.ML.Recommendation.SARModel.GetNumItemBlocks ( )

Gets numItemBlocks value

Returns: numItemBlocks: number of item blocks

◆ GetNumUserBlocks()

int Synapse.ML.Recommendation.SARModel.GetNumUserBlocks ( )

Gets numUserBlocks value

Returns: numUserBlocks: number of user blocks

◆ GetPredictionCol()

string Synapse.ML.Recommendation.SARModel.GetPredictionCol ( )

Gets predictionCol value

Returns: predictionCol: prediction column name

◆ GetRank()

int Synapse.ML.Recommendation.SARModel.GetRank ( )

Gets rank value

Returns: rank: rank of the factorization

◆ GetRatingCol()

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

Gets ratingCol value

Returns: ratingCol: column name for ratings

◆ GetRegParam()

double Synapse.ML.Recommendation.SARModel.GetRegParam ( )

Gets regParam value

Returns: regParam: regularization parameter (>= 0)

◆ GetSeed()

long Synapse.ML.Recommendation.SARModel.GetSeed ( )

Gets seed value

Returns: seed: random seed

◆ GetSimilarityFunction()

string Synapse.ML.Recommendation.SARModel.GetSimilarityFunction ( )

Gets similarityFunction value

Returns: similarityFunction: Defines the similarity function to be used by the model. Lift favors serendipity, Co-occurrence favors predictability, and Jaccard is a nice compromise between the two.

◆ GetStartTime()

string Synapse.ML.Recommendation.SARModel.GetStartTime ( )

Gets startTime value

Returns: startTime: Set time custom now time if using historical data

◆ GetStartTimeFormat()

string Synapse.ML.Recommendation.SARModel.GetStartTimeFormat ( )

Gets startTimeFormat value

Returns: startTimeFormat: Format for start time

◆ GetSupportThreshold()

int Synapse.ML.Recommendation.SARModel.GetSupportThreshold ( )

Gets supportThreshold value

Returns: supportThreshold: Minimum number of ratings per item

◆ GetTimeCol()

string Synapse.ML.Recommendation.SARModel.GetTimeCol ( )

Gets timeCol value

Returns: timeCol: Time of activity

◆ GetTimeDecayCoeff()

int Synapse.ML.Recommendation.SARModel.GetTimeDecayCoeff ( )

Gets timeDecayCoeff value

Returns: timeDecayCoeff: Use to scale time decay coeff to different half life dur

◆ GetUserCol()

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

Gets userCol value

Returns: userCol: column name for user ids. Ids must be within the integer value range.

◆ GetUserDataFrame()

DataFrame Synapse.ML.Recommendation.SARModel.GetUserDataFrame ( )

Gets userDataFrame value

Returns: userDataFrame: Time of activity

◆ Load()

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

static

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

Parameters

path	The path the previous SARModel was saved to

Returns: New SARModel object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<SARModel> instance for this ML instance.

◆ Save()

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

◆ SetActivityTimeFormat()

SARModel Synapse.ML.Recommendation.SARModel.SetActivityTimeFormat ( string value )

Sets value for activityTimeFormat

Parameters

value Time format for events, default: yyyy/MM/dd'T'h:mm:ss

Returns: New SARModel object

◆ SetAlpha()

SARModel Synapse.ML.Recommendation.SARModel.SetAlpha ( double value )

Sets value for alpha

Parameters

value alpha for implicit preference

Returns: New SARModel object

◆ SetBlockSize()

SARModel Synapse.ML.Recommendation.SARModel.SetBlockSize ( int value )

Sets value for blockSize

Parameters

value block size for stacking input data in matrices. Data is stacked within partitions. If block size is more than remaining data in a partition then it is adjusted to the size of this data.

Returns: New SARModel object

◆ SetCheckpointInterval()

SARModel Synapse.ML.Recommendation.SARModel.SetCheckpointInterval ( int value )

Sets value for checkpointInterval

Parameters

value set checkpoint interval (>= 1) or disable checkpoint (-1). E.g. 10 means that the cache will get checkpointed every 10 iterations. Note: this setting will be ignored if the checkpoint directory is not set in the SparkContext

Returns: New SARModel object

◆ SetColdStartStrategy()

SARModel Synapse.ML.Recommendation.SARModel.SetColdStartStrategy ( string value )

Sets value for coldStartStrategy

Parameters

value strategy for dealing with unknown or new users/items at prediction time. This may be useful in cross-validation or production scenarios, for handling user/item ids the model has not seen in the training data. Supported values: nan,drop.

Returns: New SARModel object

◆ SetFinalStorageLevel()

SARModel Synapse.ML.Recommendation.SARModel.SetFinalStorageLevel ( string value )

Sets value for finalStorageLevel

Parameters

value StorageLevel for ALS model factors.

Returns: New SARModel object

◆ SetImplicitPrefs()

SARModel Synapse.ML.Recommendation.SARModel.SetImplicitPrefs ( bool value )

Sets value for implicitPrefs

Parameters

value whether to use implicit preference

Returns: New SARModel object

◆ SetIntermediateStorageLevel()

SARModel Synapse.ML.Recommendation.SARModel.SetIntermediateStorageLevel ( string value )

Sets value for intermediateStorageLevel

Parameters

value StorageLevel for intermediate datasets. Cannot be 'NONE'.

Returns: New SARModel object

◆ SetItemCol()

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

Sets value for itemCol

Parameters

value column name for item ids. Ids must be within the integer value range.

Returns: New SARModel object

◆ SetItemDataFrame()

SARModel Synapse.ML.Recommendation.SARModel.SetItemDataFrame ( DataFrame value )

Sets value for itemDataFrame

Parameters

value Time of activity

Returns: New SARModel object

◆ SetMaxIter()

SARModel Synapse.ML.Recommendation.SARModel.SetMaxIter ( int value )

Sets value for maxIter

Parameters

value maximum number of iterations (>= 0)

Returns: New SARModel object

◆ SetNonnegative()

SARModel Synapse.ML.Recommendation.SARModel.SetNonnegative ( bool value )

Sets value for nonnegative

Parameters

value whether to use nonnegative constraint for least squares

Returns: New SARModel object

◆ SetNumItemBlocks()

SARModel Synapse.ML.Recommendation.SARModel.SetNumItemBlocks ( int value )

Sets value for numItemBlocks

Parameters

value number of item blocks

Returns: New SARModel object

◆ SetNumUserBlocks()

SARModel Synapse.ML.Recommendation.SARModel.SetNumUserBlocks ( int value )

Sets value for numUserBlocks

Parameters

value number of user blocks

Returns: New SARModel object

◆ SetPredictionCol()

SARModel Synapse.ML.Recommendation.SARModel.SetPredictionCol ( string value )

Sets value for predictionCol

Parameters

value prediction column name

Returns: New SARModel object

◆ SetRank()

SARModel Synapse.ML.Recommendation.SARModel.SetRank ( int value )

Sets value for rank

Parameters

value rank of the factorization

Returns: New SARModel object

◆ SetRatingCol()

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

Sets value for ratingCol

Parameters

value column name for ratings

Returns: New SARModel object

◆ SetRegParam()

SARModel Synapse.ML.Recommendation.SARModel.SetRegParam ( double value )

Sets value for regParam

Parameters

value regularization parameter (>= 0)

Returns: New SARModel object

◆ SetSeed()

SARModel Synapse.ML.Recommendation.SARModel.SetSeed ( long value )

Sets value for seed

Parameters

value random seed

Returns: New SARModel object

◆ SetSimilarityFunction()

SARModel Synapse.ML.Recommendation.SARModel.SetSimilarityFunction ( string value )

Sets value for similarityFunction

Parameters

value Defines the similarity function to be used by the model. Lift favors serendipity, Co-occurrence favors predictability, and Jaccard is a nice compromise between the two.

Returns: New SARModel object

◆ SetStartTime()

SARModel Synapse.ML.Recommendation.SARModel.SetStartTime ( string value )

Sets value for startTime

Parameters

value Set time custom now time if using historical data

Returns: New SARModel object

◆ SetStartTimeFormat()

SARModel Synapse.ML.Recommendation.SARModel.SetStartTimeFormat ( string value )

Sets value for startTimeFormat

Parameters

value Format for start time

Returns: New SARModel object

◆ SetSupportThreshold()

SARModel Synapse.ML.Recommendation.SARModel.SetSupportThreshold ( int value )

Sets value for supportThreshold

Parameters

value Minimum number of ratings per item

Returns: New SARModel object

◆ SetTimeCol()

SARModel Synapse.ML.Recommendation.SARModel.SetTimeCol ( string value )

Sets value for timeCol

Parameters

value Time of activity

Returns: New SARModel object

◆ SetTimeDecayCoeff()

SARModel Synapse.ML.Recommendation.SARModel.SetTimeDecayCoeff ( int value )

Sets value for timeDecayCoeff

Parameters

value Use to scale time decay coeff to different half life dur

Returns: New SARModel object

◆ SetUserCol()

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

Sets value for userCol

Parameters

value column name for user ids. Ids must be within the integer value range.

Returns: New SARModel object

◆ SetUserDataFrame()

SARModel Synapse.ML.Recommendation.SARModel.SetUserDataFrame ( DataFrame value )

Sets value for userDataFrame

Parameters

value Time of activity

Returns: New SARModel object

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

synapse/ml/recommendation/SARModel.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SARModel() [1/2]

◆ SARModel() [2/2]

Member Function Documentation

◆ GetActivityTimeFormat()

◆ GetAlpha()

◆ GetBlockSize()

◆ GetCheckpointInterval()

◆ GetColdStartStrategy()

◆ GetFinalStorageLevel()

◆ GetImplicitPrefs()

◆ GetIntermediateStorageLevel()

◆ GetItemCol()

◆ GetItemDataFrame()

◆ GetMaxIter()

◆ GetNonnegative()

◆ GetNumItemBlocks()

◆ GetNumUserBlocks()

◆ GetPredictionCol()

◆ GetRank()

◆ GetRatingCol()

◆ GetRegParam()

◆ GetSeed()

◆ GetSimilarityFunction()

◆ GetStartTime()

◆ GetStartTimeFormat()

◆ GetSupportThreshold()

◆ GetTimeCol()

◆ GetTimeDecayCoeff()

◆ GetUserCol()

◆ GetUserDataFrame()

◆ Load()

◆ Read()

◆ Save()

◆ SetActivityTimeFormat()

◆ SetAlpha()

◆ SetBlockSize()

◆ SetCheckpointInterval()

◆ SetColdStartStrategy()

◆ SetFinalStorageLevel()

◆ SetImplicitPrefs()

◆ SetIntermediateStorageLevel()

◆ SetItemCol()

◆ SetItemDataFrame()

◆ SetMaxIter()

◆ SetNonnegative()

◆ SetNumItemBlocks()

◆ SetNumUserBlocks()

◆ SetPredictionCol()

◆ SetRank()

◆ SetRatingCol()

◆ SetRegParam()

◆ SetSeed()

◆ SetSimilarityFunction()

◆ SetStartTime()

◆ SetStartTimeFormat()

◆ SetSupportThreshold()

◆ SetTimeCol()

◆ SetTimeDecayCoeff()

◆ SetUserCol()

◆ SetUserDataFrame()