Class

com.salesforce.op.evaluators

OpEvaluatorBase

Related Doc: package evaluators

Permalink

abstract class OpEvaluatorBase[T <: EvaluationMetrics] extends Evaluator with OpHasLabelCol[RealNN] with OpHasPredictionValueCol[RealNN] with OpHasPredictionCol

Base Interface for OpEvaluator to be used in Evaluator creation. Can be used for both OP and spark eval (so with workflows and cross validation).

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

Instance Constructors

  1. new OpEvaluatorBase()

    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

  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

  3. abstract 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
  4. abstract val name: EvalMetric

    Permalink

    Name of evaluator

  5. abstract val uid: String

    Permalink
    Definition Classes
    Identifiable

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[_]): OpEvaluatorBase.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): OpEvaluatorBase.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
    Definition Classes
    Evaluator
    Annotations
    @Since( "1.5.0" )
  34. final def isSet(param: Param[_]): Boolean

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

    Permalink
    Definition Classes
    OpHasLabelCol
  36. final def ne(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    OpHasLabelCol
  48. def setLabelCol(value: String): OpEvaluatorBase.this.type

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

    Permalink
    Definition Classes
    OpHasPredictionCol
  50. def setPredictionCol(value: String): OpEvaluatorBase.this.type

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

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

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

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

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

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

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

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

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