Class/Object

com.johnsnowlabs.nlp.annotators.disambiguation.models

NerDisambiguatorModel

Related Docs: object NerDisambiguatorModel | package models

Permalink

class NerDisambiguatorModel extends AnnotatorModel[NerDisambiguatorModel] with AnnotationLogic with PoolingLogicNd4s with DisambiguatorModelParams with SwitchableEmbeddingsExtractor

Linear Supertypes
SwitchableEmbeddingsExtractor, DisambiguatorModelParams, PoolingLogicNd4s, PoolingLogic, AnnotationLogic, PredictionLogic, EmbeddingsExtractor, Mappings, AnnotatorModel[NerDisambiguatorModel], CanBeLazy, RawAnnotator[NerDisambiguatorModel], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[NerDisambiguatorModel], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NerDisambiguatorModel
  2. SwitchableEmbeddingsExtractor
  3. DisambiguatorModelParams
  4. PoolingLogicNd4s
  5. PoolingLogic
  6. AnnotationLogic
  7. PredictionLogic
  8. EmbeddingsExtractor
  9. Mappings
  10. AnnotatorModel
  11. CanBeLazy
  12. RawAnnotator
  13. HasOutputAnnotationCol
  14. HasInputAnnotationCols
  15. HasOutputAnnotatorType
  16. ParamsAndFeaturesWritable
  17. HasFeatures
  18. DefaultParamsWritable
  19. MLWritable
  20. Model
  21. Transformer
  22. PipelineStage
  23. Logging
  24. Params
  25. Serializable
  26. Serializable
  27. Identifiable
  28. AnyRef
  29. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NerDisambiguatorModel(knowledge: Knowledge, uid: String = "NerDisambiguator")

    Permalink

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  2. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType
  3. type OptionAsSeq[T] = Seq[T]

    Permalink
    Definition Classes
    Mappings
  4. final case class Prediction(chunk: Annotation, score2link: Map[Score, String], score2id: Map[Score, DataId], score2title: Map[Score, String], score2category: Map[Score, String]) extends Product with Serializable

    Permalink
    Definition Classes
    PredictionLogic

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. def $$[T](feature: StructFeature[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. val EmbeddingsRef: String

    Permalink
    Definition Classes
    EmbeddingsExtractor
  10. def _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  11. def afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  12. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink
    Definition Classes
    AnnotationLogic
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  15. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  16. lazy val chunk2idF: (String) ⇒ Option[List[Int]]

    Permalink
    Definition Classes
    NerDisambiguatorModelMappings
  17. final def clear(param: Param[_]): NerDisambiguatorModel.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. def copy(extra: ParamMap): NerDisambiguatorModel

    Permalink
    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  20. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  22. def dfAnnotate: UserDefinedFunction

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  23. def embeddingType: String

    Permalink
  24. val embeddingTypeParam: Param[String]

    Permalink
    Definition Classes
    DisambiguatorModelParams
  25. def enableApproximateMatching: Boolean

    Permalink
    Definition Classes
    NerDisambiguatorModelPredictionLogic
  26. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  28. def explainParam(param: Param[_]): String

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

    Permalink
    Definition Classes
    Params
  30. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  31. def extraValidateMsg: String

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  32. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  34. val features: ArrayBuffer[Feature[_, _, _]]

    Permalink
    Definition Classes
    HasFeatures
  35. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  37. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  38. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  39. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  40. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  41. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  42. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  43. def getEmbeddingType: String

    Permalink
    Definition Classes
    DisambiguatorModelParams
  44. def getInputCols: Array[String]

    Permalink
    Definition Classes
    HasInputAnnotationCols
  45. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  46. def getLevenshteinDistanceThresholdParam: Double

    Permalink
    Definition Classes
    DisambiguatorModelParams
  47. def getNarrowWithApproximateMatching: Boolean

    Permalink
    Definition Classes
    DisambiguatorModelParams
  48. def getNearMatchingGapParam: Int

    Permalink
    Definition Classes
    DisambiguatorModelParams
  49. def getNumFirstChars: Int

    Permalink
    Definition Classes
    DisambiguatorModelParams
  50. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  51. final def getOutputCol: String

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  52. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  53. def getPredictionLimit: Int

    Permalink
    Definition Classes
    DisambiguatorModelParams
  54. def getSentenceEmbedding(annotations: Seq[Annotation]): SentenceEmbeddingWithType

    Permalink
  55. def getTokenSearch: Boolean

    Permalink
    Definition Classes
    DisambiguatorModelParams
  56. final def hasDefault[T](param: Param[T]): Boolean

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

    Permalink
    Definition Classes
    Params
  58. def hasParent: Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  60. lazy val id2categoryF: (Int) ⇒ OptionAsSeq[String]

    Permalink
    Definition Classes
    NerDisambiguatorModelMappings
  61. lazy val id2embF: (Int) ⇒ OptionAsSeq[Array[Double]]

    Permalink
    Definition Classes
    NerDisambiguatorModelMappings
  62. lazy val id2linkF: (Int) ⇒ OptionAsSeq[String]

    Permalink
    Definition Classes
    NerDisambiguatorModelMappings
  63. lazy val id2titleF: (Int) ⇒ OptionAsSeq[String]

    Permalink
    Definition Classes
    NerDisambiguatorModelMappings
  64. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. val inputAnnotatorTypes: Array[String]

    Permalink
    Definition Classes
    NerDisambiguatorModel → HasInputAnnotationCols
  67. final val inputCols: StringArrayParam

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  72. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  73. def levenshteinDistanceThreshold: Double

    Permalink
    Definition Classes
    NerDisambiguatorModelPredictionLogic
  74. val levenshteinDistanceThresholdParam: DoubleParam

    Permalink
    Definition Classes
    DisambiguatorModelParams
  75. def limit: Int

    Permalink
    Definition Classes
    NerDisambiguatorModelPredictionLogic
  76. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  88. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  89. val narrowWithApproximateMatching: BooleanParam

    Permalink
    Definition Classes
    DisambiguatorModelParams
  90. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  91. def nearMatchingGap: Int

    Permalink
    Definition Classes
    NerDisambiguatorModelPredictionLogic
  92. val nearMatchingGapParam: IntParam

    Permalink
    Definition Classes
    DisambiguatorModelParams
  93. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  95. val numFirstChars: IntParam

    Permalink
    Definition Classes
    DisambiguatorModelParams
  96. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  97. val outputAnnotatorType: AnnotatorType

    Permalink
    Definition Classes
    NerDisambiguatorModelAnnotationLogic → HasOutputAnnotatorType
  98. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  99. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  100. var parent: Estimator[NerDisambiguatorModel]

    Permalink
    Definition Classes
    Model
  101. def poolEmbeddings(embeddings: Array[Array[Float]]): Array[Double]

    Permalink
    Definition Classes
    PoolingLogicNd4sPoolingLogic
  102. def predictByChunk(annotations: Seq[Annotation], numFirstChars: Int): Seq[Prediction]

    Permalink
    Definition Classes
    PredictionLogic
  103. val predictionsLimit: IntParam

    Permalink
    Definition Classes
    DisambiguatorModelParams
  104. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  105. def searchByToken: Boolean

    Permalink
    Definition Classes
    NerDisambiguatorModelPredictionLogic
  106. def set[T](feature: StructFeature[T], value: T): NerDisambiguatorModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  107. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): NerDisambiguatorModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  108. def set[T](feature: SetFeature[T], value: Set[T]): NerDisambiguatorModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  109. def set[T](feature: ArrayFeature[T], value: Array[T]): NerDisambiguatorModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  110. final def set(paramPair: ParamPair[_]): NerDisambiguatorModel.this.type

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

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

    Permalink
    Definition Classes
    Params
  113. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NerDisambiguatorModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  114. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): NerDisambiguatorModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  115. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): NerDisambiguatorModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  116. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): NerDisambiguatorModel.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  117. final def setDefault(paramPairs: ParamPair[_]*): NerDisambiguatorModel.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  119. def setEmbeddingType(v: String): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    DisambiguatorModelParams
  120. final def setInputCols(value: String*): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  121. final def setInputCols(value: Array[String]): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  122. def setLazyAnnotator(value: Boolean): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    CanBeLazy
  123. def setLevenshteinDistanceThresholdParam(v: Double): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    DisambiguatorModelParams
  124. def setNarrowWithApproximateMatching(v: Boolean): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    DisambiguatorModelParams
  125. def setNearMatchingGapParam(v: Int): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    DisambiguatorModelParams
  126. def setNumFirstChars(v: Int): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    DisambiguatorModelParams
  127. final def setOutputCol(value: String): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  128. def setParent(parent: Estimator[NerDisambiguatorModel]): NerDisambiguatorModel

    Permalink
    Definition Classes
    Model
  129. def setPredictionLimit(v: Int): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    DisambiguatorModelParams
  130. def setTokenSearch(v: Boolean): NerDisambiguatorModel.this.type

    Permalink
    Definition Classes
    DisambiguatorModelParams
  131. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  133. val tokenSearch: BooleanParam

    Permalink
    Definition Classes
    DisambiguatorModelParams
  134. final def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    AnnotatorModel → Transformer
  135. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  137. final def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    RawAnnotator → PipelineStage
  138. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  139. val uid: String

    Permalink
    Definition Classes
    NerDisambiguatorModel → Identifiable
  140. def validate(schema: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  141. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  144. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  145. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from DisambiguatorModelParams

Inherited from PoolingLogicNd4s

Inherited from PoolingLogic

Inherited from AnnotationLogic

Inherited from PredictionLogic

Inherited from EmbeddingsExtractor

Inherited from Mappings

Inherited from AnnotatorModel[NerDisambiguatorModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[NerDisambiguatorModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[NerDisambiguatorModel]

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