class DocumentSimilarityRankerApproach extends AnnotatorApproach[DocumentSimilarityRankerModel] with HasEnableCachingProperties

Linear Supertypes
HasEnableCachingProperties, ParamsAndFeaturesWritable, HasFeatures, AnnotatorApproach[DocumentSimilarityRankerModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[DocumentSimilarityRankerModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DocumentSimilarityRankerApproach
  2. HasEnableCachingProperties
  3. ParamsAndFeaturesWritable
  4. HasFeatures
  5. AnnotatorApproach
  6. CanBeLazy
  7. DefaultParamsWritable
  8. MLWritable
  9. HasOutputAnnotatorType
  10. HasOutputAnnotationCol
  11. HasInputAnnotationCols
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentSimilarityRankerApproach()

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

  2. new DocumentSimilarityRankerApproach(uid: String)

Type Members

  1. type AnnotatorType = String
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. val DISTANCE: String
  10. val INDEX_COL_NAME: String
  11. val INPUT_EMBEDDINGS: String
  12. val LSH_INPUT_COL_NAME: String
  13. val LSH_OUTPUT_COL_NAME: String
  14. val TEXT: String
  15. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): DocumentSimilarityRankerModel
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def beforeTraining(spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  18. val bucketLength: Param[Double]
  19. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  20. final def clear(param: Param[_]): DocumentSimilarityRankerApproach.this.type
    Definition Classes
    Params
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. final def copy(extra: ParamMap): Estimator[DocumentSimilarityRankerModel]
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  23. def copyValues[T <: Params](to: T, extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  24. final def defaultCopy[T <: Params](extra: ParamMap): T
    Attributes
    protected
    Definition Classes
    Params
  25. val description: AnnotatorType
    Definition Classes
    DocumentSimilarityRankerApproach → AnnotatorApproach
  26. val enableCaching: BooleanParam

    Whether to enable caching DataFrames or RDDs during the training

    Whether to enable caching DataFrames or RDDs during the training

    Definition Classes
    HasEnableCachingProperties
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. def explainParam(param: Param[_]): String
    Definition Classes
    Params
  30. def explainParams(): String
    Definition Classes
    Params
  31. final def extractParamMap(): ParamMap
    Definition Classes
    Params
  32. final def extractParamMap(extra: ParamMap): ParamMap
    Definition Classes
    Params
  33. val features: ArrayBuffer[Feature[_, _, _]]
    Definition Classes
    HasFeatures
  34. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. final def fit(dataset: Dataset[_]): DocumentSimilarityRankerModel
    Definition Classes
    AnnotatorApproach → Estimator
  36. def fit(dataset: Dataset[_], paramMaps: Seq[ParamMap]): Seq[DocumentSimilarityRankerModel]
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  37. def fit(dataset: Dataset[_], paramMap: ParamMap): DocumentSimilarityRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  38. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DocumentSimilarityRankerModel
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  39. def get[T](feature: StructFeature[T]): Option[T]
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  41. def get[T](feature: SetFeature[T]): Option[Set[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  42. def get[T](feature: ArrayFeature[T]): Option[Array[T]]
    Attributes
    protected
    Definition Classes
    HasFeatures
  43. final def get[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  44. def getBucketLength: Double
  45. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  46. final def getDefault[T](param: Param[T]): Option[T]
    Definition Classes
    Params
  47. def getEnableCaching: Boolean

    Definition Classes
    HasEnableCachingProperties
  48. def getIdentityRanking: Boolean
  49. def getInputCols: Array[String]

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  50. def getLazyAnnotator: Boolean
    Definition Classes
    CanBeLazy
  51. def getNeighborsResultSet(query: (Int, Vector), similarityDataset: DataFrame): NeighborsResultSet
  52. def getNumberOfNeighbours: Int
  53. final def getOrDefault[T](param: Param[T]): T
    Definition Classes
    Params
  54. final def getOutputCol: String

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  55. def getParam(paramName: String): Param[Any]
    Definition Classes
    Params
  56. def getSimilarityMethod: String
  57. def getVisibleDistances: Boolean
  58. final def hasDefault[T](param: Param[T]): Boolean
    Definition Classes
    Params
  59. def hasParam(paramName: String): Boolean
    Definition Classes
    Params
  60. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  61. val identityRanking: BooleanParam
  62. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  63. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. val inputAnnotatorTypes: Array[AnnotatorType]

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

    Definition Classes
    DocumentSimilarityRankerApproach → HasInputAnnotationCols
  65. final val inputCols: StringArrayParam

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  66. final def isDefined(param: Param[_]): Boolean
    Definition Classes
    Params
  67. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  68. final def isSet(param: Param[_]): Boolean
    Definition Classes
    Params
  69. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  70. val lazyAnnotator: BooleanParam
    Definition Classes
    CanBeLazy
  71. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  72. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  73. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  74. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  75. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  77. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  79. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  80. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  81. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  82. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  83. def msgHelper(schema: StructType): String
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  84. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  85. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  86. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  87. val numHashTables: Param[Int]
  88. val numberOfNeighbours: Param[Int]

    The number of neighbours the model will return (Default:"10").

  89. def onTrained(model: DocumentSimilarityRankerModel, spark: SparkSession): Unit
    Definition Classes
    AnnotatorApproach
  90. def onWrite(path: String, spark: SparkSession): Unit
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  91. val optionalInputAnnotatorTypes: Array[String]
    Definition Classes
    HasInputAnnotationCols
  92. val outputAnnotatorType: AnnotatorType
    Definition Classes
    DocumentSimilarityRankerApproach → HasOutputAnnotatorType
  93. final val outputCol: Param[String]
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  94. lazy val params: Array[Param[_]]
    Definition Classes
    Params
  95. def save(path: String): Unit
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  96. def set[T](feature: StructFeature[T], value: T): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  97. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  98. def set[T](feature: SetFeature[T], value: Set[T]): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  99. def set[T](feature: ArrayFeature[T], value: Array[T]): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  100. final def set(paramPair: ParamPair[_]): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  101. final def set(param: String, value: Any): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  102. final def set[T](param: Param[T], value: T): DocumentSimilarityRankerApproach.this.type
    Definition Classes
    Params
  103. def setBucketLength(value: Double): DocumentSimilarityRankerApproach.this.type
  104. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  105. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  106. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  107. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    HasFeatures
  108. final def setDefault(paramPairs: ParamPair[_]*): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected
    Definition Classes
    Params
  109. final def setDefault[T](param: Param[T], value: T): DocumentSimilarityRankerApproach.this.type
    Attributes
    protected[org.apache.spark.ml]
    Definition Classes
    Params
  110. def setEnableCaching(value: Boolean): DocumentSimilarityRankerApproach.this.type

    Definition Classes
    HasEnableCachingProperties
  111. def setIdentityRanking(value: Boolean): DocumentSimilarityRankerApproach.this.type
  112. final def setInputCols(value: String*): DocumentSimilarityRankerApproach.this.type
    Definition Classes
    HasInputAnnotationCols
  113. def setInputCols(value: Array[String]): DocumentSimilarityRankerApproach.this.type

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  114. def setLazyAnnotator(value: Boolean): DocumentSimilarityRankerApproach.this.type
    Definition Classes
    CanBeLazy
  115. def setNumHashTables(value: Int): DocumentSimilarityRankerApproach.this.type
  116. def setNumberOfNeighbours(value: Int): DocumentSimilarityRankerApproach.this.type
  117. final def setOutputCol(value: String): DocumentSimilarityRankerApproach.this.type

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  118. def setSimilarityMethod(value: String): DocumentSimilarityRankerApproach.this.type
  119. def setVisibleDistances(value: Boolean): DocumentSimilarityRankerApproach.this.type
  120. val similarityMethod: Param[String]

    The similarity method used to calculate the neighbours.

    The similarity method used to calculate the neighbours. (Default: "brp", Bucketed Random Projection for Euclidean Distance)

  121. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  122. def toString(): String
    Definition Classes
    Identifiable → AnyRef → Any
  123. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DocumentSimilarityRankerModel
    Definition Classes
    DocumentSimilarityRankerApproach → AnnotatorApproach
  124. final def transformSchema(schema: StructType): StructType

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    AnnotatorApproach → PipelineStage
  125. def transformSchema(schema: StructType, logging: Boolean): StructType
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  126. val uid: String
    Definition Classes
    DocumentSimilarityRankerApproach → Identifiable
  127. def validate(schema: StructType): Boolean

    takes a Dataset and checks to see if all the required annotation types are present.

    takes a Dataset and checks to see if all the required annotation types are present.

    schema

    to be validated

    returns

    True if all the required types are present, else false

    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  128. val visibleDistances: BooleanParam
  129. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  132. def write: MLWriter
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from HasEnableCachingProperties

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from AnnotatorApproach[DocumentSimilarityRankerModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[DocumentSimilarityRankerModel]

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