Class

org.apache.predictionio.core

BaseEngine

Related Doc: package core

Permalink

abstract class BaseEngine[EI, Q, P, A] extends Serializable

:: DeveloperApi :: Base class of all engine controller classes

EI

Evaluation information class

Q

Query class

P

Predicted result class

A

Actual result class

Annotations
@DeveloperApi()
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Engine, FastEvalEngine, SimpleEngine
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseEngine
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BaseEngine()

    Permalink

Abstract Value Members

  1. abstract def eval(sc: SparkContext, engineParams: EngineParams, params: WorkflowParams): Seq[(EI, RDD[(Q, P, A)])]

    Permalink

    :: DeveloperApi :: Implement this method so that org.apache.predictionio.controller.Evaluation can use this method to generate inputs for org.apache.predictionio.controller.Metric.

    :: DeveloperApi :: Implement this method so that org.apache.predictionio.controller.Evaluation can use this method to generate inputs for org.apache.predictionio.controller.Metric.

    sc

    An instance of SparkContext.

    engineParams

    An instance of EngineParams for running a single evaluation.

    params

    An instance of WorkflowParams that controls the workflow.

    returns

    A list of evaluation information and RDD of query, predicted result, and actual result tuple tuple.

    Annotations
    @DeveloperApi()

  2. abstract def train(sc: SparkContext, engineParams: EngineParams, engineInstanceId: String, params: WorkflowParams): Seq[Any]

    Permalink

    :: DeveloperApi :: Implement this method so that training this engine would return a list of models.

    :: DeveloperApi :: Implement this method so that training this engine would return a list of models.

    sc

    An instance of SparkContext.

    engineParams

    An instance of EngineParams for running a single training.

    params

    An instance of WorkflowParams that controls the workflow.

    returns

    A list of models.

    Annotations
    @DeveloperApi()

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 batchEval(sc: SparkContext, engineParamsList: Seq[EngineParams], params: WorkflowParams): Seq[(EngineParams, Seq[(EI, RDD[(Q, P, A)])])]

    Permalink

    :: DeveloperApi :: Override this method to further optimize the process that runs multiple evaluations (during tuning, for example).

    :: DeveloperApi :: Override this method to further optimize the process that runs multiple evaluations (during tuning, for example). By default, this method calls eval for each element in the engine parameters list.

    sc

    An instance of SparkContext.

    engineParamsList

    A list of EngineParams for running batch evaluation.

    params

    An instance of WorkflowParams that controls the workflow.

    returns

    A list of engine parameters and evaluation result (from eval) tuples.

    Annotations
    @DeveloperApi()

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. def jValueToEngineParams(variantJson: JValue, jsonExtractor: JsonExtractorOption): EngineParams

    Permalink

    :: DeveloperApi :: Implement this method to convert a JValue (read from an engine variant JSON file) to an instance of EngineParams.

    :: DeveloperApi :: Implement this method to convert a JValue (read from an engine variant JSON file) to an instance of EngineParams.

    variantJson

    Content of the engine variant JSON as JValue.

    jsonExtractor

    Content of the engine variant JSON as JValue.

    returns

    An instance of EngineParams converted from JSON.

    Annotations
    @DeveloperApi()

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

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

  20. final def wait(arg0: Long, arg1: Int): Unit

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

  21. final def wait(arg0: Long): Unit

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped