o

io.citrine.lolo.validation

UncertaintyCorrelation

case object UncertaintyCorrelation extends Merit[Double] with Product with Serializable

Measure of the correlation between the predicted uncertainty and error magnitude

This is expressed as a ratio of correlation coefficients. The numerator is the correlation coefficient of the predicted uncertainty and the actual error magnitude. The denominator is the correlation coefficient of the predicted uncertainty and the ideal error distribution. That is: let X be the predicted uncertainty and Y := N(0, x) be the ideal error distribution about each predicted uncertainty x. It is the correlation coefficient between X and Y In the absence of a closed form for that coefficient, it is model empirically by drawing from N(0, x) to produce an "ideal" error series from which the correlation coefficient can be estimated.

Linear Supertypes
Serializable, Product, Equals, Merit[Double], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UncertaintyCorrelation
  2. Serializable
  3. Product
  4. Equals
  5. Merit
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def computeFromPredictedUncertaintyActual(pua: Seq[(Double, Double, Double)]): Double

    Covariance(X, Y) / Sqrt(Var(X) * Var(Y)), where X is predicted uncertainty and Y is magnitude of error

    Covariance(X, Y) / Sqrt(Var(X) * Var(Y)), where X is predicted uncertainty and Y is magnitude of error

    pua

    predicted, uncertainty, and actual

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def estimate(pva: Iterable[(PredictionResult[Double], Seq[Double])], rng: Random = Random): (Double, Double)

    Estimate the merit and the uncertainty in the merit over batches of predicted and ground-truth values

    Estimate the merit and the uncertainty in the merit over batches of predicted and ground-truth values

    pva

    predicted-vs-actual data as an iterable over PredictionResult and ground-truth tuples

    returns

    the estimate of the merit value and the uncertainty in that estimate

    Definition Classes
    Merit
  10. def evaluate(predictionResult: PredictionResult[Double], actual: Seq[Double], rng: Random = Random): Double

    Apply the figure of merti to a prediction result and set of ground-truth values

    Apply the figure of merti to a prediction result and set of ground-truth values

    returns

    the value of the figure of merit

    Definition Classes
    UncertaintyCorrelationMerit
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def productElementName(n: Int): String
    Definition Classes
    Product
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Merit[Double]

Inherited from AnyRef

Inherited from Any

Ungrouped