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], 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. AutoCloseable
  6. AnnotatorApproach
  7. DefaultParamsWritable
  8. MLWritable
  9. HasAnnotatorType
  10. HasOutputAnnotationCol
  11. HasInputAnnotationCols
  12. Estimator
  13. PipelineStage
  14. Logging
  15. Params
  16. Serializable
  17. Serializable
  18. Identifiable
  19. AnyRef
  20. 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. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. val annotatorType: String

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

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

    Permalink
  8. val c0: IntParam

    Permalink
  9. final def clear(param: Param[_]): NerCrfApproach.this.type

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

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

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

    Permalink
    Definition Classes
    AnnotatorApproach → Estimator → PipelineStage → Params
  13. def copyValues[T <: Params](to: T, extra: ParamMap): T

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  15. val description: String

    Permalink
    Definition Classes
    NerCrfApproachAnnotatorApproach
  16. def embeddings: Option[WordEmbeddings]

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  17. val embeddingsFormat: IntParam

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  18. val embeddingsNDims: IntParam

    Permalink
    Definition Classes
    ApproachWithWordEmbeddings
  19. val entities: StringArrayParam

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

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

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

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

    Permalink
    Definition Classes
    Params
  24. val externalDataset: ExternalResourceParam

    Permalink
    Definition Classes
    NerApproach
  25. val externalFeatures: ExternalResourceParam

    Permalink
  26. final def extractParamMap(): ParamMap

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

    Permalink
    Definition Classes
    Params
  28. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  33. final def get[T](param: Param[T]): Option[T]

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

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

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

    Permalink

    returns

    input annotations columns currently used

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

    Permalink
    Definition Classes
    Params
  38. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  51. val labelColumn: Param[String]

    Permalink
    Definition Classes
    NerApproach
  52. def log: Logger

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
  65. val maxEpochs: IntParam

    Permalink
    Definition Classes
    NerApproach
  66. val minEpochs: IntParam

    Permalink
    Definition Classes
    NerApproach
  67. val minW: DoubleParam

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

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

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

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

    Permalink
  72. final val outputCol: Param[String]

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

    Permalink
    Definition Classes
    Params
  74. val randomSeed: IntParam

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

    Permalink
    Definition Classes
    HasRecursiveFit
  76. 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
  77. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  78. final def set(paramPair: ParamPair[_]): NerCrfApproach.this.type

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

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

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

    Permalink
  82. final def setDefault(paramPairs: ParamPair[_]*): NerCrfApproach.this.type

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

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  84. def setEmbeddingsSource(path: String, nDims: Int, format: String): NerCrfApproach

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

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

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

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

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

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

    Permalink
  91. final def setInputCols(value: String*): NerCrfApproach.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  92. 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
  93. def setL2(l2: Double): NerCrfApproach

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

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

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

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

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

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

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    NerCrfApproach → Identifiable
  110. 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
  111. val verbose: IntParam

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

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

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

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

    Permalink
    Definition Classes
    DefaultParamsWritable → MLWritable

Inherited from NerApproach[NerCrfApproach]

Inherited from HasRecursiveFit[NerCrfModel]

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