Fit

scalation.modeling.Fit
See theFit companion trait
object Fit

The Fit companion object provides factory methods for assessing quality of fit for standard types of modeling techniques.

Attributes

Companion
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Fit.type

Members list

Value members

Concrete methods

inline def extreme(qk: Int): Double

Return a contrary/starting value, -∞ for maximization, ∞ for minimization

Return a contrary/starting value, -∞ for maximization, ∞ for minimization

Value parameters

qk

the QoF metric index/ordinal value

Attributes

def help: String

Return the help string that describes the Quality of Fit (QoF) measures provided by the Fit trait. The QoF measures are divided into two groups: general and statistical (that often require degrees of freedom and/or log-likelihoods).

Return the help string that describes the Quality of Fit (QoF) measures provided by the Fit trait. The QoF measures are divided into two groups: general and statistical (that often require degrees of freedom and/or log-likelihoods).

Attributes

See also

en.wikipedia.org/wiki/Coefficient_of_determination

def iscore_(y: VectorD, low: VectorD, up: VectorD, alpha: Double): Double

Return the Interval Score (IS) metric, i.e., the ...

Return the Interval Score (IS) metric, i.e., the ...

Value parameters

low

the lower bound

up

the upper bound & @param alpha the prediction level

y

the given time-series (must be aligned with the interval forecast)

Attributes

See also

arxiv.org/pdf/2005.12881.pdf

inline def mae(y: VectorD, yp: VectorD, h: Int): Double

Return the Mean Absolute Error (MAE) for the forecasting model under test.

Return the Mean Absolute Error (MAE) for the forecasting model under test.

Value parameters

h

the forecasting horizon or stride (defaults to 1)

y

the given time-series (must be aligned with the forecast)

yp

the forecasted time-series

Attributes

def mae_n(y: VectorD, h: Int): Double

Return the Mean Absolute Error (MAE) for the Naive Model (simple random walk) with horizon/stride h. For comparison with the above method.

Return the Mean Absolute Error (MAE) for the Naive Model (simple random walk) with horizon/stride h. For comparison with the above method.

Value parameters

h

the forecasting horizon or stride (defaults to 1)

y

the given time-series

Attributes

def mase(y: VectorD, yp: VectorD, h: Int): Double

Return the Mean Absolute Scaled Error (MASE) for the given time-series. It is the ratio of MAE of the forecasting model under test and the MAE of the Naive Model (simple random walk).

Return the Mean Absolute Scaled Error (MASE) for the given time-series. It is the ratio of MAE of the forecasting model under test and the MAE of the Naive Model (simple random walk).

Value parameters

h

the forecasting horizon or stride (defaults to 1)

y

the given time-series (must be aligned with the forecast)

yp

the forecasted time-series

Attributes

inline def picp_(y: VectorD, low: VectorD, up: VectorD): Double

Return the Prediction Interval Coverage Probability (PICP) metric, i.e., the fraction is actual values inside the prediction interval.

Return the Prediction Interval Coverage Probability (PICP) metric, i.e., the fraction is actual values inside the prediction interval.

Value parameters

low

the lower bound

up

the upper bound

y

the given time-series (must be aligned with the interval forecast)

Attributes

inline def pinad_(y: VectorD, low: VectorD, up: VectorD): Double

Return the Prediction Interval Normalised Average Deviation (PINAD) metric, i.e., the normalized (by range) average deviation outside the prediction interval.

Return the Prediction Interval Normalised Average Deviation (PINAD) metric, i.e., the normalized (by range) average deviation outside the prediction interval.

Value parameters

low

the lower bound

up

the upper bound

y

the given time-series (must be aligned with the interval forecast)

Attributes

def qofStatTable: Array[Statistic]

Create a table to store statistics for QoF measures, where each row corresponds to the statistics on a particular QoF measure, e.g., rSq.

Create a table to store statistics for QoF measures, where each row corresponds to the statistics on a particular QoF measure, e.g., rSq.

Attributes

def qofVector(fit: VectorD, cv_fit: Array[Statistic]): VectorD

Collect QoF results for a model and return them in a vector.

Collect QoF results for a model and return them in a vector.

Value parameters

cv_fit

the fit array of statistics for cross-validation (upon test sets)

fit

the fit vector with regard to the training set

Attributes

def tallyQof(stats: Array[Statistic], qof: VectorD): Unit

Tally the current QoF measures into the statistical accumulators.

Tally the current QoF measures into the statistical accumulators.

Value parameters

qof

the current QoF measure vector

stats

the statistics table being updated

Attributes

def wis_(y: VectorD, yp: VectorD, low: MatrixD, up: MatrixD, alphas: Array[Double]): Double

Return the Weighted Interval Score (WIS) metric, i.e., the ...

Return the Weighted Interval Score (WIS) metric, i.e., the ...

Value parameters

alphas

the array of prediction levels

low

the lower bounds for various alpha levels

up

the upper bounds for various alpha levels

y

the given time-series (must be aligned with the interval forecast)

yp

the point prediction mean/median

Attributes

See also

arxiv.org/pdf/2005.12881.pdf

Concrete fields

val MIN_FOLDS: Int
val N_QoF: Int
val maxi: Set[Int]
val qofVectorSize: Int