From commits-return-4591-archive-asf-public=cust-asf.ponee.io@predictionio.apache.org Tue Feb 13 05:56:00 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 337F6180652 for ; Tue, 13 Feb 2018 05:56:00 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 23627160C66; Tue, 13 Feb 2018 04:56:00 +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 47FAE160C61 for ; Tue, 13 Feb 2018 05:55:58 +0100 (CET) Received: (qmail 64965 invoked by uid 500); 13 Feb 2018 04:55:57 -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 64956 invoked by uid 99); 13 Feb 2018 04:55:57 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 13 Feb 2018 04:55:57 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id F38FA1A0B60 for ; Tue, 13 Feb 2018 04:55:56 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -4.531 X-Spam-Level: X-Spam-Status: No, score=-4.531 tagged_above=-999 required=6.31 tests=[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] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id 0e6MeR2dEdWn for ; Tue, 13 Feb 2018 04:55:49 +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 BB40B5F666 for ; Tue, 13 Feb 2018 04:55:47 +0000 (UTC) Received: (qmail 63084 invoked by uid 99); 13 Feb 2018 04:55:41 -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:41 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 344B9DFADA; 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:55:51 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [13/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/OptionStdevMetric.html ---------------------------------------------------------------------- diff --git a/api/current/org/apache/predictionio/controller/OptionStdevMetric.html b/api/current/org/apache/predictionio/controller/OptionStdevMetric.html new file mode 100644 index 0000000..ea6e2eb --- /dev/null +++ b/api/current/org/apache/predictionio/controller/OptionStdevMetric.html @@ -0,0 +1,606 @@ + + + + OptionStdevMetric - PredictionIO Scala API 0.12.0-incubating - org.apache.predictionio.controller.OptionStdevMetric + + + + + + + + + + + + + + + +
+ Class +

org.apache.predictionio.controller

+

OptionStdevMetric

Related Doc: + package controller +

+ + Permalink + + +
+ +

+ + abstract + class + + + OptionStdevMetric[EI, Q, P, A] extends Metric[EI, Q, P, A, Double] with StatsOptionMetricHelper[EI, Q, P, A] with QPAMetric[Q, P, A, Option[Double]] + +

+ +

Returns the global standard deviation of the non-None score returned by the calculate method

This method uses org.apache.spark.util.StatCounter library, a one pass +method is used for calculation +

EI

Evaluation information

Q

Query

P

Predicted result

A

Actual result

+ Linear Supertypes +
QPAMetric[Q, P, A, Option[Double]], StatsOptionMetricHelper[EI, Q, P, A], Metric[EI, Q, P, A, Double], Serializable, Serializable, AnyRef, Any
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By Inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. OptionStdevMetric
  2. QPAMetric
  3. StatsOptionMetricHelper
  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 + + + OptionStdevMetric() + +

    + + Permalink + + +

    +
+
+ + + +
+

Abstract Value Members

+
  1. + + +

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

    + + Permalink + + +

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

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

    q

    Query

    p

    Predicted result

    a

    Actual result

    returns

    Metric result

    Definition Classes
    OptionStdevMetric → QPAMetric → StatsOptionMetricHelper
    +
+
+ +
+

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
    OptionStdevMetric → Metric
    +
  6. + + +

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

    + + Permalink + + +
    Definition Classes
    StatsOptionMetricHelper
    +
  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, Option[Double]]

+
+

Inherited from StatsOptionMetricHelper[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

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