Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id D0EDA200C3B for ; Sat, 4 Mar 2017 01:17:15 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id CF6B6160B6D; Sat, 4 Mar 2017 00:17:15 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 8EAF4160B80 for ; Sat, 4 Mar 2017 01:17:13 +0100 (CET) Received: (qmail 4712 invoked by uid 500); 4 Mar 2017 00:17:12 -0000 Mailing-List: contact commits-help@predictionio.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@predictionio.incubator.apache.org Delivered-To: mailing list commits@predictionio.incubator.apache.org Received: (qmail 4703 invoked by uid 99); 4 Mar 2017 00:17:12 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 04 Mar 2017 00:17:12 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id 3E55F1A0399 for ; Sat, 4 Mar 2017 00:17:12 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -6.567 X-Spam-Level: X-Spam-Status: No, score=-6.567 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-2.999, SPF_NEUTRAL=0.652] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id Lv7QFRZ-NcuR for ; Sat, 4 Mar 2017 00:16:59 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id 7CBFC5FC00 for ; Sat, 4 Mar 2017 00:16:58 +0000 (UTC) Received: (qmail 1468 invoked by uid 99); 4 Mar 2017 00:15:36 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 04 Mar 2017 00:15:36 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id A36D2DFF71; Sat, 4 Mar 2017 00:15:36 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: git-site-role@apache.org To: commits@predictionio.incubator.apache.org Date: Sat, 04 Mar 2017 00:16:08 -0000 Message-Id: In-Reply-To: <66ea9dddd6c84081978a2e1229a65917@git.apache.org> References: <66ea9dddd6c84081978a2e1229a65917@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [34/51] [abbrv] [partial] incubator-predictionio-site git commit: Clean up before apache/incubator-predictionio#9c427148a2e60578437d915f3cf38a17196efd3d archived-at: Sat, 04 Mar 2017 00:17:16 -0000 http://git-wip-us.apache.org/repos/asf/incubator-predictionio-site/blob/e4eda199/api/current/org/apache/predictionio/controller/Engine.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/Engine.html b/api/current/org/apache/predictionio/controller/Engine.html deleted file mode 100644 index 3103fe1..0000000 --- a/api/current/org/apache/predictionio/controller/Engine.html +++ /dev/null @@ -1,645 +0,0 @@ - - - - - Engine - PredictionIO Scala API 0.10.0-incubating - org.apache.predictionio.controller.Engine - - - - - - - - - - - - -

- - - class - - - Engine[TD, EI, PD, Q, P, A] extends BaseEngine[EI, Q, P, A] - -

- -

This class chains up the entire data process. PredictionIO uses this -information to create workflows and deployments. In Scala, you should -implement an object that extends the EngineFactory trait similar to the -following example.

object ItemRankEngine extends EngineFactory {
-def apply() = {
-  new Engine(
-    classOf[ItemRankDataSource],
-    classOf[ItemRankPreparator],
-    Map(
-      "knn" -> classOf[KNNAlgorithm],
-      "rand" -> classOf[RandomAlgorithm],
-      "mahoutItemBased" -> classOf[MahoutItemBasedAlgorithm]),
-    classOf[ItemRankServing])
-}
-}
TD

Training data class.

EI

Evaluation info class.

PD

Prepared data class.

Q

Input query class.

P

Output prediction class.

A

Actual value class.

See also

EngineFactory

- Linear Supertypes -
BaseEngine[EI, Q, P, A], Serializable, Serializable, AnyRef, Any
-
- Known Subclasses -
FastEvalEngine, SimpleEngine
-
- - -
-
-
- Ordering -
    - -
  1. Alphabetic
    2. -
  2. By inheritance
    3. -
-
-
- Inherited
- -
    -
  1. Engine
  2. BaseEngine
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
    7. -
-
- -
    -
  1. Hide All
    2. -
  2. Show all
    3. -
- Learn more about member selection -
-
- Visibility -
  1. Public
  2. All
-
-
- -
-
-
-

Instance Constructors

