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 0738B200C26 for ; Fri, 10 Feb 2017 20:07:11 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 05A14160B69; Fri, 10 Feb 2017 19:07:11 +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 DF2EB160B4E for ; Fri, 10 Feb 2017 20:07:08 +0100 (CET) Received: (qmail 46051 invoked by uid 500); 10 Feb 2017 19:07:07 -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 45939 invoked by uid 99); 10 Feb 2017 19:07:07 -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:07:07 +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 1FB0CC0974 for ; Fri, 10 Feb 2017 19:07:07 +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-us.apache.org ([10.40.0.8]) by localhost (spamd4-us-west.apache.org [10.40.0.11]) (amavisd-new, port 10024) with ESMTP id D2XriXEoJN7Q for ; Fri, 10 Feb 2017 19:06:54 +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 064A460FA9 for ; Fri, 10 Feb 2017 19:06:49 +0000 (UTC) Received: (qmail 35282 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 74AECDFDC6; Fri, 10 Feb 2017 19:05:34 +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:56 -0000 Message-Id: <48a3e1243ba04c759b2a1dc863ba04e1@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [24/51] [abbrv] [partial] incubator-predictionio-site git commit: Documentation based on apache/incubator-predictionio#d674b89c7c3a17437bd406a497a08773c24c8007 archived-at: Fri, 10 Feb 2017 19:07:11 -0000 http://git-wip-us.apache.org/repos/asf/incubator-predictionio-site/blob/3ef16a6c/api/current/org/apache/predictionio/controller/LAverageServing.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/LAverageServing.html b/api/current/org/apache/predictionio/controller/LAverageServing.html new file mode 100644 index 0000000..aab99e3 --- /dev/null +++ b/api/current/org/apache/predictionio/controller/LAverageServing.html @@ -0,0 +1,523 @@ + + + + + LAverageServing - PredictionIO Scala API 0.10.0-incubating - org.apache.predictionio.controller.LAverageServing + + + + + + + + + + + + +

+ + + class + + + LAverageServing[Q] extends LServing[Q, Double] + +

+ +

A concrete implementation of LServing returning the average of all +algorithms' predictions, where their classes are expected to be all Double. +

+ Linear Supertypes +
LServing[Q, Double], BaseServing[Q, Double], AbstractDoer, Serializable, Serializable, AnyRef, Any
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. LAverageServing
  2. LServing
  3. BaseServing
  4. AbstractDoer
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
    9. +
+
+ +
    +
  1. Hide All
    2. +
  2. Show all
    3. +
+ Learn more about member selection +
+
+ Visibility +
  1. Public
  2. All
+
+
+ +
+
+
+

Instance Constructors

+
  1. + + +

    + + + new + + + LAverageServing() + +

    + +
+
+ + + + + +
+

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

    + + + def + + + serve(query: Q, predictions: Seq[Double]): Double + +

    +

    Returns the average of all algorithms' predictions.

    Returns the average of all algorithms' predictions.

    query

    Original input query. +

    predictions

    A list of algorithms' predictions.

    Definition Classes
    LAverageServing → LServing
    +
  18. + + +

    + + + def + + + serveBase(q: Q, ps: Seq[Double]): Double + +

    +

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

    :: DeveloperApi :: +Engine developers should not use this directly. This is called by serving +layer to combine multiple predicted results from multiple algorithms, and +custom business logic before serving to the end user. +

    q

    Query

    ps

    List of predicted results

    returns

    A single predicted result +

    Definition Classes
    LServing → BaseServing
    +
  19. + + +

    + + + def + + + supplement(q: Q): Q + +

    +

    :: Experimental :: +Implement this method to supplement the query before sending it to +algorithms.

    :: Experimental :: +Implement this method to supplement the query before sending it to +algorithms. +

    q

    Query

    returns

    A supplemented Query +

    Definition Classes
    LServing
    Annotations
    + @Experimental() + +
    +
  20. + + +

    + + + def + + + supplementBase(q: Q): Q + +

    +

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

    :: Experimental :: +Engine developers should not use this directly. This is called by serving +layer to supplement process the query before sending it to algorithms. +

    q

    Query

    returns

    A supplement Query +

    Definition Classes
    LServing → BaseServing
    +
  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 LServing[Q, Double]

+
+

Inherited from BaseServing[Q, Double]

+
+

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/controller/LDataSource.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/LDataSource.html b/api/current/org/apache/predictionio/controller/LDataSource.html new file mode 100644 index 0000000..c611466 --- /dev/null +++ b/api/current/org/apache/predictionio/controller/LDataSource.html @@ -0,0 +1,539 @@ + + + + + LDataSource - PredictionIO Scala API 0.10.0-incubating - org.apache.predictionio.controller.LDataSource + + + + + + + + + + +
+ +

org.apache.predictionio.controller

+

LDataSource

+
+ +

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

+ +

Base class of a local data source.

A local data source runs locally within a single machine and return data +that can fit within a single machine. +

TD

Training data class.

EI

Evaluation Info class.

Q

Input query class.

A

Actual value class.

+ Linear Supertypes +
BaseDataSource[RDD[TD], EI, Q, A], AbstractDoer, Serializable, Serializable, AnyRef, An y
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. LDataSource
  2. BaseDataSource
  3. AbstractDoer
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
    8. +
+
+ +
    +
  1. Hide All
    2. +
  2. Show all
    3. +
+ Learn more about member selection +
+
+ Visibility +
  1. Public
  2. All
+
+
+ +
+
+
+

Instance Constructors

+
  1. + + +

    + + + new + + + LDataSource()(implicit arg0: ClassTag[TD]) + +

    +

    +
+
+ + + +
+

Abstract Value Members

+
  1. + + +

    + + abstract + def + + + readTraining(): TD + +

    +

    Implement this method to only return training data from a data source

    +
+
+ +
+

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

    + + + def + + + readEval(): Seq[(TD, EI, Seq[(Q, A)])] + +

    +

    To provide evaluation feature for your engine, your must override this +method to return data for evaluation from a data source.

    To provide evaluation feature for your engine, your must override this +method to return data for evaluation from a data source. Returned data can +optionally include a sequence of query and actual value pairs for +evaluation purpose.

    The default implementation returns an empty sequence as a stub, so that +an engine can be compiled without implementing evaluation. +

    +
  18. + + +

    + + + def + + + readEvalBase(sc: SparkContext): Seq[(RDD[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 +

    Definition Classes
    LDataSource → BaseDataSource
    +
  19. + + +

    + + + def + + + readTrainingBase(sc: SparkContext): RDD[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 +

    Definition Classes
    LDataSource → BaseDataSource
    +
  20. + + +

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

    +
    Definition Classes
    AnyRef
    +
  21. + + +

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

    +
    Definition Classes
    AnyRef → Any
    +
  22. + + +

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

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

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

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

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

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

Deprecated Value Members

+
  1. + + +

    + + + def + + + read(): Seq[(TD, EI, Seq[(Q, A)])] + +

    +
    Annotations
    + @deprecated + +
    Deprecated

    (Since version 0.9.0) Use readEval() instead.

    +
+
+
+ +
+
+

Inherited from BaseDataSource[RDD[TD], EI, Q, A]

+
+

Inherited from AbstractDoer

+
+

Inherited from Serializable

+
+

Inherited from Serializable

+
+

Inherited from AnyRef

+
+

Inherited from Any

+
+ +
+ +
+
+

Ungrouped

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