Class/Object

com.johnsnowlabs.nlp.annotators.ner.dl

NerDLModel

Related Docs: object NerDLModel | package dl

Permalink

class NerDLModel extends AnnotatorModel[NerDLModel] with WriteTensorflowModel with HasStorageRef with ParamsAndFeaturesWritable

This Named Entity recognition annotator allows to train generic NER model based on Neural Networks. Its train data (train_ner) is either a labeled or an external CoNLL 2003 IOB based spark dataset with Annotations columns. Also the user has to provide word embeddings annotation column. Neural Network architecture is Char CNNs - BiLSTM - CRF that achieves state-of-the-art in most datasets.

See https://github.com/JohnSnowLabs/spark-nlp/tree/master/src/test/scala/com/johnsnowlabs/nlp/annotators/ner/dl for further reference on how to use this API.

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

Instance Constructors

  1. new NerDLModel()

    Permalink
  2. new NerDLModel(uid: String)

    Permalink

Type Members

  1. type AnnotationContent = Seq[Row]

    Permalink

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    internal types to show Rows as a relevant StructType Should be deleted once Spark releases UserDefinedTypes to @developerAPI

    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

    takes a document and annotations and produces new annotations of this annotator's annotation type

    takes a document and annotations and produces new annotations of this annotator's annotation type

    annotations

    Annotations that correspond to inputAnnotationCols generated by previous annotators if any

    returns

    any number of annotations processed for every input annotation. Not necessary one to one relationship

    Definition Classes
    NerDLModelAnnotatorModel
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. val batchSize: IntParam

    Permalink

    Size of every batch.

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. val configProtoBytes: IntArrayParam

    Permalink

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

  19. def copy(extra: ParamMap): NerDLModel

    Permalink

    requirement for annotators copies

    requirement for annotators copies

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  21. def createDatabaseConnection(database: Name): RocksDBConnection

    Permalink
    Definition Classes
    HasStorageRef
  22. val datasetParams: StructFeature[DatasetEncoderParams]

    Permalink

    datasetParams

  23. final def defaultCopy[T <: Params](extra: ParamMap): T

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

    Permalink

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    Wraps annotate to happen inside SparkSQL user defined functions in order to act with org.apache.spark.sql.Column

    returns

    udf function to be applied to inputCols using this annotator's annotate function as part of ML transformation

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

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

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

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

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

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

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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 getBatchSize: Int

    Permalink

    Size of every batch.

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

    Permalink
    Definition Classes
    AnyRef → Any
  42. def getConfigProtoBytes: Option[Array[Byte]]

    Permalink

    datasetParams

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

    Permalink
    Definition Classes
    Params
  44. def getIncludeConfidence: Boolean

    Permalink

    whether to include confidence scores in annotation metadata

  45. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  46. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  47. def getMinProba: Float

    Permalink

    Minimum probability.

    Minimum probability. Used only if there is no CRF on top of LSTM layer.

  48. def getModelIfNotSet: TensorflowNer

    Permalink

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

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

    Permalink
    Definition Classes
    Params
  50. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

    Permalink
    Definition Classes
    Params
  52. def getStorageRef: String

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

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

    Permalink
    Definition Classes
    Params
  55. def hasParent: Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  57. val includeConfidence: BooleanParam

    Permalink

    whether to include confidence scores in annotation metadata

  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

    Required input Annotators coulumns, expects DOCUMENT, TOKEN, WORD_EMBEDDINGS

    Required input Annotators coulumns, expects DOCUMENT, TOKEN, WORD_EMBEDDINGS

    Definition Classes
    NerDLModelHasInputAnnotationCols
  61. final val inputCols: StringArrayParam

    Permalink

    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
  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 lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  67. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  79. val minProba: FloatParam

    Permalink

    Minimum probability.

    Minimum probability. Used only if there is no CRF on top of LSTM layer.

  80. def msgHelper(schema: StructType): String

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

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

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

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

    Permalink
    Definition Classes
    NerDLModelParamsAndFeaturesWritable
  85. val outputAnnotatorType: String

    Permalink

    Output Annnotator type : NAMED_ENTITY

    Output Annnotator type : NAMED_ENTITY

    Definition Classes
    NerDLModelHasOutputAnnotatorType
  86. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  88. var parent: Estimator[NerDLModel]

    Permalink
    Definition Classes
    Model
  89. def save(path: String): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  97. def setBatchSize(size: Int): NerDLModel

    Permalink

    Size of every batch.

  98. def setConfigProtoBytes(bytes: Array[Int]): NerDLModel

    Permalink

    ConfigProto from tensorflow, serialized into byte array.

    ConfigProto from tensorflow, serialized into byte array. Get with config_proto.SerializeToString()

  99. def setDatasetParams(params: DatasetEncoderParams): NerDLModel

    Permalink

    datasetParams

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  106. def setIncludeConfidence(value: Boolean): NerDLModel

    Permalink

    whether to include confidence scores in annotation metadata

  107. final def setInputCols(value: String*): NerDLModel.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  109. def setLazyAnnotator(value: Boolean): NerDLModel.this.type

    Permalink
    Definition Classes
    CanBeLazy
  110. def setMinProbability(minProba: Float): NerDLModel

    Permalink

    Minimum probability.

    Minimum probability. Used only if there is no CRF on top of LSTM layer.

  111. def setModelIfNotSet(spark: SparkSession, tf: TensorflowWrapper): NerDLModel.this.type

    Permalink
  112. final def setOutputCol(value: String): NerDLModel.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  113. def setParent(parent: Estimator[NerDLModel]): NerDLModel

    Permalink
    Definition Classes
    Model
  114. def setStorageRef(value: String): NerDLModel.this.type

    Permalink
    Definition Classes
    HasStorageRef
  115. val storageRef: Param[String]

    Permalink
    Definition Classes
    HasStorageRef
  116. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  117. def tag(tokenized: Array[WordpieceEmbeddingsSentence]): Array[NerTaggedSentence]

    Permalink
  118. def toString(): String

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

    Permalink

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    Given requirements are met, this applies ML transformation within a Pipeline or stand-alone Output annotation will be generated as a new column, previous annotations are still available separately metadata is built at schema level to record annotations structural information outside its content

    dataset

    Dataset[Row]

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

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

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

    Permalink

    requirement for pipeline transformation validation.

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

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

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

    Permalink
    Definition Classes
    NerDLModel → Identifiable
  125. def validate(schema: StructType): Boolean

    Permalink

    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
    RawAnnotator
  126. def validateStorageRef(dataset: Dataset[_], inputCols: Array[String], annotatorType: String): Unit

    Permalink
    Definition Classes
    HasStorageRef
  127. final def wait(): Unit

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable
  132. def writeTensorflowHub(path: String, tfPath: String, spark: SparkSession, suffix: String = "_use"): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel
  133. def writeTensorflowModel(path: String, spark: SparkSession, tensorflow: TensorflowWrapper, suffix: String, filename: String, configProtoBytes: Option[Array[Byte]] = None): Unit

    Permalink
    Definition Classes
    WriteTensorflowModel

Inherited from HasStorageRef

Inherited from WriteTensorflowModel

Inherited from AnnotatorModel[NerDLModel]

Inherited from CanBeLazy

Inherited from RawAnnotator[NerDLModel]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[NerDLModel]

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