-
  1. - - -

    - - - new - - - Engine(dataSourceClass: Class[_ <: BaseDataSource[TD, EI, Q, A]], preparatorClass: Class[_ <: BasePreparator[TD, PD]], algorithmClassMap: Map[String, Class[_ <: BaseAlgorithm[PD, _, Q, P]]], servingClass: Class[_ <: BaseServing[Q, P]]) - -

    -

    Java-friendly constructor -

    Java-friendly constructor -

    dataSourceClass

    Data source class.

    preparatorClass

    Preparator class.

    algorithmClassMap

    Map of algorithm names to classes.

    servingClass

    Serving class. -

    -
  2. - - -

    - - - new - - - Engine(dataSourceClass: Class[_ <: BaseDataSource[TD, EI, Q, A]], preparatorClass: Class[_ <: BasePreparator[TD, PD]], algorithmClassMap: Map[String, Class[_ <: BaseAlgorithm[PD, _, Q, P]]], servingClass: Class[_ <: BaseServing[Q, P]]) - -

    -

    This auxiliary constructor is provided for backward compatibility.

    This auxiliary constructor is provided for backward compatibility. -

    dataSourceClass

    Data source class.

    preparatorClass

    Preparator class.

    algorithmClassMap

    Map of algorithm names to classes.

    servingClass

    Serving class. -

    -
  3. - - -

    - - - new - - - Engine(dataSourceClassMap: Map[String, Class[_ <: BaseDataSource[TD, EI, Q, A]]], preparatorClassMap: Map[String, Class[ _ <: BasePreparator[TD, PD]]], algorithmClassMap: Map[String, Class[_ <: BaseAlgorithm[PD, _, Q, P]]], servingClassMap: Map[String, Class[_ <: BaseServing[Q, P]]]) - -

    -

    dataSourceClassMap

    Map of data source names to class.

    preparatorClassMap

    Map of preparator names to class.

    algorithmClassMap

    Map of algorithm names to classes.

    servingClassMap

    Map of serving names to class.

    -
-
- - - - - -
-

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

    - - - val - - - algorithmClassMap: Map[String, Class[_ <: BaseAlgorithm[PD, _, Q, P]]] - -

    -

    Map of algorithm names to classes.

    -
  7. - - -

    - - final - def - - - asInstanceOf[T0]: T0 - -

    -
    Definition Classes
    Any
    -
  8. - - -

    - - - def - - - batchEval(sc: SparkContext, engineParamsList: Seq[EngineParams], params: WorkflowParams): Seq[(EngineParams, Seq[(EI, RDD[(Q, P, A)])])] - -

    -

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

    Definition Classes
    BaseEngine
    Annotations
    - @DeveloperApi() - -
    -
  9. - - -

    - - - def - - - clone(): AnyRef - -

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

    - - - def - - - copy(dataSourceClassMap: Map[String, Class[_ <: BaseDataSource[TD, EI, Q, A]]] = dataSourceClassMap, preparatorClassMap: Map[String, Class[_ <: BasePreparator[TD, PD]]] = preparatorClassMap, algorithmClassMap: Map[String, Class[_ <: BaseAlgorithm[PD, _, Q, P]]] = algorithmClassMap, servingClassMap: Map[String, Class[_ <: BaseServing[Q, P]]] = servingClassMap): Engine[TD, EI, PD, Q, P, A] - -

    -

    Returns a new Engine instance, mimicking case class's copy method behavior.

    -
  11. - - -

    - - - val - - - dataSourceClassMap: Map[String, Class[_ <: BaseDataSource[TD, EI, Q, A]]] - -

    -

    Map of data source names to class.

    -
  12. - - -

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

    -
    Definition Classes
    AnyRef
    -
  13. - - -

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

    -
    Definition Classes
    AnyRef → Any
    -
  14. - - -

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

    -

    This is implemented such that org.apache.predictionio.controller.Evaluation can -use this method to generate inputs for org.apache.predictionio.controller.Metric.

    This is implemented such 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. -

    Definition Classes
    Engine → BaseEngine
    -
  15. - - -

    - - - def - - - finalize(): Unit - -

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

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

    -
    Definition Classes
    AnyRef → Any
    -
  17. - - -

    - - - def - - - hashCode(): Int - -

    -
    Definition Classes
    AnyRef → Any
    -
  18. - - -

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

    -
    Definition Classes
    Any
    -
  19. - - -

    - - - def - - - jValueToEngineParams(variantJson: JValue, jsonExtractor: JsonExtractorOption): EngineParams - -

    -

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

    Definition Classes
    Engine → BaseEngine
    -
  20. - - -

    - - - lazy val - - - logger: Logger - -

    -
    Attributes
    protected
    -
  21. - - -

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

    -
    Definition Classes
    AnyRef
    -
  22. - - -

    - - final - def - - - notify(): Unit - -

    -
    Definition Classes
    AnyRef
    -
  23. - - -

    - - final - def - - - notifyAll(): Unit - -

    -
    Definition Classes
    AnyRef
    -
  24. - - -

    - - - val - - - preparatorClassMap: Map[String, Class[_ <: BasePreparator[TD, PD]]] - -

    -

    Map of preparator names to class.

    -
  25. - - -

    - - - val - - - servingClassMap: Map[String, Class[_ <: BaseServing[Q, P]]] - -

    -

    Map of serving names to class.

    -
  26. - - -

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

    -
    Definition Classes
    AnyRef
    -
  27. - - -

    - - - def - - - toString(): String - -

    -
    Definition Classes
    AnyRef → Any
    -
  28. - - -

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

    -

    Training this engine would return a list of models.

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

    Definition Classes
    Engine → BaseEngine
    -
  29. - - -

    - - final - def - - - wait(): Unit - -

    -
    Definition Classes
    AnyRef
    Annotations
    - @throws( - - ... - ) - -
    -
  30. - - -

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

    -
    Definition Classes
    AnyRef
    Annotations
    - @throws( - - ... - ) - -
    -
  31. - - -

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

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

