Class

com.salesforce.op.evaluators

OpRegressionEvaluatorBase

Related Doc: package evaluators

Permalink

abstract class OpRegressionEvaluatorBase[T <: EvaluationMetrics] extends OpEvaluatorBase[T]

Base Interface for OpRegressionEvaluator

Linear Supertypes
OpEvaluatorBase[T], OpHasPredictionCol, OpHasPredictionValueCol[RealNN], OpHasLabelCol[RealNN], Evaluator, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OpRegressionEvaluatorBase
  2. OpEvaluatorBase
  3. OpHasPredictionCol
  4. OpHasPredictionValueCol
  5. OpHasLabelCol
  6. Evaluator
  7. Params
  8. Serializable
  9. Serializable
  10. Identifiable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OpRegressionEvaluatorBase(uid: String)

    Permalink

Abstract Value Members

  1. abstract def evaluateAll(dataset: Dataset[_]): T

    Permalink

    Evaluate function that returns a class or value with the calculated metric value(s).

    Evaluate function that returns a class or value with the calculated metric value(s).

    dataset

    data to evaluate

    returns

    metrics

    Definition Classes
    OpEvaluatorBase
  2. abstract def getDefaultMetric: (T) ⇒ Double

    Permalink

    Conversion from full metrics returned to a double value

    Conversion from full metrics returned to a double value

    returns

    double value used as spark eval number

    Definition Classes
    OpEvaluatorBase
  3. abstract def name: EvalMetric

    Permalink

    Name of evaluator

    Name of evaluator

    Definition Classes
    OpEvaluatorBase

Concrete 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 $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  6. final def clear(param: Param[_]): OpRegressionEvaluatorBase.this.type

    Permalink
    Definition Classes
    Params
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def copy(extra: ParamMap): OpRegressionEvaluatorBase.this.type

    Permalink
    Definition Classes
    OpEvaluatorBase → Evaluator → Params
  9. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  10. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  11. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def evaluate(dataset: Dataset[_]): Double

    Permalink

    Evaluate function that returns a single metric

    Evaluate function that returns a single metric

    dataset

    data to evaluate

    returns

    metric

    Definition Classes
    OpEvaluatorBase → Evaluator
  14. def evaluate(dataset: Dataset[_], paramMap: ParamMap): Double

    Permalink
    Definition Classes
    Evaluator
    Annotations
    @Since( "2.0.0" )
  15. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  16. def explainParams(): String

    Permalink
    Definition Classes
    Params
  17. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  18. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  21. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  23. def getLabelCol: String

    Permalink
    Definition Classes
    OpHasLabelCol
  24. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  25. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  26. final def getPredictionCol: String

    Permalink
    Definition Classes
    OpHasPredictionCol
  27. final def getPredictionValueCol: String

    Permalink
    Attributes
    protected
    Definition Classes
    OpHasPredictionValueCol
  28. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  29. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  30. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  32. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  33. def isLargerBetter: Boolean

    Permalink

    Use the definition of the metric to determine if larger is better

    Use the definition of the metric to determine if larger is better

    Definition Classes
    OpEvaluatorBase → Evaluator
  34. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  35. final val labelCol: Param[String]

    Permalink
    Definition Classes
    OpHasLabelCol
  36. def makeDataToUse(data: Dataset[_], labelColName: String): Dataset[_]

    Permalink

    Prepare data with different input types so that it can be consumed by the evaluator

    Prepare data with different input types so that it can be consumed by the evaluator

    data

    input data

    labelColName

    name of the label column

    returns

    data formatted for use with the evaluator

    Attributes
    protected
    Definition Classes
    OpRegressionEvaluatorBaseOpEvaluatorBase
  37. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  40. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  41. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    OpHasPredictionCol
  42. final val predictionValueCol: Param[String]

    Permalink
    Definition Classes
    OpHasPredictionValueCol
  43. final def set(paramPair: ParamPair[_]): OpRegressionEvaluatorBase.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  44. final def set(param: String, value: Any): OpRegressionEvaluatorBase.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  45. final def set[T](param: Param[T], value: T): OpRegressionEvaluatorBase.this.type

    Permalink
    Definition Classes
    Params
  46. final def setDefault(paramPairs: ParamPair[_]*): OpRegressionEvaluatorBase.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  47. final def setDefault[T](param: Param[T], value: T): OpRegressionEvaluatorBase.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  48. def setLabelCol(value: FeatureLike[RealNN]): OpRegressionEvaluatorBase.this.type

    Permalink
    Definition Classes
    OpHasLabelCol
  49. def setLabelCol(value: String): OpRegressionEvaluatorBase.this.type

    Permalink
    Definition Classes
    OpHasLabelCol
  50. def setPredictionCol(value: FeatureLike[Prediction]): OpRegressionEvaluatorBase.this.type

    Permalink
    Definition Classes
    OpHasPredictionCol
  51. def setPredictionCol(value: String): OpRegressionEvaluatorBase.this.type

    Permalink
    Definition Classes
    OpHasPredictionCol
  52. def setPredictionValueCol(value: FeatureLike[RealNN]): OpRegressionEvaluatorBase.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    OpHasPredictionValueCol
  53. def setPredictionValueCol(value: String): OpRegressionEvaluatorBase.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    OpHasPredictionValueCol
  54. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  56. val uid: String

    Permalink
    Definition Classes
    OpRegressionEvaluatorBase → Identifiable
  57. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from OpEvaluatorBase[T]

Inherited from OpHasPredictionCol

Inherited from OpHasLabelCol[RealNN]

Inherited from Evaluator

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped