Class

org.apache.spark.ml.recommendation

KNN

Related Doc: package recommendation

Permalink

class KNN extends KNNRecommender

Collaborative filtering through user-based k-nearest neighbours.

Linear Supertypes
KNNRecommender, KNNParams, HasPredictionCol, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KNN
  2. KNNRecommender
  3. KNNParams
  4. HasPredictionCol
  5. Params
  6. Serializable
  7. Serializable
  8. Identifiable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new KNN()

    Permalink
  2. new KNN(uid: String)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. final def clear(param: Param[_]): KNN.this.type

    Permalink
    Definition Classes
    Params
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def copy(extra: ParamMap): KNN

    Permalink
    Definition Classes
    KNN → Params
  9. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  10. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  14. def explainParams(): String

    Permalink
    Definition Classes
    Params
  15. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  16. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  17. final val filterUserItems: BooleanParam

    Permalink

    Whether the items of a user should be filtered from the recommendations for the user Default: false

    Whether the items of a user should be filtered from the recommendations for the user Default: false

    Definition Classes
    KNNParams
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  22. def getFilterUserItems: Boolean

    Permalink

    Definition Classes
    KNNParams
  23. def getItemCol: String

    Permalink

    Definition Classes
    KNNParams
  24. def getK: Int

    Permalink

    Definition Classes
    KNNParams
  25. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  26. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  27. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  28. def getUserCol: String

    Permalink

    Definition Classes
    KNNParams
  29. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  30. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  32. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  34. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  35. final val itemCol: Param[String]

    Permalink

    The name of the item id column of integers from 0 to number of items in training dataset Default: "itemid"

    The name of the item id column of integers from 0 to number of items in training dataset Default: "itemid"

    Definition Classes
    KNNParams
  36. final val k: IntParam

    Permalink

    The number of nearest neighbours Default: 150

    The number of nearest neighbours Default: 150

    Definition Classes
    KNNParams
  37. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  38. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  40. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  41. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol
  42. def recommendForUserSubset(queryDataset: Dataset[_], fitDataset: Dataset[_], numItems: Int): DataFrame

    Permalink

    Returns top numItems items recommended for each user id in the input data set

    Returns top numItems items recommended for each user id in the input data set

    queryDataset

    The dataset containing a column of user ids. The column name must match userCol

    fitDataset

    The dataset of neighbours, containing a column of user ids and a column of item ids

    numItems

    The maximum number of recommendations for each user

    returns

    A dataframe of (userCol: Int, recommendations), where recommendations are stored as an array of (score: Float, itemCol: Int) rows. Or if exploded a dataframe of (userCol: Int, score: Float, itemCol: Int) rows.

  43. def recommendFromNearestUsers(queryDf: DataFrame, nnDf: DataFrame, numItems: Int): DataFrame

    Permalink
    Definition Classes
    KNNRecommender
  44. final def set(paramPair: ParamPair[_]): KNN.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  45. final def set(param: String, value: Any): KNN.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  46. final def set[T](param: Param[T], value: T): KNN.this.type

    Permalink
    Definition Classes
    Params
  47. final def setDefault(paramPairs: ParamPair[_]*): KNN.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  48. final def setDefault[T](param: Param[T], value: T): KNN.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  49. def setFilterUserItems(value: Boolean): KNN.this.type

    Permalink

    Definition Classes
    KNNRecommender
  50. def setK(value: Int): KNN.this.type

    Permalink

    Definition Classes
    KNNRecommender
  51. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  52. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  53. val uid: String

    Permalink
    Definition Classes
    KNN → Identifiable
  54. final val userCol: Param[String]

    Permalink

    The name of the user id column of integers Default: "userid"

    The name of the user id column of integers Default: "userid"

    Definition Classes
    KNNParams
  55. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from KNNRecommender

Inherited from KNNParams

Inherited from HasPredictionCol

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped