Packages

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.
Linear Supertypes
Enumeration, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UsageType
  2. Enumeration
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type UsageType = Value
  2. class Val extends Value with Serializable
    Attributes
    protected
    Definition Classes
    Enumeration
    Annotations
    @SerialVersionUID()
  3. abstract class Value extends Ordered[Value] with Serializable
    Definition Classes
    Enumeration
    Annotations
    @SerialVersionUID()
  4. class ValueSet extends AbstractSet[Value] with SortedSet[Value] with SortedSetOps[Value, SortedSet, ValueSet] with StrictOptimizedIterableOps[Value, Set, ValueSet] with Serializable
    Definition Classes
    Enumeration

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. final def Value(i: Int, name: String): Value
    Attributes
    protected
    Definition Classes
    Enumeration
  5. final def Value(name: String): Value
    Attributes
    protected
    Definition Classes
    Enumeration
  6. final def Value(i: Int): Value
    Attributes
    protected
    Definition Classes
    Enumeration
  7. final def Value: Value
    Attributes
    protected
    Definition Classes
    Enumeration
  8. val active: Value
  9. val analysisWeight: Value
  10. final def apply(x: Int): Value
    Definition Classes
    Enumeration
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. val frequencyWeight: Value
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. val group: Value
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def maxId: Int
    Definition Classes
    Enumeration
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. var nextId: Int
    Attributes
    protected
    Definition Classes
    Enumeration
  24. var nextName: Iterator[String]
    Attributes
    protected
    Definition Classes
    Enumeration
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. val order: Value
  28. val predicted: Value
  29. def readResolve(): AnyRef
    Attributes
    protected
    Definition Classes
    Enumeration
  30. val supplementary: Value
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. val target: Value
  33. def toString(): String
    Definition Classes
    Enumeration → AnyRef → Any
  34. def values: ValueSet
    Definition Classes
    Enumeration
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. final def withName(s: String): Value
    Definition Classes
    Enumeration
  39. implicit object ValueOrdering extends Ordering[Value]
    Definition Classes
    Enumeration

Inherited from Enumeration

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped