org.pmml4s.metadata

MiningField

class MiningField extends HasUsageType with PmmlElement

MiningFields also define the usage of each field (active, supplementary, target, ...) as well as policies for treating missing, invalid or outlier values.

Linear Supertypes
PmmlElement, Serializable, Serializable, HasExtensions, HasUsageType, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MiningField
  2. PmmlElement
  3. Serializable
  4. Serializable
  5. HasExtensions
  6. HasUsageType
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MiningField(name: String, usageType: UsageType, opType: Option[OpType], importance: Option[Double] = scala.None, outliers: OutlierTreatmentMethod = OutlierTreatmentMethod.asIs, lowValue: Option[Double] = scala.None, highValue: Option[Double] = scala.None, missingValueReplacement: Option[Any] = scala.None, missingValueTreatment: Option[MissingValueTreatment] = scala.None, invalidValueTreatment: InvalidValueTreatment = InvalidValueTreatment.returnInvalid, invalidValueReplacement: Option[Any] = scala.None)

    name

    Symbolic name of field, must refer to a field in the scope of the parent of the MiningSchema's model element.

    usageType
    opType

    The attribute value overrides the corresponding value in the DataField. That is, a DataField can be used with different optypes in different models. For example, a 0/1 indicator could be used as a numeric input field in a regression model while the same field is used as a categorical field in a tree model.

    importance

    States the relative importance of the field.

    outliers
    lowValue
    highValue
    missingValueReplacement

    If this attribute is specified then a missing input value is automatically replaced by the given value. That is, the model itself works as if the given value was found in the original input. For example the surrogate operator in TreeModel does not apply if the MiningField specifies a replacement value.

    missingValueTreatment

    This field is for information only.

    invalidValueTreatment

    Specifies how invalid input values are handled.

    invalidValueReplacement

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def extensions: Seq[Extension]

    Definition Classes
    HasExtensions

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def hasExtensions: Boolean

    Definition Classes
    HasExtensions

  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  15. val highValue: Option[Double]

  16. val importance: Option[Double]

    States the relative importance of the field.

  17. val invalidValueReplacement: Option[Any]

  18. val invalidValueTreatment: InvalidValueTreatment

    Specifies how invalid input values are handled.

  19. def isInput: Boolean

    Tests whether this field is input, true for active and group that is used by the association model.

    Tests whether this field is input, true for active and group that is used by the association model.

    Definition Classes
    HasUsageType

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. def isTarget: Boolean

    Tests whether this field is target, true for target and predicted

    Tests whether this field is target, true for target and predicted

    Definition Classes
    HasUsageType

  22. val lowValue: Option[Double]

  23. val missingValueReplacement: Option[Any]

    If this attribute is specified then a missing input value is automatically replaced by the given value.

    If this attribute is specified then a missing input value is automatically replaced by the given value. That is, the model itself works as if the given value was found in the original input. For example the surrogate operator in TreeModel does not apply if the MiningField specifies a replacement value.

  24. val missingValueTreatment: Option[MissingValueTreatment]

    This field is for information only.

  25. val name: String

    Symbolic name of field, must refer to a field in the scope of the parent of the MiningSchema's model element.

  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  27. final def notify(): Unit

    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  29. val opType: Option[OpType]

    The attribute value overrides the corresponding value in the DataField.

    The attribute value overrides the corresponding value in the DataField. That is, a DataField can be used with different optypes in different models. For example, a 0/1 indicator could be used as a numeric input field in a regression model while the same field is used as a categorical field in a tree model.

  30. val outliers: OutlierTreatmentMethod

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  32. def toString(): String

    Definition Classes
    AnyRef → Any

  33. val usageType: UsageType

    Definition Classes
    MiningField → HasUsageType

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from PmmlElement

Inherited from Serializable

Inherited from Serializable

Inherited from HasExtensions

Inherited from HasUsageType

Inherited from AnyRef

Inherited from Any

Ungrouped