http://git-wip-us.apache.org/repos/asf/incubator-predictionio-site/blob/48934979/api/current/org/apache/predictionio/core/AbstractDoer.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/core/AbstractDoer.html b/api/current/org/apache/predictionio/core/AbstractDoer.html new file mode 100644 index 0000000..38dd17d --- /dev/null +++ b/api/current/org/apache/predictionio/core/AbstractDoer.html @@ -0,0 +1,450 @@ + + + + + AbstractDoer - PredictionIO Scala API 0.11.0-incubating - org.apache.predictionio.core.AbstractDoer + + + + + + + + + + +
+ +

org.apache.predictionio.core

+

AbstractDoer

+
+ +

+ + abstract + class + + + AbstractDoer extends Serializable + +

+ +

:: DeveloperApi :: +Base class for all controllers +

Annotations
+ @DeveloperApi() + +
+ Linear Supertypes +
Serializable, Serializable, AnyRef, Any
+
+ Known Subclasses + +
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
  2. +
  3. By inheritance
  4. +
+
+
+ Inherited
+
+
    +
  1. AbstractDoer
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  6. +
+
+ +
    +
  1. Hide All
  2. +
  3. Show all
  4. +
+ Learn more about member selection +
+
+ Visibility +
  1. Public
  2. All
+
+
+ +
+
+
+

Instance Constructors

+
  1. + + +

    + + + new + + + AbstractDoer() + +

    + +
+
+ + + + + +
+

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

    + + final + def + + + asInstanceOf[T0]: T0 + +

    +
    Definition Classes
    Any
    +
  7. + + +

    + + + def + + + clone(): AnyRef + +

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

    + + final + def + + + eq(arg0: AnyRef): Boolean + +

    +
    Definition Classes
    AnyRef
    +
  9. + + +

    + + + def + + + equals(arg0: Any): Boolean + +

    +
    Definition Classes
    AnyRef → Any
    +
  10. + + +

    + + + def + + + finalize(): Unit + +

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

    + + final + def + + + getClass(): Class[_] + +

    +
    Definition Classes
    AnyRef → Any
    +
  12. + + +

    + + + def + + + hashCode(): Int + +

    +
    Definition Classes
    AnyRef → Any
    +
  13. + + +

    + + final + def + + + isInstanceOf[T0]: Boolean + +

    +
    Definition Classes
    Any
    +
  14. + + +

    + + final + def + + + ne(arg0: AnyRef): Boolean + +

    +
    Definition Classes
    AnyRef
    +
  15. + + +

    + + final + def + + + notify(): Unit + +

    +
    Definition Classes
    AnyRef
    +
  16. + + +

    + + final + def + + + notifyAll(): Unit + +

    +
    Definition Classes
    AnyRef
    +
  17. + + +

    + + final + def + + + synchronized[T0](arg0: ⇒ T0): T0 + +

    +
    Definition Classes
    AnyRef
    +
  18. + + +

    + + + def + + + toString(): String + +

    +
    Definition Classes
    AnyRef → Any
    +
  19. + + +

    + + final + def + + + wait(): Unit + +

    +
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
  20. + + +

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

    +
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
  21. + + +

    + + final + def + + + wait(arg0: Long): Unit + +

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

Inherited from Serializable

+
+

Inherited from Serializable

+
+

Inherited from AnyRef

+
+

Inherited from Any

+
+ +
+ +
+
+

Ungrouped

+ +
+
+ +
+ +
+ + + + + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-predictionio-site/blob/48934979/api/current/org/apache/predictionio/core/BaseAlgorithm.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/core/BaseAlgorithm.html b/api/current/org/apache/predictionio/core/BaseAlgorithm.html new file mode 100644 index 0000000..a928949 --- /dev/null +++ b/api/current/org/apache/predictionio/core/BaseAlgorithm.html @@ -0,0 +1,601 @@ + + + + + BaseAlgorithm - PredictionIO Scala API 0.11.0-incubating - org.apache.predictionio.core.BaseAlgorithm + + + + + + + + + + +
+ +

org.apache.predictionio.core

+

BaseAlgorithm

+
+ +

+ + abstract + class + + + BaseAlgorithm[PD, M, Q, P] extends AbstractDoer with BaseQuerySerializer + +

+ +

:: DeveloperApi :: +Base class of all algorithm controllers +

PD

Prepared data class

M

Model class

Q

Query class

P

Predicted result class +

Annotations
+ @DeveloperApi() + +
+ Linear Supertypes +
BaseQuerySerializer, AbstractDoer, Serializable, Serializable, AnyRef, Any
+
+ Known Subclasses + +
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
  2. +
  3. By inheritance
  4. +
+
+
+ Inherited
+
+
    +
  1. BaseAlgorithm
  2. BaseQuerySerializer
  3. AbstractDoer
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  8. +
+
+ +
    +
  1. Hide All
  2. +
  3. Show all
  4. +
+ Learn more about member selection +
+
+ Visibility +
  1. Public
  2. All
+
+
+ +
+
+
+

Instance Constructors

+
  1. + + +

    + + + new + + + BaseAlgorithm() + +

    +

    +
+
+ + + +
+

Abstract Value Members

+
  1. + + +

    + + abstract + def + + + batchPredictBase(sc: SparkContext, bm: Any, qs: RDD[(Long, Q)]): RDD[(Long, P)] + +

    +

    :: DeveloperApi :: +Engine developers should not use this directly.

    :: DeveloperApi :: +Engine developers should not use this directly. This is called by +evaluation workflow to perform batch prediction. +

    sc

    Spark context

    bm

    Model

    qs

    Batch of queries

    returns

    Batch of predicted results +

    Annotations
    + @DeveloperApi() + +
    +
  2. + + +

    + + abstract + def + + + predictBase(bm: Any, q: Q): P + +

    +

    :: DeveloperApi :: +Engine developers should not use this directly.

    :: DeveloperApi :: +Engine developers should not use this directly. Called by serving to +perform a single prediction. +

    bm

    Model

    q

    Query

    returns

    Predicted result +

    Annotations
    + @DeveloperApi() + +
    +
  3. + + +

    + + abstract + def + + + trainBase(sc: SparkContext, pd: PD): M + +

    +

    :: DeveloperApi :: +Engine developers should not use this directly.

    :: DeveloperApi :: +Engine developers should not use this directly. This is called by workflow +to train a model. +

    sc

    Spark context

    pd

    Prepared data

    returns

    Trained model +

    Annotations
    + @DeveloperApi() + +
    +
+
+ +
+

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

    + + final + def + + + asInstanceOf[T0]: T0 + +

    +
    Definition Classes
    Any
    +
  7. + + +

    + + + def + + + clone(): AnyRef + +

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

    + + final + def + + + eq(arg0: AnyRef): Boolean + +

    +
    Definition Classes
    AnyRef
    +
  9. + + +

    + + + def + + + equals(arg0: Any): Boolean + +

    +
    Definition Classes
    AnyRef → Any
    +
  10. + + +

    + + + def + + + finalize(): Unit + +

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

    + + final + def + + + getClass(): Class[_] + +

    +
    Definition Classes
    AnyRef → Any
    +
  12. + + +

    + + + lazy val + + + gsonTypeAdapterFactories: Seq[TypeAdapterFactory] + +

    +

    :: DeveloperApi :: +Serializer for Java query classes using Gson +

    :: DeveloperApi :: +Serializer for Java query classes using Gson +

    Definition Classes
    BaseQuerySerializer
    +
  13. + + +

    + + + def + + + hashCode(): Int + +

    +
    Definition Classes
    AnyRef → Any
    +
  14. + + +

    + + final + def + + + isInstanceOf[T0]: Boolean + +

    +
    Definition Classes
    Any
    +
  15. + + +

    + + + def + + + makePersistentModel(sc: SparkContext, modelId: String, algoParams: Params, bm: Any): Any + +

    +

    :: DeveloperApi :: +Engine developers should not use this directly.

    :: DeveloperApi :: +Engine developers should not use this directly. Prepare a model for +persistence in the downstream consumer. PredictionIO supports 3 types of +model persistence: automatic persistence, manual persistence, and +re-training on deployment. This method provides a way for downstream +modules to determine which mode the model should be persisted. +

    sc

    Spark context

    modelId

    Model ID

    algoParams

    Algorithm parameters that trained this model

    bm

    Model

    returns

    The model itself for automatic persistence, an instance of + org.apache.predictionio.workflow.PersistentModelManifest for manual + persistence, or Unit for re-training on deployment +

    Annotations
    + @DeveloperApi() + +
    +
  16. + + +

    + + final + def + + + ne(arg0: AnyRef): Boolean + +

    +
    Definition Classes
    AnyRef
    +
  17. + + +

    + + final + def + + + notify(): Unit + +

    +
    Definition Classes
    AnyRef
    +
  18. + + +

    + + final + def + + + notifyAll(): Unit + +

    +
    Definition Classes
    AnyRef
    +
  19. + + +

    + + + def + + + queryClass: Class[Q] + +

    +

    :: DeveloperApi :: +Obtains the type signature of query for this algorithm +

    :: DeveloperApi :: +Obtains the type signature of query for this algorithm +

    returns

    Type signature of query +

    +
  20. + + +

    + + + lazy val + + + querySerializer: Formats + +

    +

    :: DeveloperApi :: +Serializer for Scala query classes using +org.apache.predictionio.controller.Utils.json4sDefaultFormats +

    :: DeveloperApi :: +Serializer for Scala query classes using +org.apache.predictionio.controller.Utils.json4sDefaultFormats +

    Definition Classes
    BaseQuerySerializer
    +
  21. + + +

    + + final + def + + + synchronized[T0](arg0: ⇒ T0): T0 + +

    +
    Definition Classes
    AnyRef
    +
  22. + + +

    + + + def + + + toString(): String + +

    +
    Definition Classes
    AnyRef → Any
    +
  23. + + +

    + + final + def + + + wait(): Unit + +

    +
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
  24. + + +

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

    +
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
  25. + + +

    + + final + def + + + wait(arg0: Long): Unit + +

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

Inherited from BaseQuerySerializer

+
+

Inherited from AbstractDoer

+
+

Inherited from Serializable

+
+

Inherited from Serializable

+
+

Inherited from AnyRef

+
+

Inherited from Any

+
+ +
+ +
+
+

Ungrouped

+ +
+
+ +
+ +
+ + + + + \ No newline at end of file