Class

org.pmml4s.metadata

MiningField

Related Doc: package metadata

Permalink

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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    name

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

    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.

    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.

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def extensions: Seq[Extension]

    Permalink
    Definition Classes
    HasExtensions
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hasExtensions: Boolean

    Permalink
    Definition Classes
    HasExtensions
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. val highValue: Option[Double]

    Permalink
  14. val importance: Option[Double]

    Permalink

    States the relative importance of the field.

  15. val invalidValueReplacement: Option[Any]

    Permalink
  16. val invalidValueTreatment: InvalidValueTreatment

    Permalink

    Specifies how invalid input values are handled.

  17. def isInput: Boolean

    Permalink

    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
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. def isTarget: Boolean

    Permalink

    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
  20. val lowValue: Option[Double]

    Permalink
  21. val missingValueReplacement: Option[Any]

    Permalink

    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.

  22. val missingValueTreatment: Option[MissingValueTreatment]

    Permalink

    This field is for information only.

  23. val name: String

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. val opType: Option[OpType]

    Permalink

    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.

  28. val outliers: OutlierTreatmentMethod

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

    Permalink
    Definition Classes
    AnyRef
  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  31. val usageType: UsageType

    Permalink

    Usage type

    Usage type

    Definition Classes
    MiningFieldHasUsageType
  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Permalink
    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