Class

org.pmml4s.metadata

Target

Related Doc: package metadata

Permalink

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
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] = Array.empty)

    Permalink

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

    Permalink

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

  6. def categories: Array[Any]

    Permalink
  7. def clone(): AnyRef

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

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

    Permalink
  10. lazy val displayValues: Map[Any, String]

    Permalink
  11. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    HasExtensions
  14. val field: Option[String]

    Permalink

    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

  15. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    Any
  20. val max: Option[Double]

    Permalink

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

  21. val min: Option[Double]

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  25. val optype: Option[OpType]

    Permalink

    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.

  26. def postPredictedValue(predictedValue: Double): Double

    Permalink
  27. lazy val priorPredictedValue: Any

    Permalink
  28. def priorProbabilities: Map[Any, Double]

    Permalink
  29. val rescaleConstant: Double

    Permalink

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

  30. val rescaleFactor: Double

    Permalink

    after that, rescaleConstant is added to the predicted value.

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

    Permalink
    Definition Classes
    AnyRef
  32. val targetValues: Array[TargetValue]

    Permalink

    In classification models, TargetValue is required.

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

  33. def toString(): String

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

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

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

Inherited from Any

Ungrouped