org.pmml4s.metadata

Target

class Target extends PmmlElement

Note that castInteger, min, max, rescaleConstant and rescaleFactor only apply to models of type regression. Furthermore, they must be applied in sequence, which is:

min and max rescaleFactor rescaleConstant castInteger

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

Instance Constructors

  1. new Target(field: Option[String], optype: Option[OpType], castInteger: Option[CastInteger], min: Option[Double], max: Option[Double], rescaleConstant: Double = 0.0, rescaleFactor: Double = 1.0, targetValues: Array[TargetValue] = ...)

    field

    must refer to a name of a DataField or DerivedField. It can be absent when the model is used inside a Segment of a MiningModel and does not have a real target field in the input data

    optype

    When Target specifies optype then it overrides the optype attribute in a corresponding MiningField, if it exists. If the target does not specify optype then the MiningField is used as default. And, in turn, if the MiningField does not specify an optype, it is taken from the corresponding DataField. In other words, a MiningField overrides a DataField, and a Target overrides a MiningField.

    castInteger

    If a regression model should predict integers, use the attribute castInteger to control how decimal places should be handled.

    min

    If min is present, the predicted value will be the value of min if it is smaller than that.

    max

    If max is present, the predicted value will be max if it is larger than that.

    rescaleConstant

    can be used for simple rescale of the predicted value: First off, the predicted value is multiplied by rescaleFactor.

    rescaleFactor

    after that, rescaleConstant is added to the predicted value.

    targetValues

    In classification models, TargetValue is required. For regression models, TargetValue is only optional.

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. val castInteger: Option[CastInteger]

    If a regression model should predict integers, use the attribute castInteger to control how decimal places should be handled.

  8. def categories: Array[Any]

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def defaultValue: Option[Double]

  11. def displayValue(value: Any): Option[String]

  12. lazy val displayValues: Map[Any, String]

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

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

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

    Definition Classes
    HasExtensions
  16. val field: Option[String]

    must refer to a name of a DataField or DerivedField.

    must refer to a name of a DataField or DerivedField. It can be absent when the model is used inside a Segment of a MiningModel and does not have a real target field in the input data

  17. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  19. def hasExtensions: Boolean

    Definition Classes
    HasExtensions
  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. val max: Option[Double]

    If max is present, the predicted value will be max if it is larger than that.

  23. val min: Option[Double]

    If min is present, the predicted value will be the value of min if it is smaller than that.

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

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

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

    Definition Classes
    AnyRef
  27. val optype: Option[OpType]

    When Target specifies optype then it overrides the optype attribute in a corresponding MiningField, if it exists.

    When Target specifies optype then it overrides the optype attribute in a corresponding MiningField, if it exists. If the target does not specify optype then the MiningField is used as default. And, in turn, if the MiningField does not specify an optype, it is taken from the corresponding DataField. In other words, a MiningField overrides a DataField, and a Target overrides a MiningField.

  28. def postPredictedValue(predictedValue: Double): Double

  29. lazy val priorPredictedValue: Any

  30. def priorProbabilities: Map[Any, Double]

  31. val rescaleConstant: Double

    can be used for simple rescale of the predicted value: First off, the predicted value is multiplied by rescaleFactor.

  32. val rescaleFactor: Double

    after that, rescaleConstant is added to the predicted value.

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

    Definition Classes
    AnyRef
  34. val targetValues: Array[TargetValue]

    In classification models, TargetValue is required.

    In classification models, TargetValue is required. For regression models, TargetValue is only optional.

  35. def toString(): String

    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. 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 AnyRef

Inherited from Any

Ungrouped