Class/Object

com.johnsnowlabs.nlp.annotators.ner.dl

NerDLApproach

Related Docs: object NerDLApproach | package dl

Permalink

class NerDLApproach extends AnnotatorApproach[NerDLModel] with NerApproach[NerDLApproach] with Logging 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
ParamsAndFeaturesWritable, HasFeatures, Logging, NerApproach[NerDLApproach], AnnotatorApproach[NerDLModel], CanBeLazy, DefaultParamsWritable, MLWritable, HasOutputAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[NerDLModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. NerDLApproach
  2. ParamsAndFeaturesWritable
  3. HasFeatures
  4. Logging
  5. NerApproach
  6. AnnotatorApproach
  7. CanBeLazy
  8. DefaultParamsWritable
  9. MLWritable
  10. HasOutputAnnotatorType
  11. HasOutputAnnotationCol
  12. HasInputAnnotationCols
  13. Estimator
  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 NerDLApproach()

    Permalink
  2. new NerDLApproach(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]): NerDLModel

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

    Permalink
    Definition Classes
    Any
  11. val batchSize: IntParam

    Permalink

    Batch size

  12. def beforeTraining(spark: SparkSession): Unit

    Permalink
    Definition Classes
    NerDLApproachAnnotatorApproach
  13. def calculateEmbeddingsDim(sentences: Seq[WordpieceEmbeddingsSentence]): Int

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

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

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

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

    Permalink

    ConfigProto from tensorflow, serialized into byte array.

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

  18. final def copy(extra: ParamMap): Estimator[NerDLModel]

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → 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. val description: String

    Permalink

    Trains Tensorflow based Char-CNN-BLSTM model

    Trains Tensorflow based Char-CNN-BLSTM model

    Definition Classes
    NerDLApproachAnnotatorApproach
  22. val dropout: FloatParam

    Permalink

    "Dropout coefficient

  23. val enableMemoryOptimizer: BooleanParam

    Permalink
  24. val enableOutputLogs: BooleanParam

    Permalink

    Whether to output to annotators log folder

  25. val entities: StringArrayParam

    Permalink

    Entities to recognize

    Entities to recognize

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  28. val evaluationLogExtended: BooleanParam

    Permalink

    Whether logs for validation to be extended: it displays time and evaluation of each label.

    Whether logs for validation to be extended: it displays time and evaluation of each label. Default is false.

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

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

    Permalink
    Definition Classes
    Params
  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. final def fit(dataset: Dataset[_]): NerDLModel

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  44. def getBatchSize: Int

    Permalink

    Batch size

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

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

    Permalink

    ConfigProto from tensorflow, serialized into byte array.

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

  47. def getDataSetParams(dsIt: Iterator[Array[(TextSentenceLabels, WordpieceEmbeddingsSentence)]]): (Set[String], Set[Char], Int, Long)

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

    Permalink
    Definition Classes
    Params
  49. def getDropout: Float

    Permalink

    Dropout coefficient

  50. def getEnableMemoryOptimizer: Boolean

    Permalink

    Memory Optimizer

  51. def getEnableOutputLogs: Boolean

    Permalink

    Whether to output to annotators log folder

  52. def getIncludeConfidence: Boolean

    Permalink

    whether to include confidence scores in annotation metadata

  53. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  54. def getIteratorFunc(dataset: Dataset[Row]): () ⇒ Iterator[Array[(TextSentenceLabels, WordpieceEmbeddingsSentence)]]

    Permalink
  55. def getLazyAnnotator: Boolean

    Permalink
    Definition Classes
    CanBeLazy
  56. def getLogName: String

    Permalink
    Definition Classes
    NerDLApproachLogging
  57. def getLr: Float

    Permalink

    Learning Rate

  58. def getMaxEpochs: Int

    Permalink

    Maximum number of epochs to train

    Maximum number of epochs to train

    Definition Classes
    NerApproach
  59. def getMinEpochs: Int

    Permalink

    Minimum number of epochs to train

    Minimum number of epochs to train

    Definition Classes
    NerApproach
  60. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  61. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  62. def getOutputLogsPath: String

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

    Permalink
    Definition Classes
    Params
  64. def getPo: Float

    Permalink

    Learning rate decay coefficient.

    Learning rate decay coefficient. Real Learning Rage = lr / (1 + po * epoch)

  65. def getRandomSeed: Int

    Permalink

    Random seed

    Random seed

    Definition Classes
    NerApproach
  66. def getUseContrib: Boolean

    Permalink

    Whether to use contrib LSTM Cells.

    Whether to use contrib LSTM Cells. Not compatible with Windows. Might slightly improve accuracy.

  67. def getValidationSplit: Float

    Permalink

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

  68. def getVerbose: Int

    Permalink

    Level of verbosity during training

    Level of verbosity during training

    Definition Classes
    NerApproach
  69. val graphFolder: Param[String]

    Permalink

    Folder path that contain external graph files

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

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

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

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

    Permalink

    val includeConfidence = new BooleanParam(this, "includeConfidence", "Whether to include confidence scores in annotation metadata")

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

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

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

    Permalink

    Input annotator types : DOCUMENT, TOKEN, WORD_EMBEDDINGS

    Input annotator types : DOCUMENT, TOKEN, WORD_EMBEDDINGS

    Definition Classes
    NerDLApproachHasInputAnnotationCols
  77. 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
  78. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  82. val labelColumn: Param[String]

    Permalink

    Column with label per each token

    Column with label per each token

    Definition Classes
    NerApproach
  83. val lazyAnnotator: BooleanParam

    Permalink
    Definition Classes
    CanBeLazy
  84. def log(value: ⇒ String, minLevel: Level): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  85. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  97. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  98. val lr: FloatParam

    Permalink

    Learning Rate

  99. val maxEpochs: IntParam

    Permalink

    Maximum number of epochs to train

    Maximum number of epochs to train

    Definition Classes
    NerApproach
  100. val minEpochs: IntParam

    Permalink

    Minimum number of epochs to train

    Minimum number of epochs to train

    Definition Classes
    NerApproach
  101. def msgHelper(schema: StructType): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
  105. def onTrained(model: NerDLModel, spark: SparkSession): Unit

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

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  107. val outputAnnotatorType: String

    Permalink

    Input annotator types : NAMED_ENTITY

    Input annotator types : NAMED_ENTITY

    Definition Classes
    NerDLApproachHasOutputAnnotatorType
  108. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  109. def outputLog(value: ⇒ String, uuid: String, shouldLog: Boolean, outputLogsPath: String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  110. val outputLogsPath: Param[String]

    Permalink
  111. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  112. val po: FloatParam

    Permalink

    Learning rate decay coefficient.

    Learning rate decay coefficient. Real Learning Rage = lr / (1 + po * epoch)

  113. val randomSeed: IntParam

    Permalink

    Random seed

    Random seed

    Definition Classes
    NerApproach
  114. def save(path: String): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  122. def setBatchSize(batch: Int): NerDLApproach.this.type

    Permalink

    Batch size

  123. def setConfigProtoBytes(bytes: Array[Int]): NerDLApproach.this.type

    Permalink

    ConfigProto from tensorflow, serialized into byte array.

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  130. def setDropout(dropout: Float): NerDLApproach.this.type

    Permalink

    Dropout coefficient

  131. def setEnableMemoryOptimizer(value: Boolean): NerDLApproach.this.type

    Permalink
  132. def setEnableOutputLogs(enableOutputLogs: Boolean): NerDLApproach.this.type

    Permalink

    Whether to output to annotators log folder

  133. def setEntities(tags: Array[String]): NerDLApproach

    Permalink

    Entities to recognize

    Entities to recognize

    Definition Classes
    NerApproach
  134. def setEvaluationLogExtended(evaluationLogExtended: Boolean): NerDLApproach.this.type

    Permalink

    Whether logs for validation to be extended: it displays time and evaluation of each label.

    Whether logs for validation to be extended: it displays time and evaluation of each label. Default is false.

  135. def setGraphFolder(path: String): NerDLApproach.this.type

    Permalink

    Folder path that contain external graph files

  136. def setIncludeConfidence(value: Boolean): NerDLApproach.this.type

    Permalink

    Whether to include confidence scores in annotation metadata

  137. final def setInputCols(value: String*): NerDLApproach.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  139. def setLabelColumn(column: String): NerDLApproach

    Permalink

    Column with label per each token

    Column with label per each token

    Definition Classes
    NerApproach
  140. def setLazyAnnotator(value: Boolean): NerDLApproach.this.type

    Permalink
    Definition Classes
    CanBeLazy
  141. def setLr(lr: Float): NerDLApproach.this.type

    Permalink

    Learning Rate

  142. def setMaxEpochs(epochs: Int): NerDLApproach

    Permalink

    Maximum number of epochs to train

    Maximum number of epochs to train

    Definition Classes
    NerApproach
  143. def setMinEpochs(epochs: Int): NerDLApproach

    Permalink

    Minimum number of epochs to train

    Minimum number of epochs to train

    Definition Classes
    NerApproach
  144. final def setOutputCol(value: String): NerDLApproach.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  145. def setOutputLogsPath(path: String): NerDLApproach.this.type

    Permalink
  146. def setPo(po: Float): NerDLApproach.this.type

    Permalink

    Learning rate decay coefficient.

    Learning rate decay coefficient. Real Learning Rage = lr / (1 + po * epoch)

  147. def setRandomSeed(seed: Int): NerDLApproach

    Permalink

    Random seed

    Random seed

    Definition Classes
    NerApproach
  148. def setTestDataset(er: ExternalResource): NerDLApproach.this.type

    Permalink

    Path to test dataset.

    Path to test dataset. If set used to calculate statistic on it during training.

  149. def setTestDataset(path: String, readAs: Format = ReadAs.SPARK, options: Map[String, String] = Map("format" -> "parquet")): NerDLApproach.this.type

    Permalink

    Path to test dataset.

    Path to test dataset. If set used to calculate statistic on it during training.

  150. def setUseContrib(value: Boolean): NerDLApproach.this.type

    Permalink

    Whether to use contrib LSTM Cells.

    Whether to use contrib LSTM Cells. Not compatible with Windows. Might slightly improve accuracy.

  151. def setValidationSplit(validationSplit: Float): NerDLApproach.this.type

    Permalink

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

  152. def setVerbose(verbose: Level): NerDLApproach

    Permalink

    Level of verbosity during training

    Level of verbosity during training

    Definition Classes
    NerApproach
  153. def setVerbose(verbose: Int): NerDLApproach

    Permalink

    Level of verbosity during training

    Level of verbosity during training

    Definition Classes
    NerApproach
  154. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  155. val testDataset: ExternalResourceParam

    Permalink

    val testDataset = new ExternalResourceParam(this, "testDataset", "Path to test dataset.

    val testDataset = new ExternalResourceParam(this, "testDataset", "Path to test dataset. If set used to calculate statistic on it during training.")

  156. def toString(): String

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

    Permalink
    Definition Classes
    NerDLApproachAnnotatorApproach
  158. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

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

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

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

    Permalink
    Definition Classes
    NerDLApproach → Identifiable
  161. val useContrib: BooleanParam

    Permalink

    whether to use contrib LSTM Cells.

    whether to use contrib LSTM Cells. Not compatible with Windows. Might slightly improve accuracy.

  162. 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
    AnnotatorApproach
  163. val validationSplit: FloatParam

    Permalink

    Choose the proportion of training dataset to be validated against the model on each Epoch.

    Choose the proportion of training dataset to be validated against the model on each Epoch. The value should be between 0.0 and 1.0 and by default it is 0.0 and off.

  164. val verbose: IntParam

    Permalink

    Level of verbosity during training

    Level of verbosity during training

    Definition Classes
    NerApproach
  165. val verboseLevel: Level

    Permalink
    Definition Classes
    NerDLApproachLogging
  166. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from Logging

Inherited from NerApproach[NerDLApproach]

Inherited from AnnotatorApproach[NerDLModel]

Inherited from CanBeLazy

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasOutputAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[NerDLModel]

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

Parameter getters