Class/Object

com.github.jelmerk.spark.knn.hnsw

HnswSimilarityModel

Related Docs: object HnswSimilarityModel | package hnsw

Permalink

abstract class HnswSimilarityModel extends KnnModelBase[HnswSimilarityModel] with HnswModelParams with MLWritable

Model produced by HnswSimilarity.

Linear Supertypes
MLWritable, HnswModelParams, KnnModelBase[HnswSimilarityModel], KnnModelParams, HasPredictionCol, HasFeaturesCol, Model[HnswSimilarityModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HnswSimilarityModel
  2. MLWritable
  3. HnswModelParams
  4. KnnModelBase
  5. KnnModelParams
  6. HasPredictionCol
  7. HasFeaturesCol
  8. Model
  9. Transformer
  10. PipelineStage
  11. Logging
  12. Params
  13. Serializable
  14. Serializable
  15. Identifiable
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HnswSimilarityModel()

    Permalink

Abstract Value Members

  1. abstract def copy(extra: ParamMap): HnswSimilarityModel

    Permalink
    Definition Classes
    Model → Transformer → PipelineStage → Params
  2. abstract def getNumPartitions: Int

    Permalink
    Definition Classes
    KnnModelBase
  3. abstract def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  4. abstract def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  5. abstract val uid: String

    Permalink
    Definition Classes
    Identifiable
  6. abstract def write: MLWriter

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  10. final val ef: IntParam

    Permalink

    Size of the dynamic list for the nearest neighbors (used during the search).

    Size of the dynamic list for the nearest neighbors (used during the search). Default: 10

    Definition Classes
    HnswModelParams
  11. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. final val excludeSelf: BooleanParam

    Permalink

    Param that indicates whether to not return the a candidate when it's identifier equals the query identifier Default: false

    Param that indicates whether to not return the a candidate when it's identifier equals the query identifier Default: false

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

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

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

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

    Permalink
    Definition Classes
    Params
  18. final val featuresCol: Param[String]

    Permalink
    Definition Classes
    HasFeaturesCol
  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 getEf: Int

    Permalink

    Definition Classes
    HnswModelParams
  24. final def getExcludeSelf: Boolean

    Permalink

    Definition Classes
    KnnModelParams
  25. final def getFeaturesCol: String

    Permalink
    Definition Classes
    HasFeaturesCol
  26. final def getK: Int

    Permalink

    Definition Classes
    KnnModelParams
  27. final def getNumReplicas: Int

    Permalink

    Definition Classes
    KnnModelParams
  28. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  29. final def getOutputFormat: String

    Permalink

    Definition Classes
    KnnModelParams
  30. final def getParallelism: Int

    Permalink

    Definition Classes
    KnnModelParams
  31. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  32. final def getPredictionCol: String

    Permalink
    Definition Classes
    HasPredictionCol
  33. final def getQueryIdentifierCol: String

    Permalink

    Definition Classes
    KnnModelParams
  34. final def getQueryPartitionsCol: String

    Permalink

    Definition Classes
    KnnModelParams
  35. final def getSimilarityThreshold: Double

    Permalink

    Definition Classes
    KnnModelParams
  36. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  38. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  39. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  40. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  41. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  42. final def isDefined(param: Param[_]): Boolean

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

    Permalink
    Definition Classes
    Any
  44. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  45. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  46. final val k: IntParam

    Permalink

    Param for number of neighbors to find (> 0).

    Param for number of neighbors to find (> 0). Default: 5

    Definition Classes
    KnnModelParams
  47. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  48. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  49. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  50. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  52. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  53. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  62. final val numReplicas: IntParam

    Permalink

    Param that specifies the number of index replicas to create when querying the index.

    Param that specifies the number of index replicas to create when querying the index. More replicas means you can execute more queries in parallel at the expense of increased resource usage. Default: 0

    Definition Classes
    KnnModelParams
  63. final val outputFormat: Param[String]

    Permalink

    Param for the output format to produce.

    Param for the output format to produce. One of "full", "minimal" Setting this to minimal is more efficient when all you need is the identifier with its neighbors

    Default: "full"

    Definition Classes
    KnnModelParams
  64. final val parallelism: IntParam

    Permalink

    Param that specifies the number of threads to use.

    Param that specifies the number of threads to use. Default: number of processors available to the Java virtual machine

    Definition Classes
    KnnModelParams
  65. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  66. var parent: Estimator[HnswSimilarityModel]

    Permalink
    Definition Classes
    Model
  67. final val predictionCol: Param[String]

    Permalink
    Definition Classes
    HasPredictionCol
  68. final val queryIdentifierCol: Param[String]

    Permalink

    Param for the column name for the query identifier.

    Param for the column name for the query identifier.

    Definition Classes
    KnnModelParams
  69. final val queryPartitionsCol: Param[String]

    Permalink

    Param for the column name for the query partitions.

    Param for the column name for the query partitions.

    Definition Classes
    KnnModelParams
  70. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  71. final def set(paramPair: ParamPair[_]): HnswSimilarityModel.this.type

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  76. def setEf(value: Int): HnswSimilarityModel.this.type

    Permalink

  77. def setExcludeSelf(value: Boolean): HnswSimilarityModel.this.type

    Permalink

    Definition Classes
    KnnModelBase
  78. def setFeaturesCol(value: String): HnswSimilarityModel.this.type

    Permalink

    Definition Classes
    KnnModelBase
  79. def setK(value: Int): HnswSimilarityModel.this.type

    Permalink

    Definition Classes
    KnnModelBase
  80. def setNumReplicas(value: Int): HnswSimilarityModel.this.type

    Permalink

    Definition Classes
    KnnModelBase
  81. def setOutputFormat(value: String): HnswSimilarityModel.this.type

    Permalink

    Definition Classes
    KnnModelBase
  82. def setParallelism(value: Int): HnswSimilarityModel.this.type

    Permalink

    Definition Classes
    KnnModelBase
  83. def setParent(parent: Estimator[HnswSimilarityModel]): HnswSimilarityModel

    Permalink
    Definition Classes
    Model
  84. def setPredictionCol(value: String): HnswSimilarityModel.this.type

    Permalink

    Definition Classes
    KnnModelBase
  85. def setQueryIdentifierCol(value: String): HnswSimilarityModel.this.type

    Permalink

    Definition Classes
    KnnModelBase
  86. def setQueryPartitionsCol(value: String): HnswSimilarityModel.this.type

    Permalink

    Definition Classes
    KnnModelBase
  87. def setSimilarityThreshold(value: Double): HnswSimilarityModel.this.type

    Permalink

    Definition Classes
    KnnModelBase
  88. final val similarityThreshold: DoubleParam

    Permalink

    Param for the threshold value for inclusion.

    Param for the threshold value for inclusion. -1 indicates no threshold Default: -1

    Definition Classes
    KnnModelParams
  89. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  91. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  92. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  93. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  94. def validateAndTransformSchema(schema: StructType, identifierDataType: DataType): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    KnnModelParams
  95. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  97. final def wait(): Unit

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

Inherited from MLWritable

Inherited from HnswModelParams

Inherited from KnnModelBase[HnswSimilarityModel]

Inherited from KnnModelParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from Model[HnswSimilarityModel]

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

getParam

param

setParam

Ungrouped