Class/Object

com.johnsnowlabs.nlp.annotators.ner

NerConverterInternal

Related Docs: object NerConverterInternal | package ner

Permalink

class NerConverterInternal extends AnnotatorModel[NerConverterInternal]

Converts IOB or IOB2 representation of NER to user-friendly. See https://en.wikipedia.org/wiki/Inside%E2%80%93outside%E2%80%93beginning_(tagging)

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

Instance Constructors

  1. new NerConverterInternal()

    Permalink

  2. new NerConverterInternal(uid: String)

    Permalink

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel

  2. 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 _transform(dataset: Dataset[_], recursivePipeline: Option[PipelineModel]): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel

  10. def afterAnnotate(dataset: DataFrame): DataFrame

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel

  11. def annotate(annotations: Seq[Annotation]): Seq[Annotation]

    Permalink
    Definition Classes
    NerConverterInternal → AnnotatorModel

  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  13. def beforeAnnotate(dataset: Dataset[_]): Dataset[_]

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel

  14. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols

  15. final def clear(param: Param[_]): NerConverterInternal.this.type

    Permalink
    Definition Classes
    Params

  16. def clone(): AnyRef

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

  17. def copy(extra: ParamMap): NerConverterInternal

    Permalink
    Definition Classes
    RawAnnotator → Model → Transformer → 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. def dfAnnotate: UserDefinedFunction

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel

  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Params

  24. def explainParams(): String

    Permalink
    Definition Classes
    Params

  25. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator

  26. def extraValidateMsg: String

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator

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

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  32. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  33. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  34. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

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

    Permalink
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Params

  38. def getInputCols: Array[String]

    Permalink
    Definition Classes
    HasInputAnnotationCols

  39. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy

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

    Permalink
    Definition Classes
    Params

  41. final def getOutputCol: String

    Permalink
    Definition Classes
    HasOutputAnnotationCol

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

    Permalink
    Definition Classes
    Params

  43. def getThreshold: Float

    Permalink

    Get the Confidence threshold

  44. val greedyMode: BooleanParam

    Permalink

    Whether to ignore B tags for contiguous tokens of same entity same

  45. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params

  46. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params

  47. def hasParent: Boolean

    Permalink
    Definition Classes
    Model

  48. lazy val hasThreshold: Boolean

    Permalink

  49. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  50. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  51. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  52. val inputAnnotatorTypes: Array[String]

    Permalink

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

    Input Annotator Type : DOCUMENT, TOKEN, NAMED_ENTITY

    Definition Classes
    NerConverterInternal → HasInputAnnotationCols

  53. final val inputCols: StringArrayParam

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols

  54. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params

  55. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    Params

  57. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  58. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy

  59. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  60. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  61. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  62. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  63. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  64. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  65. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  66. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  67. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  68. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  69. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  70. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  71. def msgHelper(schema: StructType): String

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols

  72. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  73. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  74. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  75. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable

  76. val outputAnnotatorType: AnnotatorType

    Permalink

    Output Annotator Type : CHUNK

    Output Annotator Type : CHUNK

    Definition Classes
    NerConverterInternal → HasOutputAnnotatorType

  77. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol

  78. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params

  79. var parent: Estimator[NerConverterInternal]

    Permalink
    Definition Classes
    Model

  80. val preservePosition: BooleanParam

    Permalink

    Whether to preserve the original position of the tokens in the original document or use the modified tokens

  81. def save(path: String): Unit

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

  82. def set[T](feature: StructFeature[T], value: T): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  83. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  84. def set[T](feature: SetFeature[T], value: Set[T]): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  85. def set[T](feature: ArrayFeature[T], value: Array[T]): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  86. final def set(paramPair: ParamPair[_]): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  87. final def set(param: String, value: Any): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Definition Classes
    Params

  89. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  90. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  91. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  92. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures

  93. final def setDefault(paramPairs: ParamPair[_]*): NerConverterInternal.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params

  95. def setGreedyMode(value: Boolean): NerConverterInternal.this.type

    Permalink

    Whether to ignore B tags for contiguous tokens of same entity same

  96. final def setInputCols(value: String*): NerConverterInternal.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols

  97. final def setInputCols(value: Array[String]): NerConverterInternal.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols

  98. def setLazyAnnotator(value: Boolean): NerConverterInternal.this.type

    Permalink
    Definition Classes
    CanBeLazy

  99. final def setOutputCol(value: String): NerConverterInternal.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol

  100. def setParent(parent: Estimator[NerConverterInternal]): NerConverterInternal

    Permalink
    Definition Classes
    Model

  101. def setPreservePosition(value: Boolean): NerConverterInternal.this.type

    Permalink

    Whether to preserve the original position of the tokens in the original document or use the modified tokens

  102. def setThreshold(value: Float): NerConverterInternal.this.type

    Permalink

    Set the Confidence threshold

  103. def setWhiteList(list: String*): NerConverterInternal.this.type

    Permalink

    If defined, list of entities to process.

    If defined, list of entities to process. The rest will be ignored. Do not include IOB prefix on labels

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

    Permalink
    Definition Classes
    AnyRef

  105. val threshold: FloatParam

    Permalink

    Confidence threshold

  106. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any

  107. final def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    AnnotatorModel → Transformer

  108. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

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

  109. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()

  110. final def transformSchema(schema: StructType): StructType

    Permalink
    Definition Classes
    RawAnnotator → PipelineStage

  111. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()

  112. val uid: String

    Permalink
    Definition Classes
    NerConverterInternal → Identifiable

  113. def validate(schema: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator

  114. final def wait(): Unit

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

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

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

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

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

  117. val whiteList: StringArrayParam

    Permalink

    If defined, list of entities to process.

    If defined, list of entities to process. The rest will be ignored. Do not include IOB prefix on labels

  118. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator

  119. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from AnnotatorModel[NerConverterInternal]

Inherited from CanBeLazy

Inherited from RawAnnotator[NerConverterInternal]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[NerConverterInternal]

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

Parameters

Annotator types

Required input and expected output annotator types

Members

Parameter setters