Class/Object

com.johnsnowlabs.nlp.annotators.ner.crf

NerCrfApproach

Related Docs: object NerCrfApproach | package crf

Permalink

class NerCrfApproach extends ApproachWithWordEmbeddings[NerCrfApproach, NerCrfModel] with HasRecursiveFit[NerCrfModel] with NerApproach[NerCrfApproach]

Linear Supertypes
NerApproach[NerCrfApproach], HasRecursiveFit[NerCrfModel], ApproachWithWordEmbeddings[NerCrfApproach, NerCrfModel], HasEmbeddings, ParamsAndFeaturesWritable, HasFeatures, AutoCloseable, AnnotatorApproach[NerCrfModel], DefaultParamsWritable, MLWritable, HasAnnotatorType, HasOutputAnnotationCol, HasInputAnnotationCols, Estimator[NerCrfModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NerCrfApproach
  2. NerApproach
  3. HasRecursiveFit
  4. ApproachWithWordEmbeddings
  5. HasEmbeddings
  6. ParamsAndFeaturesWritable
  7. HasFeatures
  8. AutoCloseable
  9. AnnotatorApproach
  10. DefaultParamsWritable
  11. MLWritable
  12. HasAnnotatorType
  13. HasOutputAnnotationCol
  14. HasInputAnnotationCols
  15. Estimator
  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 NerCrfApproach()

    Permalink
  2. new NerCrfApproach(uid: String)

    Permalink

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasAnnotatorType

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. val annotatorType: String

    Permalink
    Definition Classes
    NerCrfApproachHasAnnotatorType
  10. final def asInstanceOf[T0]: T0

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

    Permalink
  12. val c0: IntParam

    Permalink
  13. val caseSensitiveEmbeddings: BooleanParam

    Permalink
    Definition Classes
    HasEmbeddings
  14. final def clear(param: Param[_]): NerCrfApproach.this.type

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def close(): Unit

    Permalink
    Definition Classes
    HasEmbeddings → AutoCloseable
  17. final def copy(extra: ParamMap): Estimator[NerCrfModel]

    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
    NerCrfApproachAnnotatorApproach
  21. val embeddingsDim: IntParam

    Permalink
    Definition Classes
    HasEmbeddings
  22. val embeddingsFormat: IntParam

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  23. val embeddingsRef: Param[String]

    Permalink
    Definition Classes
    HasEmbeddings
  24. val entities: StringArrayParam

    Permalink
    Definition Classes
    NerApproach
  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. val externalDataset: ExternalResourceParam

    Permalink
    Definition Classes
    NerApproach
  30. val externalFeatures: ExternalResourceParam

    Permalink
  31. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  32. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    AnnotatorApproach
  33. final def extractParamMap(): ParamMap

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  46. def getCaseSensitiveEmbeddings: Boolean

    Permalink
    Definition Classes
    HasEmbeddings
  47. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  48. def getClusterEmbeddings: ClusterWordEmbeddings

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

    Permalink
    Definition Classes
    Params
  50. def getEmbeddingsDim: Int

    Permalink
    Definition Classes
    HasEmbeddings
  51. def getEmbeddingsRef: String

    Permalink
    Definition Classes
    HasEmbeddings
  52. def getIncludeEmbeddings: Boolean

    Permalink
    Definition Classes
    HasEmbeddings
  53. final def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  54. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  55. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  60. val includeEmbeddings: BooleanParam

    Permalink
    Definition Classes
    HasEmbeddings
  61. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. 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
  64. final def isDefined(param: Param[_]): Boolean

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  68. val l2: DoubleParam

    Permalink
  69. val labelColumn: Param[String]

    Permalink
    Definition Classes
    NerApproach
  70. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  82. val lossEps: DoubleParam

    Permalink
  83. val maxEpochs: IntParam

    Permalink
    Definition Classes
    NerApproach
  84. val minEpochs: IntParam

    Permalink
    Definition Classes
    NerApproach
  85. val minW: DoubleParam

    Permalink
  86. final def ne(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable
  91. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  93. val randomSeed: IntParam

    Permalink
    Definition Classes
    NerApproach
  94. final def recursiveFit(dataset: Dataset[_], recursivePipeline: PipelineModel): NerCrfModel

    Permalink
    Definition Classes
    HasRecursiveFit
  95. val requiredAnnotatorTypes: Array[String]

    Permalink

    Annotator reference id.

    Annotator reference id. Used to identify elements in metadata or to refer to this annotator type

    Definition Classes
    NerCrfApproachHasInputAnnotationCols
  96. def save(path: String): Unit

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Params
  104. def setC0(c0: Int): NerCrfApproach

    Permalink
  105. def setCaseSensitiveEmbeddings(value: Boolean): NerCrfApproach.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  106. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): NerCrfApproach.this.type

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

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

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  112. def setEmbeddingsDim(value: Int): NerCrfApproach.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  113. def setEmbeddingsRef(value: String): NerCrfApproach.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  114. def setEmbeddingsSource(path: String, nDims: Int, format: String): NerCrfApproach

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  115. def setEmbeddingsSource(path: String, nDims: Int, format: Format): NerCrfApproach

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  116. def setEntities(tags: Array[String]): NerCrfApproach

    Permalink
    Definition Classes
    NerApproach
  117. def setExternalDataset(path: String, readAs: Format = ReadAs.LINE_BY_LINE, options: Map[String, String] = Map("format" -> "text")): NerCrfApproach.this.type

    Permalink
    Definition Classes
    NerApproach
  118. def setExternalDataset(path: ExternalResource): NerCrfApproach

    Permalink
    Definition Classes
    NerApproach
  119. def setExternalFeatures(path: String, delimiter: String, readAs: Format = ReadAs.LINE_BY_LINE, options: Map[String, String] = Map("format" -> "text")): NerCrfApproach.this.type

    Permalink
  120. def setExternalFeatures(value: ExternalResource): NerCrfApproach

    Permalink
  121. def setIncludeEmbeddings(value: Boolean): NerCrfApproach.this.type

    Permalink
    Definition Classes
    HasEmbeddings
  122. final def setInputCols(value: String*): NerCrfApproach.this.type

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

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  124. def setL2(l2: Double): NerCrfApproach

    Permalink
  125. def setLabelColumn(column: String): NerCrfApproach

    Permalink
    Definition Classes
    NerApproach
  126. def setLossEps(eps: Double): NerCrfApproach

    Permalink
  127. def setMaxEpochs(epochs: Int): NerCrfApproach

    Permalink
    Definition Classes
    NerApproach
  128. def setMinEpochs(epochs: Int): NerCrfApproach

    Permalink
    Definition Classes
    NerApproach
  129. def setMinW(w: Double): NerCrfApproach

    Permalink
  130. final def setOutputCol(value: String): NerCrfApproach.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  131. def setRandomSeed(seed: Int): NerCrfApproach

    Permalink
    Definition Classes
    NerApproach
  132. def setVerbose(verbose: Level): NerCrfApproach

    Permalink
    Definition Classes
    NerApproach
  133. def setVerbose(verbose: Int): NerCrfApproach

    Permalink
    Definition Classes
    NerApproach
  134. val sourceEmbeddingsPath: Param[String]

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  135. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink
    Definition Classes
    NerCrfApproachAnnotatorApproach
  138. 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
  139. def transformSchema(schema: StructType, logging: Boolean): StructType

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

    Permalink
    Definition Classes
    NerCrfApproach → Identifiable
  141. 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
    HasInputAnnotationCols
  142. val verbose: IntParam

    Permalink
    Definition Classes
    NerApproach
  143. final def wait(): Unit

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

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

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

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from NerApproach[NerCrfApproach]

Inherited from HasRecursiveFit[NerCrfModel]

Inherited from HasEmbeddings

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from AutoCloseable

Inherited from AnnotatorApproach[NerCrfModel]

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from HasAnnotatorType

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from Estimator[NerCrfModel]

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