UsageType

object UsageType extends Enumeration

Usage type

  • active: field used as input (independent field).
  • target: field that was used a training target for supervised models.
  • predicted: field whose value is predicted by the model. As of PMML 4.2, this is deprecated and it has been replaced by the usage type target.
  • supplementary: field holding additional descriptive information. Supplementary fields are not required to apply a model. They are provided as additional information for explanatory purpose, though. When some field has gone through preprocessing transformations before a model is built, then an additional supplementary field is typically used to describe the statistics for the original field values.
  • group: field similar to the SQL GROUP BY. For example, this is used by AssociationModel and SequenceModel to group items into transactions by customerID or by transactionID.
  • order: This field defines the order of items or transactions and is currently used in SequenceModel and TimeSeriesModel. Similarly to group, it is motivated by the SQL syntax, namely by the ORDER BY statement.
  • frequencyWeight and analysisWeight: These fields are not needed for scoring, but provide very important information on how the model was built. Frequency weight usually has positive integer values and is sometimes called "replication weight". Its values can be interpreted as the number of times each record appears in the data. Analysis weight can have fractional positive values, it could be used for regression weight in regression models or for case weight in trees, etc. It can be interpreted as different importance of the cases in the model. Counts in ModelStats and Partitions can be computed using frequency weight, mean and standard deviation values can be computed using both weights.
class Enumeration
trait Serializable
class Object
trait Matchable
class Any

Type members

Inherited classlikes

@SerialVersionUID(value = -3501153230598116017L)
protected class Val
Inherited from:
Enumeration
@SerialVersionUID(value = 7091335633555234129L)
abstract class Value
Inherited from:
Enumeration
Inherited from:
Enumeration
@SerialVersionUID(value = 7229671200427364242L)
class ValueSet
Inherited from:
Enumeration
@SerialVersionUID(value = 3L)
object ValueSet
Inherited from:
Enumeration

Types

Value members

Inherited methods

final protected def Value(i: Int, name: String): Value
Inherited from:
Enumeration
final protected def Value(name: String): Value
Inherited from:
Enumeration
final protected def Value(i: Int): Value
Inherited from:
Enumeration
final protected def Value: Value
Inherited from:
Enumeration
final def apply(x: Int): Value
Inherited from:
Enumeration
final def maxId: Int
Inherited from:
Enumeration
protected def readResolve(): AnyRef
Inherited from:
Enumeration
override def toString(): String
Definition Classes
Enumeration -> Any
Inherited from:
Enumeration
Inherited from:
Enumeration
final def withName(s: String): Value
Inherited from:
Enumeration