Packages

trait Model extends Error

The Model trait provides a common framework for all analytics models and serves as base trait for Classifier and Predcitor traits. The 'train' and 'eval' methods must be called first, e.g.,

val model = NullModel (y) model.train (null, y).eval (null, y)

Linear Supertypes
Error, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Model
  2. Error
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def eval(x_e: MatriD, y_e: VectoD): Model

    Evaluate the model's Quality of Fit (QoF) as well as the importance of its parameters (e.g., if 0 is in a parameter's confidence interval, it is a candidate for removal from the model).

    Evaluate the model's Quality of Fit (QoF) as well as the importance of its parameters (e.g., if 0 is in a parameter's confidence interval, it is a candidate for removal from the model). Extending traits and classess should implement various diagnostics for the test and full (training + test) datasets.

    x_e

    the test/full data/input matrix (impl. classes should default to x)

    y_e

    the test/full response/output vector (impl. classes should default to y)

  2. abstract def hparameter: HyperParameter

    Return the model hyper-parameters (if none, return null).

    Return the model hyper-parameters (if none, return null). Hyper-parameters may be used to regularize parameters or tune the optimizer.

  3. abstract def parameter: VectoD

    Return the vector of model parameter/coefficient values.

  4. abstract def report: String

    Return a basic report on the trained model.

    Return a basic report on the trained model.

    See also

    'summary' method for more details

  5. abstract def train(x_: MatriD, y_: VectoD): Model

    Train the model 'y_ = f(x_) + e' on a given dataset, by optimizing the model parameters in order to minimize error '||e||' or maximize log-likelihood 'll'.

    Train the model 'y_ = f(x_) + e' on a given dataset, by optimizing the model parameters in order to minimize error '||e||' or maximize log-likelihood 'll'.

    x_

    the training/full data/input matrix (impl. classes should default to x)

    y_

    the training/full response/output vector (impl. classes should default to y)

Concrete Value Members

  1. final def flaw(method: String, message: String): Unit
    Definition Classes
    Error
  2. val modelConcept: URI

    An optional reference to an ontological concept

  3. def modelName: String

    An optional name for the model (or modeling technique)