Inherited from BaseEngine[EI, Q, P, A]

-
-

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/e4eda199/api/current/org/apache/predictionio/controller/EngineFactory.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/EngineFactory.html b/api/current/org/apache/predictionio/controller/EngineFactory.html deleted file mode 100644 index 0350d76..0000000 --- a/api/current/org/apache/predictionio/controller/EngineFactory.html +++ /dev/null @@ -1,473 +0,0 @@ - - - - - EngineFactory - PredictionIO Scala API 0.10.0-incubating - org.apache.predictionio.controller.EngineFactory - - - - - - - - - - -
- -

org.apache.predictionio.controller

-

EngineFactory

-
- -

- - abstract - class - - - EngineFactory extends AnyRef - -

- -

If you intend to let PredictionIO create workflow and deploy serving -automatically, you will need to implement an object that extends this class -and return an Engine. -

- Linear Supertypes -
AnyRef, Any
-
- Known Subclasses -
Deployment, Evaluation, FakeRun, IEngineFactory
-
- - -
-
-
- Ordering -
    - -
  1. Alphabetic
    2. -
  2. By inheritance
    3. -
-
-
- Inherited
- -
    -
  1. EngineFactory
  2. AnyRef
  3. Any
    4. -
-
- -
    -
  1. Hide All
    2. -
  2. Show all
    3. -
- Learn more about member selection -
-
- Visibility -
  1. Public
  2. All
-
-
- -
-
-
-

Instance Constructors

-
  1. - - -

    - - - new - - - EngineFactory() - -

    - -
-
- - - -
-

Abstract Value Members

-
  1. - - -

    - - abstract - def - - - apply(): BaseEngine[_, _, _, _] - -

    -

    Creates an instance of an Engine.

    -
-
- -
-

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

    - - - def - - - engineParams(key: String): EngineParams - -

    -

    Override this method to programmatically return engine parameters.

    -
  9. - - -

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

    -
    Definition Classes
    AnyRef
    -
  10. - - -

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

    -
    Definition Classes
    AnyRef → Any
    -
  11. - - -

    - - - def - - - finalize(): Unit - -

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

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

    -
    Definition Classes
    AnyRef → Any
    -
  13. - - -

    - - - def - - - hashCode(): Int - -

    -
    Definition Classes
    AnyRef → Any
    -
  14. - - -

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

    -
    Definition Classes
    Any
    -
  15. - - -

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

    -
    Definition Classes
    AnyRef
    -
  16. - - -

    - - final - def - - - notify(): Unit - -

    -
    Definition Classes
    AnyRef
    -
  17. - - -

    - - final - def - - - notifyAll(): Unit - -

    -
    Definition Classes
    AnyRef
    -
  18. - - -

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

    -
    Definition Classes
    AnyRef
    -
  19. - - -

    - - - def - - - toString(): String - -

    -
    Definition Classes
    AnyRef → Any
    -
  20. - - -

    - - final - def - - - wait(): Unit - -

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

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

    -
    Definition Classes
    AnyRef
    Annotations
    - @throws( - - ... - ) - -
    -
  22. - - -

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

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

Inherited from AnyRef

-
-

Inherited from Any

-
- -
- -
-
-

Ungrouped

- -
-
- -
- -
- - - - - \ No newline at end of file