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 663A8200C26 for ; Fri, 10 Feb 2017 20:05:50 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 64A6F160B4E; Fri, 10 Feb 2017 19:05:50 +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 47A40160B5C for ; Fri, 10 Feb 2017 20:05:48 +0100 (CET) Received: (qmail 38302 invoked by uid 500); 10 Feb 2017 19:05:47 -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 38293 invoked by uid 99); 10 Feb 2017 19:05:47 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd4-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 10 Feb 2017 19:05:47 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd4-us-west.apache.org (ASF Mail Server at spamd4-us-west.apache.org) with ESMTP id DF3F8C0974 for ; Fri, 10 Feb 2017 19:05:46 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -6.219 X-Spam-Level: X-Spam-Status: No, score=-6.219 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-2.999] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd4-us-west.apache.org [10.40.0.11]) (amavisd-new, port 10024) with ESMTP id zNuhRpHd-gF7 for ; Fri, 10 Feb 2017 19:05:37 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with SMTP id D27D15FAC9 for ; Fri, 10 Feb 2017 19:05:34 +0000 (UTC) Received: (qmail 35233 invoked by uid 99); 10 Feb 2017 19:05:34 -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; Fri, 10 Feb 2017 19:05:34 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id E8D62E001C; Fri, 10 Feb 2017 19:05:33 +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: Fri, 10 Feb 2017 19:05:36 -0000 Message-Id: <6d459b8729ab40ce9c0e4606d2ede2db@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [04/51] [abbrv] [partial] incubator-predictionio-site git commit: Documentation based on apache/incubator-predictionio#d674b89c7c3a17437bd406a497a08773c24c8007 archived-at: Fri, 10 Feb 2017 19:05:50 -0000 http://git-wip-us.apache.org/repos/asf/incubator-predictionio-site/blob/3ef16a6c/api/current/org/apache/predictionio/core/BaseDataSource.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/core/BaseDataSource.html b/api/current/org/apache/predictionio/core/BaseDataSource.html new file mode 100644 index 0000000..8cad6e7 --- /dev/null +++ b/api/current/org/apache/predictionio/core/BaseDataSource.html @@ -0,0 +1,499 @@ + + + + + BaseDataSource - PredictionIO Scala API 0.10.0-incubating - org.apache.predictionio.core.BaseDataSource + + + + + + + + + + +
+ +

org.apache.predictionio.core

+

BaseDataSource

+
+ +

+ + abstract + class + + + BaseDataSource[TD, EI, Q, A] extends AbstractDoer + +

+ +

:: DeveloperApi :: +Base class of all data source controllers +

TD

Training data class

EI

Evaluation information class

Q

Query class

A

Actual result class +

Annotations
+ @DeveloperApi() + +
+ Linear Supertypes +
AbstractDoer, Serializable, Serializable, AnyRef, Any
+
+ Known Subclasses +
LDataSource, PDataSource
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. BaseDataSource
  2. AbstractDoer
  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 + + + BaseDataSource() + +

    +

    +
+
+ + + +
+

Abstract Value Members

+
  1. + + +

    + + abstract + def + + + readEvalBase(sc: SparkContext): Seq[(TD, EI, RDD[(Q, A)])] + +

    +

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

    :: DeveloperApi :: +Engine developer should not use this directly. This is called by +evaluation workflow to read training and validation data. +

    sc

    Spark context

    returns

    Sets of training data, evaluation information, queries, and actual + results +

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

    + + abstract + def + + + readTrainingBase(sc: SparkContext): TD + +

    +

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

    :: DeveloperApi :: +Engine developer should not use this directly. This is called by workflow +to read training data. +

    sc

    Spark context

    returns

    Training data +

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

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

+
+

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/3ef16a6c/api/current/org/apache/predictionio/core/BaseEngine.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/core/BaseEngine.html b/api/current/org/apache/predictionio/core/BaseEngine.html new file mode 100644 index 0000000..89c7c8c --- /dev/null +++ b/api/current/org/apache/predictionio/core/BaseEngine.html @@ -0,0 +1,544 @@ + + + + + BaseEngine - PredictionIO Scala API 0.10.0-incubating - org.apache.predictionio.core.BaseEngine + + + + + + + + + + +
+ +

org.apache.predictionio.core

+

BaseEngine

+
+ +

+ + 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. +
  2. By inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. BaseEngine
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
    6. +
+
+ +
    +
  1. Hide All
    2. +
  2. Show all
    3. +
+ Learn more about member selection +
+
+ Visibility +
  1. Public
  2. All
+
+
+ +
+
+
+

Instance Constructors

+
  1. + + +

    + + + new + + + BaseEngine() + +

    +

    +
+
+ + + +
+

Abstract Value Members

+
  1. + + +

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

    +

    :: 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] + +

    +

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

    Annotations
    + @DeveloperApi() + +
    +
  8. + + +

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

    +
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
  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. + + +

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

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

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

    +
    Definition Classes
    AnyRef
    +
  20. + + +

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

    +
    Definition Classes
    AnyRef → Any
    +
  21. + + +

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

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

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

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

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