package common
- Alphabetic
- By Inheritance
- common
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- case class AboveInterval(leftMargin: Double, isOpen: Boolean) extends Interval with Product with Serializable
- class AnyDistribution extends ContinuousDistribution
-
class
Application extends PmmlElement
Describes the software application that generated the model.
- case class BelowInterval(rightMargin: Double, isOpen: Boolean) extends Interval with Product with Serializable
-
class
BooleanType extends DataType
The data type representing
Boolean
values. -
class
CategoricalPredictor extends RegressionPredictor
Defines a categorical independent variable.
Defines a categorical independent variable. The list of attributes comprises the name of the variable, the value attribute, and the coefficient by which the values of this variable must be multiplied.
- trait Clearable extends AnyRef
- trait ClsOutputs extends ModelOutputs with MutablePredictedValueWithProbabilities with MutablePredictedDisplayValue
- trait CluOutputs extends ModelOutputs with MutablePredictedValue with MutablePredictedDisplayValue with MutableEntityId with MutableAffinities
- class ComparisonMeasure extends PmmlElement
-
class
CompoundPredicate extends Predicate
CompoundPredicate: an encapsulating element for combining two or more elements as defined at the entity PREDICATE.
CompoundPredicate: an encapsulating element for combining two or more elements as defined at the entity PREDICATE. The attribute associated with this element, booleanOperator, can take one of the following logical (boolean) operators: and, or, xor or surrogate.
- trait ContinuousDistribution extends PmmlElement
- class ContrastMatrixFactorPredictor extends FactorPredictor
-
class
Counts extends PmmlElement
Carries counters for frequency of values with respect to their state of being missing, invalid, or valid.
Carries counters for frequency of values with respect to their state of being missing, invalid, or valid. The counts can be non-integer if they are weighted.
- class CovariatePredictor extends RegressionPredictor
-
sealed abstract
class
DataType extends DataTypeLike
The base type of all PMML data types.
-
trait
DataTypeLike extends Serializable
A template trait for a data type.
-
case class
DateDaySinceYearType(aYear: Int) extends DateType with Product with Serializable
The type dateDaysSince[aYear] is a variant of the type date where the values are represented as the number of days since aYear-01-01.
The type dateDaysSince[aYear] is a variant of the type date where the values are represented as the number of days since aYear-01-01. The date aYear-01-01 is represented by the number 0. aYear-01-02 is represented by 1, aYear-02-01 is represented by 31, etc. Dates before aYear-01-01 are represented as negative numbers. For example, values of type dateDaysSince[1960] are the number of days since 1960-01-01. The date 1960-01-01 is represented by the number 0.
-
case class
DateTimeSecondSinceYearType(aYear: Int) extends DateTimeType with Product with Serializable
The type dateTimeSecondsSince[aYear] is a variant of the type date where the values are represented as the number of seconds since 00:00 on aYear-01-01.
The type dateTimeSecondsSince[aYear] is a variant of the type date where the values are represented as the number of seconds since 00:00 on aYear-01-01. The datetime 00:00:00 on aYear-01-01 is represented by the number 0. The datetime 00:00:01 on aYear-01-01 is represented by 1, etc. Datetimes before aYear-01-01 are represented as negative numbers. For example, values of type dateTimeSecondsSince[1960] are the number of seconds since 00:00 on 1960-01-01. The datetime 00:00:00 on 1960-01-01 is represented by the number 0. The datetime 00:01:00 on 1960-01-01 is represented by 60.
-
sealed abstract
class
DateTimeType extends NumericType
The base type of timestamp
-
sealed abstract
class
DateType extends NumericType
The base type of date
-
class
DenseMatrix extends Matrix
Dense matrix
- class DenseVector[V] extends Vector[V]
-
class
DiagonalMatrix extends Matrix
The content is just one array of numbers representing the diagonal values.
- trait Distance extends PmmlElement
- trait DoubleEvaluator extends PmmlElement
-
trait
Evaluator extends PmmlElement
A common super-trait that accepts a series, then evaluates a single value.
- case class Extension(extender: Option[String], name: Option[String], value: Option[Any], content: Option[Any]) extends Serializable with Product
- class FactorPredictor extends CategoricalPredictor
- class GaussianDistribution extends ContinuousDistribution
- case class GenericInterval(leftMargin: Double, rightMargin: Double, closure: Closure) extends Interval with Product with Serializable
- class GenericMultiModelOutputs extends MultiModelOutputs
- trait HasAffinities extends AnyRef
- trait HasAssociationRules extends AnyRef
- trait HasConfidence extends AnyRef
- trait HasDataType extends DataTypeLike
- trait HasDecision extends AnyRef
- trait HasEntityId extends AnyRef
- trait HasEntityIds extends AnyRef
-
trait
HasExtensions extends AnyRef
The PMML schema contains a mechanism for extending the content of a model.
The PMML schema contains a mechanism for extending the content of a model. Extension elements should be present as the first child in all elements and groups defined in PMML. This way it is possible to place information in the Extension elements which affects how the remaining entries are treated. The main element in each model should have Extension elements as the first and the last child for maximum flexibility.
- trait HasIntervals extends AnyRef
-
trait
HasModelAttributes extends AnyRef
Holds common attributes of a PMML model.
- trait HasModelExplanation extends AnyRef
- trait HasModelStats extends AnyRef
- trait HasModelVerification extends AnyRef
- trait HasOpType extends AnyRef
- trait HasParent extends AnyRef
- trait HasPredictedDisplayValue extends AnyRef
- trait HasPredictedValue extends AnyRef
- trait HasPredictedValueWithProbabilities extends HasPredictedValue with HasProbabilities
- trait HasProbabilities extends AnyRef
- trait HasReasonCode extends AnyRef
- trait HasReasonCodes extends AnyRef
- trait HasResidual extends AnyRef
- trait HasScoreDistributions extends AnyRef
- trait HasSegment extends HasTransformedValue
- trait HasStandardError extends AnyRef
- trait HasTransformedValue extends AnyRef
- trait HasVersion extends AnyRef
- trait HasWarning extends AnyRef
- trait HasWrappedModelAttributes extends HasModelAttributes
- class Header extends PmmlElement
- class InlineTable extends Table
-
class
IntegerType extends NumericType
The data type representing
Int
orLong
values. -
sealed abstract
class
Interval extends PmmlElement
Defines a range of numeric values.
- trait KNNOutputs extends ModelOutputs with MutablePredictedValue with MutablePredictedDisplayValue with MutableEntityIds with MutableAffinities
- case class MatCell(row: Int, col: Int, value: Double) extends Product with Serializable
-
trait
Matrix extends PmmlElement
Trait for a matrix.
- trait MixedClsWithRegOutputs extends ClsOutputs with RegOutputs
- trait MixedEvaluator extends Evaluator with DoubleEvaluator
-
class
ModelAttributes extends HasModelAttributes with Serializable
Class represents common attributes of a PMML model.
-
class
ModelExplanation extends PmmlElement
Model Explanation
- trait ModelOutputs extends AnyRef
-
class
ModelStats extends PmmlElement
Provides a basic framework for representing variable statistics.
-
class
ModelVerification extends PmmlElement
Provides a dataset of model inputs and known results that can be used to verify accurate results are generated, regardless of the environment.
- trait MultiModelOutputs extends ModelOutputs
- trait MutableAffinities extends HasAffinities
- trait MutableConfidence extends HasConfidence
- trait MutableEntityId extends HasEntityId
- trait MutableEntityIds extends HasEntityIds
- trait MutablePredictedDisplayValue extends HasPredictedDisplayValue
- trait MutablePredictedValue extends HasPredictedValue
- trait MutablePredictedValueWithProbabilities extends HasPredictedValueWithProbabilities with MutablePredictedValue with MutableProbabilities
- trait MutableProbabilities extends HasProbabilities
- trait MutableReasonCodes extends HasReasonCodes
- trait MutableSegment extends HasSegment
-
class
NumericInfo extends PmmlElement
The values for mean, minimum, maximum and standardDeviation are defined as usual.
The values for mean, minimum, maximum and standardDeviation are defined as usual. median is calculated as the 50% quantile; interQuartileRange is calculated as (75% quantile - 25% quantile).
-
class
NumericPredictor extends RegressionPredictor
Defines a numeric independent variable.
Defines a numeric independent variable. The list of valid attributes comprises the name of the variable, the exponent to be used, and the coefficient by which the values of this variable must be multiplied. Note that the exponent defaults to 1, hence it is not always necessary to specify. Also, if the input value is missing, the result evaluates to a missing value.
-
sealed abstract
class
NumericType extends DataType
Numeric data types.
-
sealed
trait
OpType extends AnyRef
Indicates which operations are defined on the values.
-
class
Partition extends PmmlElement
A Partition contains statistics for a subset of records, for example it can describe the population in a cluster.
A Partition contains statistics for a subset of records, for example it can describe the population in a cluster. The content of a Partition mirrors the definition of the general univariate statistics. That is, each Partition describes the distribution per field. For each field there can be information about frequencies, numeric moments, etc.
The attribute name identifies the Partition. The attribute size is the number of records. All aggregates in PartitionFieldStats must have size = totalFrequency in Counts if specified.
-
class
PartitionFieldStats extends PmmlElement
field references to (the name of) a MiningField for background statistics.
field references to (the name of) a MiningField for background statistics. The sequence of NUM-ARRAYs is the same as for ContStats. For categorical fields there is only one array containing the frequencies; for numeric fields, the second and third array contain the sums of values and the sums of squared values, respectively. The number of values in each array must match the number of categories or intervals in UnivariateStats of the field.
-
trait
PmmlElement extends HasExtensions with Serializable
The base trait for all elements of PMML
- case class PointInterval(x: Double) extends Interval with Product with Serializable
- class PoissonDistribution extends ContinuousDistribution
- trait Predicate extends PmmlElement
- trait Predictable extends AnyRef
-
class
PredictorTerm extends RegressionPredictor
Contains one or more fields that are combined by multiplication.
Contains one or more fields that are combined by multiplication. That is, this element supports interaction terms. The type of all fields referenced within PredictorTerm must be continuous. Note that if the input value is missing, the result evaluates to a missing value.
- class Quantile extends PmmlElement
-
class
RealType extends NumericType
The data type representing
Float
orDouble
values. - trait RegOutputs extends ModelOutputs with MutablePredictedValue
- trait RegressionEvaluator extends Evaluator with DoubleEvaluator
- class RegressionParameter extends RegressionPredictor
- sealed trait RegressionPredictor extends RegressionEvaluator
-
class
RegressionTable extends RegressionPredictor
Lists the values of all predictors or independent variables.
Lists the values of all predictors or independent variables. If the model is used to predict a numerical field, then there is only one RegressionTable and the attribute targetCategory may be missing. If the model is used to predict a categorical field, then there are two or more RegressionTables and each one must have the attribute targetCategory defined with a unique value.
- class Row extends AnyRef
-
class
ScoreDistribution extends PmmlElement
Comprises a method to list predicted values in a classification trees structure.
- class ScoreDistributions extends PmmlElement
- trait SegmentOutputs extends ModelOutputs with MutableSegment
-
class
SimplePredicate extends Predicate
Defines a rule in the form of a simple boolean expression.
Defines a rule in the form of a simple boolean expression. The rule consists of field, operator (booleanOperator) for binary comparison, and value.
-
class
SimpleSetPredicate extends Predicate
Checks whether a field value is element of a set.
Checks whether a field value is element of a set. The set of values is specified by the array.
-
class
SparseMatrix extends Matrix
Column-major sparse matrix.
- class SparseVector[V] extends Vector[V]
-
class
StringType extends DataType
The data type representing
String
values. -
case class
StructField(name: String, dataType: DataType) extends Product with Serializable
A field inside a StructType.
A field inside a StructType.
- name
The name of this field.
- dataType
The data type of this field.
-
case class
StructType(fields: Array[StructField]) extends DataType with Seq[StructField] with Product with Serializable
StructType defines a type for a [Series]
-
class
SymmetricMatrix extends Matrix
The content must be represented by Arrays.
The content must be represented by Arrays. The first array contains the matrix element M(0,0), the second array contains M(1,0), M(1,1), and so on (that is the lower left triangle). Other elements are defined by symmetry.
- sealed trait Table extends PmmlElement
- class TableLocator extends Table
-
class
TimeSecondsType extends TimeType
The type timeSeconds is a variant of the type time where the values are represented as the number of seconds since 00:00, that is, since midnight.
The type timeSeconds is a variant of the type time where the values are represented as the number of seconds since 00:00, that is, since midnight. The time 00:00 is represented by the number 0. No negative values are allowed.
-
class
TimeType extends NumericType
The data type representing
Time
values. -
trait
Transformer extends AnyRef
Abstract class for transformers that transform one series into another.
- class UniformDistribution extends ContinuousDistribution
- class Value extends PmmlElement
- trait Vector[V] extends AnyRef
- class binarySimilarity extends Distance
- class minkowski extends Distance
Value Members
- object ArrayType extends Enumeration
- object BooleanType extends BooleanType with Product with Serializable
- object Closure extends Enumeration
-
object
CompareFunction extends Enumeration
- absDiff: absolute difference c(x,y) = |x-y|
- gaussSim: gaussian similarity c(x,y) = exp(-ln(2)*z*z/(s*s)) where z=x-y, and s is the value of attribute similarityScale (required in this case) in the ClusteringField
- delta: c(x,y) = 0 if x=y, 1 else
- equal: c(x,y) = 1 if x=y, 0 else
- table: c(x,y) = lookup in similarity matrix
- object ComparisonMeasureKind extends Enumeration
- object CompoundPredicate extends Serializable
- object ContinuousDistribution extends Serializable
- object ContinuousDistributionType extends Enumeration
- object DataType extends Serializable
- object DateDaySinceYearType extends Product with Serializable
- object DateTimeSecondSinceYearType extends Product with Serializable
- object DateTimeType extends DateTimeType with Product with Serializable
- object DateType extends DateType with Product with Serializable
- object Distance extends Serializable
-
object
False extends Predicate
Identifies the boolean constant FALSE.
- object InfinityInterval extends Interval with Product with Serializable
- object IntegerType extends IntegerType with Product with Serializable
- object Interval extends Serializable
- object MatrixKind extends Enumeration
- object MiningFunction extends Enumeration
- object OpType
-
object
Operator extends Enumeration
Pre-defined comparison operators.
- object Predicate extends Serializable
- object Predication extends Enumeration
-
object
Property extends Enumeration
- Valid value: A value which is neither missing nor invalid.
- Invalid value: The input value is not missing but it does not belong to a certain value range. The range of valid values can be defined for each field.
- Missing value: Input value is missing, for example, if a database column contains a null value. It is possible to explicitly define values which are interpreted as missing values.
- object RealType extends RealType with Product with Serializable
- object RegressionPredictor extends Serializable
- object SimpleSetPredicate extends Serializable
- object SparseMatrix extends Serializable
- object StringType extends StringType with Product with Serializable
- object StructType extends Serializable
- object Table extends Serializable
- object TimeSecondsType extends TimeSecondsType with Product with Serializable
- object TimeType extends TimeType with Product with Serializable
-
object
True extends Predicate
Identifies the boolean constant TRUE.
- object UnresolvedDataType extends DataType with Product with Serializable
- object Value extends Serializable
- object chebychev extends Distance
- object cityBlock extends Distance
- object euclidean extends Distance
- object jaccard extends Distance
- object simpleMatching extends Distance
- object squaredEuclidean extends Distance
- object tanimoto extends Distance