From commits-return-4608-archive-asf-public=cust-asf.ponee.io@predictionio.apache.org Tue Feb 13 05:56:14 2018 Return-Path: X-Original-To: archive-asf-public@eu.ponee.io Delivered-To: archive-asf-public@eu.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by mx-eu-01.ponee.io (Postfix) with ESMTP id AF134180652 for ; Tue, 13 Feb 2018 05:56:14 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 9EFC6160C64; Tue, 13 Feb 2018 04:56:14 +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 751DB160C61 for ; Tue, 13 Feb 2018 05:56:12 +0100 (CET) Received: (qmail 67894 invoked by uid 500); 13 Feb 2018 04:56:11 -0000 Mailing-List: contact commits-help@predictionio.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@predictionio.apache.org Delivered-To: mailing list commits@predictionio.apache.org Received: (qmail 67885 invoked by uid 99); 13 Feb 2018 04:56:11 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 13 Feb 2018 04:56:11 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id D6BF2C24CD for ; Tue, 13 Feb 2018 04:56:10 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -11.231 X-Spam-Level: X-Spam-Status: No, score=-11.231 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, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01, USER_IN_DEF_SPF_WL=-7.5] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id xczAzHPw_RlY for ; Tue, 13 Feb 2018 04:56:06 +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 5BECB60E9F for ; Tue, 13 Feb 2018 04:55:50 +0000 (UTC) Received: (qmail 63732 invoked by uid 99); 13 Feb 2018 04:55:42 -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, 13 Feb 2018 04:55:42 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 58F3DF4DC5; Tue, 13 Feb 2018 04:55:39 +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, 13 Feb 2018 04:56:20 -0000 Message-Id: <0493effdfad24fc49a61b41a81d2aec1@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [42/51] [partial] predictionio-site git commit: Documentation based on apache/predictionio#9547507e46ca8eacc3026d7646c3a352b0a6c680 http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/0927bfda/api/current/org/apache/predictionio/controller/AverageMetric.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/AverageMetric.html b/api/current/org/apache/predictionio/controller/AverageMetric.html new file mode 100644 index 0000000..3ddafa2 --- /dev/null +++ b/api/current/org/apache/predictionio/controller/AverageMetric.html @@ -0,0 +1,603 @@ + + + + AverageMetric - PredictionIO Scala API 0.12.0-incubating - org.apache.predictionio.controller.AverageMetric + + + + + + + + + + + + + + + +
+ Class +

org.apache.predictionio.controller

+

AverageMetric

Related Doc: + package controller +

+ + Permalink + + +
+ +

+ + abstract + class + + + AverageMetric[EI, Q, P, A] extends Metric[EI, Q, P, A, Double] with StatsMetricHelper[EI, Q, P, A] with QPAMetric[Q, P, A, Double] + +

+ +

Returns the global average of the score returned by the calculate method. +

EI

Evaluation information

Q

Query

P

Predicted result

A

Actual result

+ Linear Supertypes +
QPAMetric[Q, P, A, Double], StatsMetricHelper[EI, Q, P, A] , Metric[EI, Q, P, A, Double], Serializable, Serializable, AnyRef, Any
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By Inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. AverageMetric
  2. QPAMetric
  3. StatsMetricHelper
  4. Metric
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
    9. +
+
+ +
    +
  1. Hide All
    2. +
  2. Show All
    3. +
+
+
+ Visibility +
  1. Public
  2. All
+
+
+ +
+
+
+

Instance Constructors

+
  1. + + +

    + + + new + + + AverageMetric() + +

    + + Permalink + + +

    +
+
+ + + +
+

Abstract Value Members

+
  1. + + +

    + + abstract + def + + + calculate(q: Q, p: P, a: A): Double + +

    + + Permalink + + +

    Implement this method to return a score that will be used for averaging +across all QPA tuples.

    Implement this method to return a score that will be used for averaging +across all QPA tuples.

    q

    Query

    p

    Predicted result

    a

    Actual result

    returns

    Metric result

    Definition Classes
    AverageMetric → QPAMetric → StatsMetricHelper
    +
+
+ +
+

Concrete Value Members

+
  1. + + +

    + + final + def + + + !=(arg0: Any): Boolean + +

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  2. + + +

    + + final + def + + + ##(): Int + +

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  3. + + +

    + + final + def + + + ==(arg0: Any): Boolean + +

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  4. + + +

    + + final + def + + + asInstanceOf[T0]: T0 + +

    + + Permalink + + +
    Definition Classes
    Any
    +
  5. + + +

    + + + def + + + calculate(sc: SparkContext, evalDataSet: Seq[(EI, RDD[(Q, P, A)])]): Double + +

    + + Permalink + + +

    Calculates the result of this Metric.

    Calculates the result of this Metric.

    Definition Classes
    AverageMetric → Metric
    +
  6. + + +

    + + + def + + + calculateStats(sc: SparkContext, evalDataSet: Seq[(EI, RDD[(Q, P, A)])]): StatCounter + +

    + + Permalink + + +
    Definition Classes
    StatsMetricHelper
    +
  7. + + +

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

    + + Permalink + + +
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
  8. + + +

    + + + def + + + compare(r0: Double, r1: Double): Int + +

    + + Permalink + + +

    Comparison function for R's ordering.

    Comparison function for R's ordering.

    Definition Classes
    Metric
    +
  9. + + +

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

    + + Permalink + + +
    Definition Classes
    AnyRef
    +
  10. + + +

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

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  11. + + +

    + + + def + + + finalize(): Unit + +

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

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

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  13. + + +

    + + + def + + + hashCode(): Int + +

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  14. + + +

    + + + def + + + header: String + +

    + + Permalink + + +

    Class name of this Metric.

    Class name of this Metric.

    Definition Classes
    Metric
    +
  15. + + +

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

    + + Permalink + + +
    Definition Classes
    Any
    +
  16. + + +

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

    + + Permalink + + +
    Definition Classes
    AnyRef
    +
  17. + + +

    + + final + def + + + notify(): Unit + +

    + + Permalink + + +
    Definition Classes
    AnyRef
    +
  18. + + +

    + + final + def + + + notifyAll(): Unit + +

    + + Permalink + + +
    Definition Classes
    AnyRef
    +
  19. + + +

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

    + + Permalink + + +
    Definition Classes
    AnyRef
    +
  20. + + +

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

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

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

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

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

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

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

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

Inherited from QPAMetric[Q, P, A, Double]

+
+

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

+
+

Inherited from Metric[EI, Q, P, A, Double]

+
+

Inherited from Serializable

+
+

Inherited from Serializable

+
+

Inherited from AnyRef

+
+

Inherited from Any

+
+ +
+ +
+
+

Ungrouped

+ +
+
+ +
+ +
+ + + + + + http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/0927bfda/api/current/org/apache/predictionio/controller/CustomQuerySerializer.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/CustomQuerySerializer.html b/api/current/org/apache/predictionio/controller/CustomQuerySerializer.html new file mode 100644 index 0000000..20ec343 --- /dev/null +++ b/api/current/org/apache/predictionio/controller/CustomQuerySerializer.html @@ -0,0 +1,537 @@ + + + + CustomQuerySerializer - PredictionIO Scala API 0.12.0-incubating - org.apache.predictionio.controller.CustomQuerySerializer + + + + + + + + + + + + + + + +
+ Trait +

org.apache.predictionio.controller

+

CustomQuerySerializer

Related Doc: + package controller +

+ + Permalink + + +
+ +

+ + + trait + + + CustomQuerySerializer extends BaseQuerySerializer + +

+ +

If your query class cannot be automatically serialized/deserialized to/from +JSON, implement a trait by extending this trait, and overriding the +querySerializer member with your +custom JSON4S serializer. +Algorithm and serving classes using your query class would only need to mix +in the trait to enable the custom serializer. +

+ Linear Supertypes +
BaseQuerySerializer, AnyRef, Any
+
+ Known Subclasses +
WithQuerySerializer
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By Inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. CustomQuerySerializer
  2. BaseQuerySerializer
  3. AnyRef
  4. Any
    5. +
+
+ +
    +
  1. Hide All
    2. +
  2. Show All
    3. +
+
+
+ Visibility +
  1. Public
  2. All
+
+
+ +
+
+ + + + + + +
+

Value Members

+
  1. + + +

    + + final + def + + + !=(arg0: Any): Boolean + +

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  2. + + +

    + + final + def + + + ##(): Int + +

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  3. + + +

    + + final + def + + + ==(arg0: Any): Boolean + +

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  4. + + +

    + + final + def + + + asInstanceOf[T0]: T0 + +

    + + Permalink + + +
    Definition Classes
    Any
    +
  5. + + +

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

    + + Permalink + + +
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
  6. + + +

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

    + + Permalink + + +
    Definition Classes
    AnyRef
    +
  7. + + +

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

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  8. + + +

    + + + def + + + finalize(): Unit + +

    + + Permalink + + +
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + classOf[java.lang.Throwable] + ) + +
    +
  9. + + +

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

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  10. + + +

    + + + lazy val + + + gsonTypeAdapterFactories: Seq[TypeAdapterFactory] + +

    + + Permalink + + +

    :: DeveloperApi :: +Serializer for Java query classes using Gson +

    :: DeveloperApi :: +Serializer for Java query classes using Gson +

    Definition Classes
    BaseQuerySerializer
    +
  11. + + +

    + + + def + + + hashCode(): Int + +

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  12. + + +

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

    + + Permalink + + +
    Definition Classes
    Any
    +
  13. + + +

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

    + + Permalink + + +
    Definition Classes
    AnyRef
    +
  14. + + +

    + + final + def + + + notify(): Unit + +

    + + Permalink + + +
    Definition Classes
    AnyRef
    +
  15. + + +

    + + final + def + + + notifyAll(): Unit + +

    + + Permalink + + +
    Definition Classes
    AnyRef
    +
  16. + + +

    + + + lazy val + + + querySerializer: Formats + +

    + + Permalink + + +

    :: DeveloperApi :: +Serializer for Scala query classes using +org.apache.predictionio.controller.Utils.json4sDefaultFormats +

    :: DeveloperApi :: +Serializer for Scala query classes using +org.apache.predictionio.controller.Utils.json4sDefaultFormats +

    Definition Classes
    BaseQuerySerializer
    +
  17. + + +

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

    + + Permalink + + +
    Definition Classes
    AnyRef
    +
  18. + + +

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

    + + Permalink + + +
    Definition Classes
    AnyRef → Any
    +
  19. + + +

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

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

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

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

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

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

Inherited from BaseQuerySerializer

+
+

Inherited from AnyRef

+
+

Inherited from Any

+
+ +
+ +
+
+

Ungrouped

+ +
+
+ +
+ +
+ + + + + +