Class

com.johnsnowlabs.nlp.annotators.resolution

SentenceEntityResolverApproach

Related Doc: package resolution

Permalink

class SentenceEntityResolverApproach extends AnnotatorApproach[SentenceEntityResolverModel] with SentenceResolverParams with HasCaseSensitiveProperties with Licensed

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

Instance Constructors

  1. new SentenceEntityResolverApproach()

    Permalink
  2. new SentenceEntityResolverApproach(uid: String)

    Permalink

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

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. def _fit(dataset: Dataset[_], recursiveStages: Option[PipelineModel]): SentenceEntityResolverModel

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  12. val caseSensitive: BooleanParam

    Permalink
    Definition Classes
    HasCaseSensitiveProperties
  13. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  14. final def clear(param: Param[_]): SentenceEntityResolverApproach.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. val confidenceFunction: Param[String]

    Permalink
    Definition Classes
    SentenceResolverParams
  17. final def copy(extra: ParamMap): Estimator[SentenceEntityResolverModel]

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  18. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  20. val description: String

    Permalink
    Definition Classes
    SentenceEntityResolverApproach → AnnotatorApproach
  21. val distanceFunction: Param[String]

    Permalink

    what distance function to use for KNN: 'EUCLIDEAN' or 'COSINE'

    what distance function to use for KNN: 'EUCLIDEAN' or 'COSINE'

    Definition Classes
    SentenceResolverParams
  22. lazy val embeddingsColumnName: String

    Permalink
  23. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. final def fit(dataset: Dataset[_]): SentenceEntityResolverModel

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator
  32. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[SentenceEntityResolverModel]

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  33. def fit(dataset: Dataset[_], paramMap: ParamMap): SentenceEntityResolverModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  34. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): SentenceEntityResolverModel

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  35. def get[T](feature: StructFeature[T]): Option[T]

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

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

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

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

    Permalink
    Definition Classes
    Params
  40. def getCaseSensitive: Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  42. def getConfidenceFunction: String

    Permalink
    Definition Classes
    SentenceResolverParams
  43. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  44. def getDistanceFunction: String

    Permalink
    Definition Classes
    SentenceResolverParams
  45. def getInputCols: Array[String]

    Permalink
    Definition Classes
    HasInputAnnotationCols
  46. def getLabelCol: String

    Permalink
  47. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  48. def getMissAsEmpty: Boolean

    Permalink
    Definition Classes
    SentenceResolverParams
  49. def getNeighbours: Int

    Permalink
    Definition Classes
    SentenceResolverParams
  50. def getNormalizedCol: String

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

    Permalink
    Definition Classes
    Params
  52. final def getOutputCol: String

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

    Permalink
    Definition Classes
    Params
  54. def getThreshold: Double

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

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

    Permalink
    Definition Classes
    Params
  57. def hashCode(): Int

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

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

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

    Permalink
    Definition Classes
    SentenceEntityResolverApproach → HasInputAnnotationCols
  61. final val inputCols: StringArrayParam

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. val labelCol: Param[String]

    Permalink

    column name for the value we are trying to resolve

  67. lazy val labelColumnName: String

    Permalink
  68. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  69. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  81. val missAsEmpty: BooleanParam

    Permalink

    whether or not to return an empty annotation on unmatched chunks

    whether or not to return an empty annotation on unmatched chunks

    Definition Classes
    SentenceResolverParams
  82. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  83. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  84. val neighbours: IntParam

    Permalink

    number of neighbours to consider in the KNN query to calculate WMD

    number of neighbours to consider in the KNN query to calculate WMD

    Definition Classes
    SentenceResolverParams
  85. val normalizedCol: Param[String]

    Permalink

    column name for the original, normalized description

  86. lazy val normalizedColumnName: String

    Permalink
  87. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  89. def onTrained(model: SentenceEntityResolverModel, spark: SparkSession): Unit

    Permalink
    Definition Classes
    AnnotatorApproach
  90. def onWrite(path: String, spark: SparkSession): Unit

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

    Permalink
    Definition Classes
    SentenceEntityResolverApproach → HasOutputAnnotatorType
  92. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  94. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  95. def set[T](feature: StructFeature[T], value: T): SentenceEntityResolverApproach.this.type

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  102. def setCaseSensitive(value: Boolean): SentenceEntityResolverApproach.this.type

    Permalink
    Definition Classes
    HasCaseSensitiveProperties
  103. def setConfidenceFunction(v: String): SentenceEntityResolverApproach.this.type

    Permalink
    Definition Classes
    SentenceResolverParams
  104. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): SentenceEntityResolverApproach.this.type

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  110. def setDistanceFunction(value: String): SentenceEntityResolverApproach.this.type

    Permalink
    Definition Classes
    SentenceResolverParams
  111. final def setInputCols(value: String*): SentenceEntityResolverApproach.this.type

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  113. def setLabelCol(value: String): SentenceEntityResolverApproach.this.type

    Permalink
  114. def setLazyAnnotator(value: Boolean): SentenceEntityResolverApproach.this.type

    Permalink
    Definition Classes
    CanBeLazy
  115. def setMissAsEmpty(v: Boolean): SentenceEntityResolverApproach.this.type

    Permalink
    Definition Classes
    SentenceResolverParams
  116. def setNeighbours(k: Int): SentenceEntityResolverApproach.this.type

    Permalink
    Definition Classes
    SentenceResolverParams
  117. def setNormalizedCol(value: String): SentenceEntityResolverApproach.this.type

    Permalink
  118. final def setOutputCol(value: String): SentenceEntityResolverApproach.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  119. def setThreshold(dist: Double): SentenceEntityResolverApproach.this.type

    Permalink
    Definition Classes
    SentenceResolverParams
  120. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  121. val threshold: DoubleParam

    Permalink

    threshold value for the aggregated distance

    threshold value for the aggregated distance

    Definition Classes
    SentenceResolverParams
  122. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  123. def train(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): SentenceEntityResolverModel

    Permalink

    Returns the ChunkEntityResolverModel Transformer, that can be used to transform input datasets

    Returns the ChunkEntityResolverModel Transformer, that can be used to transform input datasets

    The dataset provided to the fit method should have one chunk per row and contain the following columns: ChunkTokens, ChunkEmbeddings, ResolverLabel, [ResolverNormalized]

    The cardinality of the dataset should not exceed 100.000 data points since searching in such a big KD-tree becomes impractical

    This method is called inside the AnnotatorApproach's fit method

    dataset

    a Dataset containing ChunkTokens, ChunkEmbeddings, ClassifierLabel, ResolverLabel, [ResolverNormalized]

    returns

    a trained ChunkEntityResolverModel

    Definition Classes
    SentenceEntityResolverApproach → AnnotatorApproach
  124. final def transformSchema(schema: StructType): StructType

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

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

    Permalink
    Definition Classes
    SentenceEntityResolverApproach → Identifiable
  127. def validate(schema: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  128. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from Licensed

Inherited from HasCaseSensitiveProperties

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from SentenceResolverParams

Inherited from AnnotatorApproach[SentenceEntityResolverModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[SentenceEntityResolverModel]

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