Packages

class NullModel extends ClassifierInt

The NullModel class implements a Null Model Classifier, which is a simple classifier for discrete input data. The classifier is trained just using a classification vector 'y'. Picks the most frequent class. Each data instance is classified into one of 'k' classes numbered 0, ..., k-1. Note: also works for ClassifierReal problems.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NullModel
  2. ClassifierInt
  3. Classifier
  4. Model
  5. ConfusionFit
  6. Error
  7. QoF
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new NullModel(y: VectoI, k: Int = 2, cn_: Strings = null)

    y

    the classification vector, where y(i) = class for instance i

    k

    the number of classes

    cn_

    the names for all classes

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. def accuracy: Double

    Compute the accuracy of the classification, i.e., the fraction of correct classifications.

    Compute the accuracy of the classification, i.e., the fraction of correct classifications. Note, the correct classifications 'tp_i' are in the main diagonal of the confusion matrix.

    Definition Classes
    ConfusionFit
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def calcCorrelation: MatriD

    Calculate the correlation matrix for the feature vectors 'fea'.

    Calculate the correlation matrix for the feature vectors 'fea'. If the correlations are too high, the independence assumption may be dubious.

    Definition Classes
    ClassifierInt
  7. def calcCorrelation2(zrg: Range, xrg: Range): MatriD

    Calculate the correlation matrix for the feature vectors of Z (Level 3) and those of X (level 2).

    Calculate the correlation matrix for the feature vectors of Z (Level 3) and those of X (level 2). If the correlations are too high, the independence assumption may be dubious.

    zrg

    the range of Z-columns

    xrg

    the range of X-columns

    Definition Classes
    ClassifierInt
  8. def classify(xx: MatriD): VectoI
  9. def classify(xx: MatriI = null): VectoI

    Classify all of the row vectors in matrix 'xx'.

    Classify all of the row vectors in matrix 'xx'.

    xx

    the row vectors to classify

    Definition Classes
    NullModelClassifierInt
  10. def classify(z: VectoI): (Int, String, Double)

    Given a discrete data vector 'z', classify it returning the class number (0, ..., k-1) with the highest relative posterior probability.

    Given a discrete data vector 'z', classify it returning the class number (0, ..., k-1) with the highest relative posterior probability. Return the best class, its name and its relative probability.

    z

    the data vector to classify

    Definition Classes
    NullModelClassifier
  11. def classify(z: VectoD): (Int, String, Double)

    Given a new continuous data vector 'z', determine which class it fits into, returning the best class, its name and its relative probability.

    Given a new continuous data vector 'z', determine which class it fits into, returning the best class, its name and its relative probability. Override in classes that require precise real values for classification.

    z

    the real vector to classify

    Definition Classes
    ClassifierIntClassifier
  12. def clearConfusion(): Unit

    Clear the total cummulative confusion matrix.

    Clear the total cummulative confusion matrix.

    Definition Classes
    ConfusionFit
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  14. var cn: Strings
    Attributes
    protected
    Definition Classes
    ClassifierInt
  15. def confusion(yp: VectoI, yy: VectoI = y): MatriI

    Compare the actual class 'y' vector versus the predicted class 'yp' vector, returning the confusion matrix 'cmat', which for 'k = 2' is

    Compare the actual class 'y' vector versus the predicted class 'yp' vector, returning the confusion matrix 'cmat', which for 'k = 2' is

    yp 0 1 ---------- y 0 | tn fp | 1 | fn tp | ----------

    Note: ScalaTion's confusion matrix is Actual × Predicted, but to swap the position of actual 'y' (rows) with predicted 'yp' (columns) simply use 'cmat.t', the transpose of 'cmat'.

    yp

    the precicted class values/labels

    yy

    the actual class values/labels for full (y) or test (y_e) dataset

    Definition Classes
    ConfusionFit
    See also

    www.dataschool.io/simple-guide-to-confusion-matrix-terminology

  16. def contrast(yp: VectoI, yy: VectoI = y): Unit

    Contract the actual class 'yy' vector versus the predicted class 'yp' vector.

    Contract the actual class 'yy' vector versus the predicted class 'yp' vector.

    yp

    the predicted class values/labels

    yy

    the actual class values/labels for full (y) or test (y_e) dataset

    Definition Classes
    ConfusionFit
  17. def crossValidate(nx: Int = 10, show: Boolean = false): Array[Statistic]

    Test the accuracy of the classified results by cross-validation, returning the Quality of Fit (QoF) measures such as accuracy.

    Test the accuracy of the classified results by cross-validation, returning the Quality of Fit (QoF) measures such as accuracy. This method slices out instances/rows to form the test dataset.

    nx

    number of crosses and cross-validations (defaults to 10x).

    show

    the show flag (show result from each iteration)

    Definition Classes
    ClassifierIntClassifier
  18. def crossValidateRand(nx: Int = 10, show: Boolean = false): Array[Statistic]

    Test the accuracy of the classified results by cross-validation, returning the Quality of Fit (QoF) measures such as accuracy.

    Test the accuracy of the classified results by cross-validation, returning the Quality of Fit (QoF) measures such as accuracy. This method randomizes the instances/rows selected for the test dataset.

    nx

    number of crosses and cross-validations (defaults to 10x).

    show

    the show flag (show result from each iteration)

    Definition Classes
    ClassifierIntClassifier
  19. def diagnose(e: VectoD, yy: VectoD, yp: VectoD, w: VectoD = null, ym: Double = noDouble): Unit

    Diagnose the health of the model by computing the Quality of Fit (QoF) measures, from the error/residual vector and the predicted & actual responses.

    Diagnose the health of the model by computing the Quality of Fit (QoF) measures, from the error/residual vector and the predicted & actual responses. For some models the instances may be weighted.

    e

    the m-dimensional error/residual vector (yy - yp)

    yy

    the actual response vector to use (test/full)

    yp

    the predicted response vector (test/full)

    w

    the weights on the instances (defaults to null)

    ym

    the mean of the actual response vector to use (test/full)

    Definition Classes
    ConfusionFitQoF
    See also

    Regression_WLS

  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. def eval(xx: MatriD, yy: VectoD = null): ClassifierInt

    Test the quality of the training with a test dataset and return the fraction of correct classifications.

    Test the quality of the training with a test dataset and return the fraction of correct classifications.

    xx

    the integer-valued test vectors stored as rows of a matrix

    yy

    the classification vector (impl. classes should ignore or default yy to y)

    Definition Classes
    ClassifierIntModel
  23. def f1_measure(p: Double, r: Double): Double

    Compute the F1-measure, i.e., the harmonic mean of the precision and recall.

    Compute the F1-measure, i.e., the harmonic mean of the precision and recall.

    p

    the precision

    r

    the recall

    Definition Classes
    ConfusionFit
  24. def f1v: VectoD

    Compute the micro-F1-measure vector, i.e., the harmonic mean of the precision and recall.

    Compute the micro-F1-measure vector, i.e., the harmonic mean of the precision and recall.

    Definition Classes
    ConfusionFit
  25. def f_(z: Double): String

    Format a double value.

    Format a double value.

    z

    the double value to format

    Definition Classes
    QoF
  26. def featureSelection(TOL: Double = 0.01): Unit

    Perform feature selection on the classifier.

    Perform feature selection on the classifier. Use backward elimination technique, that is, remove the least significant feature, in terms of cross- validation accuracy, in each round.

    TOL

    tolerance indicating negligible accuracy loss when removing features

    Definition Classes
    ClassifierInt
  27. def fit: VectoD

    Return the Quality of Fit (QoF) measures corresponding to the labels given above in the 'fitLabel' method.

    Return the Quality of Fit (QoF) measures corresponding to the labels given above in the 'fitLabel' method.

    Definition Classes
    ConfusionFitQoF
  28. def fitLabel: Seq[String]

    Return the labels for the Quality of Fit (QoF) measures.

    Return the labels for the Quality of Fit (QoF) measures. Override to add additional QoF measures.

    Definition Classes
    ConfusionFitQoF
  29. def fitLabel_v: Seq[String]

    Return the labels for the Quality of Fit (QoF) measures.

    Return the labels for the Quality of Fit (QoF) measures. Override to add additional QoF measures.

    Definition Classes
    ConfusionFit
  30. def fitMap: Map[String, String]

    Build a map of quality of fit measures (use of LinkedHashMap makes it ordered).

    Build a map of quality of fit measures (use of LinkedHashMap makes it ordered).

    Definition Classes
    QoF
  31. def fitMicroMap: Map[String, VectoD]

    Return the Quality of Fit (QoF) vector micor-measures, i.e., measures for each class.

    Return the Quality of Fit (QoF) vector micor-measures, i.e., measures for each class.

    Definition Classes
    ConfusionFit
  32. final def flaw(method: String, message: String): Unit
    Definition Classes
    Error
  33. var fn: Strings
    Attributes
    protected
    Definition Classes
    ClassifierInt
  34. val fset: Array[Boolean]

    the set of features to turn on or off.

    the set of features to turn on or off. All features are on by default. Used for feature selection.

    Attributes
    protected
    Definition Classes
    ClassifierInt
  35. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. def getY: VectoI

    Return the response (class label) vector.

    Return the response (class label) vector.

    Definition Classes
    ClassifierInt
  37. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. def help: String

    Return the help string that describes the Quality of Fit (QoF) measures provided by the ConfusionFit class.

    Return the help string that describes the Quality of Fit (QoF) measures provided by the ConfusionFit class. Override to correspond to 'fitLabel'.

    Definition Classes
    ConfusionFitQoF
  39. 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.

    Definition Classes
    ClassifierIntModel
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def kappa: Double

    Compute Cohen's 'kappa' coefficient that measures agreement between actual 'y' and predicted 'yp' classifications.

    Compute Cohen's 'kappa' coefficient that measures agreement between actual 'y' and predicted 'yp' classifications.

    Definition Classes
    ConfusionFit
    See also

    en.wikipedia.org/wiki/Cohen%27s_kappa

  42. val m: Int

    the number of data vectors in training/test-set (# rows)

    the number of data vectors in training/test-set (# rows)

    Attributes
    protected
    Definition Classes
    ClassifierInt
  43. val md: Double

    the training-set size as a Double

    the training-set size as a Double

    Attributes
    protected
    Definition Classes
    ClassifierInt
  44. val modelConcept: URI

    An optional reference to an ontological concept

    An optional reference to an ontological concept

    Definition Classes
    Model
  45. def modelName: String

    An optional name for the model (or modeling technique)

    An optional name for the model (or modeling technique)

    Definition Classes
    Model
  46. val n: Int

    the number of features/variables (# columns)

    the number of features/variables (# columns)

    Attributes
    protected
    Definition Classes
    ClassifierInt
  47. val nd: Double

    the feature-set size as a Double

    the feature-set size as a Double

    Attributes
    protected
    Definition Classes
    ClassifierInt
  48. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  51. def p_r_s(): Unit

    Compute the micro-precision, micro-recall and micro-specificity vectors which have elements for each class i in {0, 1, ...

    Compute the micro-precision, micro-recall and micro-specificity vectors which have elements for each class i in {0, 1, ... k-1}. -------------------------------------------------------------------------- Precision is the fraction classified as true that are actually true. Recall (sensitivity) is the fraction of the actually true that are classified as true. Specificity is the fraction of the actually false that are classified as false. -------------------------------------------------------------------------- Note, for 'k = 2', ordinary precision 'p', recall 'r' and specificity 's' will correspond to the last elements in the 'pv', 'rv' and 'sv' micro vectors.

    Definition Classes
    ConfusionFit
  52. def parameter: VectoD

    Return the vector of parameter values (probability estimates for 'y').

    Return the vector of parameter values (probability estimates for 'y').

    Definition Classes
    NullModelModel
  53. def pseudo_rSq: Double

    Compute the Efron's pseudo R-squared value.

    Compute the Efron's pseudo R-squared value. Override to McFadden's, etc.

    Definition Classes
    ConfusionFit
  54. def report: String

    Return a basic report on the trained model.

    Return a basic report on the trained model.

    Definition Classes
    ClassifierIntModel
  55. def reset(): Unit

    Reset or re-initialize all the frequency counters.

    Reset or re-initialize all the frequency counters.

    Definition Classes
    NullModelClassifier
  56. def setStream(str: Int = 0): Unit

    Set the random number 'stream' to 'str'.

    Set the random number 'stream' to 'str'. This is useful for testing purposes, since a fixed stream will follow the same sequence each time.

    str

    the new fixed random number stream

    Definition Classes
    Classifier
  57. def shiftToZero(): Unit

    Shift the 'x' Matrix so that the minimum value for each column equals zero.

    Shift the 'x' Matrix so that the minimum value for each column equals zero.

    Definition Classes
    ClassifierInt
  58. def size: Int

    Return the number of data vectors/points in the entire dataset (training + testing),

    Return the number of data vectors/points in the entire dataset (training + testing),

    Definition Classes
    ClassifierIntClassifier
  59. val stream: Int

    the random number stream {0, 1, ..., 999} to be used

    the random number stream {0, 1, ..., 999} to be used

    Attributes
    protected
    Definition Classes
    Classifier
  60. def summary(b: VectoD = null, show: Boolean = false): String

    Produce a summary report with diagnostics and the overall quality of fit.

    Produce a summary report with diagnostics and the overall quality of fit.

    b

    the parameters of the model

    show

    flag indicating whether to print the summary

    Definition Classes
    ConfusionFit
  61. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  62. def test(itest: VectorI): Double

    Test the quality of the training with a testiing dataset and return the fraction of correct classifications.

    Test the quality of the training with a testiing dataset and return the fraction of correct classifications.

    itest

    indices of the instances considered test data

    Definition Classes
    NullModelClassifierIntClassifier
  63. def test(xx: MatriI, yy: VectoI): Double

    Test the quality of the training with a test-set and return the fraction of correct classifications.

    Test the quality of the training with a test-set and return the fraction of correct classifications.

    xx

    the integer-valued test vectors stored as rows of a matrix

    yy

    the test classification vector, where 'yy_i = class' for row 'i' of 'xx'

    Definition Classes
    ClassifierInt
  64. def test(testStart: Int, testEnd: Int): Double

    Test the quality of the training with a test dataset and return the fraction of correct classifications.

    Test the quality of the training with a test dataset and return the fraction of correct classifications. Can be used when the dataset is randomized so that the testing/training part of a dataset corresponds to simple slices of vectors and matrices.

    testStart

    the beginning of test region (inclusive).

    testEnd

    the end of test region (exclusive).

    Definition Classes
    Classifier
  65. def tn_fp_fn_tp(con: MatriI = cmat): (Double, Double, Double, Double)

    Return the confusion matrix for 'k = 2' as a tuple (tn, fp, fn, tp).

    Return the confusion matrix for 'k = 2' as a tuple (tn, fp, fn, tp).

    con

    the confusion matrix (defaults to cmat)

    Definition Classes
    ConfusionFit
  66. def toString(): String
    Definition Classes
    AnyRef → Any
  67. def total_cmat(): MatriI

    Return a copy of the total cummulative confusion matrix 'tcmat' and clear 'tcmat'.

    Return a copy of the total cummulative confusion matrix 'tcmat' and clear 'tcmat'.

    Definition Classes
    ConfusionFit
  68. def train(itest: VectorI): NullModel

    Train the classifier by computing the probabilities for y, and the conditional probabilities for X_j.

    Train the classifier by computing the probabilities for y, and the conditional probabilities for X_j.

    itest

    indices of the instances considered as testing data

    Definition Classes
    NullModelClassifier
  69. def train(xx: MatriD = null, yy: VectoD = null): Classifier

    Train the classifier by computing the probabilities from a training dataset of data vectors and their classifications.

    Train the classifier by computing the probabilities from a training dataset of data vectors and their classifications. Must be implemented in any extending class. Can be used when the whole dataset is used for training.

    xx

    the data/input matrix (impl. classes should ignore or default xx to x)

    yy

    the response/classification vector (impl. classes should ignore or default yy to y)

    Definition Classes
    ClassifierModel
  70. def train(testStart: Int, testEnd: Int): Classifier

    Train the classifier by computing the probabilities from a training dataset of data vectors and their classifications.

    Train the classifier by computing the probabilities from a training dataset of data vectors and their classifications. Must be implemented in any extending class. Can be used when the dataset is randomized so that the training part of a dataset corresponds to simple slices of vectors and matrices.

    testStart

    starting index of test region (inclusive) used in cross-validation

    testEnd

    ending index of test region (exclusive) used in cross-validation

    Definition Classes
    Classifier
  71. def vc_default: Array[Int]

    Return default values for binary input data (value count 'vc' set to 2).

    Return default values for binary input data (value count 'vc' set to 2).

    Definition Classes
    ClassifierInt
  72. def vc_fromData: Array[Int]

    Return value counts calculated from the input data.

    Return value counts calculated from the input data. May wish to call 'shiftToZero' before calling this method.

    Definition Classes
    ClassifierInt
  73. def vc_fromData2(rg: Range): Array[Int]

    Return value counts calculated from the input data.

    Return value counts calculated from the input data. May wish to call 'shiftToZero' before calling this method.

    rg

    the range of columns to be considered

    Definition Classes
    ClassifierInt
  74. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  75. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  76. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from ClassifierInt

Inherited from Classifier

Inherited from Model

Inherited from ConfusionFit

Inherited from Error

Inherited from QoF

Inherited from AnyRef

Inherited from Any

Ungrouped