org.pmml4s

model

package model

PMML is a standard for XML documents which express trained instances of analytic models. The following classes of model are addressed:

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. model
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class AnomalyDetectionAttributes extends ModelAttributes with HasAnomalyDetectionAttributes

    Holds attributes of an Anomaly Detection Model.

  2. class AnomalyDetectionModel extends Model with HasWrappedAnomalyDetectionAttributes

    Anomaly detection (also outlier detection) is the identification of items, events or observations which do not conform to an expected pattern or other items in a data set.

  3. class AnomalyDetectionOutput extends RegOutputs

  4. class AssociationAttributes extends ModelAttributes with HasAssociationAttributes

  5. class AssociationModel extends Model with HasWrappedAssociationAttributes

    The Association Rule model represents rules where some set of items is associated to another set of items.

  6. class AssociationOutputs extends ModelOutputs with HasAssociationRules

  7. class AssociationRule extends HasPredictedValue with HasEntityId with HasConfidence with PmmlElement

    We consider association rules of the form "<antecedent itemset> => <consequent itemset>" next:

  8. class Attribute extends Predicate with PmmlElement

    Defines input attributes for each scorecard characteristic are defined in terms of predicates.

  9. class BaseCumHazardTables extends PmmlElement

  10. class BaselineCell extends PmmlElement

  11. class BaselineStratum extends PmmlElement

  12. class BayesInput extends PmmlElement

    For a discrete field, each BayesInput contains the counts pairing the discrete values of that field with those of the target field.

  13. class BayesInputs extends PmmlElement

    Contains several BayesInput elements.

  14. class BayesOutput extends PmmlElement

    Contains the counts associated with the values of the target field.

  15. class Categories extends PmmlElement

  16. class Category extends PmmlElement

  17. class Characteristic extends PmmlElement

    Defines the point allocation strategy for each scorecard characteristic (numeric or categorical).

  18. class Characteristics extends PmmlElement

    Envelopes for all scorecard characteristics.

  19. class Cluster extends PmmlElement

    A cluster is defined by its center vector or by statistics.

  20. class ClusteringAttributes extends ModelAttributes with HasClusteringAttributes

  21. class ClusteringField extends PmmlElement

  22. class ClusteringModel extends Model with HasWrappedClusteringAttributes

    A cluster model basically consists of a set of clusters.

  23. class ClusteringOutputs extends CluOutputs

  24. class Coefficient extends PmmlElement

    Coefficient αi is described

  25. class Coefficients extends PmmlElement

    Used to store the support vector coefficients αi and b.

  26. class Comparisons extends PmmlElement

    Comparisons is a matrix which contains the similarity values or distance values, depending on the attribute modelClass in ClusteringModel.

  27. class ComplexPartialScore extends RegressionEvaluator with PmmlElement

    Defines ComplexPartialScore, the actual partial score is the value returned by the EXPRESSION (see org.pmml4s .transformations for more information).

  28. class CompoundRule extends Rule with PmmlElement

    CompoundRule consists of a predicate and one or more rules.

  29. class Con extends PmmlElement

    Defines the connections coming into that parent element.

  30. class Covariances extends PmmlElement

    Stores coordinate-by-coordinate variances (diagonal cells) and covariances (non-diagonal cells).

  31. class CovariateList extends PmmlElement

    List of covariate names.

  32. class DataModel extends Model

    DataModel is a container for all info about metadata, it's the parent model of all predictive models.

  33. class DecisionTree extends EmbeddedModel

  34. abstract class EmbeddedModel extends Model

    Model Composition

  35. class EventValues extends PmmlElement

  36. class FactorList extends PmmlElement

    List of factor (categorical predictor) names.

  37. class GeneralRegressionAttributes extends ModelAttributes with HasGeneralRegressionAttributes

  38. class GeneralRegressionModel extends Model with HasWrappedGeneralRegressionAttributes

    Definition of a general regression model.

  39. class GeneralRegressionOutputs extends MixedClsWithRegOutputs

  40. trait HasAnomalyDetectionAttributes extends HasModelAttributes

  41. trait HasAssociationAttributes extends HasModelAttributes

  42. trait HasClusteringAttributes extends HasModelAttributes

  43. trait HasGeneralRegressionAttributes extends HasModelAttributes

  44. trait HasNaiveBayesAttributes extends HasModelAttributes

  45. trait HasNearestNeighborAttributes extends HasModelAttributes

  46. trait HasNeuralNetworkAttributes extends HasModelAttributes

  47. trait HasRegressionAttributes extends HasModelAttributes

  48. trait HasScorecardAttributes extends HasModelAttributes

  49. trait HasSupportVectorMachineAttributes extends HasModelAttributes

  50. trait HasTreeAttributes extends HasModelAttributes

  51. trait HasWrappedAnomalyDetectionAttributes extends HasWrappedModelAttributes with HasAnomalyDetectionAttributes

  52. trait HasWrappedAssociationAttributes extends HasWrappedModelAttributes with HasAssociationAttributes

  53. trait HasWrappedClusteringAttributes extends HasWrappedModelAttributes with HasClusteringAttributes

  54. trait HasWrappedGeneralRegressionAttributes extends HasWrappedModelAttributes with HasGeneralRegressionAttributes

  55. trait HasWrappedNaiveBayesAttributes extends HasWrappedModelAttributes with HasNaiveBayesAttributes

  56. trait HasWrappedNearestNeighborAttributes extends HasWrappedModelAttributes with HasNearestNeighborAttributes

  57. trait HasWrappedNeuralNetworkAttributes extends HasWrappedModelAttributes with HasNeuralNetworkAttributes

  58. trait HasWrappedRegressionAttributes extends HasWrappedModelAttributes with HasRegressionAttributes

  59. trait HasWrappedScorecardAttributes extends HasWrappedModelAttributes with HasScorecardAttributes

  60. trait HasWrappedSupportVectorMachineAttributes extends HasWrappedModelAttributes with HasSupportVectorMachineAttributes

  61. trait HasWrappedTreeAttributes extends HasWrappedModelAttributes with HasTreeAttributes

  62. class InstanceField extends PmmlElement

  63. class InstanceFields extends PmmlElement

    Serves as an envelope for all the fields included in the training instances.

  64. class Item extends PmmlElement

    Obviously the id of an Item must be unique.

  65. class ItemRef extends PmmlElement

    Item references point to elements of type Item

  66. class Itemset extends PmmlElement

  67. class KNNInput extends PmmlElement

  68. class KNNInputs extends PmmlElement

    encapsulates several KNNInput elements which define the fields used to query the k-NN model, one KNNInput element per field.

  69. trait KernelType extends AnyRef

  70. class KohonenMap extends PmmlElement

    The element KohonenMap is appropriate for clustering models that were produced by a Kohonen map algorithm.

  71. class LinearKernelType extends KernelType with PmmlElement

    Linear basis functions which lead to a hyperplane as classifier.

  72. class MeanClusterDistances extends PmmlElement

    Contains an array of non-negative real values, it is required when the algorithm type is clusterMeanDist.

  73. class MiningModel extends Model with HasWrappedModelAttributes

    The element MiningModel allows precise specification of the usage of multiple models within one PMML file.

  74. class MiningOutputs extends ClsOutputs with RegOutputs with CluOutputs with SegmentOutputs

  75. class MissingValueWeights extends PmmlElement

    MissingValueWeights is used to adjust distance or similarity measures for missing data.

  76. abstract class Model extends HasParent with HasVersion with HasWrappedModelAttributes with HasMiningSchema with HasOutput with HasModelStats with HasModelExplanation with HasTargets with HasLocalTransformations with FieldScope with ModelLocation with HasTargetFields with Predictable with HasModelVerification with PmmlElement

    Abstract class that represents a PMML model

  77. sealed trait ModelElement extends AnyRef

  78. trait ModelLocation extends AnyRef

  79. class MutableModel extends Model

  80. class NaiveBayesAttributes extends ModelAttributes with HasNaiveBayesAttributes

  81. class NaiveBayesModel extends Model with HasWrappedNaiveBayesAttributes

    Naïve Bayes uses Bayes' Theorem, combined with a ("naive") presumption of conditional independence, to predict the value of a target (output), from evidence given by one or more predictor (input) fields.

  82. class NaiveBayesOutputs extends ClsOutputs

  83. class NearestNeighborAttributes extends ModelAttributes with HasNearestNeighborAttributes

  84. class NearestNeighborModel extends Model with HasWrappedNearestNeighborAttributes

    k-Nearest Neighbors (k-NN) is an instance-based learning algorithm.

  85. class NearestNeighborModelOutputs extends KNNOutputs

  86. class NeuralInput extends PmmlElement

    Defines how input fields are normalized so that the values can be processed in the neural network.

  87. class NeuralInputs extends PmmlElement

    An input neuron represents the normalized value for an input field.

  88. class NeuralLayer extends PmmlElement

  89. class NeuralNetwork extends Model with HasWrappedNeuralNetworkAttributes

    A neural network has one or more input nodes and one or more neurons.

  90. class NeuralNetworkAttributes extends ModelAttributes with HasNeuralNetworkAttributes

  91. class NeuralNetworkOutputs extends MixedClsWithRegOutputs

  92. class NeuralOutput extends PmmlElement

    Defines how the output of the neural network must be interpreted.

  93. class NeuralOutputs extends PmmlElement

  94. class Neuron extends PmmlElement

    Contains an identifier id which must be unique in all layers.

  95. class Node extends Predicate with HasScoreDistributions

    This element is an encapsulation for either defining a split or a leaf in a tree model.

  96. class PCell extends PmmlElement

    Cell in the ParamMatrix.

  97. class PCovCell extends PmmlElement

  98. class PCovMatrix extends PmmlElement

    Matrix of Parameter estimate covariances.

  99. class PPCell extends PmmlElement

    Cell in the PPMatrix.

  100. class PPMatrix extends PmmlElement

    Predictor-to-Parameter correlation matrix.

  101. class PairCounts extends PmmlElement

    PairCounts lists, for a field Ii's discrete value Iij, the TargetValueCounts that pair the value Iij with each value of the target field.

  102. class ParamMatrix extends PmmlElement

    Parameter matrix.

  103. class Parameter extends PmmlElement

    Each Parameter contains a required name and optional label.

  104. class ParameterList extends PmmlElement

    Lists all Parameters.

  105. class PolynomialKernelType extends KernelType with PmmlElement

    Polynomial basis functions which lead to a polynome classifier.

  106. class Predictor extends PmmlElement

    Describes a categorical (factor) or a continuous (covariate) predictor for the model.

  107. class RadialBasisKernelType extends KernelType with PmmlElement

    Radial basis functions, the most common kernel type K(x,y) = exp(-gamma*||x - y||2)

  108. class Regression extends EmbeddedModel

  109. class RegressionAttributes extends ModelAttributes with HasRegressionAttributes

  110. class RegressionModel extends Model with HasWrappedRegressionAttributes

    The regression functions are used to determine the relationship between the dependent variable (target field) and one or more independent variables.

  111. class RegressionOutputs extends MixedClsWithRegOutputs

  112. sealed trait Rule extends AnyRef

  113. class RuleSelectionMethod extends PmmlElement

    Describes how rules are selected to apply the model to a new case

  114. class RuleSet extends PmmlElement

  115. class RuleSetModel extends Model with HasWrappedModelAttributes

    Ruleset models can be thought of as flattened decision tree models.

  116. class RuleSetOutputs extends ModelOutputs with MutablePredictedValue with MutableConfidence

  117. class SVMOutputs extends MixedClsWithRegOutputs

  118. class Scorecard extends Model with HasWrappedScorecardAttributes

    A data mining model contains a set of input fields which are used to predict a certain target value.

  119. class ScorecardAttributes extends ModelAttributes with HasScorecardAttributes

    Holds attributes of a Scorecard.

  120. class ScorecardOutput extends RegOutputs with MutableReasonCodes

  121. class Segment extends Predictable with Predicate with PmmlElement

  122. class Segmentation extends PmmlElement

  123. class SigmoidKernelType extends KernelType with PmmlElement

    Sigmoid kernel functions for some models of Neural Network type K(x,y) = tanh(gamma*<x,y>+coef0)

  124. class SimpleRule extends Rule with HasScoreDistributions with PmmlElement

    SimpleRule consists of an identifier, a predicate, a score and information on rule performance.

  125. class SupportVector extends PmmlElement

    SupportVector which only has the attribute vectorId - the reference to the support vector in VectorDictionary.

  126. class SupportVectorMachine extends PmmlElement

    Holds a single instance of an SVM.

  127. class SupportVectorMachineAttributes extends ModelAttributes with HasSupportVectorMachineAttributes

  128. class SupportVectorMachineModel extends Model with HasWrappedSupportVectorMachineAttributes

    Support Vector Machine models for classification and regression are considered.

  129. class SupportVectors extends PmmlElement

    Contains all support vectors required for the respective SVM instance.

  130. class TargetValueCount extends PmmlElement

  131. class TargetValueCounts extends PmmlElement

    Lists the counts associated with each value of the target field, However, a TargetValueCount whose count is zero may be omitted.

  132. class TargetValueStat extends PmmlElement

    Used for a continuous input field Ii to define statistical measures associated with each value of the target field.

  133. class TargetValueStats extends PmmlElement

    Serves as the envelope for element TargetValueStat.

  134. class TrainingInstances extends PmmlElement

    Encapsulates the definition of the fields included in the training instances as well as their values.

  135. class TransformationModel extends DataModel

  136. class TreeAttributes extends ModelAttributes with HasTreeAttributes

    Holds attributes of a Tree model

  137. class TreeModel extends Model with HasWrappedTreeAttributes

    The TreeModel in PMML allows for defining either a classification or prediction structure.

  138. class TreeOutputs extends MixedClsWithRegOutputs with MutableConfidence with MutableEntityId

  139. class VariableWeight extends PmmlElement

  140. class VectorDictionary extends PmmlElement

    Contains the set of support vectors which are of the typeVectorInstance.

  141. class VectorFields extends PmmlElement

    Defines which entries in the vectors correspond to which fields.

  142. class VectorInstance extends PmmlElement

    A data vector given in dense or sparse array format.

Value Members

  1. object ActivationFunction extends Enumeration

  2. object AlgorithmType extends Enumeration

    Defines model types used by the anomaly model.

  3. object BaselineMethod extends Enumeration

    An informational string describing the technique used by the model designer to establish the baseline scores.

  4. object CatScoringMethod extends Enumeration

  5. object ContScoringMethod extends Enumeration

  6. object Criterion extends Enumeration

  7. object CumulativeLinkFunction extends Enumeration

    Definition is used for specifying a cumulative link function used in ordinalMultinomial model.

  8. object Distribution extends Enumeration

    The probability distribution of the dependent variable for generalizedLinear model.

  9. object GeneralModelType extends Enumeration

    Specifies the type of regression model in use.

  10. object KernelType

  11. object LinkFunction extends Enumeration

    Definition is used for specifies the type of link function to use when generalizedLinear model type is specified.

  12. object MissingPredictionTreatment extends Enumeration

    The missing prediction treatment options are used when at least one model for which the predicate in the Segment evaluates to true has a missing result.

  13. object MissingValueStrategy extends Enumeration

    Defines a strategy for dealing with missing values.

  14. object Model extends Serializable

  15. object ModelClass extends Enumeration

  16. object ModelElement

  17. object MultipleModelMethod extends Enumeration

    Specifying how all the models applicable to a record should be combined.

  18. object NNNormalizationMethod extends Enumeration

    A normalization method softmax ( pj = exp(yj) / Sumi(exp(yi) ) ) or simplemax ( pj = yj / Sumi(yi) ) can be applied to the computed activation values.

  19. object NoTrueChildStrategy extends Enumeration

    Defines what to do in situations where scoring cannot reach a leaf node.

  20. object PCovMatrixType extends Enumeration

  21. object ReasonCodeAlgorithm extends Enumeration

    Describes how reason codes shall be ranked.

  22. object RegressionModelType extends Enumeration

    Specifies the type of a regression model.

  23. object RegressionNormalizationMethod extends Enumeration

    Describes how the prediction is converted into a confidence value (aka probability).

  24. object Rule

  25. object SVMClassificationMethod extends Enumeration

    The two most popular methods for multi-class classification are one-against-all (also known as one-against-rest) and one-against-one.

  26. object SVMRepresentation extends Enumeration

    Usually the SVM model uses support vectors to define the model function.

  27. object SplitCharacteristic extends Enumeration

    Indicates whether non-leaf Nodes in the tree model have exactly two children, or an unrestricted number of children.

Inherited from AnyRef

Inherited from Any

Ungrouped