Trait

org.apache.predictionio.controller

PersistentModel

Related Doc: package controller

Permalink

trait PersistentModel[AP <: Params] extends AnyRef

Mix in and implement this trait if your model cannot be persisted by PredictionIO automatically. A companion object extending IPersistentModelLoader is required for PredictionIO to load the persisted model automatically during deployment.

Notice that models generated by PAlgorithm cannot be persisted automatically by nature and must implement these traits if model persistence is desired.

class MyModel extends PersistentModel[MyParams] {
  def save(id: String, params: MyParams, sc: SparkContext): Boolean = {
    ...
  }
}

object MyModel extends PersistentModelLoader[MyParams, MyModel] {
  def apply(id: String, params: MyParams, sc: Option[SparkContext]): MyModel = {
    ...
  }
}

In Java, all you need to do is to implement this interface, and add a static method with 3 arguments of type String, Params, and SparkContext.

public class MyModel implements PersistentModel<MyParams>, Serializable {
  ...
  public boolean save(String id, MyParams params, SparkContext sc) {
    ...
  }

  public static MyModel load(String id, Params params, SparkContext sc) {
    ...
  }
  ...
}
AP

Algorithm parameters class.

See also

PersistentModelLoader

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PersistentModel
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def save(id: String, params: AP, sc: SparkContext): Boolean

    Permalink

    Save the model to some persistent storage.

    Save the model to some persistent storage.

    This method should return true if the model has been saved successfully so that PredictionIO knows that it can be restored later during deployment. This method should return false if the model cannot be saved (or should not be saved due to configuration) so that PredictionIO will re-train the model during deployment. All arguments of this method are provided by automatically by PredictionIO.

    id

    ID of the run that trained this model.

    params

    Algorithm parameters that were used to train this model.

    sc

    An Apache Spark context.

Concrete 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 ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped