Class/Object

com.johnsnowlabs.nlp.annotators.ner

NerChunker

Related Docs: object NerChunker | package ner

Permalink

class NerChunker extends AnnotatorModel[NerChunker]

Linear Supertypes
AnnotatorModel[NerChunker], CanBeLazy, RawAnnotator[NerChunker], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[NerChunker], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NerChunker
  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 NerChunker()

    Permalink
  2. new NerChunker(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 addRegexParser(value: String): NerChunker

    Permalink

    adds a pattern to the current list of chunk patterns, for example: “‹DT›?‹JJ›*‹NN›”

  11. def afterAnnotate(dataset: DataFrame): DataFrame

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

    Permalink
    Definition Classes
    NerChunker → AnnotatorModel
  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. final def clear(param: Param[_]): NerChunker.this.type

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorModel
  22. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  39. def getInputCols: Array[String]

    Permalink
    Definition Classes
    HasInputAnnotationCols
  40. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  41. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  42. final def getOutputCol: String

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

    Permalink
    Definition Classes
    Params
  44. def getRegexParsers: Array[String]

    Permalink

    A list of regex patterns to match chunks, for example: Array(“‹DT›?‹JJ›*‹NN›”)

  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. def hashCode(): Int

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. val inputAnnotatorTypes: Array[AnnotatorType]

    Permalink

    Input annotator type : DOCUMENT, POS

    Input annotator type : DOCUMENT, POS

    Definition Classes
    NerChunker → HasInputAnnotationCols
  52. final val inputCols: StringArrayParam

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

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

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

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

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

    Permalink
    Definition Classes
    CanBeLazy
  58. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  74. def onWrite(path: String, spark: SparkSession): Unit

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

    Permalink

    Output annotator type : CHUNK

    Output annotator type : CHUNK

    Definition Classes
    NerChunker → HasOutputAnnotatorType
  76. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  78. var parent: Estimator[NerChunker]

    Permalink
    Definition Classes
    Model
  79. val regexParsers: StringArrayParam

    Permalink

    an array of grammar based chunk parsers

  80. def save(path: String): Unit

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  94. final def setInputCols(value: String*): NerChunker.this.type

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

    Permalink
    Definition Classes
    HasInputAnnotationCols
  96. def setLazyAnnotator(value: Boolean): NerChunker.this.type

    Permalink
    Definition Classes
    CanBeLazy
  97. final def setOutputCol(value: String): NerChunker.this.type

    Permalink
    Definition Classes
    HasOutputAnnotationCol
  98. def setParent(parent: Estimator[NerChunker]): NerChunker

    Permalink
    Definition Classes
    Model
  99. def setRegexParsers(value: Array[String]): NerChunker

    Permalink

    A list of regex patterns to match chunks, for example: Array(“‹DT›?‹JJ›*‹NN›”)

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

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

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  102. final def transform(dataset: Dataset[_]): DataFrame

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

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

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

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

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

    Permalink
    Definition Classes
    NerChunker → Identifiable
  108. def validate(schema: StructType): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from AnnotatorModel[NerChunker]

Inherited from CanBeLazy

Inherited from RawAnnotator[NerChunker]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[NerChunker]

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

anno

getParam

param

setParam

Ungrouped