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 1212D200D0B for ; Tue, 29 Aug 2017 07:15:52 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 101AF166125; Tue, 29 Aug 2017 05:15:52 +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 9B18716611C for ; Tue, 29 Aug 2017 07:15:49 +0200 (CEST) Received: (qmail 32407 invoked by uid 500); 29 Aug 2017 05:15:48 -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 32297 invoked by uid 99); 29 Aug 2017 05:15:48 -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:48 +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 091C7C286A for ; Tue, 29 Aug 2017 05:15:48 +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 3aQeEbVQttJ1 for ; Tue, 29 Aug 2017 05:15:27 +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 489E160EEB for ; Tue, 29 Aug 2017 05:15:25 +0000 (UTC) Received: (qmail 30443 invoked by uid 99); 29 Aug 2017 05:15:24 -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:24 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id CDED5DFA24; Tue, 29 Aug 2017 05:15:23 +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:25 -0000 Message-Id: <386697d5a42d4604b5d75ef4fadc7a9f@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [03/51] [abbrv] [partial] incubator-predictionio-site git commit: Documentation based on apache/incubator-predictionio#9c68d86c61a06b08d618b8cd8177c9d76cd86618 archived-at: Tue, 29 Aug 2017 05:15:52 -0000 http://git-wip-us.apache.org/repos/asf/incubator-predictionio-site/blob/f6f3c69c/api/current/org/apache/predictionio/core/BaseEvaluator.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/core/BaseEvaluator.html b/api/current/org/apache/predictionio/core/BaseEvaluator.html new file mode 100644 index 0000000..dbc98ed --- /dev/null +++ b/api/current/org/apache/predictionio/core/BaseEvaluator.html @@ -0,0 +1,477 @@ + + + + + BaseEvaluator - PredictionIO Scala API 0.11.0-incubating - org.apache.predictionio.core.BaseEvaluator + + + + + + + + + + +
+ +

org.apache.predictionio.core

+

BaseEvaluator

+
+ +

+ + abstract + class + + + BaseEvaluator[EI, Q, P, A, ER <: BaseEvaluatorResult] extends AbstractDoer + +

+ +

:: DeveloperApi :: +Base class of all evaluator controller classes +

EI

Evaluation information class

Q

Query class

P

Predicted result class

A

Actual result class

ER

Evaluation result class +

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

    +

    +
+
+ + + +
+

Abstract Value Members

+
  1. + + +

    + + abstract + def + + + evaluateBase(sc: SparkContext, evaluation: Evaluation, engineEvalDataSet: Seq[(EngineParams, Seq[(EI, RDD[(Q, P, A)])])], params: WorkflowParams): ER + +

    +

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

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

    sc

    Spark context

    evaluation

    Evaluation to run

    engineEvalDataSet

    Sets of engine parameters and data for evaluation

    params

    Evaluation workflow parameters

    returns

    Evaluation result +

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

org.apache.predictionio.core

+

BaseEvaluatorResult

+
+ +

+ + + trait + + + BaseEvaluatorResult extends Serializable + +

+ +

Base trait of evaluator result

+ Linear Supertypes +
Serializable, Serializable, AnyRef, Any
+
+ Known Subclasses +
MetricEvaluatorResult
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. BaseEvaluatorResult
  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
+
+
+ +
+
+ + + + + + +
+

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

    + + + val + + + noSave: Boolean + +

    +

    :: Experimental :: +Indicate if this result is inserted into database +

    +
  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 + + + toHTML(): String + +

    +

    HTML portion of the rendered evaluator results

    +
  20. + + +

    + + + def + + + toJSON(): String + +

    +

    JSON portion of the rendered evaluator results

    +
  21. + + +

    + + + def + + + toOneLiner(): String + +

    +

    A short description of the result

    +
  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 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/core/BasePreparator.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/core/BasePreparator.html b/api/current/org/apache/predictionio/core/BasePreparator.html new file mode 100644 index 0000000..82f8ba7 --- /dev/null +++ b/api/current/org/apache/predictionio/core/BasePreparator.html @@ -0,0 +1,477 @@ + + + + + BasePreparator - PredictionIO Scala API 0.11.0-incubating - org.apache.predictionio.core.BasePreparator + + + + + + + + + + +
+ +

org.apache.predictionio.core

+

BasePreparator

+
+ +

+ + abstract + class + + + BasePreparator[TD, PD] extends AbstractDoer + +

+ +

:: DeveloperApi :: +Base class of all preparator controller classes

Dev note: Probably will add an extra parameter for ad hoc JSON formatter +

TD

Training data class

PD

Prepared data class +

Annotations
+ @DeveloperApi() + +
+ Linear Supertypes +
AbstractDoer, Serializable, Serializable, AnyRef, Any
+
+ Known Subclasses +
IdentityPreparator, LIdentityPreparator, LPreparator, PIdentityPreparator, PPreparator
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. BasePreparator
  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 + + + BasePreparator() + +

    +

    +
+
+ + + +
+

Abstract Value Members

+
  1. + + +

    + + abstract + def + + + prepareBase(sc: SparkContext, td: TD): PD + +

    +

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

    :: DeveloperApi :: +Engine developers should not use this directly. This is called by training +workflow to prepare data before handing it over to algorithm +

    sc

    Spark context

    td

    Training data

    returns

    Prepared 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