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. final def evaluateImage(imageFrame: ImageFrame, vMethods: Array[_ <: ValidationMethod[T]], batchSize: Option[Int]): Array[(ValidationResult, ValidationMethod[T])]

    Definition Classes
    AbstractModule
  25. def finalize(): Unit

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

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

    Definition Classes
    AbstractModule
  28. var forwardTime: Long

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

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

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

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

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

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

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

    Definition Classes
    InferShape
  36. def getParametersTable(): Table

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

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

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

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

    Definition Classes
    Container → AbstractModule
  41. final def getTimesGroupByModuleType(): Array[(String, Long, Long)]

    Definition Classes
    AbstractModule
  42. final def getWeightsBias(): Array[Tensor[T]]

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

    Definition Classes
    AbstractModule
  44. final def hasName: Boolean

    Definition Classes
    AbstractModule
  45. def hashCode(): Int

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

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

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

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

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

    Definition Classes
    AbstractModule
  51. var line: String

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

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

    Definition Classes
    AbstractModule
  54. 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
  55. val modules: ArrayBuffer[AbstractModule[Activity, Activity, T]]

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

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

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

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

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

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

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

    Definition Classes
    AbstractModule
  63. 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
  64. final def predictImage(imageFrame: ImageFrame, outputLayer: String, shareBuffer: Boolean, batchPerPartition: Int, predictKey: String, featurePaddingParam: Option[PaddingParam[T]]): ImageFrame

    Definition Classes
    AbstractModule
  65. 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.

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

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

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

    Definition Classes
    AbstractModule
  69. 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.

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

  71. def release(): Unit

    Definition Classes
    Container → AbstractModule
  72. def reset(): Unit

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

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

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

    Definition Classes
    AbstractModule
  76. 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
  77. final def saveModule(path: String, weightPath: String, overWrite: Boolean): Recommender.this.type

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

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

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

    Definition Classes
    AbstractModule
  81. var scaleB: Double

    Attributes
    protected
    Definition Classes
    AbstractModule
  82. var scaleW: Double

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

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

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

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

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

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

    Definition Classes
    AbstractModule
  89. def summary(): Unit

    Print out the summary of the model.

    Print out the summary of the model.

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

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

    Definition Classes
    AbstractModule
  92. def toString(): String

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  101. 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