Class/Object

org.apache.spark.ml.odkl

PartitionedRankingEvaluator

Related Docs: object PartitionedRankingEvaluator | package odkl

Permalink

class PartitionedRankingEvaluator extends Evaluator[PartitionedRankingEvaluator] with HasOutputCol with HasGroupByColumns

Evaluator used to compute metrics for predictions grouped by a certain criteria (typically by a user id). Materializes all the predictions for a criteria in memory and calculates multiple metrics. Can be used only for fine-grained grouping criteria. Supports mutli-label and multi-score cross evaluation (computes metrics for each label-score combinations if provided with vectors instead of scalars).

Linear Supertypes
HasGroupByColumns, HasOutputCol, Evaluator[PartitionedRankingEvaluator], HasPredictionCol, HasLabelCol, Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PartitionedRankingEvaluator
  2. HasGroupByColumns
  3. HasOutputCol
  4. Evaluator
  5. HasPredictionCol
  6. HasLabelCol
  7. Transformer
  8. PipelineStage
  9. Logging
  10. Params
  11. Serializable
  12. Serializable
  13. Identifiable
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PartitionedRankingEvaluator()

    Permalink

  2. new PartitionedRankingEvaluator(uid: String)

    Permalink

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[_]): PartitionedRankingEvaluator.this.type

    Permalink
    Definition Classes
    Params

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def constructMetadata(indexedMetrics: IndexedSeq[Metric]): Metadata

    Permalink

  9. def copy(extra: ParamMap): PartitionedRankingEvaluator

    Permalink
    Definition Classes
    PartitionedRankingEvaluator → Evaluator → Transformer → PipelineStage → Params

  10. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  11. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params

  15. def explainParams(): String

    Permalink
    Definition Classes
    Params

  16. val extraColumns: StringArrayParam

    Permalink

  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. final def getLabelCol: String

    Permalink
    Definition Classes
    HasLabelCol

  24. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params

  25. final def getOutputCol: String

    Permalink
    Definition Classes
    HasOutputCol

  26. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params

  27. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol

  28. final val groupByColumns: StringArrayParam

    Permalink
    Definition Classes
    HasGroupByColumns

  29. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params

  30. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  32. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  33. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  34. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  35. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  36. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  37. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  38. final val labelCol: Param[String]

    Permalink
    Definition Classes
    HasLabelCol

  39. val labelIndexColumnParam: Param[String]

    Permalink

  40. val labelThreshold: DoubleParam

    Permalink

  41. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  42. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  43. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  44. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  45. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  46. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  47. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  48. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  49. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  50. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  51. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  52. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  53. val metrics: Param[Seq[Metric]]

    Permalink

  54. val modelThreshold: DoubleParam

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  56. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  57. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  58. final val outputCol: Param[String]

    Permalink
    Definition Classes
    HasOutputCol

  59. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  60. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol

  61. val scoreIndexColumnParam: Param[String]

    Permalink

  62. final def set(paramPair: ParamPair[_]): PartitionedRankingEvaluator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  63. final def set(param: String, value: Any): PartitionedRankingEvaluator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  64. final def set[T](param: Param[T], value: T): PartitionedRankingEvaluator.this.type

    Permalink
    Definition Classes
    Params

  65. final def setDefault(paramPairs: ParamPair[_]*): PartitionedRankingEvaluator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  66. final def setDefault[T](param: Param[T], value: T): PartitionedRankingEvaluator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  67. def setExtraColumns(column: String*): PartitionedRankingEvaluator.this.type

    Permalink

  68. def setGroupByColumns(columns: String*): PartitionedRankingEvaluator.this.type

    Permalink
    Definition Classes
    HasGroupByColumns

  69. def setLabelColumn(value: String): PartitionedRankingEvaluator.this.type

    Permalink
    Definition Classes
    Evaluator

  70. def setLabelNameCol(column: String): PartitionedRankingEvaluator.this.type

    Permalink

  71. def setLabelThreshold(value: Double): PartitionedRankingEvaluator.this.type

    Permalink

  72. def setMetrics(metric: Metric*): PartitionedRankingEvaluator.this.type

    Permalink

  73. def setModelThreshold(value: Double): PartitionedRankingEvaluator.this.type

    Permalink

  74. def setOutputCol(column: String): PartitionedRankingEvaluator.this.type

    Permalink

  75. def setPredictionColumn(value: String): PartitionedRankingEvaluator.this.type

    Permalink
    Definition Classes
    Evaluator

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

    Permalink
    Definition Classes
    AnyRef

  77. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  78. def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    PartitionedRankingEvaluator → Transformer

  79. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )

  80. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()

  81. def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    PartitionedRankingEvaluator → PipelineStage

  82. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  83. val uid: String

    Permalink
    Definition Classes
    PartitionedRankingEvaluator → Evaluator → Identifiable

  84. final def wait(): Unit

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

  85. final def wait(arg0: Long, arg1: Int): Unit

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

  86. final def wait(arg0: Long): Unit

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

Inherited from HasGroupByColumns

Inherited from HasOutputCol

Inherited from Evaluator[PartitionedRankingEvaluator]

Inherited from HasPredictionCol

Inherited from HasLabelCol

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped