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. +
  3. By Inheritance
  4. +
+
+
+ Inherited
+
+
    +
  1. OptionStdevMetric
  2. QPAMetric
  3. StatsOptionMetricHelper
  4. Metric
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  9. +
+
+ +
    +
  1. Hide All
  2. +
  3. Show All
  4. +
+
+
+ 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
    OptionStdevMetricQPAMetric → 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
    OptionStdevMetricMetric
    +
  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

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