com.intel.analytics.zoo.models.recommendation

Recommender

abstract class Recommender[T] extends ZooModel[Tensor[T], Tensor[T], T]

The base class for recommendation models in Analytics Zoo.

T

Numeric type of parameter(e.g. weight, bias). Only support float/double now.

Linear Supertypes
ZooModel[Tensor[T], Tensor[T], T], Container[Tensor[T], Tensor[T], T], AbstractModule[Tensor[T], Tensor[T], T], InferShape, Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Recommender
  2. ZooModel
  3. Container
  4. AbstractModule
  5. InferShape
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Recommender()(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

Abstract Value Members

  1. abstract def buildModel(): AbstractModule[Tensor[T], Tensor[T], T]

    Override this method to define a model.

    Override this method to define a model.

    Attributes
    protected
    Definition Classes
    ZooModel

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def accGradParameters(input: Tensor[T], gradOutput: Tensor[T]): Unit

    Definition Classes
    ZooModel → AbstractModule
  7. def addModel(model: AbstractModule[Tensor[T], Tensor[T], T]): Recommender.this.type

    Definition Classes
    ZooModel
  8. def apply(name: String): Option[AbstractModule[Activity, Activity, T]]

    Definition Classes
    Container → AbstractModule
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def backward(input: Tensor[T], gradOutput: Tensor[T]): Tensor[T]

    Definition Classes
    AbstractModule
  11. var backwardTime: Long

    Attributes
    protected
    Definition Classes
    AbstractModule
  12. def build(): Recommender.this.type

    Definition Classes
    ZooModel
  13. def canEqual(other: Any): Boolean

    Definition Classes
    Container → AbstractModule
  14. final def checkEngineType(): Recommender.this.type

    Definition Classes
    Container → AbstractModule
  15. def clearState(): Recommender.this.type

    Definition Classes
    Container → AbstractModule
  16. final def clone(deepCopy: Boolean): AbstractModule[Tensor[T], Tensor[T], T]

    Definition Classes
    AbstractModule
  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def cloneModule(): AbstractModule[Tensor[T], Tensor[T], T]

    Definition Classes
    AbstractModule
  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. def equals(other: Any): Boolean

    Definition Classes
    Container → AbstractModule → AnyRef → Any
  21. final def evaluate(): Recommender.this.type

    Definition Classes
    Container → AbstractModule
  22. final def evaluate(dataSet: LocalDataSet[MiniBatch[T]], vMethods: Array[_ <: ValidationMethod[T]]): Array[(ValidationResult, ValidationMethod[T])]

    Definition Classes
    AbstractModule
  23. final def evaluate(dataset: RDD[Sample[T]], vMethods: Array[_ <: ValidationMethod[T]], batchSize: Option[Int]): Array[(ValidationResult, ValidationMethod[T])]

    Definition Classes
    AbstractModule
  24. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def findModules(moduleType: String): ArrayBuffer[AbstractModule[_, _, T]]

    Definition Classes
    Container
  26. final def forward(input: Tensor[T]): Tensor[T]

    Definition Classes
    AbstractModule
  27. var forwardTime: Long

    Attributes
    protected
    Definition Classes
    AbstractModule
  28. def freeze(names: String*): Recommender.this.type

    Definition Classes
    Container → AbstractModule
  29. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  30. def getExtraParameter(): Array[Tensor[T]]

    Definition Classes
    Container → AbstractModule
  31. final def getInputShape(): Shape

    Definition Classes
    InferShape
  32. final def getName(): String

    Definition Classes
    AbstractModule
  33. final def getNumericType(): TensorDataType

    Definition Classes
    AbstractModule
  34. final def getOutputShape(): Shape

    Definition Classes
    InferShape
  35. def getParametersTable(): Table

    Definition Classes
    Container → AbstractModule
  36. final def getPrintName(): String

    Attributes
    protected
    Definition Classes
    AbstractModule
  37. final def getScaleB(): Double

    Definition Classes
    AbstractModule
  38. final def getScaleW(): Double

    Definition Classes
    AbstractModule
  39. def getTimes(): Array[(AbstractModule[_ <: Activity, _ <: Activity, T], Long, Long)]

    Definition Classes
    Container → AbstractModule
  40. final def getWeightsBias(): Array[Tensor[T]]

    Definition Classes
    AbstractModule
  41. var gradInput: Tensor[T]

    Definition Classes
    AbstractModule
  42. final def hasName: Boolean

    Definition Classes
    AbstractModule
  43. def hashCode(): Int

    Definition Classes
    Container → AbstractModule → AnyRef → Any
  44. def inputs(first: (ModuleNode[T], Int), nodesWithIndex: (ModuleNode[T], Int)*): ModuleNode[T]

    Definition Classes
    AbstractModule
  45. def inputs(nodes: Array[ModuleNode[T]]): ModuleNode[T]

    Definition Classes
    AbstractModule
  46. def inputs(nodes: ModuleNode[T]*): ModuleNode[T]

    Definition Classes
    AbstractModule
  47. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  48. final def isTraining(): Boolean

    Definition Classes
    AbstractModule
  49. var line: String

    Attributes
    protected
    Definition Classes
    AbstractModule
  50. final def loadModelWeights(srcModel: Module[Float], matchAll: Boolean): Recommender.this.type

    Definition Classes
    AbstractModule
  51. final def loadWeights(weightPath: String, matchAll: Boolean): Recommender.this.type

    Definition Classes
    AbstractModule
  52. def model: AbstractModule[Tensor[T], Tensor[T], T]

    The defined model, either from buildModel() or loaded from file.

    The defined model, either from buildModel() or loaded from file.

    Definition Classes
    ZooModel
  53. val modules: ArrayBuffer[AbstractModule[Activity, Activity, T]]

    Definition Classes
    Container
  54. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  55. final def notify(): Unit

    Definition Classes
    AnyRef
  56. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  57. var output: Tensor[T]

    Definition Classes
    AbstractModule
  58. def parameters(): (Array[Tensor[T]], Array[Tensor[T]])

    Definition Classes
    Container → AbstractModule
  59. final def predict(dataset: RDD[Sample[T]], batchSize: Int, shareBuffer: Boolean): RDD[Activity]

    Definition Classes
    AbstractModule
  60. final def predictClass(dataset: RDD[Sample[T]], batchSize: Int): RDD[Int]

    Definition Classes
    AbstractModule
  61. def predictClasses(x: RDD[Sample[T]], batchSize: Int = 1, zeroBasedLabel: Boolean = true): RDD[Int]

    Predict for classes.

    Predict for classes. By default, label predictions start from 0.

    x

    Prediction data, RDD of Sample.

    batchSize

    Number of samples per batch. Default is 32.

    zeroBasedLabel

    Boolean. Whether result labels start from 0. Default is true. If false, result labels start from 1.

    Definition Classes
    ZooModel
  62. final def predictImage(imageFrame: ImageFrame, outputLayer: String, shareBuffer: Boolean, batchPerPartition: Int, predictKey: String, featurePaddingParam: Option[PaddingParam[T]]): ImageFrame

    Definition Classes
    AbstractModule
  63. def predictUserItemPair(featureRdd: RDD[UserItemFeature[T]]): RDD[UserItemPrediction]

    Predict for user-item pairs.

    Predict for user-item pairs.

    featureRdd

    RDD of user item pair feature.

    returns

    RDD of user item pair prediction.

  64. def processInputs(first: (ModuleNode[T], Int), nodesWithIndex: (ModuleNode[T], Int)*): ModuleNode[T]

    Attributes
    protected
    Definition Classes
    AbstractModule
  65. def processInputs(nodes: Seq[ModuleNode[T]]): ModuleNode[T]

    Attributes
    protected
    Definition Classes
    AbstractModule
  66. final def quantize(): Module[T]

    Definition Classes
    AbstractModule
  67. def recommendForItem(featureRdd: RDD[UserItemFeature[T]], maxUsers: Int): RDD[UserItemPrediction]

    Recommend a number of users for each item given a rdd of user item pair features.

    Recommend a number of users for each item given a rdd of user item pair features.

    featureRdd

    RDD of user item pair feature.

    maxUsers

    Number of users to be recommended to each item. Positive integer.

    returns

    RDD of user item pair prediction.

  68. def recommendForUser(featureRdd: RDD[UserItemFeature[T]], maxItems: Int): RDD[UserItemPrediction]

    Recommend a number of items for each user given a rdd of user item pair features.

    Recommend a number of items for each user given a rdd of user item pair features.

    featureRdd

    RDD of user item pair feature.

    maxItems

    Number of items to be recommended to each user. Positive integer.

    returns

    RDD of user item pair prediction.

  69. def reset(): Unit

    Definition Classes
    Container → AbstractModule
  70. def resetTimes(): Unit

    Definition Classes
    Container → AbstractModule
  71. final def saveCaffe(prototxtPath: String, modelPath: String, useV2: Boolean, overwrite: Boolean): Recommender.this.type

    Definition Classes
    AbstractModule
  72. final def saveDefinition(path: String, overWrite: Boolean): Recommender.this.type

    Definition Classes
    AbstractModule
  73. def saveModel(path: String, weightPath: String = null, overWrite: Boolean = false): Recommender.this.type

    Save the model to the specified path.

    Save the model to the specified path.

    path

    The path to save the model. Local file system, HDFS and Amazon S3 are supported. HDFS path should be like "hdfs://[host]:[port]/xxx". Amazon S3 path should be like "s3a://bucket/xxx".

    weightPath

    The path to save weights. Default is null.

    overWrite

    Whether to overwrite the file if it already exists. Default is false.

    Definition Classes
    ZooModel
  74. final def saveModule(path: String, weightPath: String, overWrite: Boolean): Recommender.this.type

    Definition Classes
    AbstractModule
  75. final def saveTF(inputs: Seq[(String, Seq[Int])], path: String, byteOrder: ByteOrder, dataFormat: TensorflowDataFormat): Recommender.this.type

    Definition Classes
    AbstractModule
  76. final def saveTorch(path: String, overWrite: Boolean): Recommender.this.type

    Definition Classes
    AbstractModule
  77. final def saveWeights(path: String, overWrite: Boolean): Unit

    Definition Classes
    AbstractModule
  78. var scaleB: Double

    Attributes
    protected
    Definition Classes
    AbstractModule
  79. var scaleW: Double

    Attributes
    protected
    Definition Classes
    AbstractModule
  80. final def setExtraParameter(extraParam: Array[Tensor[T]]): Recommender.this.type

    Definition Classes
    AbstractModule
  81. final def setLine(line: String): Recommender.this.type

    Definition Classes
    AbstractModule
  82. final def setName(name: String): Recommender.this.type

    Definition Classes
    AbstractModule
  83. def setScaleB(b: Double): Recommender.this.type

    Definition Classes
    Container → AbstractModule
  84. def setScaleW(w: Double): Recommender.this.type

    Definition Classes
    Container → AbstractModule
  85. final def setWeightsBias(newWeights: Array[Tensor[T]]): Recommender.this.type

    Definition Classes
    AbstractModule
  86. def summary(): Unit

    Print out the summary of the model.

    Print out the summary of the model.

    Definition Classes
    ZooModel
  87. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  88. def toGraph(startNodes: ModuleNode[T]*): Graph[T]

    Definition Classes
    AbstractModule
  89. def toString(): String

    Definition Classes
    AbstractModule → AnyRef → Any
  90. var train: Boolean

    Attributes
    protected
    Definition Classes
    AbstractModule
  91. final def training(): Recommender.this.type

    Definition Classes
    Container → AbstractModule
  92. def unFreeze(names: String*): Recommender.this.type

    Definition Classes
    Container → AbstractModule
  93. def updateGradInput(input: Tensor[T], gradOutput: Tensor[T]): Tensor[T]

    Definition Classes
    ZooModel → AbstractModule
  94. def updateOutput(input: Tensor[T]): Tensor[T]

    Definition Classes
    ZooModel → AbstractModule
  95. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  98. final def zeroGradParameters(): Unit

    Definition Classes
    AbstractModule

Deprecated Value Members

  1. final def save(path: String, overWrite: Boolean): Recommender.this.type

    Definition Classes
    AbstractModule
    Annotations
    @deprecated
    Deprecated

    (Since version 0.3.0) please use recommended saveModule(path, overWrite)

Inherited from ZooModel[Tensor[T], Tensor[T], T]

Inherited from Container[Tensor[T], Tensor[T], T]

Inherited from AbstractModule[Tensor[T], Tensor[T], T]

Inherited from InferShape

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped