case class 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) extends HasUsageType with PmmlElement with Product with Serializable
MiningFields also define the usage of each field (active, supplementary, target, ...) as well as policies for treating missing, invalid or outlier values.
- 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.
- Alphabetic
- By Inheritance
- MiningField
- Product
- Equals
- PmmlElement
- Serializable
- HasExtensions
- HasUsageType
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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)
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def extensions: Seq[Extension]
- Definition Classes
- HasExtensions
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hasExtensions: Boolean
- Definition Classes
- HasExtensions
- val highValue: Option[Double]
- val importance: Option[Double]
- val invalidValueReplacement: Option[Any]
- val invalidValueTreatment: InvalidValueTreatment
- def isDefault: Boolean
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- val lowValue: Option[Double]
- val missingValueReplacement: Option[Any]
- val missingValueTreatment: Option[MissingValueTreatment]
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val opType: Option[OpType]
- val outliers: OutlierTreatmentMethod
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val usageType: UsageType
Usage type
Usage type
- Definition Classes
- MiningField → HasUsageType
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)