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 79C1D200D0B for ; Tue, 29 Aug 2017 07:15:57 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 77D07166132; Tue, 29 Aug 2017 05:15:57 +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 7503916612E for ; Tue, 29 Aug 2017 07:15:55 +0200 (CEST) Received: (qmail 33207 invoked by uid 500); 29 Aug 2017 05:15:54 -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 33198 invoked by uid 99); 29 Aug 2017 05:15:54 -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; Tue, 29 Aug 2017 05:15:54 +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 F359BC286A for ; Tue, 29 Aug 2017 05:15:53 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -3.722 X-Spam-Level: X-Spam-Status: No, score=-3.722 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_NUMSUBJECT=0.5, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.001, SPF_PASS=-0.001] 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 hQOUhCmGLIwN for ; Tue, 29 Aug 2017 05:15:40 +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 247846102F for ; Tue, 29 Aug 2017 05:15:25 +0000 (UTC) Received: (qmail 30487 invoked by uid 99); 29 Aug 2017 05:15:25 -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; Tue, 29 Aug 2017 05:15:25 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 408AAF5F40; Tue, 29 Aug 2017 05:15:24 +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: Tue, 29 Aug 2017 05:15:43 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [21/51] [abbrv] [partial] incubator-predictionio-site git commit: Documentation based on apache/incubator-predictionio#9c68d86c61a06b08d618b8cd8177c9d76cd86618 archived-at: Tue, 29 Aug 2017 05:15:57 -0000 http://git-wip-us.apache.org/repos/asf/incubator-predictionio-site/blob/f6f3c69c/api/current/org/apache/predictionio/controller/LServing.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/LServing.html b/api/current/org/apache/predictionio/controller/LServing.html new file mode 100644 index 0000000..e498b9d --- /dev/null +++ b/api/current/org/apache/predictionio/controller/LServing.html @@ -0,0 +1,530 @@ + + + + + LServing - PredictionIO Scala API 0.11.0-incubating - org.apache.predictionio.controller.LServing + + + + + + + + + + +
+ +

org.apache.predictionio.controller

+

LServing

+
+ +

+ + abstract + class + + + LServing[Q, P] extends BaseServing[Q, P] + +

+ +

Base class of serving. +

Q

Input query class.

P

Output prediction class.

+ Linear Supertypes +
BaseServing[Q, P], AbstractDoer, Serializable, Serializable, AnyRef, Any
+
+ Known Subclasses +
LAverageServing, LFirstServing
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. LServing
  2. BaseServing
  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 + + + LServing() + +

    +

    +
+
+ + + +
+

Abstract Value Members

+
  1. + + +

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

    +

    Implement this method to combine multiple algorithms' predictions to +produce a single final prediction.

    Implement this method to combine multiple algorithms' predictions to +produce a single final prediction. The query is the original query sent to +the engine, not the supplemented produced by LServing.supplement. +

    query

    Original input query.

    predictions

    A list of algorithms' predictions. +

    +
+
+ +
+

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 + + + serveBase(q: Q, ps: Seq[P]): P + +

    +

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

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

    Annotations
    + @Experimental() + +
    +
  19. + + +

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

Inherited from BaseServing[Q, P]

+
+

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/f6f3c69c/api/current/org/apache/predictionio/controller/LocalFileSystemPersistentModel.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/LocalFileSystemPersistentModel.html b/api/current/org/apache/predictionio/controller/LocalFileSystemPersistentModel.html new file mode 100644 index 0000000..52977c4 --- /dev/null +++ b/api/current/org/apache/predictionio/controller/LocalFileSystemPersistentModel.html @@ -0,0 +1,455 @@ + + + + + LocalFileSystemPersistentModel - PredictionIO Scala API 0.11.0-incubating - org.apache.predictionio.controller.LocalFileSystemPersistentModel + + + + + + + + + + +
+ +

org.apache.predictionio.controller

+

LocalFileSystemPersistentModel

+
+ +

+ + + trait + + + LocalFileSystemPersistentModel[AP <: Params] extends PersistentModel[AP] + +

+ +

This trait is a convenience helper for persisting your model to the local +filesystem. This trait and LocalFileSystemPersistentModelLoader contain +concrete implementation and need not be implemented.

The underlying implementation is Utils.save.

class MyModel extends LocalFileSystemPersistentModel[MyParams] {
+  ...
+}
+
+object MyModel extends LocalFileSystemPersistentModelLoader[MyParams, MyModel] {
+  ...
+}
AP

Algorithm parameters class.

See also

LocalFileSystemPersistentModelLoader

+ Linear Supertypes +
PersistentModel[AP], AnyRef, Any
+
+ Known Subclasses +
IFSPersistentModel
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. LocalFileSystemPersistentModel
  2. PersistentModel
  3. AnyRef
  4. Any
    5. +
+
+ +
    +
  1. Hide All
    2. +
  2. Show all
    3. +
+ Learn more about member selection +
+
+ Visibility +
  1. Public
  2. All
+
+
+ +
+
+ + + + + + +
+

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 + + + save(id: String, params: AP, sc: SparkContext): Boolean + +

    +

    Save the model to some persistent storage.

    Save the model to some persistent storage.

    This method should return true if the model has been saved successfully so +that PredictionIO knows that it can be restored later during deployment. +This method should return false if the model cannot be saved (or should +not be saved due to configuration) so that PredictionIO will re-train the +model during deployment. All arguments of this method are provided by +automatically by PredictionIO. +

    id

    ID of the run that trained this model.

    params

    Algorithm parameters that were used to train this model.

    sc

    An Apache Spark context. +

    Definition Classes
    LocalFileSystemPersistentModel → PersistentModel
    +
  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 PersistentModel[AP]

+
+

Inherited from AnyRef

+
+

Inherited from Any

+
+ +
+ +
+
+

Ungrouped

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