Class/Object

com.github.jelmerk.spark.knn.evaluation

KnnSimilarityEvaluator

Related Docs: object KnnSimilarityEvaluator | package evaluation

Permalink

class KnnSimilarityEvaluator extends Evaluator with DefaultParamsWritable

Evaluator for knn algorithms, which expects two input columns, the exact neighbors and approximate neighbors. It compares the results to determine the accuracy of the approximate results. Typically you will want to compute this over a small sample given the cost of computing the exact results on a large index.

Linear Supertypes
DefaultParamsWritable, MLWritable, Evaluator, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KnnSimilarityEvaluator
  2. DefaultParamsWritable
  3. MLWritable
  4. Evaluator
  5. Params
  6. Serializable
  7. Serializable
  8. Identifiable
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new KnnSimilarityEvaluator()

    Permalink

  2. new KnnSimilarityEvaluator(uid: String)

    Permalink

    uid

    identifier

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 val approximateNeighborsCol: Param[String]

    Permalink

    Param for the column name for the approximate results.

    Param for the column name for the approximate results. Default: "approximateNeighbors"

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. final def clear(param: Param[_]): KnnSimilarityEvaluator.this.type

    Permalink
    Definition Classes
    Params

  8. def clone(): AnyRef

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

  9. def copy(extra: ParamMap): Evaluator

    Permalink
    Definition Classes
    KnnSimilarityEvaluator → Evaluator → 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 evaluate(dataset: Dataset[_]): Double

    Permalink

    Returns the accuracy of the approximate results.

    Returns the accuracy of the approximate results.

    dataset

    a dataset

    returns

    the accuracy of the approximate results

    Definition Classes
    KnnSimilarityEvaluator → Evaluator

  15. def evaluate(dataset: Dataset[_], paramMap: ParamMap): Double

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

  16. final val exactNeighborsCol: Param[String]

    Permalink

    Param for the column name for the exact results.

    Param for the column name for the exact results. Default: "exactNeighbors"

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

    Permalink
    Definition Classes
    Params

  18. def explainParams(): String

    Permalink
    Definition Classes
    Params

  19. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params

  20. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params

  21. def finalize(): Unit

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

  22. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  23. final def getApproximateNeighborsCol: String

    Permalink

  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params

  26. final def getExactNeighborsCol: String

    Permalink

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

    Permalink
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

  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. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  34. def isLargerBetter: Boolean

    Permalink
    Definition Classes
    KnnSimilarityEvaluator → Evaluator

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

    Permalink
    Definition Classes
    Params

  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. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )

  41. final def set(paramPair: ParamPair[_]): KnnSimilarityEvaluator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  42. final def set(param: String, value: Any): KnnSimilarityEvaluator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

  44. final def setApproximateNeighborsCol(value: String): KnnSimilarityEvaluator.this.type

    Permalink

  45. final def setDefault(paramPairs: ParamPair[_]*): KnnSimilarityEvaluator.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  47. final def setExactNeighborsCol(value: String): KnnSimilarityEvaluator.this.type

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  49. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  50. val uid: String

    Permalink

    identifier

    identifier

    Definition Classes
    KnnSimilarityEvaluator → Identifiable

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

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

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

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

  53. final def wait(): Unit

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

  54. def write: MLWriter

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Evaluator

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

getParam

param

setParam

Ungrouped