Inheritance diagram for Synapse.ML.Recommendation.SAR:

Collaboration diagram for Synapse.ML.Recommendation.SAR:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SAR	SetUserCol (string value)
	Sets value for userCol 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...

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...

override SARModel	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< SAR >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

Detailed Description

SAR implements SAR

Constructor & Destructor Documentation

◆ SAR() [1/2]

Synapse.ML.Recommendation.SAR.SAR ( )

inline

Creates a SAR without any parameters.

◆ SAR() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ Fit()

override SARModel Synapse.ML.Recommendation.SAR.Fit ( DataFrame dataset )

Fits a model to the input data.

Parameters

dataset The DataFrame to fit the model to.

Returns: SARModel

◆ GetActivityTimeFormat()

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

Gets activityTimeFormat value

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

◆ GetAlpha()

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

Gets alpha value

Returns: alpha: alpha for implicit preference

◆ GetBlockSize()

int Synapse.ML.Recommendation.SAR.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.SAR.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.SAR.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.SAR.GetFinalStorageLevel ( )

Gets finalStorageLevel value

Returns: finalStorageLevel: StorageLevel for ALS model factors.

◆ GetImplicitPrefs()

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

Gets implicitPrefs value

Returns: implicitPrefs: whether to use implicit preference

◆ GetIntermediateStorageLevel()

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

Gets intermediateStorageLevel value

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

◆ GetItemCol()

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

Gets itemCol value

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

◆ GetMaxIter()

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

Gets maxIter value

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

◆ GetNonnegative()

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

Gets nonnegative value

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

◆ GetNumItemBlocks()

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

Gets numItemBlocks value

Returns: numItemBlocks: number of item blocks

◆ GetNumUserBlocks()

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

Gets numUserBlocks value

Returns: numUserBlocks: number of user blocks

◆ GetPredictionCol()

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

Gets predictionCol value

Returns: predictionCol: prediction column name

◆ GetRank()

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

Gets rank value

Returns: rank: rank of the factorization

◆ GetRatingCol()

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

Gets ratingCol value

Returns: ratingCol: column name for ratings

◆ GetRegParam()

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

Gets regParam value

Returns: regParam: regularization parameter (>= 0)

◆ GetSeed()

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

Gets seed value

Returns: seed: random seed

◆ GetSimilarityFunction()

string Synapse.ML.Recommendation.SAR.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.SAR.GetStartTime ( )

Gets startTime value

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

◆ GetStartTimeFormat()

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

Gets startTimeFormat value

Returns: startTimeFormat: Format for start time

◆ GetSupportThreshold()

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

Gets supportThreshold value

Returns: supportThreshold: Minimum number of ratings per item

◆ GetTimeCol()

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

Gets timeCol value

Returns: timeCol: Time of activity

◆ GetTimeDecayCoeff()

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

Gets timeDecayCoeff value

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

◆ GetUserCol()

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

Gets userCol value

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

◆ Load()

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

static

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

Parameters

path	The path the previous SAR was saved to

Returns: New SAR object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

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

Sets value for activityTimeFormat

Parameters

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

Returns: New SAR object

◆ SetAlpha()

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

Sets value for alpha

Parameters

value alpha for implicit preference

Returns: New SAR object

◆ SetBlockSize()

SAR Synapse.ML.Recommendation.SAR.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 SAR object

◆ SetCheckpointInterval()

SAR Synapse.ML.Recommendation.SAR.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 SAR object

◆ SetColdStartStrategy()

SAR Synapse.ML.Recommendation.SAR.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 SAR object

◆ SetFinalStorageLevel()

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

Sets value for finalStorageLevel

Parameters

value StorageLevel for ALS model factors.

Returns: New SAR object

◆ SetImplicitPrefs()

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

Sets value for implicitPrefs

Parameters

value whether to use implicit preference

Returns: New SAR object

◆ SetIntermediateStorageLevel()

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

Sets value for intermediateStorageLevel

Parameters

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

Returns: New SAR object

◆ SetItemCol()

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

Sets value for itemCol

Parameters

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

Returns: New SAR object

◆ SetMaxIter()

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

Sets value for maxIter

Parameters

value maximum number of iterations (>= 0)

Returns: New SAR object

◆ SetNonnegative()

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

Sets value for nonnegative

Parameters

value whether to use nonnegative constraint for least squares

Returns: New SAR object

◆ SetNumItemBlocks()

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

Sets value for numItemBlocks

Parameters

value number of item blocks

Returns: New SAR object

◆ SetNumUserBlocks()

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

Sets value for numUserBlocks

Parameters

value number of user blocks

Returns: New SAR object

◆ SetPredictionCol()

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

Sets value for predictionCol

Parameters

value prediction column name

Returns: New SAR object

◆ SetRank()

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

Sets value for rank

Parameters

value rank of the factorization

Returns: New SAR object

◆ SetRatingCol()

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

Sets value for ratingCol

Parameters

value column name for ratings

Returns: New SAR object

◆ SetRegParam()

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

Sets value for regParam

Parameters

value regularization parameter (>= 0)

Returns: New SAR object

◆ SetSeed()

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

Sets value for seed

Parameters

value random seed

Returns: New SAR object

◆ SetSimilarityFunction()

SAR Synapse.ML.Recommendation.SAR.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 SAR object

◆ SetStartTime()

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

Sets value for startTime

Parameters

value Set time custom now time if using historical data

Returns: New SAR object

◆ SetStartTimeFormat()

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

Sets value for startTimeFormat

Parameters

value Format for start time

Returns: New SAR object

◆ SetSupportThreshold()

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

Sets value for supportThreshold

Parameters

value Minimum number of ratings per item

Returns: New SAR object

◆ SetTimeCol()

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

Sets value for timeCol

Parameters

value Time of activity

Returns: New SAR object

◆ SetTimeDecayCoeff()

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

Sets value for timeDecayCoeff

Parameters

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

Returns: New SAR object

◆ SetUserCol()

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

Sets value for userCol

Parameters

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

Returns: New SAR object

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

synapse/ml/recommendation/SAR.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SAR() [1/2]

◆ SAR() [2/2]

Member Function Documentation

◆ Fit()

◆ GetActivityTimeFormat()

◆ GetAlpha()

◆ GetBlockSize()

◆ GetCheckpointInterval()

◆ GetColdStartStrategy()

◆ GetFinalStorageLevel()

◆ GetImplicitPrefs()

◆ GetIntermediateStorageLevel()

◆ GetItemCol()

◆ GetMaxIter()

◆ GetNonnegative()

◆ GetNumItemBlocks()

◆ GetNumUserBlocks()

◆ GetPredictionCol()

◆ GetRank()

◆ GetRatingCol()

◆ GetRegParam()

◆ GetSeed()

◆ GetSimilarityFunction()

◆ GetStartTime()

◆ GetStartTimeFormat()

◆ GetSupportThreshold()

◆ GetTimeCol()

◆ GetTimeDecayCoeff()

◆ GetUserCol()

◆ Load()

◆ Read()

◆ Save()

◆ SetActivityTimeFormat()

◆ SetAlpha()

◆ SetBlockSize()

◆ SetCheckpointInterval()

◆ SetColdStartStrategy()

◆ SetFinalStorageLevel()

◆ SetImplicitPrefs()

◆ SetIntermediateStorageLevel()

◆ SetItemCol()

◆ SetMaxIter()

◆ SetNonnegative()

◆ SetNumItemBlocks()

◆ SetNumUserBlocks()

◆ SetPredictionCol()

◆ SetRank()

◆ SetRatingCol()

◆ SetRegParam()

◆ SetSeed()

◆ SetSimilarityFunction()

◆ SetStartTime()

◆ SetStartTimeFormat()

◆ SetSupportThreshold()

◆ SetTimeCol()

◆ SetTimeDecayCoeff()

◆ SetUserCol()